cliproc 0.1.0

A low-level command-line processor
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
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66

# `cliproc`

[![Pipeline](https://github.com/cdotrus/cliproc/actions/workflows/pipeline.yml/badge.svg?branch=trunk)](https://github.com/cdotrus/cliproc/actions/workflows/pipeline.yml) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

This library provides support for fast, low-level, and configurable command-line processing.

``` toml
[dependencies]
cliproc = "0.1.0"
```

## Details

Arguments are learned as-they-go: the cli parsing framework learns each argument upon checking it. For this reason, in order to maximize effectiveness of the parsing __it is recommended to parse arguments in the following order__:
1. flags
2. options
3. positionals
4. subcommands

For a type to be accepted by the command-line, it must implement the standard library's [`std::str::FromStr`](https://doc.rust-lang.org/std/str/trait.FromStr.html) trait.

## Features

- long options (flags/options)): `--verbose`

- short options (switches): `-v`

- positional value placement: `--output a.out`, `-o a.out`

- attached value placement: `--output=a.out`, `-o=a.out`

- combine switches: `-rf`

- capture variable flag calls: `--inc --inc --inc...`

- capture variable option calls: `--op 10 --op 20 --op 30`

- capture variable positional calls: `10 20 30`

- capture variable limited user-defined caps for flag and option calls: `--verbose --verbose --verbose` (ex: up to 3)

- combine switches and give value to final switch: `-rfo=a.out`

- ability to prioritize help over any other error

- ability to enable/disable a help flag with custom long/short flag names

- subcommand support: `calc add 10 20`, `calc mult 10 20`

- arguments can be reused in both structs for overall command and nested subcommand

- minimal dependencies (only relies on `colored` crate)

- uses dynamic programming sequence alignment algorithm to detect misspelled arguments (with configurable `threshold` for string comparison)

- ability to set user-defined help text before parsing

- ability to verify there are no unused arguments passed in the cli

- verifies all argument type conversions are accepted during parsing

- preserves unprocessed arguments found after an empty flag `--` symbol

## Examples

See the [examples/](./examples/) folder for practical implementations.