# @done-coding/cli-harness 中文文档

规范地址：https://npmcn.com/package/%40done-coding/cli-harness/

版本：0\.4\.1
npm 元数据更新时间：2026-11-11T10:01:16.292Z
中文译文更新时间：2026-11-13T03:17:56.326Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：37.9 kB，7 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=18\.0\.0
- 运行依赖：1 个
- 首次发布：2026-10-23T04:46:07.134Z
- 最新版本发布：2026-11-11T10:01:15.878Z
- 近 30 天下载量：2403（2026-10-13 至 2026-11-11，npm 官方下载统计）
- 已发布版本数：13（近 12 个月 13 个）

## 中文简介

已做编码 qq( harness- work space) : qq / qq / qq 问题

## 安装

```sh
npm install @done-coding/cli-harness
```

也可以使用：`pnpm add @done-coding/cli-harness`、`yarn add @done-coding/cli-harness`、`bun add @done-coding/cli-harness`

## README

# @done-coding/cli-harness

done-coding 工作区治理（harness-workspace）工具：治理清单生成、治理闸、跨仓提 issue、仓库注册表。各仓 `docs/governance/` 的清单与闸以本命令为唯一实现，规则语义见 harness-workspace skill。

[![npm version](https://badge.fury.io/js/@done-coding%2Fcli-harness.svg)](https://www.npmjs.com/package/@done-coding/cli-harness) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

完整文档：[使用文档](https://done-coding.github.io/cli/docs/packages/harness)。

## 安装

```bash
npm install -g @done-coding/cli-harness
# 或免安装
npx @done-coding/cli-harness <command>
# 或作为主 CLI 子命令
DC harness <command>
```

## 命令一览

| 命令 | 说明 |
| --- | --- |
| `dc-harness lists [-d <dir>] [-c]` | 从条目 frontmatter 重生成 `BACKLOG` / `SCHEDULE` / `ARCHIVE-DONE` / `DROPPED` / `ISSUE` |
| `dc-harness instructions [--json]` | AGENTS.md 单文件 / 链路预算与 CLAUDE.md 兼容入口 |
| `dc-harness check [-d <dir>]` | 治理闸：元闸 + 并行闸 + 收口形态 + 清单零 diff，任一不过退出码 1 |
| `dc-harness issue <仓名或仓根> -t <标题> -s <slug> -b <正文文件>` | 向另一仓的 issue 收件箱提单 |
| `dc-harness scope list [--inbox] [--json]` | 列出仓库注册表里登记的仓 |
| `dc-harness scope check` | 校验注册表 |
| `dc-harness scope register [-n <名>] [-p <定位>] [-a <受理范围>] [--tier <档位>] [--dir <治理目录>]` | 把当前 git 仓登记进注册表 |

所有命令在**项目根**执行（只认当前目录，不向上查找）。

## lists / check

-   治理目录缺省 `docs/governance`；`-d` 或项目配置可改。
-   `lists -c` 只比对不写盘，清单与条目不一致即退出码 1。
-   `check` 的检查项：
    -   **元闸**：`backlog/` 与在途批次里的条目都有 `modules`，且只用领域表里登记的名字。
    -   **并行闸**：在途批次（`schedule/` 下）的领域集合两两不相交；同一 `after` 链上的批次（同窗口串行）豁免。`after` 指向不存在的批次、分叉或成环即违规。
    -   **收口形态**：在途批次有 `PROGRESS.md`；`archive/` 下批次只留 `PROGRESS.md`；`dropped/` 条目写明 `dropped` 理由或 `merged_into`；`issue/` 条目有 `from`。
    -   **清单零 diff**：同 `lists -c`。
-   批次的领域 = 条目 `modules` ∪ 批次 `PROGRESS.md` 的 `modules`。

项目配置（可选）`<项目根>/.done-coding/harness/governance/config.json`：

```json
{
  "governanceDir": "docs/governance",
  "domains": { "file": "docs/governance/SNAPSHOT.md", "section": "领域模块" }
}
```

`domains` 指定领域表从哪个文件（可限定某个二级标题下）读取，缺省为治理目录下 `MODULES.md` 全文。

## instructions — 指令预算与兼容入口

```bash
dc-harness instructions
dc-harness instructions --json
```

项目根执行，必须是 Git 仓根；无需存在治理目录。枚举 Git 跟踪的 `AGENTS.md` / `CLAUDE.md`，读取工作树当前内容（包含未暂存修改），未跟踪的兼容入口不算已交付。命令只读，不修改文件或索引。

-   默认预算：根 `AGENTS.md` 16384 B，其他层 8192 B，根到各含指令目录的链路合计 32768 B；按 UTF-8 字节计，等于预算通过。链路违规列出各层字节与最大贡献者。
-   每个 `AGENTS.md` 须有同级跟踪的普通 `CLAUDE.md`，首个非空行是 `@AGENTS.md`，其后允许 Claude 专属增量；软链不通过。只有 `CLAUDE.md` 而无同级 `AGENTS.md` 时，单行纯 `@路径` 导入可保留，其他内容报「正文仍在 CLAUDE.md」。
-   逐条 `❌` 或单行 `✅`；通过退出码 0，违规退出码 1。`--json` 输出 `{ budget, files: [{ file, bytes }], errors }`，不混入文本日志，退出码不变。

在现有项目配置内追加可选段（预算支持逐项覆盖）：

```json
{
  "instructions": {
    "budget": { "root": 16384, "nested": 8192, "chain": 32768 },
    "exclude": [".done-coding/generator/assemble/fragments/**", ".claude/skills/**"],
    "gate": false
  }
}
```

`exclude` 使用 Git glob pathspec（相对仓根；`*` 不跨目录、`**` 跨目录，支持 `?` / 字符组），从文件枚举和链路中排除模板、第三方内容。默认不排除任何路径。`gate: true` 才把本检查并入 `check`，默认 false；独立 `instructions` 始终检查。

改动 `AGENTS.md` / `CLAUDE.md` 后及交付收口前运行；建议在仓内 pre-commit 检测到暂存指令文件时运行本命令。检查的是工作树内容，并非索引快照。

## issue：跨仓提单

```bash
dc-harness issue template-hub -t "模板缺少 apps/ 工作区配置" -s monorepo-apps-workspace -b ./body.md
```

-   目标可写仓根路径，或注册表里的仓名（已存在的目录优先按路径解析）。
-   在目标仓 `issue/` 写入 `<id>-<slug>.md`（frontmatter：`id` / `title` / `created` / `from`），重生成其 `ISSUE.md`，并在目标仓**只提交这两个文件**。
-   目标仓 `ISSUE.md` 有未提交改动、或注册表中该仓未开收件箱时拒绝。
-   `-f` 指定来源仓名，缺省取当前 git 仓目录名。
-   写入前将标题与正文中的当前用户家目录（`os.homedir()`，其后为 `/` 或字符串结束）替换为 `~`；有替换时输出总处数，正文源文件不改。

## scope：仓库注册表

注册表位于 `~/.done-coding/harness/scope/<由仓路径转义的目录>/repo.json`（环境变量 `DC_HARNESS_SCOPE_DIR` 可改位置），每仓一份：

```json
{
  "name": "dotfiles",
  "path": "<全局配置仓的绝对路径>",
  "positioning": "一句话定位",
  "accepts": "受理哪些反馈",
  "governance": {
    "dir": "docs/governance",
    "tier": "medium",
    "issueInbox": "docs/governance/issue"
  }
}
```

-   `register` 登记当前 git 仓；已登记则更新，目录键被别的仓占用时拒绝覆盖。收件箱按治理目录下是否有 `issue/` 推出，没有则为 `null`。
-   `check` 校验字段、`path` 存在、目录名与 `path` 一致、收件箱存在、`name` 唯一。
-   `list --inbox` 只列开了收件箱的仓，供「给某仓提 issue」时按名字找目标。

## 在 AI 编码工具里使用

插件 `done-coding` 内含 `cli-harness` skill（安装见 [done-coding-agent-plugins](https://github.com/done-coding/done-coding-agent-plugins)）：说「重生成治理清单」「跑治理闸」「给 <仓名> 提 issue」即可，skill 会调用本命令。

## 许可证

MIT

## 常见问题

### @done-coding/cli-harness 是什么？

已做编码 qq\( harness- work space\) : qq / qq / qq 问题

### 如何安装 @done-coding/cli-harness？

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

### @done-coding/cli-harness 支持 TypeScript 吗？

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

### @done-coding/cli-harness 支持 ESM 还是 CommonJS？

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

### @done-coding/cli-harness 需要什么版本的 Node\.js？

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

### @done-coding/cli-harness 可以商用吗？

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

### @done-coding/cli-harness 的下载量有多少？

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

### @done-coding/cli-harness 还在维护吗？

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