clap/examples/cargo-example.md
Hugo Osvaldo Barrera 7110401595 docs: Fix messed up highlighting
This just affects how it's rendered; rather than attempting to highlight
these blocks as a shell script, they'll get highlighted as console
output.

See the rendered versions for a better comparison.
2022-01-05 11:53:06 -06:00

1.1 KiB

Jump to source

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
cargo 

USAGE:
    cargo <SUBCOMMAND>

OPTIONS:
    -h, --help    Print help information

SUBCOMMANDS:
    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)

$ cargo-example example --help
cargo-example [..]
A simple to use, efficient, and full-featured Command Line Argument Parser

USAGE:
    cargo example [OPTIONS]

OPTIONS:
    -h, --help                    Print help information
        --manifest-path <PATH>    
    -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")