Skip to navigation
Get Started

Install DocsFab

Dev
View as Markdown

Install the DocsFab command-line interface (CLI) from this repository, explore workflows offline, then configure a model when you are ready to run a model-backed task.

Prerequisites

You need Node.js 24.21.0 or later, npm, Git, and access to the DocsFab source repository. DocsFab supports macOS and Linux, including Ubuntu on Windows Subsystem for Linux 2 (WSL2). Native Windows Node.js is unsupported. On WSL2, use Linux tools and keep your checkout and DocsFab state in the Linux filesystem.

Some required workflow checks need Linux, /usr/bin/bwrap (Bubblewrap), and working unprivileged user namespaces. macOS supports setup and model-backed workflows, but this release has no admitted required-check backend for macOS. Refer to the Support Matrix for platform details.

Install From a Source Checkout

This alpha is installed from a source checkout. Open the repository page and copy its HTTPS or SSH clone URL, then run:

git clone <clone-url-from-the-repository-page> docsfab
cd docsfab
npm --prefix packages/runtime ci
npm install --global ./packages/runtime
docsfab --version

npm ci installs the runtime dependencies from the lockfile. The global install makes the docsfab command available from your shell and links it to this checkout, so keep the checkout in place. The CLI can rebuild missing or stale compiled output when it starts.

Explore Without a Model

Installation and local discovery do not require a model key. List workflows and inspect a plan:

docsfab list
docsfab plan review-documentation

The plan command shows a workflow’s steps without running them. For a first review of a repository, configure a model, enter the target checkout, and start a read-only session:

docsfab setup
cd /path/to/your-repository
docsfab live-agent --read-only

Setup asks for a provider, model ID, and API key. The live agent uses the configured model. It allows documentation edits by default; --read-only disables edits, workflow writes, and host commands.

Platform Notes

On WSL2, prepare Ubuntu 24.04 and use its terminal for every command after installation. Install Linux versions of Node.js, npm, Git, and any tools required by your task. Keep the checkout, configuration, and run records under the Linux filesystem, for example ~/work, rather than /mnt/c/.

If a required check needs Bubblewrap, install it with your Linux distribution’s package manager and confirm that unprivileged user namespaces work. Do not disable host security policy to make a check pass. The Support Matrix lists requirements by operation.

What’s Next

Choose the guide that matches your next task: