CLI command reference

This is the complete reference for the dxb CLI (@doxbrix/cli), organized by task. Every command supports --help for inline usage and the global --json flag where output is structured.

Global flags

These flags work on every command:

Flag	Alias	Description
`--project <slug\	id>`	`-p`
`--profile <name>`		Use a specific auth profile.
`--token <token>`		Authenticate with a token.
`--api-url <url>`		Override the API base URL.
`--cwd <dir>`		Run as if started in this directory.
`--json`		Output machine-readable JSON.
`--yes`	`-y`	Skip confirmation prompts.
`--quiet`	`-q`	Suppress non-essential output.
`--verbose`	`-v`	Verbose output (request ids, stacks).
`--help`	`-h`	Show help for a command.
`--version`		Print the CLI version.

Setup

Command	Description	Reference
`dxb init [dir]`	Scaffold a new docs-as-code project (`--from` to convert).	Initialize a project
`dxb doctor`	Check your environment and configuration.	Install the CLI
`dxb completion <shell>`	Print a shell completion script.	Install the CLI
`dxb open [app\	editor]`	Open the app or editor in your browser.

Authoring structure

Command	Description	Reference
`dxb space create <name>`	Create a space (`--slug`, `--locale`, `--parent`).	Create pages & spaces
`dxb space list`	List spaces.	Create pages & spaces
`dxb new page <path>`	Create a page and wire it into nav (`--title`, `--space`).	Create pages & spaces
`dxb sync`	Fold orphan files into `docs.json` (`--dry-run`, `--space`).	Create pages & spaces
`dxb nav tree`	Print the navigation tree.	Manage navigation
`dxb nav add-label <text>`	Add a section label.	Manage navigation
`dxb nav add-link <title> <href>`	Add an external link.	Manage navigation
`dxb nav add-divider`	Add a divider.	Manage navigation
`dxb nav remove <file>`	Remove a nav entry (alias `rm`).	Manage navigation

Preview, validate & publish

Command	Description	Reference
`dxb dev`	Local live-reload preview (`--port`, `--open`).	Local preview
`dxb lint`	Validate structure, links, and blocks (`--strict`).	Lint & validate
`dxb status`	Show how local files compare to the cloud.	Push & status
`dxb diff [path]`	Show what would change vs. the cloud.	Diff changes
`dxb push`	Send local changes up (`--publish`, `--dry-run`, `--strict`, `--media`, `--allow-orphans`).	Push & status

Inspect

Command	Description	Reference
`dxb project list`	List projects (alias `projects`).	Projects & pages
`dxb project view <slug>`	Inspect a project (alias `get`).	Projects & pages
`dxb project use <slug>`	Select the working project.	Projects & pages
`dxb page list`	List pages (`--space`, `--status`, `--limit`).	Projects & pages
`dxb page get <id>`	Read a page (`--content`).	Projects & pages
`dxb search <query>`	Full-text search (`--limit`, `--locale`).	Search & quality
`dxb quality`	Score content quality (aliases `health`, `score`).	Search & quality
`dxb ai ask <question>`	Ask AI about your docs (`--locale`).	Ask AI
`dxb review` / `dxb queue`	Inspect the review queue.	Review workflow

Import, keys & Git

Command	Description	Reference
`dxb import file <path>`	Import a single document (`--into`, `--title`).	Import content
`dxb import repo [dir]`	Import a folder of docs (`--out`).	Import content
`dxb keys list`	List assistant API keys.	Settings
`dxb keys create <label>`	Create a key (`--origin`, `--allow-private`).	Settings
`dxb keys revoke <id>`	Revoke a key.	Settings
`dxb git connect`	Connect a Git repository (`--provider`, `--repo`, `--branch`).	Connect GitHub / GitLab
`dxb git status`	Show Git sync status.	Sync & conflicts

Getting help

bash

dxb --help            # general help
dxb new page --help   # help for a command
dxb nav --help        # help for a subcommand group

Next steps

🌿

Docs-as-code overview

How the workflow fits together.

The most-used command.

🔄

Push & status

Sync and publish.