Generate Documentation for Your CLI Tool
Create user-friendly CLI documentation with command references, installation instructions, and usage examples.
Free for public repos. No account needed.
Command reference
ReadmeBot detects your command definitions from popular CLI frameworks (Commander, Click, Cobra, clap) and generates a structured command reference with flags and examples.
Installation instructions
ReadmeBot generates both global and local installation options for your CLI tool, covering npm, pip, cargo, go install, and Homebrew where applicable.
Usage examples
Every CLI needs a quick-start section. ReadmeBot creates practical examples showing the most common workflows so users can start using your tool immediately.
Frequently asked questions
Does it detect subcommands?
Yes. ReadmeBot parses CLI framework definitions to document all commands, subcommands, and their flags.
Will it include shell completion docs?
If your CLI supports shell completions, ReadmeBot documents setup for bash, zsh, and fish.
Does it work with compiled binaries?
ReadmeBot analyses the source code, not the binary. It works with any CLI tool that has source code on GitHub.