# @docs\.page/cli 中文文档

规范地址：https://npmcn.com/package/%40docs.page/cli/

版本：2\.2\.0
npm 元数据更新时间：2026-10-01T18:53:16.448Z
中文译文更新时间：2026-11-12T14:03:10.817Z
软件包许可：Apache-2\.0

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40docs.page/cli
原文对照：https://npmcn.com/package/%40docs.page/cli/?lang=original
项目主页：https://github.com/invertase/docs.page#readme
源码仓库：https://github.com/invertase/docs.page

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：10.8 MB，7 个文件
- 模块格式：ES Module
- TypeScript 类型：未声明
- 运行依赖：14 个
- peer 依赖：typescript ^5
- 首次发布：2022-04-01T11:51:00.843Z
- 最新版本发布：2026-10-01T18:53:15.271Z
- 近 30 天下载量：4904（2026-10-13 至 2026-11-11，npm 官方下载统计）
- 已发布版本数：15（近 12 个月 4 个）

## 中文简介

用于管理文档的 docs.page cli 工具.

## 安装

```sh
npm install @docs.page/cli
```

也可以使用：`pnpm add @docs.page/cli`、`yarn add @docs.page/cli`、`bun add @docs.page/cli`

## README

# @docs.page/cli (英语)

用于命令行工具 [文档.p](https://docs.page/) ——启动项目,验证文档,就地预览,管理文档代理.

## 安装

不安装运行 :

```bash
npx @docs.page/cli <command>
```

或在全球安装:

```bash
npm install -g @docs.page/cli
```

这个 `docs` 财务报告和审定财务报表 `docs.page` 二进制在安装后都可以使用 .

## 图标

### `init`

脚手架上的一个新的docs.page项目 `docs.json` 并启动 MDX 文件.

```bash
docs init
docs init ./my-project --name "My Project"
docs init --no-docs          # docs.json only
docs init --overwrite        # replace existing docs.page files
```

### `check`

将您的文档记录为断开的链接、丢失的资产、错误和元数据问题。 有代码的退出 `1` 当发现错误时, 它在CI中起作用.

```bash
docs check
docs check ./my-project
docs check --external-links warn --internal-links error --assets error
docs check --render error --metadata warn
```

检查的严重程度 : `off`, (中文(简体) ), `warn`, (中文(简体) ), `error`。 。 。 .

### `preview`

启动您文档网站的本地实时重载预览 。 监视 `docs.json` 财务报告和审定财务报表 `docs/**/*.mdx`,然后流向浏览器中的docs.page预览UI提供了内容.

```bash
docs preview
docs preview --port 4000
docs preview --no-browser
```

需要一个有效的 `docs.json` (或 `docs.yaml`)和至少一个 `.mdx` 文件编号 `docs/`。 。 。 .

### `agent`

为 GitHub 仓库管理 docs.page 文档代理 .

```bash
docs agent create --repo org/repo --provider openai --apikey sk-...
docs agent delete --repo org/repo
```

支助提供者: `openai`, (中文(简体) ), `anthropic`, (中文(简体) ), `google`, (中文(简体) ), `xai`。 。 。 .

## 全球备选方案

```bash
docs --api-url https://your-api.example.com <command>
```

默认 `DOCS_PAGE_API_BASE` 环境变量,或生产docs.page API.

## 文档

学习更多 [文档.p](https://use.docs.page/cli)。 。 。 .

## 常见问题

### @docs\.page/cli 是什么？

用于管理文档的 docs\.page cli 工具\.

### 如何安装 @docs\.page/cli？

在项目目录运行 npm install @docs\.page/cli，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：typescript（^5）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。它还提供命令行工具 docs、docs\.page，可以用 npx docs 直接运行。

### @docs\.page/cli 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/docs\.page\_\_cli 是否存在。

### @docs\.page/cli 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @docs\.page/cli 可以商用吗？

@docs\.page/cli 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @docs\.page/cli 的下载量有多少？

根据 npm 官方下载统计，@docs\.page/cli 在 2026/10/13 – 2026/11/11 这 30 天内被下载 4,904 次，日均约 163 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @docs\.page/cli 还在维护吗？

最新版本 2\.2\.0 发布于 2026/10/02（1 个月前）；至今共发布 15 个版本，其中过去 12 个月发布了 4 个；首次发布于 2022/04/01。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。