Skip to content

Kobzol/cli_doc

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

26 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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).

Examples

Cargo

$ cli_doc cargo

Output: doc.html

HyperQueue

Generating documentation for HyperQueue

$ cli_doc hq

Output: doc.html

Installation

$ cargo install cli_doc

About

Documentation generator for CLI

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Rust 83.6%
  • HTML 10.2%
  • JavaScript 6.2%