mirror of
https://github.com/clap-rs/clap
synced 2024-12-13 22:32:33 +00:00
36bc641648
This is an intermediate solution for #4408. As there were no agreeed upon goals, I went with what I felt read well and that I saw commonly used on non-clap commands. - "information" isn't really a necessary word. - I originally favored `Print this help` but realied that doesn't read correctly in completions. - Besides being shorter, the reason for the flipped short/long hint is it gives people the context they need for scanning, emphasizing "summary" and "more". Fixes #4409
38 lines
961 B
Markdown
38 lines
961 B
Markdown
For more on creating a custom subcommand, see [the cargo
|
|
book](https://doc.rust-lang.org/cargo/reference/external-tools.html#custom-subcommands).
|
|
The crate [`clap-cargo`](https://github.com/crate-ci/clap-cargo) can help in
|
|
mimicking cargo's interface.
|
|
|
|
The help looks like:
|
|
```console
|
|
$ cargo-example --help
|
|
Usage: cargo <COMMAND>
|
|
|
|
Commands:
|
|
example A simple to use, efficient, and full-featured Command Line Argument Parser
|
|
help Print this message or the help of the given subcommand(s)
|
|
|
|
Options:
|
|
-h, --help Print help
|
|
|
|
$ cargo-example example --help
|
|
A simple to use, efficient, and full-featured Command Line Argument Parser
|
|
|
|
Usage: cargo example [OPTIONS]
|
|
|
|
Options:
|
|
--manifest-path <PATH>
|
|
-h, --help Print help
|
|
-V, --version Print version
|
|
|
|
```
|
|
|
|
Then to directly invoke the command, run:
|
|
```console
|
|
$ cargo-example example
|
|
None
|
|
|
|
$ cargo-example example --manifest-path Cargo.toml
|
|
Some("Cargo.toml")
|
|
|
|
```
|