mirror of
https://github.com/clap-rs/clap
synced 2025-03-04 23:37:32 +00:00
42c943844c
In switching to title case for help headings (#4123), it caused me to look at "subcommand" in a fresh light. I can't quite put my finger on it but "Subcommand" looks a bit sloppy. I also have recently been surveying other CLIs and they just use "command" as well. All of them are commands anyways, just some are children of others (subcommands) while others are not (root or top-level commands, or just command). Context is good enough for clarifying subcommands from root commands. This is part of #4132
2.1 KiB
2.1 KiB
Git is an example of several common subcommand patterns.
Help:
$ git
? failed
git
A fictional versioning CLI
Usage:
git[EXE] <COMMAND>
Commands:
clone Clones repos
push pushes things
add adds things
stash
help Print this message or the help of the given subcommand(s)
Options:
-h, --help Print help information
$ git help
git
A fictional versioning CLI
Usage:
git[EXE] <COMMAND>
Commands:
clone Clones repos
push pushes things
add adds things
stash
help Print this message or the help of the given subcommand(s)
Options:
-h, --help Print help information
$ git help add
git-add
adds things
Usage:
git[EXE] add <PATH>...
Arguments:
<PATH>... Stuff to add
Options:
-h, --help Print help information
A basic argument:
$ git add
? failed
git-add
adds things
Usage:
git[EXE] add <PATH>...
Arguments:
<PATH>... Stuff to add
Options:
-h, --help Print help information
$ git add Cargo.toml Cargo.lock
Adding ["Cargo.toml", "Cargo.lock"]
Default subcommand:
$ git stash -h
git-stash
Usage:
git[EXE] stash [OPTIONS]
git[EXE] stash <COMMAND>
Commands:
push
pop
apply
help Print this message or the help of the given subcommand(s)
Options:
-m, --message <MESSAGE>
-h, --help Print help information
$ git stash push -h
git-stash-push
Usage:
git[EXE] stash push [OPTIONS]
Options:
-m, --message <MESSAGE>
-h, --help Print help information
$ git stash pop -h
git-stash-pop
Usage:
git[EXE] stash pop [STASH]
Arguments:
[STASH]
Options:
-h, --help Print help information
$ git stash -m "Prototype"
Pushing Some("Prototype")
$ git stash pop
Popping None
$ git stash push -m "Prototype"
Pushing Some("Prototype")
$ git stash pop
Popping None
External subcommands:
$ git custom-tool arg1 --foo bar
Calling out to "custom-tool" with ["arg1", "--foo", "bar"]