helloagents 3.0.3-beta.1 → 3.0.8-beta.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.claude-plugin/marketplace.json +1 -1
- package/.claude-plugin/plugin.json +1 -1
- package/.codex-plugin/plugin.json +1 -1
- package/README.md +157 -57
- package/README_CN.md +157 -57
- package/bootstrap-lite.md +125 -50
- package/bootstrap.md +169 -123
- package/cli.mjs +80 -427
- package/gemini-extension.json +1 -1
- package/hooks/hooks-claude.json +10 -0
- package/hooks/hooks.json +10 -0
- package/package.json +1 -1
- package/scripts/advisor-state.mjs +222 -0
- package/scripts/capability-registry.mjs +59 -0
- package/scripts/cli-codex-backup.mjs +59 -0
- package/scripts/cli-codex-config.mjs +94 -0
- package/scripts/cli-codex.mjs +90 -222
- package/scripts/cli-config.mjs +1 -0
- package/scripts/cli-doctor-render.mjs +28 -0
- package/scripts/cli-doctor.mjs +370 -0
- package/scripts/cli-host-detect.mjs +94 -0
- package/scripts/cli-lifecycle-hosts.mjs +123 -0
- package/scripts/cli-lifecycle.mjs +213 -0
- package/scripts/cli-messages.mjs +76 -52
- package/scripts/cli-toml.mjs +30 -0
- package/scripts/closeout-state.mjs +213 -0
- package/scripts/delivery-gate.mjs +256 -0
- package/scripts/guard-rules.mjs +147 -0
- package/scripts/guard.mjs +218 -168
- package/scripts/notify-context.mjs +78 -23
- package/scripts/notify-events.mjs +5 -1
- package/scripts/notify-route.mjs +111 -0
- package/scripts/notify-shared.mjs +0 -2
- package/scripts/notify-source.mjs +113 -0
- package/scripts/notify-ui.mjs +40 -6
- package/scripts/notify.mjs +137 -65
- package/scripts/plan-contract.mjs +210 -0
- package/scripts/project-storage.mjs +235 -0
- package/scripts/ralph-loop.mjs +9 -58
- package/scripts/replay-state.mjs +210 -0
- package/scripts/review-state.mjs +220 -0
- package/scripts/runtime-context.mjs +74 -0
- package/scripts/turn-state.mjs +173 -0
- package/scripts/verify-state.mjs +226 -0
- package/scripts/visual-state.mjs +244 -0
- package/scripts/workflow-core.mjs +165 -0
- package/scripts/workflow-plan-files.mjs +249 -0
- package/scripts/workflow-recommendation.mjs +335 -0
- package/scripts/workflow-state.mjs +113 -0
- package/skills/_meta/SKILL.md +1 -1
- package/skills/commands/auto/SKILL.md +48 -67
- package/skills/commands/build/SKILL.md +67 -0
- package/skills/commands/clean/SKILL.md +10 -8
- package/skills/commands/commit/SKILL.md +8 -4
- package/skills/commands/help/SKILL.md +18 -11
- package/skills/commands/idea/SKILL.md +55 -0
- package/skills/commands/init/SKILL.md +16 -8
- package/skills/commands/loop/SKILL.md +6 -5
- package/skills/commands/plan/SKILL.md +118 -0
- package/skills/commands/prd/SKILL.md +22 -15
- package/skills/commands/verify/SKILL.md +32 -9
- package/skills/commands/wiki/SKILL.md +11 -11
- package/skills/hello-review/SKILL.md +9 -0
- package/skills/hello-subagent/SKILL.md +5 -3
- package/skills/hello-ui/SKILL.md +36 -8
- package/skills/hello-verify/SKILL.md +12 -3
- package/skills/helloagents/SKILL.md +36 -20
- package/templates/DESIGN.md +25 -4
- package/templates/STATE.md +3 -0
- package/templates/plans/contract.json +48 -0
- package/templates/plans/plan.md +23 -0
- package/templates/plans/tasks.md +3 -3
- package/skills/commands/design/SKILL.md +0 -108
- package/skills/commands/review/SKILL.md +0 -16
- package/templates/plans/design.md +0 -14
package/README_CN.md
CHANGED
|
@@ -6,9 +6,9 @@
|
|
|
6
6
|
|
|
7
7
|
<div align="center">
|
|
8
8
|
|
|
9
|
-
**质量驱动的 AI 编码 CLI
|
|
9
|
+
**质量驱动的 AI 编码 CLI 工作流框架 — 14 个自动激活技能、流程纪律、检查清单把关。**
|
|
10
10
|
|
|
11
|
-
[](./package.json)
|
|
12
12
|
[](https://www.npmjs.com/package/helloagents)
|
|
13
13
|
[](./package.json)
|
|
14
14
|
[](./skills)
|
|
@@ -33,6 +33,7 @@
|
|
|
33
33
|
<summary><strong>点击展开</strong></summary>
|
|
34
34
|
|
|
35
35
|
- [🎯 为什么选择 HelloAGENTS?](#-为什么选择-helloagents)
|
|
36
|
+
- [🆚 相比 v2.3.8 的变化](#-相比-v238-的变化)
|
|
36
37
|
- [✨ 核心特性](#-核心特性)
|
|
37
38
|
- [🚀 快速开始](#-快速开始)
|
|
38
39
|
- [🔄 安装链路与文件写入](#-安装链路与文件写入)
|
|
@@ -90,6 +91,25 @@ HelloAGENTS 就是为了解决这个问题。它是一个编排层,装在你
|
|
|
90
91
|
- ❌ 简单的一次性问题(HelloAGENTS 会增加流程开销)
|
|
91
92
|
- ❌ 非编码任务(针对软件工程优化)
|
|
92
93
|
|
|
94
|
+
## 🆚 相比 v2.3.8 的变化
|
|
95
|
+
|
|
96
|
+
如果你上一次认真使用 HelloAGENTS 还是 `v2.3.8`,这一代的变化不是“增量补丁”,而是整条产品线重构。
|
|
97
|
+
|
|
98
|
+
| 维度 | v2.3.8 | 本地 `v3.0.8` |
|
|
99
|
+
|------|--------|---------------|
|
|
100
|
+
| **底层实现** | Python 包 + 大量脚本/规则混合 | 纯 Node.js + Markdown 运行时,围绕 `cli.mjs`、`bootstrap*.md`、`skills/`、`scripts/` 重建 |
|
|
101
|
+
| **目标定位** | 更像多 CLI 管理工具 + 提示协议集合 | 更像 AI CLI 的质量工作流框架,重点是路由、把关、验证和可恢复执行 |
|
|
102
|
+
| **安装方式** | pip / uv / npx / 一键脚本并行存在 | npm 为主;安装包后再显式部署到 Claude / Gemini / Codex |
|
|
103
|
+
| **CLI 支持策略** | 6 个目标,能力差异很大 | 聚焦 3 个主战场:Claude Code、Gemini CLI、Codex CLI |
|
|
104
|
+
| **工作流模型** | R0/R1/R2 三层路由 + 老式 design/develop 语义 | ROUTE/TIER → SPEC → PLAN → BUILD → VERIFY → CONSOLIDATE 六阶段主流程 |
|
|
105
|
+
| **命令体系** | 15 个命令,含 `~exec` / `~rollback` / `~rlm` / `~validatekb` | 13 个聚焦命令:`~idea` / `~plan` / `~build` / `~verify` / `~prd` / `~loop` / `~wiki` / `~help` 等 |
|
|
106
|
+
| **质量模型** | 规则较分散,更多依赖自然语言约束 | 14 个自动激活技能 + 检查清单把关 + Ralph Loop + 结构化证据 |
|
|
107
|
+
| **项目状态** | 知识库更多是附属能力 | `.helloagents/` 成为项目激活边界,`STATE.md` / 方案包 / `DESIGN.md` / `contract.json` 组成主流程的主要判断依据 |
|
|
108
|
+
| **知识库存储** | 默认项目本地 | 默认项目本地,同时新增 `project_store_mode=repo-shared`,支持同一 git 仓库多个 worktree 共享稳定知识和方案资产 |
|
|
109
|
+
| **Codex 集成** | 早期依赖更多兼容层和旧链路 | 标准模式使用注入规则 + 本地链接;全局模式使用原生本地插件链路,减少噪音与漂移 |
|
|
110
|
+
|
|
111
|
+
一句话概括:`v2.3.8` 更像“给多个 CLI 加一层工作流外壳”,`v3.0.8` 更像“把质量协议、计划产物、验证证据和安装生命周期统一成一套真正可运转的工作流框架”。
|
|
112
|
+
|
|
93
113
|
## ✨ 核心特性
|
|
94
114
|
|
|
95
115
|
HelloAGENTS 通过三重机制协同保障质量:
|
|
@@ -112,7 +132,7 @@ HelloAGENTS 通过三重机制协同保障质量:
|
|
|
112
132
|
<td width="50%" valign="top">
|
|
113
133
|
<img src="./readme_images/03-feature-icon-workflow.svg" width="48" align="left">
|
|
114
134
|
|
|
115
|
-
**📋
|
|
135
|
+
**📋 检查清单把关**
|
|
116
136
|
|
|
117
137
|
编码完成后,HelloAGENTS 收集所有已激活技能的交付检查清单,逐项验证通过才能报告完成。
|
|
118
138
|
|
|
@@ -136,10 +156,32 @@ L1 拦截破坏性命令(`rm -rf /`、`git push --force`、`DROP DATABASE`)
|
|
|
136
156
|
|
|
137
157
|
**⚡ 结构化工作流**
|
|
138
158
|
|
|
139
|
-
|
|
159
|
+
简单任务保持快速。复杂任务走“先选路再执行”的主流程:ROUTE/TIER → SPEC → PLAN → BUILD → VERIFY → CONSOLIDATE,并通过显式命令通道拆分脑暴、规划、实现与验证。
|
|
140
160
|
|
|
141
161
|
**你的收益:** 按需投入 — 简单任务保持快速,复杂任务获得完整流程。
|
|
142
162
|
|
|
163
|
+
</td>
|
|
164
|
+
</tr>
|
|
165
|
+
<tr>
|
|
166
|
+
<td width="50%" valign="top">
|
|
167
|
+
<img src="./readme_images/02-feature-icon-installer.svg" width="48" align="left">
|
|
168
|
+
|
|
169
|
+
**🧠 结构化计划产物**
|
|
170
|
+
|
|
171
|
+
复杂任务不再只靠一段自然语言方案,而是落成 `requirements.md`、`plan.md`、`tasks.md`、`contract.json`、`STATE.md`、`DESIGN.md` 等可追踪产物。
|
|
172
|
+
|
|
173
|
+
**你的收益:** 路由、实现、验证、收尾都围绕同一组判断依据推进,不容易中途漂移。
|
|
174
|
+
|
|
175
|
+
</td>
|
|
176
|
+
<td width="50%" valign="top">
|
|
177
|
+
<img src="./readme_images/05-feature-icon-compat.svg" width="48" align="left">
|
|
178
|
+
|
|
179
|
+
**🗂️ 本地 / 共享双存储**
|
|
180
|
+
|
|
181
|
+
默认把知识库和方案包放在项目本地 `.helloagents/`;如果你有多个 worktree,可以切到 `project_store_mode=repo-shared`,把稳定项目知识共享到 `~/.helloagents/projects/<repo-key>/`。
|
|
182
|
+
|
|
183
|
+
**你的收益:** 保留本地运行态隔离,同时避免在多个 worktree 间复制方案和知识库。
|
|
184
|
+
|
|
143
185
|
</td>
|
|
144
186
|
</tr>
|
|
145
187
|
</table>
|
|
@@ -226,7 +268,7 @@ Codex CLI 无需手动执行插件命令。`helloagents --global` 会自动走
|
|
|
226
268
|
```
|
|
227
269
|
💡【HelloAGENTS】- 帮助
|
|
228
270
|
|
|
229
|
-
可用命令: ~auto, ~
|
|
271
|
+
可用命令: ~idea, ~auto, ~plan, ~build, ~prd, ~loop, ~wiki, ~init, ~test, ~verify, ~commit, ~clean, ~help
|
|
230
272
|
|
|
231
273
|
自动激活技能 (14): hello-ui, hello-api, hello-security, hello-test, hello-verify, hello-errors, hello-perf, hello-data, hello-arch, hello-debug, hello-subagent, hello-review, hello-write, hello-reflect
|
|
232
274
|
```
|
|
@@ -241,7 +283,7 @@ Codex CLI 无需手动执行插件命令。`helloagents --global` 会自动走
|
|
|
241
283
|
~auto "添加基于 JWT 的用户认证"
|
|
242
284
|
|
|
243
285
|
# 想先看方案?
|
|
244
|
-
~
|
|
286
|
+
~plan "重构支付模块"
|
|
245
287
|
```
|
|
246
288
|
|
|
247
289
|
## 🔄 安装链路与文件写入
|
|
@@ -266,7 +308,7 @@ HelloAGENTS 在不同模式下会写入不同文件,但写入/恢复/清理都
|
|
|
266
308
|
|
|
267
309
|
### 更新 / 重装 / 切分支行为
|
|
268
310
|
|
|
269
|
-
- **标准模式** 通过 `~/.claude/helloagents`、`~/.gemini/helloagents`、`~/.codex/helloagents` 这三个符号链接保持脚本、技能、模板和 hooks 与包根目录同步,相关链接文件会立即反映本地变化;但 `CLAUDE.md`、`GEMINI.md`、`AGENTS.md`
|
|
311
|
+
- **标准模式** 通过 `~/.claude/helloagents`、`~/.gemini/helloagents`、`~/.codex/helloagents` 这三个符号链接保持脚本、技能、模板和 hooks 与包根目录同步,相关链接文件会立即反映本地变化;但 `CLAUDE.md`、`GEMINI.md`、`AGENTS.md` 这类注入后的规则文件仍是快照,bootstrap 或分支变化后需要显式刷新。
|
|
270
312
|
- **Codex 全局模式** 使用复制后的运行时文件。重新执行 `helloagents --global` 会刷新 `~/plugins/helloagents/` 和 Codex cache 中的副本。
|
|
271
313
|
- 重新执行当前模式命令是被支持的:`helloagents --standby` 和 `helloagents --global` 都是 **切换或刷新** 命令。
|
|
272
314
|
- 如需确定性的手动清理,先执行 `helloagents cleanup`,再执行 `npm uninstall -g helloagents`。
|
|
@@ -280,8 +322,10 @@ HelloAGENTS 在不同模式下会写入不同文件,但写入/恢复/清理都
|
|
|
280
322
|
|
|
281
323
|
| 命令 | 说明 |
|
|
282
324
|
|------|------|
|
|
283
|
-
| `~
|
|
284
|
-
| `~
|
|
325
|
+
| `~idea` | 轻量点子探索 — 比较方向与方案,不写文件 |
|
|
326
|
+
| `~auto` | 自动编排 — 自动选择主路径并持续衔接到实现 / 验证 / 收尾,并优先复用现有活跃方案包 |
|
|
327
|
+
| `~plan` | 结构化规划 — 需求澄清 + 方案收敛 + 计划包 |
|
|
328
|
+
| `~build` | 执行实现 — 基于当前需求或现有计划包完成实现 |
|
|
285
329
|
| `~prd` | 完整 PRD — 13 维度头脑风暴式探索,生成产品需求文档 |
|
|
286
330
|
| `~loop` | 自主迭代优化 — 设定目标和指标,AI 循环改进直到达标 |
|
|
287
331
|
|
|
@@ -290,19 +334,23 @@ HelloAGENTS 在不同模式下会写入不同文件,但写入/恢复/清理都
|
|
|
290
334
|
| 命令 | 说明 |
|
|
291
335
|
|------|------|
|
|
292
336
|
| `~test` | 编写完整测试(TDD:Red → Green → Refactor) |
|
|
293
|
-
| `~verify` |
|
|
294
|
-
| `~review` | 代码审查,按严重程度分类 |
|
|
337
|
+
| `~verify` | 统一验证入口 — 审查、lint、typecheck、test、build 与修复循环 |
|
|
295
338
|
|
|
296
339
|
**工具命令:**
|
|
297
340
|
|
|
298
341
|
| 命令 | 说明 |
|
|
299
342
|
|------|------|
|
|
300
343
|
| `~wiki` | 仅创建/同步项目知识库(`.helloagents/`) |
|
|
301
|
-
| `~init` | 完整初始化项目:知识库 +
|
|
344
|
+
| `~init` | 完整初始化项目:知识库 + 项目级规则文件 |
|
|
302
345
|
| `~commit` | 生成规范化提交信息 + 知识库同步 |
|
|
303
346
|
| `~clean` | 归档已完成方案,清理临时文件 |
|
|
304
347
|
| `~help` | 显示所有命令和当前配置 |
|
|
305
348
|
|
|
349
|
+
兼容别名:
|
|
350
|
+
- `~design` → `~plan`
|
|
351
|
+
- `~do` → `~build`
|
|
352
|
+
- `~review` → `~verify`(审查优先模式)
|
|
353
|
+
|
|
306
354
|
## 🔧 配置
|
|
307
355
|
|
|
308
356
|
配置文件:`~/.helloagents/helloagents.json`(安装时自动创建)
|
|
@@ -317,6 +365,7 @@ HelloAGENTS 在不同模式下会写入不同文件,但写入/恢复/清理都
|
|
|
317
365
|
"ralph_loop_enabled": true,
|
|
318
366
|
"guard_enabled": true,
|
|
319
367
|
"kb_create_mode": 1,
|
|
368
|
+
"project_store_mode": "local",
|
|
320
369
|
"commit_attribution": "",
|
|
321
370
|
"install_mode": "standby"
|
|
322
371
|
}
|
|
@@ -330,6 +379,7 @@ HelloAGENTS 在不同模式下会写入不同文件,但写入/恢复/清理都
|
|
|
330
379
|
| `ralph_loop_enabled` | `true` | 任务完成时自动运行验证 |
|
|
331
380
|
| `guard_enabled` | `true` | 拦截危险命令 |
|
|
332
381
|
| `kb_create_mode` | `1` | `0`=关闭,`1`=已激活项目或全局模式中的编码任务自动,`2`=已激活项目或全局模式中始终 |
|
|
382
|
+
| `project_store_mode` | `"local"` | `"local"`=知识库/方案包保留在项目本地 `.helloagents/`;`"repo-shared"`=本地 `.helloagents/` 仅保留激活/STATE/运行态,知识库与方案包改写到 `~/.helloagents/projects/<repo-key>/` |
|
|
333
383
|
| `commit_attribution` | `""` | 空=不添加,填写内容则追加到 commit message |
|
|
334
384
|
| `install_mode` | `"standby"` | `"standby"`=按项目激活(精简规则),`"global"`=所有项目启用完整规则 |
|
|
335
385
|
|
|
@@ -356,6 +406,11 @@ helloagents --standby
|
|
|
356
406
|
{ "kb_create_mode": 0 }
|
|
357
407
|
```
|
|
358
408
|
|
|
409
|
+
**多个 worktree 共享知识库和方案包:**
|
|
410
|
+
```json
|
|
411
|
+
{ "project_store_mode": "repo-shared" }
|
|
412
|
+
```
|
|
413
|
+
|
|
359
414
|
**开启桌面+声音通知:**
|
|
360
415
|
```json
|
|
361
416
|
{ "notify_level": 3 }
|
|
@@ -370,22 +425,33 @@ helloagents --standby
|
|
|
370
425
|
|
|
371
426
|
## ⚙️ 工作原理
|
|
372
427
|
|
|
373
|
-
**简单说:** HelloAGENTS
|
|
428
|
+
**简单说:** HelloAGENTS 根据任务类型、风险等级和项目状态选择执行深度。标准模式下,未激活项目只保留轻量规则:安全、完成约束、压缩版质量下限,以及显式 `~command` 通道;一旦项目通过 `.helloagents/` 激活,或启用全局模式,就切换到完整主流程,显式经过脑暴、规划、实现、验证与收尾阶段。
|
|
374
429
|
|
|
375
|
-
|
|
430
|
+
**六阶段主流程:**
|
|
376
431
|
|
|
377
|
-
1. **
|
|
378
|
-
2. **
|
|
379
|
-
3. **PLAN** —
|
|
380
|
-
4. **
|
|
381
|
-
5. **
|
|
432
|
+
1. **ROUTE / TIER** — 判断当前任务应进入 `~idea`、`~plan`、`~build`、`~verify`、`~prd` 还是 `~auto`
|
|
433
|
+
2. **SPEC** — 明确目标、约束与成功标准
|
|
434
|
+
3. **PLAN** — 标记所需质量技能,并准备 `requirements.md`、`plan.md`、`tasks.md` 等结构化产物
|
|
435
|
+
4. **BUILD** — 实现,TDD(写测试 → 写代码 → 重构),每步后增量验证
|
|
436
|
+
5. **VERIFY** — 运行 Ralph Loop,需要时先审查 diff,再收集交付检查清单
|
|
437
|
+
6. **CONSOLIDATE** — 更新 `STATE.md`、同步知识库、归档计划包
|
|
382
438
|
|
|
383
|
-
|
|
384
|
-
-
|
|
385
|
-
-
|
|
439
|
+
**Delivery Tier:**
|
|
440
|
+
- `T0` — 只读探索、点子比较、方向发散
|
|
441
|
+
- `T1` — 低风险小改动、明确实现、显式验证
|
|
442
|
+
- `T2` — 多文件功能、新项目、需要结构化产物的任务
|
|
443
|
+
- `T3` — 高风险或不可逆链路,如认证、安全、支付、数据库、生产发布
|
|
386
444
|
|
|
387
|
-
|
|
388
|
-
-
|
|
445
|
+
**路由规则:**
|
|
446
|
+
- 点子探索 / 比较方向 → `~idea`
|
|
447
|
+
- 简单任务(单文件、明确修复)→ 直接执行或 `~build`
|
|
448
|
+
- 复杂任务(3+ 文件、架构变更、新项目)→ 通过 `~plan`、`~auto` 或 `~prd` 走完整流程
|
|
449
|
+
- 审查 / 验证类任务 → `~verify`
|
|
450
|
+
|
|
451
|
+
**按任务类型生效的质量规则与技能:**
|
|
452
|
+
- UI / 前端 / 视觉交互任务始终先遵循当前 bootstrap 文件中的 UI 质量基线
|
|
453
|
+
- 在已激活项目、全局模式或显式 UI 工作流命令中,`hello-ui` 会进一步补充设计契约执行、设计系统映射与视觉验收
|
|
454
|
+
- 只有当 UI `contract.json` 显式要求更强 UI 保障时,HelloAGENTS 才会在保持默认路径轻量的前提下,额外引入 `.helloagents/.ralph-advisor.json` 和 `.helloagents/.ralph-visual.json`
|
|
389
455
|
- 涉及 API?→ `hello-api` 激活(REST 规范、校验、错误格式)
|
|
390
456
|
- 任何代码变更?→ `hello-test`、`hello-verify`、`hello-review` 激活
|
|
391
457
|
|
|
@@ -395,10 +461,12 @@ HelloAGENTS 支持两种安装模式,采用不同的安装方式:
|
|
|
395
461
|
|
|
396
462
|
| 模式 | 安装方式 | 规则 | 技能 | 适用场景 |
|
|
397
463
|
|------|---------|------|------|----------|
|
|
398
|
-
| **标准模式** (默认) | `helloagents install <target> --standby` 或 `helloagents install --all --standby` | `bootstrap-lite.md
|
|
464
|
+
| **标准模式** (默认) | `helloagents install <target> --standby` 或 `helloagents install --all --standby` | `bootstrap-lite.md`(含压缩版质量下限、UI 质量基线、安全规则与完成约束的精简规则) | `~command` 按需使用;激活前 UI 任务仍受 UI 质量基线约束,出现 `.helloagents/` 后切换到完整流程 | 按需使用,不影响其他项目 |
|
|
399
465
|
| **全局模式** | Claude/Gemini 手动装插件;Codex 自动装原生本地插件 | `bootstrap.md`(完整规则) | 14 个技能自动激活 | 全面使用 HelloAGENTS |
|
|
400
466
|
|
|
401
|
-
标准模式会把规则注入到 `~/.claude/CLAUDE.md`、`~/.gemini/GEMINI.md`、`~/.codex/AGENTS.md
|
|
467
|
+
标准模式会把规则注入到 `~/.claude/CLAUDE.md`、`~/.gemini/GEMINI.md`、`~/.codex/AGENTS.md`;对于 Codex,HelloAGENTS 还会在 `~/.codex/config.toml` 中写入一条受管的 `model_instructions_file`,指向同步后的 `~/.codex/AGENTS.md`,让同一份 home carrier 同时成为 Codex 的 base instructions override。执行清理时会恢复用户原来的 `model_instructions_file`。每个 CLI 还会创建 `helloagents` 包根目录符号链接。Claude Code 和 Gemini 仍使用 hooks,因为宿主可以较安静地承载这类注入;Codex 默认**不启用** HelloAGENTS hooks:最新 pre 源码里 hook 生命周期会在 TUI 中可见显示,且 `suppressOutput` 不能作为真正的静默注入通道,所以 Codex 改为依赖注入后的规则文件,以及本地符号链接 / 原生本地插件目录结构。全局模式下,Claude Code 通过 `.claude-plugin/plugin.json` 中声明的 hooks 工作,Gemini 通过 `contextFileName=bootstrap.md` 和扩展 hooks 工作;Codex 仍使用原生本地插件安装链路(marketplace + 本地插件目录 + cache + `config.toml` 插件启用段),并继续使用同一份 `~/.codex/AGENTS.md` home 基线,但不启用插件 hooks。
|
|
468
|
+
|
|
469
|
+
在标准模式下,`.helloagents/` 就是项目激活边界。激活前,lite 规则**不会**进入完整六阶段主流程,也不会启用语义自动选路;它只保留轻量执行规则、显式 `~command` 入口,以及最低质量/完成门槛。项目一旦存在 `.helloagents/`,当前项目就切换到完整项目流程,并以 `bootstrap.md` 作为运行时判断依据。
|
|
402
470
|
|
|
403
471
|
整套切换可用:`helloagents --global` 或 `helloagents --standby`
|
|
404
472
|
|
|
@@ -406,39 +474,45 @@ HelloAGENTS 支持两种安装模式,采用不同的安装方式:
|
|
|
406
474
|
|
|
407
475
|
## 📚 使用指南
|
|
408
476
|
|
|
409
|
-
###
|
|
477
|
+
### 核心工作流通道
|
|
410
478
|
|
|
411
479
|
| 模式 | 说明 | 适用场景 |
|
|
412
480
|
|------|------|----------|
|
|
413
|
-
| `~
|
|
414
|
-
| `~
|
|
481
|
+
| `~idea` | 仅做轻量探索,不写文件 | 想先比较方向,不想进入完整项目流程 |
|
|
482
|
+
| `~plan` | 仅做交互式规划,生成计划包 | 想先审查方案再编码 |
|
|
483
|
+
| `~build` | 从当前需求或现有计划包执行实现 | 需求已明确,想直接开始做 |
|
|
484
|
+
| `~verify` | 审查与验证工作流 | 想先看审查结果、跑检查并修复 |
|
|
485
|
+
| `~auto` | 在以上模式之间自动编排并一路推进 | 需求明确,想要端到端交付 |
|
|
415
486
|
| `~prd` | 13 维度 PRD 生成 | 需要完整的产品需求文档 |
|
|
416
487
|
|
|
417
|
-
典型模式:先 `~
|
|
488
|
+
典型模式:先 `~idea` 比较方向,再 `~plan` 收敛方案,然后 `~build` 实现,最后 `~verify` 验证。或者直接 `~auto` 一步到位。如果项目里已经有活跃方案包,`~auto` 应先复用这条现有链路,而不是无故重新脑暴或重新规划。涉及 UI 时,决策优先级固定为:`plan.md` / PRD 中的 UI 决策 → `DESIGN.md` → 通用 UI 规则。
|
|
418
489
|
|
|
419
490
|
### 质量验证(Ralph Loop)
|
|
420
491
|
|
|
421
492
|
每个任务完成后,Ralph Loop 自动运行项目的验证命令:
|
|
422
|
-
-
|
|
493
|
+
- 优先级:逻辑 `.helloagents/verify.yaml`(`project_store_mode=repo-shared` 时解析到共享知识目录)→ `package.json` scripts → 自动检测
|
|
423
494
|
- 全部通过?→ 收集技能检查清单 → 验证 → 完成
|
|
424
495
|
- 有失败?→ 反思 → 修复 → 重跑(3 次连续失败后触发熔断)
|
|
496
|
+
- 若当前活跃方案包仍有未完成任务、缺少必需结构化产物,或残留模板占位内容,交付也会被额外把关拦下
|
|
425
497
|
|
|
426
498
|
### 知识库(`.helloagents/`)
|
|
427
499
|
|
|
428
|
-
`~wiki`
|
|
500
|
+
`~wiki` 只创建或同步项目知识库。`~init` 是更完整的项目初始化:它还会写入项目级规则文件(`AGENTS.md`、`CLAUDE.md`、`.gemini/GEMINI.md`)、刷新各宿主项目级原生 skills 链接,并补齐相关忽略项。在标准模式下,真正让当前项目进入完整项目流程的是项目本地 `.helloagents/` 的存在,项目级规则文件只是 `~init` 的附加能力。
|
|
429
501
|
|
|
430
|
-
`STATE.md`
|
|
502
|
+
默认情况下,知识库和方案包都写在项目本地 `.helloagents/`。若 `project_store_mode = "repo-shared"`,本地 `.helloagents/` 仅保留激活信号、`STATE.md` 与 `.ralph-*` 等运行态文件;`context.md`、`guidelines.md`、`DESIGN.md`、`verify.yaml`、`modules/`、`plans/`、`archive/` 会改写到 `~/.helloagents/projects/<repo-key>/`,从而在同一 git 仓库的多个 worktree 间共享稳定资料。
|
|
503
|
+
|
|
504
|
+
`STATE.md` 是项目级恢复快照,不是所有交互的统一记忆文件。它会在 `~wiki`、`~init`、`~plan`、`~build`、`~auto`、`~prd`、`~loop` 这类项目级连续流程中创建并持续更新;在验证/审查类任务中仅在文件已存在时更新;对 `~help` 这类一次性只读交互则不会创建。
|
|
431
505
|
|
|
432
506
|
| 文件 | 用途 |
|
|
433
507
|
|------|------|
|
|
434
|
-
| `STATE.md` | 项目级恢复快照(≤
|
|
435
|
-
| `DESIGN.md` |
|
|
508
|
+
| `STATE.md` | 项目级恢复快照(≤70 行,压缩后可据此续接) |
|
|
509
|
+
| `DESIGN.md` | 项目级 UI 契约(设计系统、组件模式、状态覆盖、无障碍要求) |
|
|
436
510
|
| `context.md` | 项目架构、技术栈、约定 |
|
|
437
511
|
| `guidelines.md` | 非显而易见的编码规则 |
|
|
438
512
|
| `verify.yaml` | 验证命令 |
|
|
439
513
|
| `CHANGELOG.md` | 变更历史 |
|
|
440
514
|
| `modules/*.md` | 模块文档 + 经验 |
|
|
441
|
-
| `plans/` |
|
|
515
|
+
| `plans/` | 活跃计划包(`requirements.md`、`plan.md`、`tasks.md`、`contract.json`) |
|
|
442
516
|
| `archive/` | 已完成计划包 |
|
|
443
517
|
|
|
444
518
|
### 智能提交(~commit)
|
|
@@ -486,7 +560,7 @@ npm test
|
|
|
486
560
|
- Python 包 → 纯 Node.js/Markdown 架构
|
|
487
561
|
- 15 个命令 → 12 个命令 + 14 个自动激活质量技能
|
|
488
562
|
- 6 个 CLI 目标 → 3 个(Claude Code + Codex CLI + Gemini CLI)
|
|
489
|
-
-
|
|
563
|
+
- 新增:检查清单把关、Guard 系统、~prd、~loop、~verify、设计系统生成
|
|
490
564
|
- 详见[版本历史](#-版本历史)。
|
|
491
565
|
</details>
|
|
492
566
|
|
|
@@ -500,11 +574,11 @@ npm test
|
|
|
500
574
|
<summary><strong>Q:14 个质量技能是什么?</strong></summary>
|
|
501
575
|
|
|
502
576
|
**A:** 按任务类型自动激活:
|
|
503
|
-
- **hello-ui
|
|
577
|
+
- **hello-ui**:深层 UI 实现与验收(设计契约、设计系统映射、无障碍、响应式、动画)
|
|
504
578
|
- **hello-api**:API 设计(REST、校验、错误格式、限流)
|
|
505
579
|
- **hello-security**:安全(认证、输入校验、XSS/CSRF、密钥管理)
|
|
506
580
|
- **hello-test**:测试(TDD 流程、边界用例、AAA 模式)
|
|
507
|
-
- **hello-verify
|
|
581
|
+
- **hello-verify**:验证把关(Ralph Loop、熔断器)
|
|
508
582
|
- **hello-errors**:错误处理(结构化错误、日志、恢复策略)
|
|
509
583
|
- **hello-perf**:性能(N+1、缓存、代码分割、虚拟滚动)
|
|
510
584
|
- **hello-data**:数据库(迁移、事务、索引、完整性)
|
|
@@ -527,7 +601,7 @@ npm test
|
|
|
527
601
|
<details>
|
|
528
602
|
<summary><strong>Q:项目知识存在哪里?</strong></summary>
|
|
529
603
|
|
|
530
|
-
**A:**
|
|
604
|
+
**A:** 默认在项目本地 `.helloagents/` 目录。可以由 `~wiki`(仅知识库)或 `~init`(完整项目初始化)创建;之后会按 `kb_create_mode` 在代码变更场景中自动同步。若 `project_store_mode = "repo-shared"`,本地 `.helloagents/` 只保留激活信号、`STATE.md` 与 `.ralph-*` 运行态文件,知识库和方案包会改存到 `~/.helloagents/projects/<repo-key>/`。其中 `STATE.md` 只作为长流程任务的精简恢复快照,不承担所有交互的统一记忆。
|
|
531
605
|
</details>
|
|
532
606
|
|
|
533
607
|
<details>
|
|
@@ -590,7 +664,7 @@ npm test
|
|
|
590
664
|
- 验证安装:`npm list -g helloagents`
|
|
591
665
|
- Claude Code:检查 `~/.claude/CLAUDE.md` 是否包含 HelloAGENTS 标记
|
|
592
666
|
- Gemini CLI:检查 `~/.gemini/GEMINI.md` 是否包含 HelloAGENTS 标记
|
|
593
|
-
- Codex CLI
|
|
667
|
+
- Codex CLI:检查 `~/.codex/AGENTS.md` 是否包含 HelloAGENTS 标记,`~/.codex/config.toml` 是否保留指向 `~/.codex/AGENTS.md` 的 `model_instructions_file` 与 `notify`
|
|
594
668
|
- 重启你的 CLI
|
|
595
669
|
|
|
596
670
|
---
|
|
@@ -644,11 +718,35 @@ npm test
|
|
|
644
718
|
|
|
645
719
|
## 📈 版本历史
|
|
646
720
|
|
|
647
|
-
### v3.0.
|
|
721
|
+
### v3.0.8(当前版本)
|
|
722
|
+
|
|
723
|
+
**修复与验证:**
|
|
724
|
+
- 🔧 Claude Code / Gemini CLI 的 `stop` 交付门控现在优先读取结构化 `turn-state`,不再先从自然语言文本反推“是否完成交付”,普通等待态不再被误判为已完成
|
|
725
|
+
- 🔧 Codex 清理链路现在会保留安装后用户自行改写的 `model_instructions_file`、`notify` 与非托管 `codex_hooks`,不再被安装前旧备份回写覆盖
|
|
726
|
+
- 🧪 新增运行时 / 生命周期回归,覆盖 `stop` 的结构化完成态门控,以及安装后用户改写 Codex 配置时的 cleanup 保留行为
|
|
727
|
+
|
|
728
|
+
### v3.0.7
|
|
729
|
+
|
|
730
|
+
**相对 `v2.3.8` 的当前主线结果:**
|
|
731
|
+
- ✨ 从 Python 包全面重写为 Node.js/Markdown 工作流框架,安装、运行时注入、技能、规则与验证链路全部重建
|
|
732
|
+
- ✨ 把旧的多层路由 / design-develop 流程,统一收敛成 ROUTE/TIER → SPEC → PLAN → BUILD → VERIFY → CONSOLIDATE 六阶段主流程
|
|
733
|
+
- ✨ 从旧命令集切换到 `~idea` / `~plan` / `~build` / `~verify` / `~prd` / `~loop` / `~wiki` 等更聚焦的命令体系,并引入 14 个自动激活质量技能
|
|
734
|
+
- ✨ 项目产物体系成型:`STATE.md`、`DESIGN.md`、`requirements.md`、`plan.md`、`tasks.md`、`contract.json`、`.ralph-*` 证据成为流程判断依据,而不是附属文档
|
|
735
|
+
- ✨ 安装模型重构为标准模式 / 全局模式双轨;Codex 改为原生本地插件链路,Claude/Gemini 保留各自宿主原生能力
|
|
736
|
+
- ✨ 新增 `project_store_mode=repo-shared`,让同一 git 仓库的多个 worktree 可以共享稳定知识库和方案包,而本地 `.helloagents/` 继续保留激活和运行态隔离
|
|
737
|
+
|
|
738
|
+
### v3.0.4
|
|
739
|
+
|
|
740
|
+
**标准待机与运行时边界:**
|
|
741
|
+
- 🔧 相对 `v3.0.3`,进一步明确激活边界:完整六阶段主流程保留在 `bootstrap.md`,`bootstrap-lite.md` 作为项目激活前的待机规则文件
|
|
742
|
+
- ✨ 固化标准模式、未激活项目的压缩版质量下限,让轻量模式仍能维持现代技术基线、性能基线和 UI 质量要求
|
|
743
|
+
- 🔧 统一精修 bootstrap 的运行时术语与规则表述,在不改变既有把关模型的前提下提升准确性和专业性
|
|
744
|
+
|
|
745
|
+
### v3.0.3
|
|
648
746
|
|
|
649
747
|
**流程与知识库激活:**
|
|
650
|
-
- ✨ 新增 `~wiki`,用于只创建或同步 `.helloagents
|
|
651
|
-
- 🔧 明确标准模式下的激活边界:`.helloagents/`
|
|
748
|
+
- ✨ 新增 `~wiki`,用于只创建或同步 `.helloagents/`,不写项目级规则文件
|
|
749
|
+
- 🔧 明确标准模式下的激活边界:`.helloagents/` 才是项目进入完整流程的实际信号;项目级规则文件仍属于 `~init` 的职责
|
|
652
750
|
- 🔧 统一修正 bootstrap、帮助文本和 README 中 `kb_create_mode` 的表述,使其只描述已激活项目或全局模式下的同步时机
|
|
653
751
|
- 🧪 新增 `~wiki` 路由覆盖,并持续验证标准模式下基于 `.helloagents/` 的激活行为
|
|
654
752
|
|
|
@@ -656,41 +754,43 @@ npm test
|
|
|
656
754
|
|
|
657
755
|
**修复与验证:**
|
|
658
756
|
- 🔧 移除误回流到 Codex 标准/全局安装产物 `AGENTS.md` 中的静态运行时上下文前缀
|
|
659
|
-
- 🔧 复查 Claude / Gemini
|
|
660
|
-
- 🔧 同步修正文档中关于 Codex `
|
|
661
|
-
- 🧪 新增回归断言,确保 Codex
|
|
757
|
+
- 🔧 复查 Claude / Gemini 标准模式与全局模式静态规则文件,确认本来就不存在同类已废弃运行时规则块
|
|
758
|
+
- 🔧 同步修正文档中关于 Codex `model_instructions_file -> ~/.codex/AGENTS.md` 和无 hooks 运行方式的表述
|
|
759
|
+
- 🧪 新增回归断言,确保 Codex 标准/全局规则文件中不再出现被移除的运行时上下文前缀
|
|
662
760
|
|
|
663
761
|
### v3.0.1
|
|
664
762
|
|
|
665
763
|
**修复与验证:**
|
|
666
764
|
- 🔧 收敛并加强 `STATE.md` 恢复规则:关键决策变更即更新,长流程一旦失真立即重写,宿主明确进入压缩/恢复前置阶段前必须先确认已同步
|
|
667
|
-
- 🔧 修复 Codex 本地插件链路清理后的空 `~/.agents/plugins/marketplace.json`
|
|
765
|
+
- 🔧 修复 Codex 本地插件链路清理后的空 `~/.agents/plugins/marketplace.json` 残留
|
|
668
766
|
- 🔧 修复并验证单 CLI `update` 在记录模式过期时仍会优先复用本地已检测模式,符合 `helloagents update <cli>` 的预期行为
|
|
669
|
-
- 🔧
|
|
670
|
-
- 🧪
|
|
767
|
+
- 🔧 明确标准模式下“链接文件立即同步、注入后的规则文件需显式刷新”的分支 / bootstrap 刷新语义
|
|
768
|
+
- 🧪 新增标准模式规则文件刷新、模式自动复用、Codex 空 marketplace 清理,以及与版本号无关的 npm pack 生命周期测试
|
|
671
769
|
|
|
672
770
|
### v3.0.0 🎉
|
|
673
771
|
|
|
674
772
|
**破坏性变更:**
|
|
675
773
|
- 🔴 完全重写:Python 包 → 纯 Node.js/Markdown 架构。`pip`/`uv` 安装方式不再可用
|
|
676
|
-
- 🔴 命令重命名/移除:`~plan` → `~
|
|
774
|
+
- 🔴 命令重命名/移除:`~design` → `~plan`、`~review` → `~verify`、`~do` → `~build`,移除 `~exec`/`~rollback`/`~rlm`/`~status`/`~validatekb`/`~upgradekb`/`~cleanplan`
|
|
677
775
|
- 🔴 配置键从大写改为小写。移除:`BILINGUAL_COMMIT`、`EVAL_MODE`、`UPDATE_CHECK`、`CSV_BATCH_MAX`
|
|
678
776
|
|
|
679
777
|
**新功能:**
|
|
680
778
|
- ✨ 14 个自动激活质量技能:hello-ui、hello-api、hello-security、hello-test、hello-verify、hello-errors、hello-perf、hello-data、hello-arch、hello-debug、hello-subagent、hello-review、hello-write、hello-reflect
|
|
681
779
|
- ✨ 3 个支持的 CLI:Claude Code(插件/marketplace)、Gemini CLI(扩展)、Codex CLI(npm)
|
|
682
|
-
- ✨
|
|
780
|
+
- ✨ 检查清单把关:所有已激活技能必须通过交付检查清单才能完成任务
|
|
683
781
|
- ✨ `~prd` 命令:13 维度头脑风暴式 PRD 框架
|
|
684
782
|
- ✨ `~loop` 命令:自主迭代优化,带指标追踪和 git 回滚
|
|
685
783
|
- ✨ `~verify` 命令:自动检测并运行所有验证命令
|
|
686
784
|
- ✨ Guard 系统(`guard.mjs`):L1 拦截破坏性命令 + L2 安全模式建议
|
|
687
785
|
- ✨ 标准/全局模式:`install_mode` 配置项支持按项目或全局激活
|
|
688
|
-
- ✨ 流状态管理(`STATE.md
|
|
689
|
-
- ✨ 设计系统生成(`DESIGN.md
|
|
690
|
-
- ✨ 计划包系统:`requirements.md` + `
|
|
786
|
+
- ✨ 流状态管理(`STATE.md`):用于压缩/恢复衔接的恢复快照(≤70 行)
|
|
787
|
+
- ✨ 设计系统生成(`DESIGN.md`):作为项目级 UI 契约自动创建
|
|
788
|
+
- ✨ 计划包系统:`requirements.md` + `plan.md` + `tasks.md` + `contract.json`
|
|
789
|
+
- ✨ 可选 advisor 契约与证据:仅在 T3 / UI / 高风险链路启用,通过 `contract.json` + `.helloagents/.ralph-advisor.json` 落地
|
|
790
|
+
- ✨ 可选视觉验收证据:仅在 UI 契约明确要求时启用,通过 `contract.json` + `.helloagents/.ralph-visual.json` 落地
|
|
691
791
|
|
|
692
792
|
**架构:**
|
|
693
|
-
- 📦
|
|
793
|
+
- 📦 先选路再执行的六阶段主流程:ROUTE/TIER → SPEC → PLAN → BUILD → VERIFY → CONSOLIDATE
|
|
694
794
|
- 📦 简化配置:8 个小写键,合理默认值
|
|
695
795
|
- 📦 双模式安装:标准模式(非插件,显式部署)/ 全局模式(插件/扩展)
|
|
696
796
|
- 📦 模块化脚本架构:`cli-utils.mjs`(共享工具)、`notify-ui.mjs`(跨平台声音/桌面通知)、`guard.mjs`(安全防护)、`ralph-loop.mjs`(质量验证)
|
|
@@ -746,7 +846,7 @@ npm test
|
|
|
746
846
|
- ✨ Claude Code hooks 从 9 个扩展到 11 个生命周期事件类型
|
|
747
847
|
- ✨ Hooks 支持扩展到 Gemini CLI 和 Grok CLI
|
|
748
848
|
- ✨ 会话启动时配置完整性检查
|
|
749
|
-
- ✨
|
|
849
|
+
- ✨ 上下文压缩前注入恢复游标
|
|
750
850
|
- ✨ 用户自定义工具注册和编排
|
|
751
851
|
|
|
752
852
|
**改进:**
|