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.

init: Initialize great-docs in your project (one-time bootstrap).
config: Generate a great-docs.yml configuration file.
uninstall: Remove great-docs from your project.

Building & previewing

Build the documentation site, preview it locally, and freeze executable content.

build: Build your documentation site.
preview: Preview your documentation locally.
freeze: Execute specific pages and persist their freeze cache.

Analysis & quality

Inspect the project, validate links, and check SEO, prose, and style.

scan: Discover package exports and preview what can be documented.
timings: Show page-level build timings from the last build.
check-links: Check for broken links in source code and documentation.
seo: Audit SEO health of your documentation site.
lint: Lint documentation quality for your package.
proofread: Check spelling and grammar in documentation files using Harper.

API tracking

Snapshot the public API and diff it across versions.

api-snapshot: Capture a JSON snapshot of a package’s public API.
api-diff: Compare the public API between two versions.

Publishing & versions

Set up GitHub Pages, manage versioned builds, and generate the changelog.

setup-github-pages: Set up automatic deployment to GitHub Pages.
versions: List configured documentation versions.
changelog: Generate a Changelog page from GitHub Releases.

Command groups

Grouped commands for Agent Skills and terminal session recordings.

skill: Manage AI coding agent skills.
termshow: Terminal recording and playback for CLI/TUI documentation.