---
title: Archbee CLI Installation & Setup
slug: docs/archbee-cli-installation-and-setup
docTags: 
createdAt: 2026-08-25T09:37:14.249Z
---

## 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

:::hint{type="warning"}
Archbee CLI requires Node.js 18 or newer. Older Node.js versions may cause installation or runtime issues.
:::

## Installation Workflow

::::WorkflowBlock
:::WorkflowBlockItem
Install the Archbee CLI globally using npm.
:::

:::WorkflowBlockItem
Create a new documentation project or open an existing docs repository.
:::

:::WorkflowBlockItem
Start the local development server with `archbee dev`.
:::

:::WorkflowBlockItem
Validate documentation changes and publish updates when ready.
:::
::::

## Install the CLI

```bash
npm install -g @archbee/cli
```

Verify the installation:

```bash
archbee version
```

Example output:

```text
@archbee/cli 1.0.0
```

## Create a New Documentation Project

```bash
archbee new my-docs
cd my-docs
archbee dev
```

Example output:

```text
Archbee local server running at http://localhost:3000
```

The local preview server starts at:

```text
http://localhost:3000
```

## Use 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:

```bash
cd your-existing-docs-project
archbee dev
```

Example output:

```text
Detected Docusaurus project
Starting development server...
```

## Common Setup Errors

### "archbee: command not found"

Try reinstalling globally:

```bash
npm install -g @archbee/cli
```

Then 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:

```bash
node -v
```

Upgrade to Node.js 18+ if needed.

## Additional Resources

- [https://archbee.com/docs](https://archbee.com/docs)
- [https://www.npmjs.com/package/@archbee/cli](https://www.npmjs.com/package/@archbee/cli)