cargo-xtask-runner 0.3.0

A graphical task runner for cargo xtask workflows. Run `cargo xtask-runner` inside any Rust project.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78

# cargo-xtask-runner


A GUI for [cargo xtask](https://github.com/matklad/cargo-xtask) workflows.

<img src="cargo_xtask_runner/images/img.png" alt="Logo" width="500">

Instead of typing `cargo xtask <task> <target>` in the terminal, open a GUI that lists all your tasks, lets you check which ones to run, and streams the output to a built-in console - all without leaving your project or blocking the terminal

---

## Installation


```bash
cargo install cargo-xtask-runner
```

## Usage


Navigate to any Rust project that has an xtask runner and run:

```bash
cd my-rust-project
cargo xtask-runner
```

The GUI will open. The terminal is free to use for anything else while it runs.

## Requirements


Your project's xtask runner must support a `--list` flag that outputs tasks in this format:

```
target|task_id|description
```

For example:
```
workspace|fmt|Format all code
package|test|Run unit tests
package|build|Build release binary
```

Each line is one task. The `target` field groups tasks in the dropdown. Use `workspace` (or any other keyword) for tasks that apply globally and don't need a target argument.

### Example xtask `--list` implementation


```rust
// in xtask/src/main.rs
if args.contains(&"--list") {
    println!("workspace|fmt|Format all code");
    println!("workspace|clippy|Run clippy lints");
    println!("package|test|Run unit tests");
    println!("package|build|Build release binary");
    return;
}
```

## How it works


### Run all tasks via checkboxes.


![img.png](cargo_xtask_runner/images/img.png)

### Aborts when an error occurs in ooder.


![img_1.png](cargo_xtask_runner/images/img_1.png)

### Run individual tasks (test is running)


![img_2.png](cargo_xtask_runner/images/img_2.png)

### Stop tasks at will.


![img_3.png](cargo_xtask_runner/images/img_3.png)

## License


MIT — see [LICENSE](LICENSE)