# @ankhorage/ankh 中文文档

规范地址：https://npmcn.com/package/%40ankhorage/ankh/

版本：0\.13\.3
npm 元数据更新时间：2026-10-29T12:56:42.647Z
中文译文更新时间：2026-11-06T05:07:30.746Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：1 MB，153 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：3 个
- 首次发布：2026-06-30T21:05:38.104Z
- 最新版本发布：2026-10-29T12:56:41.818Z
- 近 30 天下载量：129509（2026-10-06 至 2026-11-04，npm 官方下载统计）
- 已发布版本数：137（近 12 个月 137 个）

## 中文简介

Bun- first root CLI 为 Ankhorage 提供者的命令提供前门.

## 安装

```sh
npm install @ankhorage/ankh
```

也可以使用：`pnpm add @ankhorage/ankh`、`yarn add @ankhorage/ankh`、`bun add @ankhorage/ankh`

## README

# @ankhorage/ankh (英语)

![license: MIT](https://npmcn.com/package/%40ankhorage/ankh/paradox/badges/license.svg) ![npm: v0.13.3](https://npmcn.com/package/%40ankhorage/ankh/paradox/badges/npm.svg) ![runtime: bun](https://npmcn.com/package/%40ankhorage/ankh/paradox/badges/runtime.svg) ![typescript: strict](https://npmcn.com/package/%40ankhorage/ankh/paradox/badges/typescript.svg) ![eslint: checked](https://npmcn.com/package/%40ankhorage/ankh/paradox/badges/eslint.svg) ![prettier: checked](https://npmcn.com/package/%40ankhorage/ankh/paradox/badges/prettier.svg) ![build: checked](https://npmcn.com/package/%40ankhorage/ankh/paradox/badges/build.svg) ![tests: checked](https://npmcn.com/package/%40ankhorage/ankh/paradox/badges/tests.svg) ![docs: paradox](https://npmcn.com/package/%40ankhorage/ankh/paradox/badges/docs.svg)

Bun- first root CLI 为 Ankhorage 提供者的命令提供前门.

## 使用量

### 启动状态

`@ankhorage/ankh` 是 Ankhorage 的根 CLI 前门和命令总线.

`ankh --help`、提供者的帮助、规划和发送所有解析提供者 动态发现路径。 发现结合了安装在运行中的 Ankh CLI 的供应商 当前软件包/工作空间; 项目本地软件包胜过安装的软件包 具有相同软件包名称的软件包.

没有硬码提供者类别。 包通过它的 `ankh` 软件包元数据及有效的提供者模块,根帮助列表中只有提供者解决 同样的引用.

Root CLI中没有域行为属于. 域行为留在提供者包中, 例如 下面是模板、工作室、板子、医生和编剧.

Root内置是帮助,规划和版本输出. `ankh commands` 不是一个单独的 拖曳命令; 命令概览属于 root 帮助 .

`ankh <category> --help` 财务报告和审定财务报表 `ankh <category> -h` 使用 包描述和完整命令列表,而不暴露能力或提供者元数据. 提供者的列表还输入了共享提供者- 帮助渲染器, 由 `@ankhorage/ankh` 这样 独立的CLI不需要第二个手持命令列表.

`ankh <category> <command> ...args` 执行向装入的提供者处理器的基本直接发送. Root CLI 保留了稀薄的路由器:提供者拥有选项解析,验证,输出,以及行为.

`ankh plan <category> <command>` 要求提供者规划操作员检查 `AnkhCommandPlan` 不执行提供者命令处理器。 使用 `--json` 稳定 机器可读输出.

提供者包通过可选程序显示规划 `planningHandlers` 他们的 `AnkhRuntimeCommandProvider` 默认导出 。 规划是供应商合同,而不是工作流程 执行: 给提供者规划处理器的根 CLI 路径并制作返回的计划, 但是它 不编写真实的工作流程、创建项目、运行命令或执行破坏性步骤.

`ankh run ...` 保留到明确执行语义设计完成.

资料来源: `src/readme-usage.ts`

```ts
import { runCli } from './cli/index.js';

await runCli(['--help']);
```

## 生成的文件

-   [交互式文件应用](https://npmcn.com/package/%40ankhorage/ankh/paradox/index.html)
-   [公共 API 参考](https://npmcn.com/package/%40ankhorage/ankh/paradox/exports.md)
-   [构成部分登记册](https://npmcn.com/package/%40ankhorage/ankh/paradox/components.md)
-   [结构概览](https://npmcn.com/package/%40ankhorage/ankh/paradox/diagrams/architecture-overview.mmd)
-   [模块关系](https://npmcn.com/package/%40ankhorage/ankh/paradox/diagrams/module-relationships.mmd)
-   [导出图](https://npmcn.com/package/%40ankhorage/ankh/paradox/diagrams/export-graph.mmd)
-   [创建DefaultCommand Context序列](https://npmcn.com/package/%40ankhorage/ankh/paradox/diagrams/sequences/create-default-command-context.mmd)
-   [parseArgv 序列](https://npmcn.com/package/%40ankhorage/ankh/paradox/diagrams/sequences/parse-argv.mmd)
-   [渲染 ProviderHelp 序列](https://npmcn.com/package/%40ankhorage/ankh/paradox/diagrams/sequences/render-provider-help.mmd)
-   [解析 AnkhInputValue 序列](https://npmcn.com/package/%40ankhorage/ankh/paradox/diagrams/sequences/resolve-ankh-input-value.mmd)

## 常见问题

### @ankhorage/ankh 是什么？

Bun- first root CLI 为 Ankhorage 提供者的命令提供前门\.

### 如何安装 @ankhorage/ankh？

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

### @ankhorage/ankh 支持 TypeScript 吗？

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

### @ankhorage/ankh 支持 ESM 还是 CommonJS？

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

### @ankhorage/ankh 可以商用吗？

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

### @ankhorage/ankh 的下载量有多少？

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

### @ankhorage/ankh 还在维护吗？

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