https://github.com/lusingander/cargo-selector
Cargo subcommand to select and execute binary/example targets 📦
https://github.com/lusingander/cargo-selector
cargo cargo-plugin cargo-subcommand ratatui tui
Last synced: 6 days ago
JSON representation
Cargo subcommand to select and execute binary/example targets 📦
- Host: GitHub
- URL: https://github.com/lusingander/cargo-selector
- Owner: lusingander
- License: mit
- Created: 2024-04-11T08:49:13.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2024-04-25T13:12:27.000Z (12 months ago)
- Last Synced: 2024-04-30T07:17:31.658Z (12 months ago)
- Topics: cargo, cargo-plugin, cargo-subcommand, ratatui, tui
- Language: Rust
- Homepage: https://lusingander.github.io/cargo-selector/
- Size: 999 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-ratatui - cargo-selector - Cargo subcommand to select and execute binary/example targets. (💻 Apps / ⌨️ Development Tools)
README
# cargo-selector
[](https://crates.io/crates/cargo-selector)
Cargo subcommand to select and execute binary/example targets
(This demo uses [Ratatui](https://github.com/ratatui-org/ratatui) as an example!)
## Installation
```
$ cargo install cargo-selector
```
### AUR
```
$ paru -S cargo-selector
```
## Usage
### Basic
Run the command in the cargo project directory:
```
$ cargo selector
```
Then, target list will be displayed, and you can execute the following command by selecting it.
```sh
# if the target is bin
$ cargo run --bin xyz [--features "foo bar"]
# if the target is example
$ cargo run --example xyz [--features "foo bar"]
```
By switching the action, you can also run only the build.
### Options
```
Usage: cargo selector [OPTIONS]
Options:
-i, --inline Display list inline
-n, --inline-list-size List size [default: 10]
-k, --kind Target kind [possible values: bin, example]
-t, --match-type Match type [possible values: substring, fuzzy]
-a, --additional-args Additional arguments
-h, --help Print help
-V, --version Print version
```
#### -a, --additional-args
If you run the command:
```
$ cargo selector -a "-- --foo 1"
```
Then select the command and it will run:
```sh
$ cargo run --bin xyz -- --foo 1
```
### Keybindings
| Key | Description |
| --------------------------------- | -------------------------------------------- |
| Down Ctrl+n | cursor down |
| Up Ctrl+p | cursor up |
| Enter | execute `cargo run --bin/example ` |
| Tab | switch actions |
| Esc Ctrl+c | quit |
### Config
If the `CARGO_SELECTOR_CONFIG` environment variable specifies the path to the config file, the config will be loaded.
The config file uses the following format:
```toml
# Sets the default match type. If argument `-t` or `--match-type` is specified, it will be overridden.
# type: enum ("substring" | "fuzzy")
match_type = "substring"
# Sets the display colors.
# Colors can be set in one of the following formats:
# - ANSI color name
# - "red", "bright-blue"
# - 8-bit color (256-color) index values
# - "34", "128", "255"
# - 24-bit true color hex codes
# - "#abcdef"
# type: string
[color]
bg = "reset"
action_run_bg = "green"
action_run_fg = "black"
action_build_bg = "blue"
action_build_fg = "black"
input_fg = "reset"
numbers_fg = "darkgrey"
kind_fg = "blue"
name_fg = "white"
name_match_fg = "red"
path_fg = "darkgrey"
features_fg = "darkgrey"
selected_bg = "yellow"
```
## License
MIT