clap/examples/cargo-example-derive.md
Ed Page 65b5b5f7bf fix(help): Remove name/version/author from help
This is to help shorten it and polish it by removing redundant
information.

This is a part of #4132
2022-08-31 15:06:15 -05:00

40 lines
1.1 KiB
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-derive --help
Usage:
cargo <COMMAND>
Commands:
example-derive 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 information
$ cargo-example-derive example-derive --help
A simple to use, efficient, and full-featured Command Line Argument Parser
Usage:
cargo example-derive [OPTIONS]
Options:
--manifest-path <MANIFEST_PATH>
-h, --help Print help information
-V, --version Print version information
```
Then to directly invoke the command, run:
```console
$ cargo-example-derive example-derive
None
$ cargo-example-derive example-derive --manifest-path Cargo.toml
Some("Cargo.toml")
```