> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.nvidia.com/docsfab/manage/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.nvidia.com/docsfab/_mcp/server. # Manage DocsFab ## Docs - [Update or Uninstall DocsFab](https://docs.nvidia.com/docsfab/manage/update-or-uninstall.md): Update or reinstall your DocsFab source checkout, repair a packaged installation, or remove the global command. - [Install a DocsFab Development Build](https://docs.nvidia.com/docsfab/manage/development-installation.md): Install a development package from the main channel for testing. - [Back Up and Restore Local DocsFab State](https://docs.nvidia.com/docsfab/manage/recover-local-state.md): Preserve the complete private configuration and saved-run stores before upgrading, repairing, or restoring a local installation. - [Manage DocsFab Live Sessions](https://docs.nvidia.com/docsfab/manage/live-sessions.md): Resume, list, or delete the owner-private transcripts for live-agent conversations. - [Check DocsFab Readiness](https://docs.nvidia.com/docsfab/manage/check-readiness.md): Check readiness for the operation you want to run. Offline checks read local configuration. Add `--live` to check model connectivity and, for draft delivery, GitLab access. - [Manage Local DocsFab Configuration and Credentials](https://docs.nvidia.com/docsfab/manage/local-configuration.md): Locate the host configuration used by DocsFab and check its private storage boundaries. To change a model selection, follow Configure the Model. - [Inspect Operational Limits in DocsFab](https://docs.nvidia.com/docsfab/manage/inspect-operational-limits.md): Inspect the effective limits and observed headroom for the current host and project before changing a setting. - [Configure Host Limits in DocsFab](https://docs.nvidia.com/docsfab/manage/configure-host-limits.md): Set supported operational overrides in the host limits file and inspect their effective values. - [Check Native CLI Readiness in DocsFab](https://docs.nvidia.com/docsfab/manage/check-native-harness.md): Inspect an explicitly configured native CLI and its authentication without running a documentation workflow. - [Diagnose a Failed DocsFab Run](https://docs.nvidia.com/docsfab/manage/diagnose-run.md): Use `docsfab why` to identify a saved run's cause, responsible owner, supporting evidence, and next action. - [Compare Completed Composition Runs in DocsFab](https://docs.nvidia.com/docsfab/manage/compare-runs.md): Compare retained composition-execution evidence without calling a provider. - [Host a DocsFab Review Report](https://docs.nvidia.com/docsfab/manage/host-review-report.md): Serve a retained review report and understand its local access boundary. - [Check Documentation Freshness in DocsFab](https://docs.nvidia.com/docsfab/manage/check-documentation-freshness.md): Run the advisory evidence-freshness check and inspect its retained report. - [Check Answer Submission Capability in DocsFab](https://docs.nvidia.com/docsfab/manage/qualify-answer-submission.md): Inspect recorded answer-submission capability or run the explicit live qualification probe. A probe records evidence; it does not approve a release. - [Check Answer-Record Capability in DocsFab](https://docs.nvidia.com/docsfab/manage/qualify-answer-records.md): Run an explicit answer-record premise probe against a selected corpus. Keep measured probe evidence separate from workflow or release qualification. - [Restore a DocsFab Deployment](https://docs.nvidia.com/docsfab/manage/restore-deployment.md): Restore a verified deployment bundle into a clean destination and establish fresh execution authority before accepting work. - [Configure the Recovery Object Bound in DocsFab](https://docs.nvidia.com/docsfab/manage/configure-recovery-bound.md): Configure the logical-object size bound and inspect recovery headroom before a backup refuses. - [Upgrade the DocsFab Forge Source Schema](https://docs.nvidia.com/docsfab/manage/upgrade-forge-source.md): Preview and apply the supported schema upgrade for an existing core installation. - [Preview the DocsFab Documentation Site](https://docs.nvidia.com/docsfab/manage/preview-documentation-site.md): Preview this repository's Fern documentation locally or inspect its merge-request Review App. CI publication remains a separate operation. > **Note:** This page contains both a page directory (above) and the landing page content (below). The page directory is generated for agent use and does not appear on the landing page. > For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.nvidia.com/docsfab/manage/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.nvidia.com/docsfab/_mcp/server. # About Managing DocsFab > Find guides for checking readiness, managing local configuration, changing versions, and using development builds. Manage a DocsFab installation, its private state, and the evidence retained by its jobs. Start with [Check Readiness](/docsfab/manage/check-readiness) when deciding whether a local review, patch, or draft merge request can run. ## Installation and Local State Choose a guide for the installation or state you need to manage: | Task | Guide | | --- | --- | | Change versions, repair an installed package, or remove the CLI. | [Update or Uninstall](/docsfab/manage/update-or-uninstall) | | Try a package from the development channel. | [Install a Development Build](/docsfab/manage/development-installation) | | Preserve and restore the complete private configuration and run stores. | [Back Up and Restore Local State](/docsfab/manage/recover-local-state) | | Resume, list, or delete live-agent transcripts. | [Manage Live Sessions](/docsfab/manage/live-sessions) | ## Configuration and Readiness Use these guides before model execution or delivery: | Task | Guide | | --- | --- | | Check local or live prerequisites for the selected operation. | [Check Readiness](/docsfab/manage/check-readiness) | | Locate host files, replace a key, or check directory permissions. | [Manage Local Configuration](/docsfab/manage/local-configuration) | | Inspect effective limits, observations, and headroom. | [Inspect Operational Limits](/docsfab/manage/inspect-operational-limits) | | Set supported host limit overrides. | [Configure Host Limits](/docsfab/manage/configure-host-limits) | | Inspect an explicitly configured Codex or Claude Code CLI. | [Check Native CLI Readiness](/docsfab/manage/check-native-harness) | ## Runs, Reports, and Model Evidence Follow the saved evidence for the question you need to answer: - [Diagnose a Failed Run](/docsfab/manage/diagnose-run), or [investigate patterns across saved runs](/docsfab/workflows/investigate-saved-runs). - [Compare Completed Composition Runs](/docsfab/manage/compare-runs). - [Host a Review Report](/docsfab/manage/host-review-report). - [Check Answer Submission Capability](/docsfab/manage/qualify-answer-submission), or [check answer-record capability](/docsfab/manage/qualify-answer-records) with the explicit live probe. ## Deployment and Documentation Site Deployment recovery uses a clean destination and fresh authority. Follow [Restore a Deployment](/docsfab/manage/restore-deployment) and [Configure the Recovery Object Bound](/docsfab/manage/configure-recovery-bound). The pilot's live recovery drill remains incomplete. For this repository's Fern site, follow [Preview the Documentation Site](/docsfab/manage/preview-documentation-site). A preview does not establish publication or release approval.