clap_allgen 0.2.1

The complete clap generation utility to give your command-line application users a more polished experience right out of the box.
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

# Clap All-Gen

[![CI](https://github.com/wiktor-k/clap_allgen/actions/workflows/rust.yml/badge.svg)](https://github.com/wiktor-k/clap_allgen/actions/workflows/rust.yml)
[![Crates.io](https://img.shields.io/crates/v/clap_allgen)](https://crates.io/crates/clap_allgen)

The complete clap generation utility to give your command-line application users a more polished experience right out of the box.

This single crate integrates all other shell-specific crates to generate *all the things* at once.

## Examples

To create all shell completions use the following command:

```rust
use clap_allgen::render_shell_completions;

#[derive(Debug, clap::Parser)]
enum Commands {
    First,
    Second,
    Third,
}

render_shell_completions::<Commands>("/tmp/shell-completions").expect("generation to work");
```

To generate man pages for your commands use:

```rust
use clap_allgen::render_manpages;

#[derive(Debug, clap::Parser)]
enum Commands {
    First,
    Second,
    Third,
}

render_manpages::<Commands>("/tmp/man-pages").expect("generation to work");
```

## Features

Since the project is called *clap_allgen* it tries to generate completions for every shell that has a Rust crate.

For people who want to have more fine-grained control over dependencies that are pulled in, this crate offers a way to disable individual dependencies by using crate features.

By default all features are enabled so `default-features = false` is required to override it.
Then, one can opt-in using the following features:

- `nushell` - generates NuShell completions using [`clap_complete_nushell`](https://crates.io/crates/clap_complete_nushell)
- `fig` - generates Fig completions using [`clap_complete_fig`](https://crates.io/crates/clap_complete_fig)
- `carapace` - generates Carapace spec files using [`carapace_spec_clap`](https://crates.io/crates/carapace_spec_clap)

## License

This project is licensed under either of:

  - [Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0),
  - [MIT license](https://opensource.org/licenses/MIT).

at your option.

### Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in this crate by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.