# 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](../../reference/cli/great_docs.md)  
Great Docs: Beautiful documentation for Python packages.


# Project setup


Initialize a project, manage its configuration, and remove Great Docs.


[init](../../reference/cli/init.md)  
Initialize great-docs in your project (one-time bootstrap).

[config](../../reference/cli/config.md)  
Generate a great-docs.yml configuration file.

[uninstall](../../reference/cli/uninstall.md)  
Remove great-docs from your project.


# Building & previewing


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


[build](../../reference/cli/build.md)  
Build your documentation site.

[preview](../../reference/cli/preview.md)  
Preview your documentation locally.

[freeze](../../reference/cli/freeze.md)  
Execute specific pages and persist their freeze cache.


# Analysis & quality


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


[scan](../../reference/cli/scan.md)  
Discover package exports and preview what can be documented.

[timings](../../reference/cli/timings.md)  
Show page-level build timings from the last build.

[check-links](../../reference/cli/check_links.md)  
Check for broken links in source code and documentation.

[seo](../../reference/cli/seo.md)  
Audit SEO health of your documentation site.

[lint](../../reference/cli/lint.md)  
Lint documentation quality for your package.

[proofread](../../reference/cli/proofread.md)  
Check spelling and grammar in documentation files using Harper.


# API tracking


Snapshot the public API and diff it across versions.


[api-snapshot](../../reference/cli/api_snapshot.md)  
Capture a JSON snapshot of a package's public API.

[api-diff](../../reference/cli/api_diff.md)  
Compare the public API between two versions.


# Publishing & versions


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


[setup-github-pages](../../reference/cli/setup_github_pages.md)  
Set up automatic deployment to GitHub Pages.

[versions](../../reference/cli/versions.md)  
List configured documentation versions.

[changelog](../../reference/cli/changelog.md)  
Generate a Changelog page from GitHub Releases.


# Command groups


Grouped commands for Agent Skills and terminal session recordings.


[skill](../../reference/cli/skill.md)  
Manage AI coding agent skills.

[termshow](../../reference/cli/termshow.md)  
Terminal recording and playback for CLI/TUI documentation.