cargo-gui 0.1.0

A browser interface for working through rustc errors and running cargo commands.
cargo-gui-0.1.0 is not a library.

cargo-gui

A browser interface for working through rustc errors and running cargo commands.

sample image

Usage

Install

Install from the github repository:

git clone https://github.com/eignnx/cargo-gui.git
cd cargo-gui
cargo build

(Eventually you should be able to run cargo install cargo-gui, but we're not there yet.)

Start the Server

Next, go to your cargo project directory and start the cargo-gui server:

$ cd my-cargo-project # go to your project directory
$ cargo run --manifest-path /path/to/cargo-gui/Cargo.toml
Your `cargo-gui` app is running at http://localhost:8080/site/index.html

(Eventually you won't have to pass the --manifest-path flag.)

Opening the Dashboard

Now open that link in your web browser: http://localhost:8080/site/index.html

In the Dashboard

You can click the Run, Build, Test, Check buttons to invoke the corresponding cargo commands (i.e. Run invokes cargo run in your project directory).

NOTE: Currently, Run doesn't support streaming output from your executables! If you're trying to run a never-ending task (like a server), you will just never get a response back unless there's an error. This is because cargo-gui is waiting for your program to finish before showing you the output. See this github issue if you have suggestions on how to fix this!

If building, testing, or checking your program results in compilation errors, they will be displayed in a paginated format below. You can used the pagination navbar to see the Next, Previous, First and Last compilation errors. You can also use the left and right arrow keys on your keyboard to go to the next and previous errors.