Install Doxloop

Install Doxloop globally before following the first-run tutorial. After installation, run every workflow with the doxloop command.

Prerequisites

Install Node.js 20.12 or later

Doxloop requires Node.js 20.12.0 or newer. Check your version:

bash

node --version

Install a supported agent CLI (required for automatic launch)

Doxloop needs at least one of these on your PATH to start create, update, or review automatically:

📝If you'd rather work inside an IDE or desktop agent session, you can skip this and use --print instead, which prints the prepared prompt for you to paste in manually. See Create documentation.

Install the CLI

Install Doxloop globally with npm:

bash

npm install --global @doxbrix/doxloop

Verify the install:

bash

doxloop --version

✅This prints the installed version number, for example 0.1.0.

Optional: install an external generator package

Doxbrix is Doxloop's default documentation generator and ships built into the core package — no extra install needed. If you want to generate documentation for a different static-site generator instead, install the core package and that generator's package together in your documentation project:

bash

mkdir my-docs
cd my-docs
npm init --yes
npm install --save-dev @doxbrix/doxloop @doxbrix/doxloop-generator-mkdocs

Replace @doxbrix/doxloop-generator-mkdocs with the package for your chosen generator. See Choose a generator for the full list and what each one requires.

Next step

Continue to Create your first docs.