Mirrors/clap
2
0
Fork 0
mirror of https://github.com/clap-rs/clap synced 2024-12-13 14:22:34 +00:00
Code Issues Projects Releases Packages Wiki Activity
clap/examples/cargo-example.md
Ed Page 83d6add9aa fix(help): Shift focus to subcommands, when present 
In surveying various tools and CLI parsers, I noticed they list the
subcommands first.  This puts an emphasis on them which makes sense
because that is most likely what an end user is supposed to pass in
next.

Listing them last aligns with the usage order but it probably doesn't
outweigh the value of getting a user moving forward.
2022-08-26 10:59:40 -05:00

1 KiB
Raw Blame History

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>

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)

Options:
    -h, --help    Print help information

$ cargo-example example --help
cargo-example [..]
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")