# @astrosheep/keiyaku 中文文档

规范地址：https://npmcn.com/package/%40astrosheep/keiyaku/

版本：4\.6\.29
npm 元数据更新时间：2026-11-04T06:56:08.793Z
中文译文更新时间：2026-11-07T01:18:38.701Z
软件包许可：ISC

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

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

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

- 包体积（解压后）：3.2 MB，634 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=22\.19\.0
- 运行依赖：13 个
- peer 依赖：@earendil-works/pi-coding-agent \*
- 首次发布：2026-02-13T10:03:01.237Z
- 最新版本发布：2026-11-04T06:56:08.580Z
- 近 30 天下载量：5032（2026-10-07 至 2026-11-05，npm 官方下载统计）
- 已发布版本数：184（近 12 个月 184 个）

## 中文简介

Keiyaku是一个代理合同工作流程.

## 安装

```sh
npm install @astrosheep/keiyaku
```

也可以使用：`pnpm add @astrosheep/keiyaku`、`yarn add @astrosheep/keiyaku`、`bun add @astrosheep/keiyaku`

## README

# 凯亚库

**Keiyaku不是为你设计的 而是为你的前沿模型设计的.**

**当今世界:** 前沿模式非常可畏,而且费用也很高。 便宜 模型很好,但是它们漂移, 它们总是报告成功。 还有 人类的注意力是三者中最稀少的.

故克相克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克.

**边境有外骨骼 不是笼子.** 它打破目标分开, 作者明确合同,指挥一个舰队平行。 它有限 上下文指决策级别信号——每项合同的状况, 从来没有个人工人。 工人可以漂流、拖延或撒谎;合同 无法.

**工人得到合同,而不是信任.** 字节前的术语 第一次编辑;每一次发送都对diff进行机械判断. 无论什么漂浮或谎言 都永远不会到达董事会.

**你退后点.** 在可能时代表——默认情况下,一切都会结束 到边框;动词是其类型。 必要时提供指导—— 顶部从未移交。 轮子还是你的.

* * *

## 债务, 不是待办事宜列表

`keiyaku debt` 已确认的未决问题和请求。 依赖关系 和产生的 `ready` 编号 : `blocked` 执行进展情况和计划 组成没有。 债务是 `open`, (中文(简体) ), `done`,或 `drop`合同接受可以 自动清偿相关债务.

这取代了前者 `task` CLI 和 `Tasks` API; 使用 `debt` 财务报告和审定财务报表 `Debts`。 。 。 . 对于已有的棋盘, 停止分类账写法, 运行离线升级 源检出 :

```bash
node scripts/migrate-task-board.mjs /absolute/path/to/world
```

动了 `.keiyaku/tasks` 改为 `.keiyaku/debts`,重写身份和关系 前缀,并返回旧进度状态 `open`本地身份证,命名空间, 证词和时间戳不变。 原字节保留在 `.keiyaku/tasks.pre-debt`; 拒绝现有的目的地或备份。 读取 ,而不是报告空分类账. 如果一个中断的升级只留下备份,则将该目录恢复到 `.keiyaku/tasks` 在重试之前。 合同日记和现有持有人记录 没有重写或成为孤儿。 不要同时运行新老作家.

## 合同是什么样子的

````markdown
# Ship typed Debt query

## Context
Debt reads scan documents ad hoc.

## Objective
One typed query surface over the whole board.

## Design
A single evaluator over persisted facts.

## Region
```
src/debt/**
tests/debt-*.test.ts
```

## Criteria
### Query is typed
The CLI parses a predicate; the evaluator never sees a raw shell string.

### Reads stay Debt-owned
Query reads only Debt facts. No Contract. No Akuma.

## Verification
```bash timeout=2m
npm test
```
````

## 交易看起来像

```bash
keiyaku bind --gates reviewed,verified - < contract.md # terms written; an isolated worktree appears
keiyaku call worker -                                  # commission names Contract and appointed worktree
keiyaku verify <contract>                              # each declared check executes and attests independently
keiyaku deliver <contract>                             # delivered; existing evidence judges placement
keiyaku review <contract> --satisfied --summary -       # review attested; ready delivery can land
```

## 明确核查

仅 `verify` 执行合同核查申报。 选择 `verified` (a) 具有约束性或修改性,使其具有放置要求 是惰性的。 与合同选择者一起从指定的工作树上核实 选项:

```bash
keiyaku verify <contract>                        # execute all current declarations
keiyaku verify <contract> --index 2              # execute only the current second declaration
keiyaku verify --index 1 --include-dirty         # contextual Contract; explicitly capture local edits
keiyaku deliver <contract> --dry-run             # observe prospective evidence without execution
```

