Archbee CLI Installation & Setup
Requirements
Before installing the Archbee CLI, make sure you have:
- Node.js 18 or newer
- npm installed
- Access to your Archbee workspace if using API commands
Archbee CLI requires Node.js 18 or newer. Older Node.js versions may cause installation or runtime issues.
Installation Workflow
Install the Archbee CLI globally using npm.
Create a new documentation project or open an existing docs repository.
Start the local development server with archbee dev.
Validate documentation changes and publish updates when ready.
Install the CLI
npm install -g @archbee/cliVerify the installation:
archbee versionExample output:
@archbee/cli 1.0.0Create a New Documentation Project
archbee new my-docs
cd my-docs
archbee devExample output:
Archbee local server running at http://localhost:3000The local preview server starts at:
http://localhost:3000Use the CLI With Existing Docs
The CLI automatically detects supported configuration files.
Format | Config File |
|---|---|
Archbee | archbee.json |
Docusaurus | docusaurus.config.js or .ts |
Example:
cd your-existing-docs-project
archbee devExample output:
Detected Docusaurus project
Starting development server...Common Setup Errors
"archbee: command not found"
Try reinstalling globally:
npm install -g @archbee/cliThen restart your terminal.
"No config file found"
Make sure your project contains one of the supported config files:
- archbee.json
- docusaurus.config.js
- docusaurus.config.ts
Node.js Version Problems
Check your installed Node version:
node -vUpgrade to Node.js 18+ if needed.