clap/examples/tutorial_builder/01_quick.md
Ed Page 9b23a09f7a fix(help): Don't rely on ALL CAPS for headers
I see them fulfilling two roles
- A form of bolding
- As a callback to their placeholder in usage

However, it is a bit of an unpolished look and no other CLI seems to do
it.  This looks a bit more proefessional.  We have colored help for
formatting and I think the sections relation to usage will be clear
enough.
2022-08-26 10:21:18 -05:00

783 B

$ 01_quick --help
clap [..]
A simple to use, efficient, and full-featured Command Line Argument Parser

Usage:
    01_quick[EXE] [OPTIONS] [name] [SUBCOMMAND]

Arguments:
    <name>    Optional name to operate on

Options:
    -c, --config <FILE>    Sets a custom config file
    -d, --debug...         Turn debugging information on
    -h, --help             Print help information
    -V, --version          Print version information

Subcommands:
    test    does testing things
    help    Print this message or the help of the given subcommand(s)

By default, the program does nothing:

$ 01_quick
Debug mode is off

But you can mix and match the various features

$ 01_quick -dd test
Debug mode is on
Not printing testing lists...