`--index` 在本文件中,这是一个基于一的肯定立场。 无效的语法 是一个使用错误;在执行或承认之前,一个异地位置拒绝. 检查使用交付的清洁工作树规则,除非 `--include-dirty` 授权 捕获。 它准备准确的预期目标整合而不提供 ;一体化冲突拒绝,而没有兑现。 证据 交货前生产,但该交货名称相同 示意图. 改变的目标或候选人需要证据才能获得新的快照.

每一个宣言都会得到自己的干净的划痕,设置,和清理. 盖一栋或 与需要的支票相同或设置中的其他先决条件; 无法共享生成的文件。 正常故障或超时证明 只有这一要求不能令人满意,全面核查仍在继续。 设置,产卵, 未知的退出,或停止取消,对受影响的支票不予裁决; 之前的入院情况依然如此。 失败场景被独立保留 合同和要求,并附有诊断结果.

目前的所有要求都需要目前满意的证词才能满足一个大门. 选定的绿色检查只是一次检查 。 身份跟随犬科的执行者, 脚本,并宣布超时,所以重排顺序保存证据,编辑一个 检查只影响这一要求,而确切的重复则共享一项要求. 取消支票将取消其义务,同时将证词留在历史中. 每次验证引用都会再次执行选择; 相同的证明 可在不跳过执行的情况下重新使用.

交付、审查、预览和依赖性完成从未执行核查. 他们消耗了现有证据,留下了失踪,僵化或不满意 所需经费待定。 核查还可完成已交付的合同 以先入为主,然后,每个城门都经过的时候, 交货前核查记录证据 无需安置。 审查仍然是一项独立的义务.

## 日记记录的内容

检查可持久的事实及其要求的范围,与现场处决分开:

```bash
keiyaku history <contract>
keiyaku history <contract> --json
keiyaku status <contract>
keiyaku deliver <contract> --dry-run --json
```

每个终端检查记录其大门、稳定要求和准确性的证词 被捕获的快照; 没有汇总的核查证明。 一会儿 不满意的结果仅取而代之 和主题。 审查证明了目前的文件和候选内容. 历史证词即使在声明被删除后仍然可以读取.

状态,预览,历史,收据,和JSON 保存每个要求缺失, 固以相克相克相克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克克 目前的声明可以使用 (b) 取消的要求保持其稳定身份。 校验 收据区分已执行的判决、新的或重新使用的接纳、可操作 停止,保留场景,完成。 现场观察 识别检查和 快照但不能创建日志存储或重放权限 .

## 董事会

`keiyaku status` 是一个屏幕。 两项合同和两项在逃债务:

```text
CONTRACTS // recent

⧗ kei/ship-typed-debt-query-c898 · 1s · Ship typed Debt query
  [✓] delivery  [ ] review
⧗ kei/tighten-receipt-vocabulary-4a70 · 18s · Tighten receipt vocabulary
  [ ] delivery  [ ] review

DEBTS // recent

○ debt/regenerate-readme-from-real-010b · ready · P1 · Regenerate README from real output
○ debt/align-debt-cli-truth-promises-3af5 · ready · P0 · Align Debt CLI truth promises
```

标记会加速扫描;词会携带状态.

## 那个工人

```markdown
---
provider: pi
model: kimi-coding/k3-256k
description: Repository implementation agent
---
Make scoped changes and run relevant tests.
```

一个马克登档案,一个工人. `keiyaku call worker` 传讯.

## 配置

设置是 JSON 在两个地址: `~/.keiyaku/settings.json` 对于用户, `.keiyaku/settings.json` 在项目。 项目记录 完全隐藏同名用户记录。 没有写入命令; 编辑 文档并直接检查 合并、出处附加说明的视图 `keiyaku settings`。 。 。 .

命名的门组提供可重复使用的门集 。 捆绑并修改选中的 `--gates`; 数据 `default` 组在约束时适用 `--gates` 省略. 未作修改 `--gates` 保留现有大门 :

```json
{
  "gates": {
    "default": { "kind": "bundle", "gates": ["reviewed"] },
    "strict": { "kind": "bundle", "gates": ["reviewed", "verified"] }
  }
}
```

选择接受内置名称 `reviewed` 财务报告和审定财务报表 `verified`,或配置 组合名称。 未知名字与已知名字一起被拒绝 。 自定义门 必须在配置的组内宣布;在制作人之前,它们不会满意 证明目前的每一项要求. `reviewed` 和定制的大门各有一个 要求; `verified` 其要求来自目前 声明。 没有单独的集合门证明.

核查仅通过明确 `verify`; 交付和审查消耗 现有证据。 每次检查都以引用过程的 Git 和 程序保管.

当合同管理的工作树被创建或 已销毁 —— 依赖安装是通常的怀疑:

