cli_doc 0.1.1

Documentation generator for CLI
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

# `cli_doc` - Documentation generator for CLI

`cli_doc` generates HTML documentation for an application's command-line interface. 

`cli_doc` does not need to be compiled with the application; it just needs its executable. It automatically extracts information by (recursively) calling the application with the `--help` option. 

Currently, `cli_doc` supports only CLIs that are generated by `clap` (or applications with a similar help format).

<p align="center">
<img src="docs/screenshot.png">
</p>


## Examples

### Cargo

```commandline
$ cli_doc cargo
```

Output: [doc.html](https://htmlpreview.github.io/?https://github.com/spirali/cli_doc/blob/main/docs/cargo.html)


### HyperQueue

Generating documentation for [HyperQueue](https://github.com/It4innovations/hyperqueue)

```commandline
$ cli_doc hq
```

Output: [doc.html](https://htmlpreview.github.io/?https://github.com/spirali/cli_doc/blob/main/docs/hq.html)

## Installation

```commandline
$ cargo install cli_doc
```