Installation

npm install -g @archbee/cli

Quick Start

archbee new my-docs
cd my-docs
archbee dev

Your docs site is running at http://localhost:3000 with hot reload.

What It Does

Run archbee with no arguments to see all available commands.

Local Development

| Command | Description | |---------|-------------| | archbee dev | Start local preview with hot reload | | archbee new <dir> | Create a new documentation project | | archbee validate | Check config and doc structure for errors | | archbee broken-links | Find broken internal links | | archbee update | Update CLI to the latest version | | archbee version | Display the current CLI version |

API Commands

Manage docs on the Archbee platform. Require --api-key and --doc-space-id.

--api-key accepts either a per-space API key (Space Settings → API keys) or a team API key (abteam_…, minted by a team admin in Settings → Developer). A team key works across every space in the team: pass --doc-space-id to pick the target space per command. Team-level commands (export, display-rules, create-space, and the File Manager commands upload, list-files, delete-file, move-file, replace-file) run with a team key alone, no --doc-space-id needed. Read-only team keys are rejected by commands that modify content.

| Command | Description | |---------|-------------| | get-doc | Get a document by ID (markdown, html, json, or source) | | create-doc | Create or update a document | | delete-doc | Delete a document | | search-docs | Search documents in a space | | import-content | Import markdown files (.md or .zip) | | create-space | Create a new space | | update-space | Update space settings | | publish-space | Publish documents | | clone-space | Clone a space | | sync-openapi | Sync an OpenAPI spec to create API reference docs | | info-openapi | Get info about an OpenAPI tree | | upload | Upload a file | | list-files | List files and folders in the File Manager | | delete-file | Delete a file or folder | | move-file | Move a file into another folder | | replace-file | Overwrite an existing file (keeps its URL) | | merge-suggestion | Merge a suggestion | | discard-suggestion | Discard a suggestion | | export | Export team documentation | | display-rules | List display rules |

Run archbee <command> --help for detailed options.

Works With Your Existing Docs

Drop into any project - the CLI auto-detects the config format:

| Format | Config File | |--------|------------| | Archbee | archbee.json | | Docusaurus | docusaurus.config.js / .ts |

cd your-existing-docs-project
archbee dev

Documentation

Full configuration reference, guides, and examples:

archbee.com/docs

Troubleshooting

1. Make sure you're in a folder with a config file (archbee.json or docusaurus.config.js/.ts)
2. Run archbee update to get the latest version
3. Requires Node.js 18+. LTS versions recommended.