# @adrkit/cli 中文文档 规范地址：https://npmcn.com/package/%40adrkit/cli/ 版本：0\.20\.0 npm 元数据更新时间：2026-10-11T00:41:24.693Z 中文译文更新时间：2026-11-06T05:46:03.022Z 软件包许可：Apache-2\.0 本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。 原始 npm 页面：https://www.npmjs.com/package/%40adrkit/cli 原文对照：https://npmcn.com/package/%40adrkit/cli/?lang=original 项目主页：https://adrkit.dev/ 源码仓库：https://github.com/mbeacom/adrkit ## 关键信息（来自 npm 元数据） - 包体积（解压后）：522 kB，40 个文件 - 模块格式：ES Module - TypeScript 类型：包内自带 - Node.js 要求：\>=22 - 运行依赖：2 个 - 首次发布：2026-07-20T03:50:56.394Z - 最新版本发布：2026-10-11T00:41:24.202Z - 近 30 天下载量：4703（2026-10-05 至 2026-11-03，npm 官方下载统计） - 已发布版本数：21（近 12 个月 21 个） ## 中文简介 Git-native架构决策记录从adrkit工具. ## 安装 ```sh npm install @adrkit/cli ``` 也可以使用：`pnpm add @adrkit/cli`、`yarn add @adrkit/cli`、`bun add @adrkit/cli` ## README # @adrkit/cli (英语) Git-native架构决策记录从adrkit工具. ## 安装和运行 使用零安装运行的包名 。 出版的二进制是 `adr`,但是一个 赤线 `npx adr` 解决不相关的 npm 软件包 : ```sh npx @adrkit/cli lint ``` 对于项目使用,添加为dev依赖,并通过脚本引用: ```sh npm install --save-dev @adrkit/cli # or: bun add --dev @adrkit/cli npm pkg set scripts.adr=adr npm run adr -- lint ``` 让你在安装的本地二进制上 而不是什么 `npx adr` 可能会 从登记册下载. 也可以在全球安装: ```sh npm install -g @adrkit/cli adr lint ``` 每个安装也提供 `adrkit`,用于同一二进制的同名化名. 偏爱 `adrkit` 在CI、Makefiles和代理指令中,因为其名称 明确无误: ```sh adrkit lint ``` 执行 **没有** 使用情况 `npx adrkit` 或者说 `bunx adrkit`。没有未扫描 `adrkit` ,因此,这些表格将解决与登记册而不是与登记册相抵触的问题 已出版 `@adrkit/cli` 软件包. 人可读的 CLI 输出为 TTY- 意识:当重定向或重定向时, 它保持 ANSI 无 烟斗,荣誉 `NO_COLOR`,可以强制使用 `--color auto|always|never`。 。 。 . ## 图标 二进制包括: - `new` - `lint` - `graph` - `explain` - `check` - `queue` - `approve` - `object` - `resolve` - `accept` - `migrate --from madr` - `completion` - `evaluate` 运行 `adr --help` 为命令列表, `adr help ` 一个命令的 旗帜,以及 `adr --version` 以打印已安装的版本. ## 审查队列和接受 `adr queue` 列表中 `proposed` 记录其苏丹解放军状态,最后期限, 批准和反对。 在终端中,它打印一个列表 大小到窗口, ,每个项目以下一个步骤结束:接受的命令,或者原因 尚无法接受。 管道、重定向或捕获输出为 确定性标记报告,不变; `--format json` 发射 `QueueReport` 页:1 `--format terminal|markdown` 明确选择. ```bash adr queue adr accept 0044 --by @octocat ``` `adr accept` 套装 `status: accepted`, (中文(简体) ), `provenance.ratifiedBy`,以及 `review.decidedAt` (现在,UTC,有秒),并且没有改变其他行. 这个 什么都不会犯 它拒绝,并留下 档案未动,当记录是 没有 `proposed`,有未解决的反对意见,其核准数少于其 `review.quorum`,或者不会成为有效的公认记录. `--by` 需要,并且 从未被推断。 退出代码 : `0` 已接受, `1` 拒绝, `2` 使用错误. ### 记录审查:批准、反对、解决 ```bash adr approve 0044 --by @octocat adr object 0044 --by @hubot --summary "Needs a load test first" adr resolve 0044 --objection 1 --by @hubot ``` `adr approve` 添加 `--by` 改为 `review.approvals`。 。 。 . `adr object` 附录 `{ by, summary, resolved: false }` 改为 `review.objections`;摘要为一 最多500个字符的行. `adr resolve` 套装 `resolved: true` 打开 反对 `n` (按文件顺序从 1 计算),只有反对者可以 解决它。 每一行为只针对 `proposed` 记录,没有改变其他行, 不犯任何罪过,而不犯任何罪过, (b) 同一公开反对意见两次,解决已解决的反对意见). `--by` 实值 需要而且从未被推断,身份 比较不敏感的情况,所以 `@Bob` 之后 `@bob` 同一批准,法定人数是不同的人。 退出代码匹配 `adr accept`数字 : `0` 书面或 不变, `1` 拒绝, `2` 使用错误; `--json` 所有三个都有. `adr queue`同意和反对都跟着写 (单位:千美元)[ADR-0051 (英语)](https://github.com/mbeacom/adrkit/blob/main/docs/adr/0051-record-review-state-with-adr-approve-adr-object-and-adr-resolve.md)页:1. ## 决定图 `adr graph` 在 stdout 边界选择默认值:交互式终端 获得紧凑状态和关系视图,而管道、方向调整或抓取 子进程继续接收决定性的 Graphviz DOT 。 刻录频道 另一个工具会消耗输出 : ```sh adr graph # terminal view on a TTY; DOT in a pipe adr graph --focus 0014 # one ADR and its direct neighborhood adr graph --kind supersedes # one relationship kind adr graph --format mermaid > decisions.mmd adr graph --format dot | dot -Tsvg > decisions.svg adr graph --format json > decisions.json ``` `--kind` 可重复并接受 `supersedes`, (中文(简体) ), `relatesTo`,以及 `conflictsWith`明确 `--format terminal|dot|json|mermaid` 总是覆盖 TTY选择. DOT,美人鱼,和JSON 仍然没有ANSI,即使强迫的颜色. 大型零星和有重点的终端视图被限制;使用另一个 `--kind` 或一个 用于完整边缘集的机器格式. 如果一个或数个实体记录无效, 图表仍然显示完整 将每个有效记录投影,将错误结果写入 stderr,以及 输出 `1`退出时 `0` 表示没有错误; 退出 `2` 现为a 使用或无法获取指令错误. ## 贝壳完成 `adr completion ` 打印决定性的完成脚本到 s. 生成的脚本同时注册 `adr` 财务报告和审定财务报表 `adrkit` 贝壳在哪里 格式许可. ```sh adr completion bash > ~/.local/share/bash-completion/completions/adr cp ~/.local/share/bash-completion/completions/adr ~/.local/share/bash-completion/completions/adrkit adr completion zsh > ~/.zsh/completions/_adr cp ~/.zsh/completions/_adr ~/.zsh/completions/_adrkit adr completion fish > ~/.config/fish/completions/adr.fish cp ~/.config/fish/completions/adr.fish ~/.config/fish/completions/adrkit.fish ``` 如果您更喜欢连锁,请将两个鱼入点指向同一个生成的文件: ```sh ln -sf ~/.config/fish/completions/adr.fish ~/.config/fish/completions/adrkit.fish ``` ## 入境 `@adr` 标记 `adr explain ` 财务报告和审定财务报表 `adr check ` a. 两项决定的解决 前进方向 记录中声明它所管理的路径 `affects`; 来源 文件可以使用注释标记声明它所居住的决定 : ```ts // @adr 0012 export function syncOnce() { /* ... */ } ``` ``` $ adr explain src/services/sync/retry.ts Decisions governing src/services/sync/retry.ts: 0009 [accepted] Resolve affects deterministically via path: src/services/sync/** 0012 [accepted] Bind catalog entities to owned paths declared by src/services/sync/retry.ts:1 (@adr 0012) ``` 标记扫描有意缩小: - 只有第一个 **8192 字节** 将文件考虑 - 扫描停止在该窗口内最后一行 - 最多为第一次 **每个档案64份申报** 保留 - 标记必须是专用评论行的第一个内容 - 栅栏码块内的行被忽略 - 标记下的文件( r)`.md`, (中文(简体) ), `.mdx`, (中文(简体) ), `.markdown`)仅接受 `