Tutorials

Tutorials are lessons that guide you through completing a real task. Each one is designed to give you working results quickly, with enough explanation to understand what's happening.

Your First CLI Documentation

Install click-docs and generate your first Markdown reference page. You'll write a small Click application and have a publishable docs/cli-reference.md file in under ten minutes.

Covers: installation, basic usage, --program-name, --output

Documenting a Real-World CLI

Go beyond the basics with a multi-group CLI that has nested subgroups, hidden admin commands, rich option types, and an ASCII art banner. By the end you'll have a fully configured pyproject.toml that generates the exact documentation you need with a single command.

Covers: nested subgroups, --depth, --exclude, --show-hidden, --style table, --list-subcommands, --remove-ascii-art, --header-depth, --full-command-path, pyproject.toml configuration