```json
{
  "worktree": {
    "create": [
      { "name": "install", "argv": ["npm", "ci", "--ignore-scripts", "--prefer-offline"], "timeoutMs": 300000 }
    ],
    "destroy": [
      { "name": "teardown", "argv": ["docker", "compose", "down", "-v"], "timeoutMs": 60000 }
    ]
  }
}
```

虎克在工作树内作为一个订购的相机运行,必须重放安全:a 重试从开始重运行此相 。 创建钩子准备工作树; 销毁 hooks 释放外部资源 工作树删除无法单独删除 . 失败的钩子保留了工作树 而且报告滞后;它永远不会放弃合同. `keiyaku settings --help` 列出每个识别的命名空间.

### Paseo 供应商

在设置中配置一个已经运行的本地 Paseo 服务器. json:

```json
{
  "providers": {
    "paseo": {
      "kind": "paseo",
      "config": { "url": "ws://127.0.0.1:6767/ws", "provider": "claude" }
    }
  }
}
```

本地提供人的身份是裸体(`claude`, (中文(简体) ), `codex`, (中文(简体) ), `pi`页:1. 在 Akuma 定义中选择 .keiyaku/akumas/paseo-worker.md :

```markdown
---
provider: paseo
model: <native-model-id>
effort: high
---
```

当地提供者必须提供模式和努力;努力是本地的 思考选项 ID。 调用 `PASEO_PASSWORD=<password> keiyaku call paseo-worker "<prompt>"`。 。 。 .

-   在重新装入或重新启动 Paseo 原生程序后, 调用新的 Akuma 而不是恢复 .
-   `kill` 财务报告和审定财务报表 `--interrupt` 在全局范围内控制当前执行会话,并可能影响 人类同时工作。 正常完成只断开客户端; 它确实 不取消以后的工作或关闭本地运行时间.
-   繁忙的代理商拒绝新的工作,但方向盘仍然可以竞相同时输入.
-   丢弃的连接不能证明取消成功 .

## 安装

```bash
npm install -g @astrosheep/keiyaku
```

Pi的运出扩展提供了本地 `akuma_*` 通过公共SDK工具, 加减 `/keiyaku` 状态叠加。 上面还写着 `keiyaku` 从 `PATH`; 本地工具没有. 见 [`plugins/pi/README.md`](https://npmcn.com/package/%40astrosheep/keiyaku/plugins/pi/README.md) 给宿主终生和离散的工作.

节点 22.19. 产品法 [`docs/`](https://npmcn.com/package/%40astrosheep/keiyaku/docs/README.md)。 。 。 .

## 来源构建

东道国融合来源 `plugins/pi`, (中文(简体) ), `plugins/claude`, (中文(简体) ), `plugins/codex`, (中文(简体) ), 财务报告和审定财务报表 `plugins/opencode`共享技能 `skills/`; 建筑复制它们 因此,本地设施是自成一体的。 分开 `plugins/square` 工作空间是Keiyaku的内部Square观察者,不是编码 绳接插件。 安装食谱并使用软件包元数据 资产 `build/plugins` 财务报告和审定财务报表 `build/skills`除了皮包元数据, 选择类型脚本扩展并 `skills/`创建源检出 在装入扩展名之前, 因此其包根 SDK 可用; 已发布 软件包已经包含 SDK 构建 .

从源起的建筑还用Zig 6.14.1来建造了Windows发射装置或更后. 安装 该系统工具单独制作 `zig` 备查 `PATH`,或设置 `KEIYAKU_ZIG` 到选定的可执行文件. `npm ci` 单靠自己是不够的 窗口启动器: 使用 `npm ci --ignore-scripts --prefer-offline` 接下来是 `npm run build` (或 `npm test`) (中文(简体) ). 在非窗口主机上, 缺少或无法使用 Zig只跳过 Windows 启动器,所以其余部分 `npm run build` 财务报告和审定财务报表 `npm test` ; Windows 构建失败,需要可操作的诊断.

## 常见问题

### @astrosheep/keiyaku 是什么？

Keiyaku是一个代理合同工作流程\.

### 如何安装 @astrosheep/keiyaku？

在项目目录运行 npm install @astrosheep/keiyaku，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：@earendil-works/pi-coding-agent（\*）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。它还提供命令行工具 kei、keiyaku，可以用 npx kei 直接运行。

### @astrosheep/keiyaku 支持 TypeScript 吗？

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

### @astrosheep/keiyaku 支持 ESM 还是 CommonJS？

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

### @astrosheep/keiyaku 需要什么版本的 Node\.js？

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

### @astrosheep/keiyaku 可以商用吗？

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

### @astrosheep/keiyaku 的下载量有多少？

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

### @astrosheep/keiyaku 还在维护吗？

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