# @doc-kit/cli 中文文档

规范地址：https://npmcn.com/package/%40doc-kit/cli/

版本：1\.1\.1
npm 元数据更新时间：2026-10-31T13:40:53.946Z
中文译文更新时间：2026-11-12T13:42:02.160Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40doc-kit/cli
原文对照：https://npmcn.com/package/%40doc-kit/cli/?lang=original
源码仓库：https://github.com/nodejs/doc-kit

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

- 包体积（解压后）：21 kB，11 个文件
- 模块格式：ES Module
- TypeScript 类型：未声明
- 运行依赖：2 个
- 首次发布：2026-08-10T13:41:33.451Z
- 最新版本发布：2026-10-31T13:40:53.625Z
- 近 30 天下载量：8579（2026-10-13 至 2026-11-11，npm 官方下载统计）
- 已发布版本数：9（近 12 个月 9 个）

## 中文简介

Doc- kit 命令行界面: 从终端运行 @ doc- kit/ 核心生成器

## 安装

```sh
npm install @doc-kit/cli
```

也可以使用：`pnpm add @doc-kit/cli`、`yarn add @doc-kit/cli`、`bun add @doc-kit/cli`

## README

# `@doc-kit/cli`

命令行接口 [医生](https://github.com/nodejs/doc-kit)数字 : 页:1 `doc-kit` 运行该程序的二进制 [`@doc-kit/core`](https://www.npmjs.com/package/@doc-kit/core) 要转动的引擎 API形状的Markdown被编成文档网站,JSON,人页等.

## 使用量

```sh
npx @doc-kit/cli --help
npx @doc-kit/cli generate --help
```

您必须通过命令行提供输入和至少一个目标 选项或配置文件。 配置自动被发现 使用 `cosmiconfig`,或者您可以明确选择一个文件 `--config-file`。 。 。 .

```sh
npx @doc-kit/cli generate \
  -t html \
  -i "path/to/docs/**/*.md" \
  -o out
```

内建的生成器名称 [`@doc-kit/core` 发电机](https://www.npmjs.com/package/@doc-kit/core) 及其伴侣 发电机包,必须安装在这个包上。 自定义 通过导入指定符加载发电机——任何默认导出为 发电机作为 `--target`。 。 。 .

为了验证本地输出, `preview` 服务于HTTP——内置 服务器只用于本地测试,不是生产级别。 通过 任意 `generate` 选项先构建;否则现有的输出目录 (单位:千美元)`./out` (默认情况下)作为实际值.

```sh
npx @doc-kit/cli preview --host localhost --port 3000
```

## 捐款

这个包裹住在 [节点/doc- kit](https://github.com/nodejs/doc-kit) 单相机。 从此目录( 或寄存器根) `npm run <script> --workspace @doc-kit/cli`:

```sh
# Run the CLI
npm run run -- generate --help

# Re-run the CLI on every change
npm run watch
```

## 常见问题

### @doc-kit/cli 是什么？

Doc- kit 命令行界面: 从终端运行 @ doc- kit/ 核心生成器

### 如何安装 @doc-kit/cli？

在项目目录运行 npm install @doc-kit/cli，或使用 pnpm add / yarn add / bun add。它还提供命令行工具 doc-kit，可以用 npx doc-kit 直接运行。

### @doc-kit/cli 支持 TypeScript 吗？

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

### @doc-kit/cli 支持 ESM 还是 CommonJS？

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

### @doc-kit/cli 可以商用吗？

@doc-kit/cli 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @doc-kit/cli 的下载量有多少？

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

### @doc-kit/cli 还在维护吗？

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