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/find.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

921 B
Raw Blame History

find is an example of position-sensitive flags

$ find --help
clap 4.0.0-alpha.0
A simple to use, efficient, and full-featured Command Line Argument Parser

Usage:
    find[EXE] [OPTIONS] --name <NAME>

Options:
    -h, --help       Print help information
    -V, --version    Print version information

TESTS:
        --empty          File is empty and is either a regular file or a directory
        --name <NAME>    Base of file name (the path with the leading directories removed) matches
                         shell pattern pattern

OPERATORS:
    -o, --or     expr2 is not evaluate if exp1 is true
    -a, --and    Same as `expr1 expr1`

$ find --empty -o --name .keep
[
    (
        "empty",
        Bool(
            true,
        ),
    ),
    (
        "or",
        Bool(
            true,
        ),
    ),
    (
        "name",
        String(
            ".keep",
        ),
    ),
]