clihelp 0.1.0

Shared colored --help rendering + --color=<WHEN> resolution for the fast* CLI toolkit
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51

# clihelp

The colored `--help` renderer shared by the `fast*` utils, extracted after
all of them independently reinvented the same `Row`/`Section`/`paint` help page.

## Usage

```rust
use clihelp::{ColorWhen, HelpPage, Row, Section};

let page = HelpPage::new("fasthex 0.3.0 - a very fast hex dumper")
    .usage("fasthex [options] [file]...")
    .usage("fasthex -r [options] [file] [-j <offset>]")
    .blurb("Multiple files are concatenated and treated as one stream.")
    .section(Section::with_note(
        "OUTPUT FORMAT",
        "Rule: lowercase = one-byte mode, UPPERCASE = two-byte mode.",
        vec![
            Row::new("", "(default)", "canonical hex + ASCII display"),
            Row::new("-x", "--hex", "one-byte hexadecimal display"),
        ],
    ))
    .section(Section::new(
        "LAYOUT",
        vec![Row::with_value("-W", "--width", "<N>", "bytes per row (default: 16)")],
    ));

page.print(ColorWhen::Auto);
```

`ColorWhen` also resolves the `-L/--color <auto|always|never>` flag pattern
shared by these tools:

```rust
let color = clihelp::ColorWhen::parse(&flag_value)?.resolve();
```

For output that doesn't fit the flag-table model, free-form prose sections,
or coloring numbers outside the help page entirely; `clihelp::header()` and
`clihelp::paint()` expose the same palette directly.

## Install

```toml
[dependencies]
clihelp = "0.1"
```

## License

GPL-3.0-or-later, matching the tools that use it.