`dxb init` scaffolds a new [docs-as-code](/cli/overview/docs-as-code) project — creating the `docs.json` manifest, a base-path folder, a starter page, the `.doxb...
`dxb init` scaffolds a new [docs-as-code](/cli/overview/docs-as-code) project — creating the `docs.json` manifest, a base-path folder, a starter page, the `.doxb...
dxb init scaffolds a new docs-as-code project — creating the docs.json manifest, a base-path folder, a starter page, the .doxbrix/config.json that links your local files to a cloud project, and (by default) a Claude Code authoring skill. It's the first command you run when starting docs from your terminal.
Run dxb init
In a new or existing directory:
# Initialize in a new folder
dxb init my-docs
# Initialize in the current directory
dxb init .Options
| Flag | Description |
|---|---|
| `--name <name>` | Project display name. |
| `--base-path <dir>` | Docs subfolder (default `docs`). |
| `--from <dialect>` | Convert an existing docs tree — `mintlify`, `gitbook`, or `generic`. |
| `--force` | Write into a non-empty directory. |
| `--no-claude-skill` | Skip scaffolding the Claude Code authoring skill (it's added by default). |
# Name the project
dxb init . --name "Handbook"
# Convert an existing Mintlify docs tree
dxb init . --from mintlifyWhat gets created
.
├─ .doxbrix/
│ └─ config.json # links local files ↔ cloud project
├─ .claude/skills/ # a Claude Code authoring skill (unless --no-claude-skill)
└─ docs/ # your chosen base path
├─ docs.json # navigation manifest
└─ introduction.mdx # a starter page.doxbrix/config.json
This file connects your local project to the cloud:
{
"projectId": "bc7bf459-3d54-4b1a-be18-393c61567633",
"projectSlug": "my-docs",
"basePath": "docs"
}Commit .doxbrix/config.json to Git so your whole team is linked to the same project. It contains no secrets — authentication uses tokens, not this file.
docs.json
The starter manifest defines one space with your first page:
{
"version": 1,
"spaces": [
{
"name": "Documentation",
"slug": "docs",
"nav": [
{ "type": "page", "file": "introduction" }
]
}
]
}Converting from another tool
If you already maintain docs in another format, point --from at the dialect and dxb init converts the tree into Doxbrix MDX + docs.json:
dxb init . --from gitbookReview the converted output and run dxb lint to catch anything the converter couldn't map cleanly.
After init
# Preview locally
dxb dev
# Create your first real page
dxb new page get-started/quickstart --title "Quickstart"
# Validate
dxb lintdxb init . inside your application's Git repository (in a docs/ subfolder) to keep documentation versioned alongside the code it describes.