CLI Reference
The great-docs command-line interface drives the full documentation workflow: from initializing a project and building the site to checking links, recording terminal sessions, and publishing to GitHub Pages.
- great-docs
- Great Docs: Beautiful documentation for Python packages.
Project setup
Initialize a project, manage its configuration, and remove Great Docs.
- great-docs init
- Initialise documentation in your project
- great-docs config
- Generate a documentation configuration file
- great-docs uninstall
- Remove documentation configuration and generated output
Building & previewing
Build the documentation site, preview it locally, and freeze executable content.
- great-docs build
- Build your documentation site
- great-docs preview
- Preview your documentation locally
- great-docs freeze
- Execute specific pages and persist their freeze cache
Analysis & quality
Inspect the project, validate links and examples, and check SEO, prose, and style.
- great-docs scan
- Discover package exports and preview what can be documented.
- great-docs timings
- Show page-level build timings from the last build.
- great-docs check-links
- Check for broken links in source code and documentation.
- great-docs check-examples
- Check that Python code examples execute without errors.
- great-docs seo
- Audit SEO health of your documentation site.
- great-docs lint
- Lint documentation quality for your package.
- great-docs proofread
- Check spelling and grammar in documentation files using Harper.
API tracking
Snapshot the public API and diff it across versions.
- great-docs api-snapshot
- Capture a JSON snapshot of a package’s public API.
- great-docs api-diff
- Compare the public API between two versions.
Publishing & versions
Set up GitHub Pages, manage versioned builds, and generate the changelog.
- great-docs setup-github-pages
- Set up automatic deployment to GitHub Pages.
- great-docs versions
- List configured documentation versions.
- great-docs changelog
- Generate a Changelog page from GitHub Releases.
Command groups
Grouped commands for Agent Skills, terminal session recordings, and CI reporting.
- great-docs skill
- Manage AI coding agent skills.
- great-docs termshow
- Terminal recording and playback for CLI/TUI documentation.
- great-docs ci
- Helpers meant to run inside CI (GitHub Actions).