The `dxb` CLI (package `@doxbrix/cli`) is the command-line tool for the Doxbrix [docs-as-code](/cli/overview/docs-as-code) workflow. It lets you initialize proje...
The `dxb` CLI (package `@doxbrix/cli`) is the command-line tool for the Doxbrix [docs-as-code](/cli/overview/docs-as-code) workflow. It lets you initialize proje...
The dxb CLI (package @doxbrix/cli) is the command-line tool for the Doxbrix docs-as-code workflow. It lets you initialize projects, create and edit pages, preview locally, validate, and publish — all from your terminal.
Requirements
- Node.js 18 or later.
- A Doxbrix project API token — see Authentication.
- Git (optional, for version-control workflows).
Install
Install it globally so the dxb command is available everywhere:
npm install -g @doxbrix/cliVerify the installation
Confirm the CLI is installed and on your PATH:
dxb --versionYou should see the installed version. If the command isn't found, make sure your global npm/pnpm bin directory is on your PATH.
Check your setup
dxb doctor checks your environment and configuration — Node version, where the CLI is looking for its config, and whether a project is linked:
dxb doctorShell completion
Enable tab completion for commands and flags with dxb completion:
# Bash
dxb completion bash >> ~/.bashrc
# Zsh
dxb completion zsh >> ~/.zshrc
# Fish
dxb completion fish > ~/.config/fish/completions/dxb.fishRestart your shell to activate completions.
Updating
Keep the CLI current to get new features and block support:
npm update -g @doxbrix/cliTroubleshooting
| Symptom | Fix |
|---|---|
| `command not found: dxb` | Add your global bin directory to `PATH` |
| `EACCES` on install | Use a Node version manager (nvm) or fix npm prefix permissions |
| Old version after update | Check for a second install via a different package manager |