@astrosheep/keiyaku 0.1.77 → 0.1.79

package/README.md

@@ -1,6 +1,6 @@
 # Keiyaku
 
-MCP server。AI 的代码改动跑在独立 branch 上，task 写进 repo，没你许可不准结束。
+MCP server. AI code changes run on an isolated branch. Tasks are written into the repo. Nothing closes without your sign-off.
 
 ```bash
 npm install -g @astrosheep/keiyaku
@@ -8,17 +8,25 @@ npm install -g @astrosheep/keiyaku
 
 ---
 
-## 装之前
+## Before You Start
 
-少一个都别来问为什么不能用：
+Missing any of these? Don't come crying.
 
-- **Git repo**，worktree 干净的。脏的不给用。
-- **MCP client**。Claude Desktop、Claude Code、随便什么 stdio 的。
-- **Subagent CLI**。[`claude`](https://docs.anthropic.com/en/docs/claude-code) 或 [`gemini`](https://github.com/google-gemini/gemini-cli)，装好，登录好。Keiyaku 自己不跑代码，全丢给 subprocess。没装 = 什么都不会发生。
+- **Git repo.** Clean worktree. Dirty = refused.
+- **MCP client.** Claude Desktop, Claude Code, anything stdio.
+- **Subagent CLI.** [`claude`](https://docs.anthropic.com/en/docs/claude-code), [`gemini`](https://github.com/google-gemini/gemini-cli), or [`codex`](https://github.com/openai/codex). Installed. Logged in. Keiyaku doesn't run code itself — it delegates everything to a subprocess. No CLI = nothing happens.
+
+  **Codex users, one extra step.** Codex clears env before spawning MCP servers. Add this to your `~/.codex/config.toml` or keiyaku won't know when it's running as a subagent:
+
+  ```toml
+  [mcp_servers.keiyaku]
+  # ... rest of your config ...
+  env_vars = ["KEIYAKU_DISABLE_SUBAGENT_SPAWN"]
+  ```
 
 ---
 
-## 配置
+## Setup
 
 Claude Desktop (`~/Library/Application Support/Claude/claude_desktop_config.json`):
 
@@ -33,31 +41,31 @@ Claude Desktop (`~/Library/Application Support/Claude/claude_desktop_config.json
 }
 ```
 
-重启 client。打开 git repo。跑 `status`。完了。
+Restart client. Open a git repo. Run `status`. Done.
 
 ---
 
-## 流程
+## Flow
 
 ```
-ask (随时)  |  summon → [drive | ask]* → petition
+ask (anytime)  |  summon → [drive | ask]* → petition
 ```
 
 ---
 
-## 工具
+## Tools
 
-**`ask`** — 问东西用的。不开 branch，不建 contract，随便用。
+**`ask`** — For questions. No branch, no contract. Use it freely.
 
 ```
-retry 逻辑在哪？跑一下那个文件的 unit test。
+Where's the retry logic? Run the unit tests for that file.
 ```
 
 ---
 
-**`summon`** — 开 branch，写 contract。repo 必须干净。
+**`summon`** — Opens a branch, writes the contract. Repo must be clean.
 
-criteria 写多具体，结果就有多具体。写 "make it better" 就别怪 AI 自由发挥。
+Vague criteria = vague results. Write "make it better" and don't blame anyone but yourself.
 
 ```
 summon:
@@ -71,38 +79,38 @@ summon:
 
 ---
 
-**`drive`** — 下一轮。看完 diff，说哪里不对，再跑一轮。
+**`drive`** — Next round. Review the diff, say what's wrong, run another round.
 
 ```
-Backoff 是 1.5x，应该 2x。改掉，test 也更新。
+Backoff is 1.5x, should be 2x. Fix it, update the tests too.
 ```
 
 ---
 
-**`petition`** — 结束 task。
+**`petition`** — Close the task.
 
-`CLAIM` = 我验证过了，criteria 全过了。`FORFEIT` = 不要了，全部丢掉。
+`CLAIM` = verified, all criteria pass. `FORFEIT` = abandon, throw everything away.
 
-要打分 (0–10)，要宣誓。gate 是真的会拒绝你的。没检查就别来。
+Scores required (0–10). Oath required. The gates will actually reject you. Don't show up without checking.
 
 ---
 
-**`status`** — 现在什么状态，什么在挡路。
+**`status`** — Current state and what's blocking you.
 
-**`help`** — 完整参考。
+**`help`** — Full reference.
 
 ---
 
-## 写进 repo 的东西
+## What Gets Written to the Repo
 
-| 文件 | |
+| File | |
 |------|--|
-| `KEIYAKU.md` | 当前 contract |
-| `KEIYAKU_TRACE.md` | 每轮记录 |
-| `KEIYAKU.draft.md` | summon 失败时的恢复用 draft |
-| `.keiyaku/response/*.md` | 每轮输出 |
+| `KEIYAKU.md` | Active contract |
+| `KEIYAKU_TRACE.md` | Per-round log |
+| `KEIYAKU.draft.md` | Recovery draft if summon fails |
+| `.keiyaku/response/*.md` | Per-round output |
 
-不想 track 就加 `.gitignore`：
+Don't want these tracked:
 
 ```gitignore
 .keiyaku/draft/
@@ -111,22 +119,22 @@ Backoff 是 1.5x，应该 2x。改掉，test 也更新。
 
 ---
 
-## 进阶
+## Advanced
 
 ```bash
 keiyaku dump-env
 ```
 
-| 变量 | 默认值 | |
-|------|--------|--|
-| `KEIYAKU_MCP_TRANSPORT` | `stdio` | `stdio` 或 `streamable-http` |
-| `KEIYAKU_MCP_HTTP_PORT` | `3000` | HTTP 端口 |
-| `KEIYAKU_SUBAGENT_EXEC_TIMEOUT_MS` | — | 执行超时 |
-| `KEIYAKU_SUBAGENT_EXEC_IDLE_TIMEOUT_MS` | — | 空闲超时 |
+| Variable | Default | |
+|----------|---------|--|
+| `KEIYAKU_MCP_TRANSPORT` | `stdio` | `stdio` or `streamable-http` |
+| `KEIYAKU_MCP_HTTP_PORT` | `3000` | HTTP port |
+| `KEIYAKU_SUBAGENT_EXEC_TIMEOUT_MS` | — | Execution timeout |
+| `KEIYAKU_SUBAGENT_EXEC_IDLE_TIMEOUT_MS` | — | Idle timeout |
 | `KEIYAKU_INCREMENTAL_DIFF_MODE` | `targeted` | `targeted` \| `stat` \| `unified` |
-| `KEIYAKU_FAKE_SUBAGENT` | `0` | `1` = 测试用 stub |
+| `KEIYAKU_FAKE_SUBAGENT` | `0` | `1` = test stub |
 
-HTTP transport：
+HTTP transport:
 
 ```bash
 KEIYAKU_MCP_TRANSPORT=streamable-http \