clap/examples/cargo-example.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

1 KiB

For more on creating a custom subcommand, see the cargo book. The crate clap-cargo can help in mimicking cargo's interface.

The help looks like:

$ 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 information

$ 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 information
    -V, --version                 Print version information

Then to directly invoke the command, run:

$ cargo-example example
None

$ cargo-example example --manifest-path Cargo.toml
Some("Cargo.toml")