# great-docs Great Docs: Beautiful documentation for Python packages. ``` bash great-docs [OPTIONS] COMMAND [ARGS]... ``` Great Docs generates professional documentation sites with auto-generated API references, CLI documentation, smart navigation, and modern styling. Get started with `great-docs init` to set up your docs, then use `great-docs build` to generate your site. Full --help output Usage: great-docs [OPTIONS] COMMAND [ARGS]... Great Docs: Beautiful documentation for Python packages. Great Docs generates professional documentation sites with auto-generated API references, CLI documentation, smart navigation, and modern styling. Get started with 'great-docs init' to set up your docs, then use 'great-docs build' to generate your site. Options: --version Show the version and exit. --help Show this message and exit. Commands: init Initialize great-docs in your project (one-time... build Build your documentation site. preview Preview your documentation locally. uninstall Remove great-docs from your project. config Generate a great-docs.yml configuration file. scan Discover package exports and preview what can be... freeze Execute specific pages and persist their freeze cache. timings Show page-level build timings from the last build. setup-github-pages Set up automatic deployment to GitHub Pages. check-links Check for broken links in source code and... changelog Generate a Changelog page from GitHub Releases. proofread Check spelling and grammar in documentation files... seo Audit SEO health of your documentation site. lint Lint documentation quality for your package. api-diff Compare the public API between two versions. versions List configured documentation versions. api-snapshot Capture a JSON snapshot of a package's public API. skill Manage AI coding agent skills. termshow Terminal recording and playback for CLI/TUI... # Options `--version` Show the version and exit. # Commands `init` [Initialize great-docs in your project (one-time bootstrap).](../../reference/cli/init.md) `build` [Build your documentation site.](../../reference/cli/build.md) `preview` [Preview your documentation locally.](../../reference/cli/preview.md) `uninstall` [Remove great-docs from your project.](../../reference/cli/uninstall.md) `config` [Generate a great-docs.yml configuration file.](../../reference/cli/config.md) `scan` [Discover package exports and preview what can be documented.](../../reference/cli/scan.md) `freeze` [Execute specific pages and persist their freeze cache.](../../reference/cli/freeze.md) `timings` [Show page-level build timings from the last build.](../../reference/cli/timings.md) `setup-github-pages` [Set up automatic deployment to GitHub Pages.](../../reference/cli/setup_github_pages.md) `check-links` [Check for broken links in source code and documentation.](../../reference/cli/check_links.md) `changelog` [Generate a Changelog page from GitHub Releases.](../../reference/cli/changelog.md) `proofread` [Check spelling and grammar in documentation files using Harper.](../../reference/cli/proofread.md) `seo` [Audit SEO health of your documentation site.](../../reference/cli/seo.md) `lint` [Lint documentation quality for your package.](../../reference/cli/lint.md) `api-diff` [Compare the public API between two versions.](../../reference/cli/api_diff.md) `versions` [List configured documentation versions.](../../reference/cli/versions.md) `api-snapshot` [Capture a JSON snapshot of a package's public API.](../../reference/cli/api_snapshot.md) `skill` [Manage AI coding agent skills.](../../reference/cli/skill.md) `termshow` [Terminal recording and playback for CLI/TUI documentation.](../../reference/cli/termshow.md)