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
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
{
|
|
10
10
|
"name": "helloagents",
|
|
11
11
|
"description": "Quality-driven orchestration kernel for AI CLIs: intelligent routing, quality verification, safety guards, and notifications",
|
|
12
|
-
"version": "3.0.
|
|
12
|
+
"version": "3.0.8-beta.1",
|
|
13
13
|
"source": "./",
|
|
14
14
|
"author": {
|
|
15
15
|
"name": "HelloWind",
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "helloagents",
|
|
3
|
-
"version": "3.0.
|
|
3
|
+
"version": "3.0.8-beta.1",
|
|
4
4
|
"description": "HelloAGENTS โ The orchestration kernel that makes any AI CLI smarter. Adds intelligent routing, quality verification (Ralph Loop), safety guards, and notifications.",
|
|
5
5
|
"author": "HelloWind",
|
|
6
6
|
"license": "Apache-2.0",
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "helloagents",
|
|
3
|
-
"version": "3.0.
|
|
3
|
+
"version": "3.0.8-beta.1",
|
|
4
4
|
"description": "HelloAGENTS โ Quality-driven orchestration kernel for AI CLIs with intelligent routing, quality verification (Ralph Loop), safety guards, and notifications.",
|
|
5
5
|
"author": {
|
|
6
6
|
"name": "HelloWind",
|
package/README.md
CHANGED
|
@@ -6,9 +6,9 @@
|
|
|
6
6
|
|
|
7
7
|
<div align="center">
|
|
8
8
|
|
|
9
|
-
**Quality-driven
|
|
9
|
+
**Quality-driven workflow framework for AI coding CLIs โ 14 auto-activated skills, process discipline, and checklist-based quality checks.**
|
|
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>Click to expand</strong></summary>
|
|
34
34
|
|
|
35
35
|
- [๐ฏ Why HelloAGENTS?](#-why-helloagents)
|
|
36
|
+
- [๐ Compared with v2.3.8](#-compared-with-v238)
|
|
36
37
|
- [โจ Core Features](#-core-features)
|
|
37
38
|
- [๐ Quick Start](#-quick-start)
|
|
38
39
|
- [๐ Installation Lifecycle & File Writes](#-installation-lifecycle--file-writes)
|
|
@@ -52,7 +53,7 @@
|
|
|
52
53
|
|
|
53
54
|
Ever had an AI coding assistant that stops at "here's what you should do" instead of actually doing it? Or one that writes code but skips tests, ignores edge cases, and calls it done?
|
|
54
55
|
|
|
55
|
-
HelloAGENTS fixes that. It's
|
|
56
|
+
HelloAGENTS fixes that. It's a workflow layer that sits on top of your AI CLI and enforces quality at every step.
|
|
56
57
|
|
|
57
58
|
<table>
|
|
58
59
|
<tr>
|
|
@@ -90,6 +91,25 @@ HelloAGENTS fixes that. It's an orchestration layer that sits on top of your AI
|
|
|
90
91
|
- โ Simple one-off questions (HelloAGENTS adds process overhead)
|
|
91
92
|
- โ Non-coding tasks (optimized for software engineering)
|
|
92
93
|
|
|
94
|
+
## ๐ Compared with v2.3.8
|
|
95
|
+
|
|
96
|
+
If the last version you used seriously was `v2.3.8`, this is not a minor update. The current line is a full product-line reset.
|
|
97
|
+
|
|
98
|
+
| Dimension | v2.3.8 | Local `v3.0.8` |
|
|
99
|
+
|-----------|--------|----------------|
|
|
100
|
+
| **Implementation base** | Python package plus mixed scripts/rules | Pure Node.js + Markdown runtime built around `cli.mjs`, `bootstrap*.md`, `skills/`, and `scripts/` |
|
|
101
|
+
| **Product shape** | More like a multi-CLI management tool plus prompt protocol bundle | More like a quality workflow framework for AI CLIs, centered on routing, checks, verification, and resumable execution |
|
|
102
|
+
| **Installation model** | pip / uv / npx / shell installers in parallel | npm-first; install the package, then deploy explicitly to Claude / Gemini / Codex |
|
|
103
|
+
| **CLI strategy** | 6 targets with uneven capabilities | Focused on 3 primary surfaces: Claude Code, Gemini CLI, and Codex CLI |
|
|
104
|
+
| **Workflow model** | R0/R1/R2 routing plus older design/develop semantics | ROUTE/TIER โ SPEC โ PLAN โ BUILD โ VERIFY โ CONSOLIDATE 6-stage workflow |
|
|
105
|
+
| **Command surface** | 15 commands including `~exec`, `~rollback`, `~rlm`, `~validatekb` | 13 focused commands such as `~idea`, `~plan`, `~build`, `~verify`, `~prd`, `~loop`, `~wiki`, and `~help` |
|
|
106
|
+
| **Quality model** | More distributed rules, more reliance on prose | 14 auto-activated skills + checklist-based quality checks + Ralph Loop + verification records |
|
|
107
|
+
| **Project state** | KB felt auxiliary | `.helloagents/` is now the activation boundary; `STATE.md`, plan packages, `DESIGN.md`, and `contract.json` anchor the workflow |
|
|
108
|
+
| **KB storage** | Project-local only | Project-local by default, plus `project_store_mode=repo-shared` for sharing stable KB/plan assets across git worktrees |
|
|
109
|
+
| **Codex integration** | Earlier compatibility layers and legacy paths | Standby = injected rules + local links; global = native local-plugin chain with less noise and drift |
|
|
110
|
+
|
|
111
|
+
In one sentence: `v2.3.8` was closer to "workflow glue for multiple CLIs"; `v3.0.8` is a workflow framework that unifies quality rules, plan files, verification records, and installation lifecycle into one operating model.
|
|
112
|
+
|
|
93
113
|
## โจ Core Features
|
|
94
114
|
|
|
95
115
|
HelloAGENTS enforces quality through three mechanisms working together:
|
|
@@ -112,7 +132,7 @@ Skills activate automatically based on what you're building โ no configuration
|
|
|
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
|
-
**๐ Checklist
|
|
135
|
+
**๐ Checklist-Based Delivery Checks**
|
|
116
136
|
|
|
117
137
|
After coding, HelloAGENTS collects delivery checklists from all activated skills and verifies each item before reporting completion.
|
|
118
138
|
|
|
@@ -136,10 +156,32 @@ L1 blocks destructive commands (`rm -rf /`, `git push --force`, `DROP DATABASE`)
|
|
|
136
156
|
|
|
137
157
|
**โก Structured Workflow**
|
|
138
158
|
|
|
139
|
-
Simple tasks
|
|
159
|
+
Simple tasks stay fast. Complex tasks use a 6-stage workflow: ROUTE/TIER โ SPEC โ PLAN โ BUILD โ VERIFY โ CONSOLIDATE, with explicit command lanes for ideation, planning, implementation, and validation.
|
|
140
160
|
|
|
141
161
|
**Your gain:** proportional effort โ quick tasks stay fast, complex tasks get full process.
|
|
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
|
+
**๐ง Structured Plan Files**
|
|
170
|
+
|
|
171
|
+
Complex tasks no longer rely on one paragraph of planning prose. They land as `requirements.md`, `plan.md`, `tasks.md`, `contract.json`, `STATE.md`, and `DESIGN.md` when needed.
|
|
172
|
+
|
|
173
|
+
**Your gain:** routing, implementation, verification, and closeout all work from the same plan files instead of drifting across free-form summaries.
|
|
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
|
+
**๐๏ธ Local / Shared Project Storage**
|
|
180
|
+
|
|
181
|
+
By default, KB and plan packages stay in the project's local `.helloagents/`. If you work with multiple worktrees, `project_store_mode=repo-shared` moves the stable project memory to `~/.helloagents/projects/<repo-key>/`.
|
|
182
|
+
|
|
183
|
+
**Your gain:** local runtime isolation stays intact while stable KB and plan files stop fragmenting across worktrees.
|
|
184
|
+
|
|
143
185
|
</td>
|
|
144
186
|
</tr>
|
|
145
187
|
</table>
|
|
@@ -226,7 +268,7 @@ Codex CLI does not need a manual plugin command. `helloagents --global` now inst
|
|
|
226
268
|
```
|
|
227
269
|
๐กใHelloAGENTSใ- Help
|
|
228
270
|
|
|
229
|
-
Available commands: ~auto, ~
|
|
271
|
+
Available commands: ~idea, ~auto, ~plan, ~build, ~prd, ~loop, ~wiki, ~init, ~test, ~verify, ~commit, ~clean, ~help
|
|
230
272
|
|
|
231
273
|
Auto-activated skills (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 @@ Auto-activated skills (14): hello-ui, hello-api, hello-security, hello-test, hel
|
|
|
241
283
|
~auto "Add user authentication with JWT"
|
|
242
284
|
|
|
243
285
|
# Want to review the plan first?
|
|
244
|
-
~
|
|
286
|
+
~plan "Refactor the payment module"
|
|
245
287
|
```
|
|
246
288
|
|
|
247
289
|
## ๐ Installation Lifecycle & File Writes
|
|
@@ -266,7 +308,7 @@ HelloAGENTS touches different files depending on mode. The write/cleanup rules a
|
|
|
266
308
|
|
|
267
309
|
### Update / reinstall / branch-switch behavior
|
|
268
310
|
|
|
269
|
-
- **Standby mode** keeps scripts, skills, templates, and hooks on `~/.claude/helloagents`, `~/.gemini/helloagents`, and `~/.codex/helloagents` symlinks, so linked package files reflect local changes immediately. The injected
|
|
311
|
+
- **Standby mode** keeps scripts, skills, templates, and hooks on `~/.claude/helloagents`, `~/.gemini/helloagents`, and `~/.codex/helloagents` symlinks, so linked package files reflect local changes immediately. The injected rules files (`CLAUDE.md`, `GEMINI.md`, `AGENTS.md`) are still snapshots and must be refreshed after bootstrap or branch changes.
|
|
270
312
|
- **Codex global mode** uses copied runtime files. Re-running `helloagents --global` refreshes both `~/plugins/helloagents/` and the Codex cache copy.
|
|
271
313
|
- Re-running the current mode command is supported intentionally: `helloagents --standby` and `helloagents --global` both act as **switch-or-refresh** commands.
|
|
272
314
|
- For deterministic manual cleanup, run `helloagents cleanup` before `npm uninstall -g helloagents`.
|
|
@@ -280,8 +322,10 @@ All commands run inside AI chat with the `~` prefix:
|
|
|
280
322
|
|
|
281
323
|
| Command | Purpose |
|
|
282
324
|
|---------|---------|
|
|
283
|
-
| `~
|
|
284
|
-
| `~
|
|
325
|
+
| `~idea` | Lightweight ideation โ compare directions and explore options without writing files |
|
|
326
|
+
| `~auto` | End-to-end execution โ picks the main lane, keeps chaining into build / verify / closeout, and reuses an active plan package before reopening a new lane |
|
|
327
|
+
| `~plan` | Structured planning โ requirement gathering + solution convergence + plan package |
|
|
328
|
+
| `~build` | Execution workflow โ implement from the current request or an existing plan package |
|
|
285
329
|
| `~prd` | Complete PRD โ 13-dimension brainstorm-style exploration, generates product requirements |
|
|
286
330
|
| `~loop` | Autonomous iteration โ set a target + metric, AI loops until goal is met |
|
|
287
331
|
|
|
@@ -290,19 +334,23 @@ All commands run inside AI chat with the `~` prefix:
|
|
|
290
334
|
| Command | Purpose |
|
|
291
335
|
|---------|---------|
|
|
292
336
|
| `~test` | Write complete tests (TDD: Red โ Green โ Refactor) |
|
|
293
|
-
| `~verify` |
|
|
294
|
-
| `~review` | Code review with severity classification |
|
|
337
|
+
| `~verify` | Unified verification entry โ review, lint, typecheck, test, build, and fix loops |
|
|
295
338
|
|
|
296
339
|
**Utility Commands:**
|
|
297
340
|
|
|
298
341
|
| Command | Purpose |
|
|
299
342
|
|---------|---------|
|
|
300
343
|
| `~wiki` | Create or sync the project knowledge base only (`.helloagents/`) |
|
|
301
|
-
| `~init` | Full project bootstrap: KB + project-
|
|
344
|
+
| `~init` | Full project bootstrap: KB + project-level rule files |
|
|
302
345
|
| `~commit` | Generate conventional commit message + KB sync |
|
|
303
346
|
| `~clean` | Archive completed plans, clean temp files |
|
|
304
347
|
| `~help` | Show all commands and current config |
|
|
305
348
|
|
|
349
|
+
Compatibility aliases:
|
|
350
|
+
- `~design` โ `~plan`
|
|
351
|
+
- `~do` โ `~build`
|
|
352
|
+
- `~review` โ `~verify` (review-priority mode)
|
|
353
|
+
|
|
306
354
|
## ๐ง Configuration
|
|
307
355
|
|
|
308
356
|
Config file: `~/.helloagents/helloagents.json` (auto-created on install)
|
|
@@ -317,6 +365,7 @@ Only include keys you want to override โ missing keys use defaults.
|
|
|
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 @@ Only include keys you want to override โ missing keys use defaults.
|
|
|
330
379
|
| `ralph_loop_enabled` | `true` | Auto-run verification after task completion |
|
|
331
380
|
| `guard_enabled` | `true` | Block dangerous commands |
|
|
332
381
|
| `kb_create_mode` | `1` | `0`=off, `1`=auto on coding tasks in activated projects or global mode, `2`=always in activated projects or global mode |
|
|
382
|
+
| `project_store_mode` | `"local"` | `"local"` = keep KB/plan files in project-local `.helloagents/`; `"repo-shared"` = keep local `.helloagents/` only for activation/STATE/runtime files and move KB/plan files to `~/.helloagents/projects/<repo-key>/` |
|
|
333
383
|
| `commit_attribution` | `""` | Empty = no attribution. Set text to append to commit messages |
|
|
334
384
|
| `install_mode` | `"standby"` | `"standby"` = per-project activation (lite rules), `"global"` = full rules for all projects |
|
|
335
385
|
|
|
@@ -356,6 +406,11 @@ helloagents --standby
|
|
|
356
406
|
{ "kb_create_mode": 0 }
|
|
357
407
|
```
|
|
358
408
|
|
|
409
|
+
**Share KB and plan packages across multiple worktrees:**
|
|
410
|
+
```json
|
|
411
|
+
{ "project_store_mode": "repo-shared" }
|
|
412
|
+
```
|
|
413
|
+
|
|
359
414
|
**Enable desktop + sound notifications:**
|
|
360
415
|
```json
|
|
361
416
|
{ "notify_level": 3 }
|
|
@@ -370,22 +425,33 @@ helloagents --standby
|
|
|
370
425
|
|
|
371
426
|
## โ๏ธ How It Works
|
|
372
427
|
|
|
373
|
-
**Short version:** HelloAGENTS selects execution depth based on task
|
|
428
|
+
**Short version:** HelloAGENTS selects execution depth based on task type, risk, and project state. In standby mode, unactivated projects keep a lightweight rule set: safety, completion constraints, a compact quality floor, and explicit `~command` lanes. Once the project is activated through `.helloagents/`, or when global mode is enabled, HelloAGENTS switches to the full 6-stage workflow with explicit ideation, planning, build, verification, and consolidation stages.
|
|
374
429
|
|
|
375
|
-
**The
|
|
430
|
+
**The 6-stage workflow:**
|
|
376
431
|
|
|
377
|
-
1. **
|
|
378
|
-
2. **
|
|
379
|
-
3. **PLAN** โ Mark
|
|
380
|
-
4. **
|
|
381
|
-
5. **
|
|
432
|
+
1. **ROUTE / TIER** โ Decide whether the task belongs in `~idea`, `~plan`, `~build`, `~verify`, `~prd`, or `~auto`
|
|
433
|
+
2. **SPEC** โ Clarify goals, constraints, and success criteria
|
|
434
|
+
3. **PLAN** โ Mark required quality skills and prepare plan files such as `requirements.md`, `plan.md`, and `tasks.md`
|
|
435
|
+
4. **BUILD** โ Implement with TDD (test โ code โ refactor), verify incrementally
|
|
436
|
+
5. **VERIFY** โ Run Ralph Loop, review diffs when needed, and collect delivery checklists
|
|
437
|
+
6. **CONSOLIDATE** โ Update `STATE.md`, sync KB files, and archive completed plan packages
|
|
382
438
|
|
|
383
|
-
**
|
|
384
|
-
-
|
|
385
|
-
-
|
|
439
|
+
**Delivery Tier:**
|
|
440
|
+
- `T0` โ read-only exploration and idea comparison
|
|
441
|
+
- `T1` โ low-risk focused fixes or explicit verification
|
|
442
|
+
- `T2` โ multi-file features, new projects, or work that needs structured files
|
|
443
|
+
- `T3` โ high-risk or irreversible chains such as auth, security, payment, database, or production release work
|
|
386
444
|
|
|
387
|
-
**
|
|
388
|
-
-
|
|
445
|
+
**Routing rules:**
|
|
446
|
+
- Exploration / compare options โ `~idea`
|
|
447
|
+
- Simple tasks (single file, clear fix) โ Direct execution or `~build`
|
|
448
|
+
- Complex tasks (3+ files, architecture change, new project) โ `~plan`, `~auto`, or `~prd`
|
|
449
|
+
- Review / validation requests โ `~verify`
|
|
450
|
+
|
|
451
|
+
**Quality rules and skills by task type:**
|
|
452
|
+
- UI / frontend / visual interaction work always follows the active bootstrap's UI quality baseline
|
|
453
|
+
- In activated projects, global mode, or explicit UI workflow commands, `hello-ui` adds deeper design-contract execution, design-system mapping, and visual validation
|
|
454
|
+
- When a UI `contract.json` explicitly asks for heavier UI assurance, HelloAGENTS keeps the default path light and only then adds optional `.helloagents/.ralph-advisor.json` and `.helloagents/.ralph-visual.json` records
|
|
389
455
|
- Touching API endpoints? โ `hello-api` activates (REST conventions, validation, error format)
|
|
390
456
|
- Any code change? โ `hello-test`, `hello-verify`, `hello-review` activate
|
|
391
457
|
|
|
@@ -395,10 +461,12 @@ HelloAGENTS supports two installation modes with different installation methods:
|
|
|
395
461
|
|
|
396
462
|
| Mode | Install Method | Rules | Skills | Best For |
|
|
397
463
|
|------|---------------|-------|--------|----------|
|
|
398
|
-
| **Standby** (default) | `helloagents install <target> --standby` or `helloagents install --all --standby` | `bootstrap-lite.md` (lite rules) | `~command` on demand
|
|
464
|
+
| **Standby** (default) | `helloagents install <target> --standby` or `helloagents install --all --standby` | `bootstrap-lite.md` (lite rules with compact quality floor, UI quality baseline, safety, and completion constraints) | `~command` on demand; before activation, UI tasks still follow the UI quality baseline; after `.helloagents/`, the full workflow activates | Selective use, keeping other projects unaffected |
|
|
399
465
|
| **Global** | Manual plugins for Claude/Gemini; native local-plugin auto-install for Codex | `bootstrap.md` (full rules) | 14 skills auto-activate | All-in on HelloAGENTS across every project |
|
|
400
466
|
|
|
401
|
-
Standby mode injects rules into `~/.claude/CLAUDE.md`, `~/.gemini/GEMINI.md`, and `~/.codex/AGENTS.md`; Codex
|
|
467
|
+
Standby mode injects rules into `~/.claude/CLAUDE.md`, `~/.gemini/GEMINI.md`, and `~/.codex/AGENTS.md`; for Codex, HelloAGENTS also writes a managed `model_instructions_file` in `~/.codex/config.toml` that points to the synced `~/.codex/AGENTS.md`, so the same home rules file becomes Codex's base instructions override. Cleanup restores the user's original `model_instructions_file` value. Each CLI also gets a `helloagents` package-root symlink. Claude Code and Gemini still use hooks where their host surfaces support quiet injection well. Codex deliberately does **not** enable HelloAGENTS hooks by default: the latest pre-source shows hook lifecycle output in TUI and does not honor `suppressOutput` as a true silent injection path, so Codex relies on the injected rules file plus the local symlink/native plugin layout instead. In global mode, Claude Code uses plugin hooks from `.claude-plugin/plugin.json`, Gemini loads `bootstrap.md` via `contextFileName` plus extension hooks, and Codex uses the native local-plugin chain (marketplace + local plugin root + cache + plugin enablement in `config.toml`) plus the same `~/.codex/AGENTS.md` home baseline, still without plugin hooks.
|
|
468
|
+
|
|
469
|
+
In standby mode, `.helloagents/` is the activation boundary. Before activation, the lite rules file does **not** run the full 6-stage workflow or semantic auto-routing; it keeps the lightweight execution rules, explicit `~command` entry points, and minimum quality/completion guardrails. Once `.helloagents/` exists, the active project switches to the full project workflow and `bootstrap.md` becomes the runtime rules source.
|
|
402
470
|
|
|
403
471
|
Bulk switch via CLI: `helloagents --global` or `helloagents --standby`
|
|
404
472
|
|
|
@@ -406,39 +474,45 @@ Re-running the same mode command is also valid. It refreshes the current mode's
|
|
|
406
474
|
|
|
407
475
|
## ๐ Usage Guide
|
|
408
476
|
|
|
409
|
-
###
|
|
477
|
+
### Core Workflow Lanes
|
|
410
478
|
|
|
411
479
|
| Mode | Description | When to use |
|
|
412
480
|
|------|-------------|-------------|
|
|
413
|
-
| `~
|
|
414
|
-
| `~
|
|
481
|
+
| `~idea` | Lightweight ideation only, no files written | Need help choosing a direction without activating full project flow |
|
|
482
|
+
| `~plan` | Interactive planning only, generates a plan package | Want to review the plan before coding |
|
|
483
|
+
| `~build` | Implementation workflow from the current task or existing plan package | Requirement is clear and you want execution |
|
|
484
|
+
| `~verify` | Verification / review workflow | Want audit, checks, and fix loops |
|
|
485
|
+
| `~auto` | End-to-end execution across the lanes above, continuing until delivery unless blocked | Want HelloAGENTS to choose the right path end-to-end |
|
|
415
486
|
| `~prd` | 13-dimension PRD generation | Need comprehensive product requirements |
|
|
416
487
|
|
|
417
|
-
Typical pattern: `~
|
|
488
|
+
Typical pattern: `~idea` first to compare directions, then `~plan` to lock a solution, then `~build`, then `~verify`. Or just `~auto` for one-shot end-to-end execution. If the project already has an active plan package, `~auto` should reuse that workflow state before reopening ideation or planning. For UI work, the decision priority is always `plan.md` / PRD UI decisions โ `DESIGN.md` โ generic UI rules.
|
|
418
489
|
|
|
419
490
|
### Quality Verification (Ralph Loop)
|
|
420
491
|
|
|
421
492
|
After every task, Ralph Loop auto-runs your project's verification commands:
|
|
422
|
-
- Priority: `.helloagents/verify.yaml` โ `package.json` scripts โ auto-detected
|
|
493
|
+
- Priority: logical `.helloagents/verify.yaml` (`project_store_mode=repo-shared` resolves it from the shared project store) โ `package.json` scripts โ auto-detected
|
|
423
494
|
- All pass? โ Collect skill checklists โ Verify โ Done
|
|
424
495
|
- Any fail? โ Reflect โ Fix โ Re-run (circuit breaker after 3 failures)
|
|
496
|
+
- Completion is also held back if the active plan package still has open tasks, missing required plan files, or unreplaced template placeholders
|
|
425
497
|
|
|
426
498
|
### Knowledge Base (`.helloagents/`)
|
|
427
499
|
|
|
428
|
-
`~wiki` creates or syncs the project
|
|
500
|
+
`~wiki` creates or syncs the project knowledge base only. `~init` is the fuller bootstrap: it also writes project-level rule files (`AGENTS.md`, `CLAUDE.md`, `.gemini/GEMINI.md`), refreshes host-native project skill links, and appends the related ignore rules. In standby mode, the presence of the local `.helloagents/` is what promotes the current project into the full project workflow; project-level rule files are optional.
|
|
429
501
|
|
|
430
|
-
|
|
502
|
+
By default, KB and plan files live in the project's local `.helloagents/`. If `project_store_mode = "repo-shared"`, the local `.helloagents/` directory keeps only the activation signal, `STATE.md`, and runtime files such as `.ralph-*`, while `context.md`, `guidelines.md`, `DESIGN.md`, `verify.yaml`, `modules/`, `plans/`, and `archive/` move to `~/.helloagents/projects/<repo-key>/` so multiple worktrees of the same git repo can share stable project memory.
|
|
503
|
+
|
|
504
|
+
`STATE.md` is a project-level recovery snapshot, not a universal memory file for every interaction. It is created and continuously updated for long-running project workflows such as `~wiki`, `~init`, `~plan`, `~build`, `~auto`, `~prd`, and `~loop`; updated when already present for verification/review style tasks; and intentionally not created for one-off read-only interactions such as `~help`.
|
|
431
505
|
|
|
432
506
|
| File | Purpose |
|
|
433
507
|
|------|---------|
|
|
434
|
-
| `STATE.md` | Project-level recovery snapshot (โค
|
|
435
|
-
| `DESIGN.md` |
|
|
508
|
+
| `STATE.md` | Project-level recovery snapshot (โค70 lines, survives compression as a resumable snapshot) |
|
|
509
|
+
| `DESIGN.md` | Project-level UI contract (design system, component patterns, state coverage, accessibility) |
|
|
436
510
|
| `context.md` | Project architecture, tech stack, conventions |
|
|
437
511
|
| `guidelines.md` | Non-obvious coding rules |
|
|
438
512
|
| `verify.yaml` | Verification commands |
|
|
439
513
|
| `CHANGELOG.md` | Change history |
|
|
440
514
|
| `modules/*.md` | Module documentation + experience |
|
|
441
|
-
| `plans/` | Active plan packages |
|
|
515
|
+
| `plans/` | Active plan packages (`requirements.md`, `plan.md`, `tasks.md`, `contract.json`) |
|
|
442
516
|
| `archive/` | Completed plan packages |
|
|
443
517
|
|
|
444
518
|
### Smart Commit (`~commit`)
|
|
@@ -469,7 +543,7 @@ The test suite validates:
|
|
|
469
543
|
- Claude/Gemini/Codex config file merge, restore, and cleanup behavior
|
|
470
544
|
- Codex local-plugin refresh after local branch or file changes
|
|
471
545
|
- runtime inject/route/guard/Ralph Loop chains
|
|
472
|
-
- cleanup when Codex global
|
|
546
|
+
- cleanup when Codex global files exist but `~/.codex/` is already gone
|
|
473
547
|
|
|
474
548
|
## โ FAQ
|
|
475
549
|
|
|
@@ -500,7 +574,7 @@ The test suite validates:
|
|
|
500
574
|
<summary><strong>Q: What are the 14 quality skills?</strong></summary>
|
|
501
575
|
|
|
502
576
|
**A:** They auto-activate based on task type:
|
|
503
|
-
- **hello-ui**: UI
|
|
577
|
+
- **hello-ui**: deep UI implementation and validation (contracts, design-system mapping, accessibility, responsive, animation)
|
|
504
578
|
- **hello-api**: API design (REST, validation, error format, rate limiting)
|
|
505
579
|
- **hello-security**: Security (auth, input validation, XSS/CSRF, secrets management)
|
|
506
580
|
- **hello-test**: Testing (TDD workflow, boundary cases, AAA pattern)
|
|
@@ -527,7 +601,7 @@ Subagents may skip workflow packaging such as routing, interaction flow, and out
|
|
|
527
601
|
<details>
|
|
528
602
|
<summary><strong>Q: Where does project knowledge go?</strong></summary>
|
|
529
603
|
|
|
530
|
-
**A:**
|
|
604
|
+
**A:** By default, in the project-local `.helloagents/` directory. It can be created by `~wiki` (KB only) or `~init` (full project bootstrap), then auto-synced on code changes according to `kb_create_mode`. If `project_store_mode = "repo-shared"`, the local `.helloagents/` keeps only the activation signal, `STATE.md`, and `.ralph-*` runtime files, while KB and plan files move to `~/.helloagents/projects/<repo-key>/`. `STATE.md` is used as a concise recovery snapshot for long-running workflows, not as a catch-all memory file for every interaction.
|
|
531
605
|
</details>
|
|
532
606
|
|
|
533
607
|
<details>
|
|
@@ -590,7 +664,7 @@ Subagents may skip workflow packaging such as routing, interaction flow, and out
|
|
|
590
664
|
- Verify installation: `npm list -g helloagents`
|
|
591
665
|
- Claude Code: check `~/.claude/CLAUDE.md` contains HelloAGENTS markers
|
|
592
666
|
- Gemini CLI: check `~/.gemini/GEMINI.md` contains HelloAGENTS markers
|
|
593
|
-
- Codex CLI: check `~/.codex/config.toml`
|
|
667
|
+
- Codex CLI: check `~/.codex/AGENTS.md` contains HelloAGENTS markers and `~/.codex/config.toml` keeps `model_instructions_file` pointing to `~/.codex/AGENTS.md` plus `notify`
|
|
594
668
|
- Restart your CLI
|
|
595
669
|
|
|
596
670
|
---
|
|
@@ -644,53 +718,79 @@ Subagents may skip workflow packaging such as routing, interaction flow, and out
|
|
|
644
718
|
|
|
645
719
|
## ๐ Version History
|
|
646
720
|
|
|
647
|
-
### v3.0.
|
|
721
|
+
### v3.0.8 (current)
|
|
722
|
+
|
|
723
|
+
**Fixes and verification:**
|
|
724
|
+
- ๐ง Claude Code / Gemini CLI `stop` delivery gating now prioritizes structured `turn-state` instead of inferring completion from natural-language text, so ordinary waiting turns no longer get misclassified as finished delivery
|
|
725
|
+
- ๐ง Codex cleanup now preserves user-owned post-install replacements for `model_instructions_file`, `notify`, and non-managed `codex_hooks` instead of restoring stale pre-install values over them
|
|
726
|
+
- ๐งช Added lifecycle/runtime regressions for structured `stop` gating and Codex config preservation after post-install user edits
|
|
727
|
+
|
|
728
|
+
### v3.0.7
|
|
729
|
+
|
|
730
|
+
**What the current line now delivers relative to `v2.3.8`:**
|
|
731
|
+
- โจ Full rewrite from a Python package to a Node.js/Markdown workflow framework, including install flow, runtime injection, skill system, and verification chain
|
|
732
|
+
- โจ Replaced the older layered routing / design-develop model with one 6-stage workflow: ROUTE/TIER โ SPEC โ PLAN โ BUILD โ VERIFY โ CONSOLIDATE
|
|
733
|
+
- โจ Re-centered the command surface around `~idea`, `~plan`, `~build`, `~verify`, `~prd`, `~loop`, and `~wiki`, plus 14 auto-activated quality skills
|
|
734
|
+
- โจ Turned project files into first-class workflow records: `STATE.md`, `DESIGN.md`, `requirements.md`, `plan.md`, `tasks.md`, `contract.json`, and `.ralph-*` records
|
|
735
|
+
- โจ Rebuilt installation around standby/global dual-mode deployment; Codex now uses the native local-plugin chain while Claude/Gemini keep host-native integration
|
|
736
|
+
- โจ Added `project_store_mode=repo-shared`, so multiple worktrees of one git repo can share stable KB and plan files while local `.helloagents/` still isolates activation and runtime state
|
|
737
|
+
|
|
738
|
+
### v3.0.4
|
|
739
|
+
|
|
740
|
+
**Standby and runtime boundaries:**
|
|
741
|
+
- ๐ง Clarified the activation boundary relative to `v3.0.3`: the full 6-stage workflow stays in `bootstrap.md`, while `bootstrap-lite.md` is treated as the standby rules file before project activation
|
|
742
|
+
- โจ Solidified standby, unactivated projects with a compact quality floor so lightweight mode still keeps modern stack, performance, and UI-quality baselines
|
|
743
|
+
- ๐ง Refined bootstrap terminology and runtime wording for more precise, professional guidance without changing the existing guardrail model
|
|
744
|
+
|
|
745
|
+
### v3.0.3
|
|
648
746
|
|
|
649
747
|
**Workflow and KB activation:**
|
|
650
|
-
- โจ Added `~wiki` for creating or syncing `.helloagents/` without writing project-
|
|
651
|
-
- ๐ง Clarified the activation boundary: in standby mode, `.helloagents/` is the actual project activation signal; project-
|
|
748
|
+
- โจ Added `~wiki` for creating or syncing `.helloagents/` without writing project-level rule files
|
|
749
|
+
- ๐ง Clarified the activation boundary: in standby mode, `.helloagents/` is the actual project activation signal; project-level rule files remain optional and belong to `~init`
|
|
652
750
|
- ๐ง Refined `kb_create_mode` wording across bootstrap, help text, and README so it only describes sync timing inside activated projects or global mode
|
|
653
751
|
- ๐งช Added routing coverage for `~wiki` and kept standby `.helloagents/` activation behavior under test
|
|
654
752
|
|
|
655
753
|
### v3.0.2
|
|
656
754
|
|
|
657
755
|
**Fixes and verification:**
|
|
658
|
-
- ๐ง Removed the Codex-only static runtime-context block that had been reintroduced into generated `AGENTS.md`
|
|
659
|
-
- ๐ง Re-checked Claude/Gemini standby/global static
|
|
660
|
-
- ๐ง Updated Codex installation docs to match the current `
|
|
661
|
-
- ๐งช Added regression assertions to ensure Codex standby/global
|
|
756
|
+
- ๐ง Removed the Codex-only static runtime-context block that had been reintroduced into generated `AGENTS.md` rules files in standby/global installs
|
|
757
|
+
- ๐ง Re-checked Claude/Gemini standby/global static rules files and confirmed they do not inject the same deprecated runtime-context rule block
|
|
758
|
+
- ๐ง Updated Codex installation docs to match the current `model_instructions_file -> ~/.codex/AGENTS.md` path and the actual no-hooks behavior
|
|
759
|
+
- ๐งช Added regression assertions to ensure Codex standby/global rules files no longer contain the removed runtime-context prefix
|
|
662
760
|
|
|
663
761
|
### v3.0.1
|
|
664
762
|
|
|
665
763
|
**Fixes and verification:**
|
|
666
764
|
- ๐ง `STATE.md` recovery rules are tightened: update on key decision changes, rewrite immediately when long-running work makes the snapshot stale, and confirm sync before host-driven compaction/recovery stages
|
|
667
|
-
- ๐ง Codex cleanup now removes empty `~/.agents/plugins/marketplace.json` residue
|
|
765
|
+
- ๐ง Codex cleanup now removes empty `~/.agents/plugins/marketplace.json` residue during config restore
|
|
668
766
|
- ๐ง Scoped `update` continues to reuse the detected host mode even when tracked config is stale, matching the intended `helloagents update <cli>` behavior
|
|
669
|
-
- ๐ง Standby branch/bootstrap refresh semantics are now documented precisely: symlinked package files update immediately, while injected
|
|
670
|
-
- ๐งช Added lifecycle coverage for standby
|
|
767
|
+
- ๐ง Standby branch/bootstrap refresh semantics are now documented precisely: symlinked package files update immediately, while injected rules files refresh on `install` / `update` / mode-refresh commands
|
|
768
|
+
- ๐งช Added lifecycle coverage for standby rules-file refresh, stale-mode inference, empty Codex marketplace cleanup, and version-agnostic npm pack testing
|
|
671
769
|
|
|
672
770
|
### v3.0.0 ๐
|
|
673
771
|
|
|
674
772
|
**Breaking Changes:**
|
|
675
773
|
- ๐ด Complete rewrite: Python package โ pure Node.js/Markdown architecture. `pip`/`uv` installation no longer available
|
|
676
|
-
- ๐ด Commands renamed/removed: `~plan` โ `~
|
|
774
|
+
- ๐ด Commands renamed/removed: `~design` โ `~plan`, `~review` โ `~verify`, `~do` โ `~build`, removed `~exec`/`~rollback`/`~rlm`/`~status`/`~validatekb`/`~upgradekb`/`~cleanplan`
|
|
677
775
|
- ๐ด Configuration keys changed from uppercase to lowercase. Removed: `BILINGUAL_COMMIT`, `EVAL_MODE`, `UPDATE_CHECK`, `CSV_BATCH_MAX`
|
|
678
776
|
|
|
679
777
|
**New Features:**
|
|
680
778
|
- โจ 14 auto-activated quality skills: 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 supported CLIs: Claude Code (plugin/marketplace), Gemini CLI (extension), Codex CLI (npm)
|
|
682
|
-
- โจ Checklist
|
|
780
|
+
- โจ Checklist-based delivery checks: all activated skills must pass the delivery checklist before task completion
|
|
683
781
|
- โจ `~prd` command: 13-dimension brainstorm-style PRD framework
|
|
684
782
|
- โจ `~loop` command: autonomous iteration optimization with metric tracking and git-based rollback
|
|
685
783
|
- โจ `~verify` command: auto-detect and run all verification commands
|
|
686
784
|
- โจ Guard system (`guard.mjs`): L1 blocking for destructive commands + L2 advisory for security patterns
|
|
687
785
|
- โจ Standby/Global mode: `install_mode` config for per-project or global activation
|
|
688
|
-
- โจ Flow state management (`STATE.md`):
|
|
689
|
-
- โจ Design system generation (`DESIGN.md`): auto-created for UI projects
|
|
690
|
-
- โจ Plan package system: `requirements.md` + `
|
|
786
|
+
- โจ Flow state management (`STATE.md`): recovery snapshot for compaction/resume handoff (โค70 lines)
|
|
787
|
+
- โจ Design system generation (`DESIGN.md`): auto-created for UI projects as a project-level contract
|
|
788
|
+
- โจ Plan package system: `requirements.md` + `plan.md` + `tasks.md` + `contract.json`
|
|
789
|
+
- โจ Optional advisor contract/records: only for T3 / UI / high-risk flows, via `contract.json` + `.helloagents/.ralph-advisor.json`
|
|
790
|
+
- โจ Optional visual validation records: only when the UI contract explicitly requires it, via `contract.json` + `.helloagents/.ralph-visual.json`
|
|
691
791
|
|
|
692
792
|
**Architecture:**
|
|
693
|
-
- ๐ฆ
|
|
793
|
+
- ๐ฆ 6-stage workflow: ROUTE/TIER โ SPEC โ PLAN โ BUILD โ VERIFY โ CONSOLIDATE
|
|
694
794
|
- ๐ฆ Simplified configuration: 8 lowercase keys with sensible defaults
|
|
695
795
|
- ๐ฆ Dual-mode installation: standby (explicit non-plugin deploy) / global (plugin/extension)
|
|
696
796
|
- ๐ฆ Modular script architecture: `cli-utils.mjs` (shared utilities), `notify-ui.mjs` (cross-platform sound/desktop), `guard.mjs` (security), `ralph-loop.mjs` (verification)
|