mirror of
https://github.com/clap-rs/clap
synced 2024-12-15 15:22:30 +00:00
32b5520ff1
mitsuhiko immediately jumped into the examples and got tripped up by the lack of documentation on feature flags needed. I limited this to just the root ones because the rest are in a more proper tutorial that steps through it all.
81 lines
1.4 KiB
Markdown
81 lines
1.4 KiB
Markdown
*Jump to [source](git_derive.rs)*
|
|
|
|
**This requires enabling the `derive` feature flag.**
|
|
|
|
Git is an example of several common subcommand patterns.
|
|
|
|
Help:
|
|
```bash
|
|
$ git_derive
|
|
? failed
|
|
git
|
|
|
|
A fictional versioning CLI
|
|
|
|
USAGE:
|
|
git_derive[EXE] <SUBCOMMAND>
|
|
|
|
OPTIONS:
|
|
-h, --help Print help information
|
|
|
|
SUBCOMMANDS:
|
|
add adds things
|
|
clone Clones repos
|
|
help Print this message or the help of the given subcommand(s)
|
|
push pushes things
|
|
$ git_derive help
|
|
git
|
|
|
|
A fictional versioning CLI
|
|
|
|
USAGE:
|
|
git_derive[EXE] <SUBCOMMAND>
|
|
|
|
OPTIONS:
|
|
-h, --help Print help information
|
|
|
|
SUBCOMMANDS:
|
|
add adds things
|
|
clone Clones repos
|
|
help Print this message or the help of the given subcommand(s)
|
|
push pushes things
|
|
$ git_derive help add
|
|
git_derive[EXE]-add
|
|
|
|
adds things
|
|
|
|
USAGE:
|
|
git_derive[EXE] add <PATH>...
|
|
|
|
ARGS:
|
|
<PATH>... Stuff to add
|
|
|
|
OPTIONS:
|
|
-h, --help Print help information
|
|
```
|
|
|
|
A basic argument:
|
|
```bash
|
|
$ git_derive add
|
|
? failed
|
|
git_derive[EXE]-add
|
|
|
|
adds things
|
|
|
|
USAGE:
|
|
git_derive[EXE] add <PATH>...
|
|
|
|
ARGS:
|
|
<PATH>... Stuff to add
|
|
|
|
OPTIONS:
|
|
-h, --help Print help information
|
|
$ git_derive add Cargo.toml Cargo.lock
|
|
Adding ["Cargo.toml", "Cargo.lock"]
|
|
```
|
|
|
|
External subcommands:
|
|
```bash
|
|
$ git_derive custom-tool arg1 --foo bar
|
|
Calling out to "custom-tool" with ["arg1", "--foo", "bar"]
|
|
```
|