AI Documentation for CLI Tools
Hosted docs for CLI tools. Auto-generated, auto-updated nightly. Detects commands, flags, and argument parsing libraries.
Free for public repos. No account needed.
What ReadmeBot detects in your project
ReadmeBot analyses your repository and automatically identifies key configuration files and project structure. Here are the files and patterns it looks for:
bin/ directoryCLI entry point in package.jsonargparse / click / cobra importsman pages
What's included in your documentation
Based on what ReadmeBot finds in your repository, it generates structured documentation with the following sections tailored to your stack:
Installation (global and local)
Usage and quick start
Commands reference
Configuration options
Contributing guidelines
Frequently asked questions
Does it document all subcommands?
Yes. ReadmeBot detects command definitions from popular CLI libraries (Commander, Click, Cobra, clap) and documents each with its flags and arguments.
Will it include global installation instructions?
ReadmeBot generates both global (npm install -g, pip install, go install) and local installation options based on your tool's ecosystem.
Does it generate shell completion docs?
If your CLI supports shell completions, ReadmeBot documents setup instructions for bash, zsh, and fish shells.