# @clidoc/core 中文文档

规范地址：https://npmcn.com/package/%40clidoc/core/

版本：1\.1\.3
npm 元数据更新时间：2026-11-06T18:50:30.419Z
中文译文更新时间：2026-11-10T01:44:17.503Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40clidoc/core
原文对照：https://npmcn.com/package/%40clidoc/core/?lang=original
项目主页：https://clidoc.ben3d.ca/docs/api
源码仓库：https://github.com/bhouston/clidoc

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

- 包体积（解压后）：216 kB，45 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=22
- 运行依赖：3 个
- 首次发布：2026-09-22T12:51:55.296Z
- 最新版本发布：2026-11-06T18:50:30.076Z
- 近 30 天下载量：3231（2026-10-10 至 2026-11-08，npm 官方下载统计）
- 已发布版本数：6（近 12 个月 6 个）

## 中文简介

CLI 文档的 OpenCLI 类型、 离线验证和 Markdown 参考生成

## 安装

```sh
npm install @clidoc/core
```

也可以使用：`pnpm add @clidoc/core`、`yarn add @clidoc/core`、`bun add @clidoc/core`

## README

[![clidoc logo](https://raw.githubusercontent.com/bhouston/clidoc/main/packages/docs/static/img/icon-512.png)](https://clidoc.ben3d.ca/)

  

[![npm package](https://img.shields.io/npm/v/@clidoc/core.svg)](https://npmjs.com/package/@clidoc/core) [![npm downloads](https://img.shields.io/npm/dw/@clidoc/core.svg)](https://www.npmtrends.com/@clidoc/core) [![coverage](https://codecov.io/gh/bhouston/clidoc/branch/main/graph/badge.svg)](https://codecov.io/gh/bhouston/clidoc) [![discord chat](https://img.shields.io/badge/chat-discord-blue?style=flat&logo=discord)](https://discord.gg/vSYc5CfRWH) [![documentation](https://img.shields.io/badge/docs-read-blue?style=flat)](https://clidoc.ben3d.ca/)

  

# @ clidoc/ 核心

> OpenCLI类型,离线验证,以及用于CLI Docs的Markdown渲染.

-   离线使用 Schema 包
-   JSON和YAML 解析
-   📝 Markdown和页面生成
-   QQ 合并作者元数据
-   完成脚本生成

从一个便携式文件分析、验证和提供CLI文件 [OpenCLI 1.0.0-α.14 (英语)](https://github.com/bcdxn/opencli) 文档。 这是每个 Clidoc 软件包下面的库: 如果您已经有一个 OpenCLI 文档, 直接使用, 或者用一个框架软件包配对, 从您的 CLI 生成一个 .

[读取 Docs 以学习更多](https://clidoc.ben3d.ca/)。 。 。 .

## 开始

```sh
npm install @clidoc/core
```

```ts
import { parse, validate, renderMarkdown, generatePages } from '@clidoc/core';

const document = parse(sourceText); // JSON or YAML; throws on invalid input
const result = validate(document); // { valid, errors }
const markdown = renderMarkdown(document);
const pages = generatePages(document, { basePath: '/cli' });
```

公布的软件包将精确的图案捆绑在一起 `upstream/opencli/spec.schema.json`,所以验证工作离线.

## 合适的话

| 你想这样 | 使用 |
| --- | --- |
| 从您的 CLI 生成文档 | [`@clidoc/yargs`](https://www.npmjs.com/package/@clidoc/yargs), (中文(简体) ), [`@clidoc/commander`](https://www.npmjs.com/package/@clidoc/commander) 或者说 [`@clidoc/oclif`](https://www.npmjs.com/package/@clidoc/oclif) |
| 从外壳中校验、渲染Markdown、完成或MCP工具 | [`@clidoc/cli`](https://www.npmjs.com/package/@clidoc/cli) |
| 在文档网站上发布参考页面 | [`@clidoc/docusaurus`](https://www.npmjs.com/package/@clidoc/docusaurus) 或者说 [`@clidoc/vitepress`](https://www.npmjs.com/package/@clidoc/vitepress) |

见 [API 参考](https://clidoc.ben3d.ca/docs/api) 编辑 [可运行演示](https://github.com/bhouston/clidoc/tree/main/demos)。 。 。 .

## 为什么Clidoc

-   **与手写参考页相比:** 文档来自您运行的 CLI 相同的命令定义, 因此选项和参数不能从 `--help`。手写指南仍然与生成的页并列.
-   **比较 `--help` 仅输出 :** 您可以得到一个经过验证的结构化文档(JSON/YAML),该文档也向Markdown、 shell 补全和MCP工具定义,而不仅仅是终端文本.
-   **比较 `oclif readme`数字 :** 命令目标为 oclif 工程,并写入 README 。 clidoc的OpenCLI文档是框架中立的,因此yargs,command and oclif CLIs共享了一条管道和一套docs-site集成.

`generatePages` 返回登陆页和每个可见命令一页。 每个命令页面都包含一个生成的用法概要:需要的值使用 `<value>`,使用可选元素 `[element]`,并使用可重复元素 `...`. 概要包括可见的指挥旗帜和继承的全球旗帜. 每页都有 `id`, (中文(简体) ), `title`, (中文(简体) ), `path`马克下 `content`命令名称 `<binary> foo-bar` 保留可读性 `/commands/foo-bar` 当它的后缀是小写 ASCII 字母,数字,以及单个连字符(最多64个字符)时,则路由。 其他名称使用规范化可读前缀(最多64个字符),保留 `~`,以及全命令名称的SHA-256摘要。 每个路由只取决于其命令名,所以添加无关的命令不会改变已存在的URL. 生成器在返回任何页前拒绝消化器相撞。 这取代了以前的相撞依赖的散列后缀,因此可读形式之外名称的URL可能会被更改. 登陆链接使用生成的基础路径 。 捆绑的JSON Schema也可以在 `@clidoc/core/schema`。 。 。 .

`validate` 对照销售商JSON Schema核对文件,一旦通过,则对照上游运输的逻辑规则 `validate/validate.go`:立场论点不得将必要的论点置于可选论点之后, `minItems`编号 :`maxItems` 只在 variadic 参数和旗帜上有效(使用 `minItems <= maxItems`, (中文(简体) ), `$FILE` 替代源必须有一个匹配文件在 `global.config`,旗名和别名必须每个命令都独有,且组命令不能声明 `args` 或者说 `flags`。错误使用相同的 `instancePath message` 形状为图谋错误.

## 添加作者提供的元数据

框架软件包从您的 CLI 参数解析器中生成一个文档, 因此, 比如 `examples`, (中文(简体) ), `exitCodes`, (中文(简体) ), `info.license`编号 :`contact`, (中文(简体) ), `install`,以及 `global` 配置通常为 失踪。 加入它们 `mergeDocument`,然后重新验证:

```ts
import { mergeDocument } from '@clidoc/core';

const documented = mergeDocument(document, {
  info: { license: { name: 'MIT', spdxId: 'MIT' } },
  install: [{ name: 'npm', command: 'npm i -g my-cli' }],
  commands: {
    'my-cli greet': {
      examples: [{ title: 'Basic', content: 'my-cli greet Ada' }],
      exitCodes: [{ code: 1, status: 'BAD_USER_INPUT_ERROR', summary: 'Missing name' }],
      flags: [{ name: 'language', alternativeSources: [{ type: '$ENV', property: 'LANG' }] }],
    },
  },
});
```

平面对象( E)`info`, (中文(简体) ), `global`,每个命令)递归合并. 阵列取代基数组, 除外 `examples` 财务报告和审定财务报表 `exitCodes`,该附件,以及 `flags`编号 :`args`合并的项目 对应 `name` - 这样你就可以添加 `alternativeSources` 或一个 `summary` 到一个生成的旗帜 不再重复其余内容。 在生成的文档中未显示的图标作为-is添加. `mergeDocument` 丢出一个 `Error` 如果合并结果失败, 则列出每个问题 审定.

## 贝壳完成生成

`generateCompletion(document, { shell: 'bash' | 'zsh' | 'fish', binary?: string })` 验证 OpenCLI 文档,并返回独立的完成脚本。 这个 支持嵌入命令、别名、全局/本地旗帜、选项和位置 选项和隐藏条目,不依赖节点或目标CLI. 可选 `binary` 只覆盖已注册的可执行名称。 见 [完成指南](https://clidoc.ben3d.ca/docs/completion) 用于激活, 支持语法和限制.

## 捐款

见 [贡献指南](https://github.com/bhouston/clidoc/blob/main/CONTRIBUTING.md)。 。 。 .

## 许可证

麻省理工学院

## 作者

[本·休斯顿](https://ben3d.ca/),赞助人 [资产土地](https://landofassets.com/)。 。 。 .

## 常见问题

### @clidoc/core 是什么？

CLI 文档的 OpenCLI 类型、 离线验证和 Markdown 参考生成

### 如何安装 @clidoc/core？

在项目目录运行 npm install @clidoc/core，或使用 pnpm add / yarn add / bun add。

### @clidoc/core 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @clidoc/core 支持 ESM 还是 CommonJS？

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

### @clidoc/core 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=22。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @clidoc/core 可以商用吗？

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

### @clidoc/core 的下载量有多少？

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

### @clidoc/core 还在维护吗？

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