コマンドの usage の書き方
1行目にコマンドの説明
2行目に Usage
<HOGE> で HOGE を必須指定
[FUGA] で FUGA はオプション
全部大文字で書くことが多い気がする
あとはオプションやサブコマンドの説明
code:usage
$ hoge --help
Description of hoge
OPTIONS:
-v, --version Print version
-h, --help Show this help text
code:cargo
❯ cargo help
Rust's package manager
USAGE:
OPTIONS:
-V, --version Print version info and exit
--list List installed commands
--explain <CODE> Run rustc --explain CODE
-v, --verbose Use verbose output (-vv very verbose/build.rs output)
-q, --quiet No output printed to stdout
--color <WHEN> Coloring: auto, always, never
--frozen Require Cargo.lock and cache are up to date
--locked Require Cargo.lock is up to date
-Z <FLAG>... Unstable (nightly-only) flags to Cargo, see 'cargo -Z help' for details
-h, --help Prints help information
Some common cargo commands are (see all commands with --list):
build Compile the current project
check Analyze the current project and report errors, but don't build object files
clean Remove the target directory
doc Build this project's and its dependencies' documentation
new Create a new cargo project
init Create a new cargo project in an existing directory
run Build and execute src/main.rs
test Run the tests
bench Run the benchmarks
update Update dependencies listed in Cargo.lock
search Search registry for crates
publish Package and upload this project to the registry
install Install a Rust binary
uninstall Uninstall a Rust binary
See 'cargo help <command>' for more information on a specific command.