---
title: Archbee CLI 安装与设置
slug: docs/cn/eW2e-archbee-cli
createdAt: 2026-08-25T09:37:14.249Z
---

## 要求

在安装 Archbee CLI 之前，请确保您具备：

- Node.js 18 或更高版本
- 已安装 npm
- 如果使用 API 命令，则需要能够访问您的 Archbee 工作区

:::hint{type="warning"}
Archbee CLI 要求 Node.js 18 或更高版本。较旧的 Node.js 版本可能会导致安装或运行时问题。
:::

## 安装工作流程

::::WorkflowBlock
:::WorkflowBlockItem
使用 npm 全局安装 Archbee CLI。
:::

:::WorkflowBlockItem
创建一个新的文档项目或打开现有的文档仓库。
:::

:::WorkflowBlockItem
使用 `archbee Dev` 启动本地开发服务器。
:::

:::WorkflowBlockItem
验证文档更改，并在准备就绪后发布更新。
:::
::::

## 安装 CLI

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

验证安装：

```bash
archbee version
```

示例输出：

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

## 创建新的文档项目

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

示例输出：

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

本地预览服务器启动地址：

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

## 将 CLI 与现有文档一起使用

CLI 会自动检测受支持的配置文件。

| 格式         | 配置文件                           |
| ---------- | ------------------------------ |
| Archbee    | `archbee.json`                 |
| Docusaurus | `docusaurus.config.js` 或 `.ts` |

示例：

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

示例输出：

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

## 常见设置错误

### "archbee: command not found"

尝试重新全局安装：

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

然后重启您的终端。

### "No config file found"

请确保您的项目包含以下受支持的配置文件之一：

- `archbee.json`
- `docusaurus.config.js`
- `docusaurus.config.ts`

### Node.js 版本问题

检查您已安装的 Node 版本：

```bash
node -v
```

如有需要，请升级到 Node.js 18+。

## 其他资源

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