clap/examples/tutorial_builder/04_04_custom.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

1.3 KiB

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

Usage:
    04_04_custom[EXE] [OPTIONS] [INPUT_FILE]

Arguments:
    <INPUT_FILE>    some regular input

Options:
        --set-ver <VER>        set version manually
        --major                auto inc major
        --minor                auto inc minor
        --patch                auto inc patch
        --spec-in <SPEC_IN>    some special input argument
    -c <CONFIG>                
    -h, --help                 Print help information
    -V, --version              Print version information

$ 04_04_custom
? failed
error: Can only modify one version field

Usage:
    04_04_custom[EXE] [OPTIONS] [INPUT_FILE]

For more information try --help

$ 04_04_custom --major
Version: 2.2.3

$ 04_04_custom --major --minor
? failed
error: Can only modify one version field

Usage:
    04_04_custom[EXE] [OPTIONS] [INPUT_FILE]

For more information try --help

$ 04_04_custom --major -c config.toml
? failed
Version: 2.2.3
error: INPUT_FILE or --spec-in is required when using --config

Usage:
    04_04_custom[EXE] [OPTIONS] [INPUT_FILE]

For more information try --help

$ 04_04_custom --major -c config.toml --spec-in input.txt
Version: 2.2.3
Doing work using input input.txt and config config.toml