helloagents 3.0.33 → 3.0.35
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/plugin.json +2 -2
- package/.codex-plugin/plugin.json +3 -4
- package/README.md +70 -71
- package/README_CN.md +70 -71
- package/bootstrap-lite.md +9 -11
- package/bootstrap.md +21 -23
- package/gemini-extension.json +1 -1
- package/install.ps1 +21 -3
- package/install.sh +19 -2
- package/package.json +2 -2
- package/scripts/capability-registry.mjs +5 -3
- package/scripts/cli-doctor-codex.mjs +150 -1
- package/scripts/cli-doctor-render.mjs +2 -1
- package/scripts/cli-lifecycle-hosts.mjs +76 -34
- package/scripts/cli-lifecycle.mjs +50 -15
- package/scripts/cli-messages.mjs +5 -5
- package/scripts/delivery-gate-messages.mjs +5 -4
- package/scripts/delivery-gate.mjs +11 -22
- package/scripts/guard.mjs +1 -1
- package/scripts/notify-closeout.mjs +61 -22
- package/scripts/notify-context.mjs +5 -5
- package/scripts/notify-route.mjs +1 -1
- package/scripts/notify.mjs +2 -2
- package/scripts/plan-contract.mjs +10 -14
- package/scripts/project-session-cleanup.mjs +45 -31
- package/scripts/qa-review-state.mjs +313 -0
- package/scripts/ralph-loop.mjs +32 -13
- package/scripts/runtime-scope.mjs +1 -3
- package/scripts/session-capsule.mjs +51 -13
- package/scripts/state-document.mjs +77 -0
- package/scripts/workflow-core.mjs +13 -19
- package/scripts/workflow-plan-files.mjs +1 -1
- package/scripts/workflow-recommendation.mjs +55 -67
- package/scripts/workflow-state.mjs +8 -8
- package/skills/commands/auto/SKILL.md +12 -12
- package/skills/commands/build/SKILL.md +9 -10
- package/skills/commands/commit/SKILL.md +1 -1
- package/skills/commands/help/SKILL.md +11 -13
- package/skills/commands/init/SKILL.md +18 -9
- package/skills/commands/loop/SKILL.md +70 -96
- package/skills/commands/plan/SKILL.md +7 -8
- package/skills/commands/prd/SKILL.md +3 -3
- package/skills/commands/qa/SKILL.md +49 -0
- package/skills/hello-ui/SKILL.md +3 -3
- package/skills/helloagents/SKILL.md +11 -14
- package/skills/qa-review/SKILL.md +92 -0
- package/templates/plans/contract.json +4 -7
- package/templates/plans/plan.md +1 -1
- package/templates/plans/tasks.md +1 -1
- package/templates/verify.yaml +1 -1
- package/scripts/review-state.mjs +0 -193
- package/scripts/verify-state.mjs +0 -175
- package/skills/commands/global/SKILL.md +0 -71
- package/skills/commands/verify/SKILL.md +0 -46
- package/skills/commands/wiki/SKILL.md +0 -57
- package/skills/hello-review/SKILL.md +0 -42
- package/skills/hello-verify/SKILL.md +0 -144
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "helloagents",
|
|
3
|
-
"version": "3.0.
|
|
4
|
-
"description": "HelloAGENTS — The orchestration kernel that makes any AI CLI smarter. Adds intelligent routing,
|
|
3
|
+
"version": "3.0.35",
|
|
4
|
+
"description": "HelloAGENTS — The orchestration kernel that makes any AI CLI smarter. Adds intelligent routing, unified QA gates, safety guards, and notifications.",
|
|
5
5
|
"author": {
|
|
6
6
|
"name": "HelloWind",
|
|
7
7
|
"email": "hellowind777@gmail.com"
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "helloagents",
|
|
3
|
-
"version": "3.0.
|
|
4
|
-
"description": "HelloAGENTS — Quality-driven orchestration kernel for AI CLIs with intelligent routing,
|
|
3
|
+
"version": "3.0.35",
|
|
4
|
+
"description": "HelloAGENTS — Quality-driven orchestration kernel for AI CLIs with intelligent routing, unified QA gates, safety guards, and notifications.",
|
|
5
5
|
"author": {
|
|
6
6
|
"name": "HelloWind",
|
|
7
7
|
"email": "hellowind777@gmail.com"
|
|
@@ -28,7 +28,7 @@
|
|
|
28
28
|
"interface": {
|
|
29
29
|
"displayName": "HelloAGENTS",
|
|
30
30
|
"shortDescription": "Quality-driven orchestration kernel for AI CLIs",
|
|
31
|
-
"longDescription": "HelloAGENTS is a quality-driven orchestration kernel that enhances AI coding CLIs with intelligent routing,
|
|
31
|
+
"longDescription": "HelloAGENTS is a quality-driven orchestration kernel that enhances AI coding CLIs with intelligent routing, goal-aware execution, unified QA gates, safety guards, and notifications. It provides a comprehensive skill system for ensuring code quality and development best practices.",
|
|
32
32
|
"developerName": "HelloWind",
|
|
33
33
|
"category": "Developer Tools",
|
|
34
34
|
"capabilities": [
|
|
@@ -37,7 +37,6 @@
|
|
|
37
37
|
],
|
|
38
38
|
"websiteURL": "https://github.com/hellowind777/helloagents",
|
|
39
39
|
"defaultPrompt": [
|
|
40
|
-
"Help me set up quality verification for my project",
|
|
41
40
|
"Review my code for potential issues",
|
|
42
41
|
"Guide me through the design workflow for a new feature",
|
|
43
42
|
"Initialize HelloAGENTS configuration for this project"
|
package/README.md
CHANGED
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
|
|
9
9
|
**A workflow layer for AI coding CLIs: skills, project knowledge, delivery checks, safer config writes, and resumable execution.**
|
|
10
10
|
|
|
11
|
-
[](./package.json)
|
|
12
12
|
[](https://www.npmjs.com/package/helloagents)
|
|
13
13
|
[](./package.json)
|
|
14
14
|
[](./skills)
|
|
@@ -78,9 +78,9 @@ HelloAGENTS adds a workflow layer on top of Claude Code, Gemini CLI, and Codex C
|
|
|
78
78
|
|
|
79
79
|
## Core Features
|
|
80
80
|
|
|
81
|
-
### 1) 14
|
|
81
|
+
### 1) 14 built-in workflow skills
|
|
82
82
|
|
|
83
|
-
HelloAGENTS
|
|
83
|
+
HelloAGENTS ships 14 built-in skills. They are loaded only when the current stage needs them, so simple tasks stay light while complex work gets stricter checks.
|
|
84
84
|
|
|
85
85
|
| Skill | Focus |
|
|
86
86
|
|-------|-------|
|
|
@@ -88,19 +88,19 @@ HelloAGENTS includes 14 `hello-*` skills. They are loaded only when the current
|
|
|
88
88
|
| `hello-api` | API design, validation, error format, compatibility |
|
|
89
89
|
| `hello-security` | auth, secrets, permissions, injection risks |
|
|
90
90
|
| `hello-test` | TDD, coverage, edge cases, test structure |
|
|
91
|
-
| `
|
|
91
|
+
| `qa-review` | unified quality review, verification commands, blocking fixes, delivery evidence, closeout |
|
|
92
|
+
| `helloagents` | command routing, workflow stage rules, project knowledge, and state coordination |
|
|
92
93
|
| `hello-errors` | error handling, logs, retry and recovery behavior |
|
|
93
94
|
| `hello-perf` | performance, caching, query and rendering risks |
|
|
94
95
|
| `hello-data` | database, migrations, transactions, indexes |
|
|
95
96
|
| `hello-arch` | architecture, boundaries, code size, maintainability |
|
|
96
97
|
| `hello-debug` | bug diagnosis and escalation when stuck |
|
|
97
98
|
| `hello-subagent` | subagent delegation and result integration |
|
|
98
|
-
| `hello-review` | code review with structured findings |
|
|
99
99
|
| `hello-write` | documentation, reports, and written deliverables |
|
|
100
100
|
| `hello-reflect` | reusable lessons and knowledge updates |
|
|
101
101
|
|
|
102
102
|
All UI work first follows the shared UI quality baseline.
|
|
103
|
-
In global mode, in initialized projects, or in explicit UI workflows, `hello-ui` adds deeper design-contract execution, design-system mapping, and visual validation on top of that baseline.
|
|
103
|
+
In host global mode, in initialized projects, or in explicit UI workflows, `hello-ui` adds deeper design-contract execution, design-system mapping, and visual validation on top of that baseline.
|
|
104
104
|
When visual evidence is required, HelloAGENTS records it in the current session `artifacts/visual.json`.
|
|
105
105
|
|
|
106
106
|
### 2) Commands for different work styles
|
|
@@ -114,12 +114,10 @@ Commands run inside the AI CLI chat with a `~` prefix. The command skill is read
|
|
|
114
114
|
| `~plan` | Requirements, solution design, task breakdown, and plan package |
|
|
115
115
|
| `~build` | Implementation from the current request or an existing plan |
|
|
116
116
|
| `~prd` | Modern product requirements document through guided dimension-by-dimension exploration |
|
|
117
|
-
| `~loop` |
|
|
118
|
-
| `~
|
|
119
|
-
| `~init` | Same as `~wiki` |
|
|
120
|
-
| `~global` | Initialize project-level global mode |
|
|
117
|
+
| `~loop` | Long-running entry; in Codex it prefers `/goal -> ~auto -> ~qa` |
|
|
118
|
+
| `~init` | Initialize the project workflow and sync project knowledge |
|
|
121
119
|
| `~test` | Write tests for a target module or recent change |
|
|
122
|
-
| `~
|
|
120
|
+
| `~qa` | Run the unified quality loop: review, verification commands, fixes, and closeout |
|
|
123
121
|
| `~commit` | Generate a conventional commit message and sync knowledge |
|
|
124
122
|
| `~clean` | Archive finished plans and clean temporary runtime files |
|
|
125
123
|
| `~help` | Show commands and current settings |
|
|
@@ -128,7 +126,7 @@ Compatibility aliases:
|
|
|
128
126
|
|
|
129
127
|
- `~do` → `~build`
|
|
130
128
|
- `~design` → `~plan`
|
|
131
|
-
- `~review` → `~
|
|
129
|
+
- `~review` → `~qa`
|
|
132
130
|
|
|
133
131
|
### 3) Project knowledge base
|
|
134
132
|
|
|
@@ -147,9 +145,7 @@ The knowledge base helps future turns understand the repo without re-discovering
|
|
|
147
145
|
| `plans/<feature>/` | active plan packages |
|
|
148
146
|
| `archive/` | archived plan packages |
|
|
149
147
|
|
|
150
|
-
`~
|
|
151
|
-
|
|
152
|
-
`~global` does more: it creates or updates the knowledge base, writes the project-level global-mode marker, and refreshes project-level HelloAGENTS package-root links for supported hosts.
|
|
148
|
+
`~init` initializes the project workflow: it writes the project-level full carrier marker, prepares project state, and creates or updates the knowledge base.
|
|
153
149
|
|
|
154
150
|
### 4) Structured plan packages
|
|
155
151
|
|
|
@@ -180,7 +176,7 @@ For `~prd`, HelloAGENTS also creates PRD files such as:
|
|
|
180
176
|
|
|
181
177
|
`contract.json` is used by the workflow to decide verification scope, reviewer/tester focus, optional advisor checks, and optional visual validation.
|
|
182
178
|
|
|
183
|
-
`tasks.md` also includes a Codex `/goal` entry. For long-running Codex work, use that prepared entry instead of giving `/goal` a raw product document.
|
|
179
|
+
`tasks.md` also includes a Codex `/goal` entry. For long-running Codex work, use that prepared entry instead of giving `/goal` a raw product document. The default chain is `/goal -> ~auto -> ~qa`: Codex keeps the long-running continuation, `~auto` executes the AFK work, and `~qa` remains the final quality gate before closeout.
|
|
184
180
|
|
|
185
181
|
### 5) State and recovery
|
|
186
182
|
|
|
@@ -193,24 +189,25 @@ HelloAGENTS now resolves the current state file from `state_path`:
|
|
|
193
189
|
|
|
194
190
|
`<workspace>` is the current Git branch, `detached-<sha>` for a detached HEAD, or `workspace` for non-Git projects. `.helloagents/sessions/active.json` only records the active session index.
|
|
195
191
|
|
|
196
|
-
`STATE.md` records where the current workflow stopped. It is not a universal memory file for every conversation.
|
|
192
|
+
`STATE.md` records where the current workflow stopped. It is not a universal memory file for every conversation. Codex `/goal` does not replace `state_path`, `turn-state`, or local evidence files; it only handles long-running continuation on the Codex side.
|
|
197
193
|
|
|
198
194
|
### 6) Verification and delivery evidence
|
|
199
195
|
|
|
200
196
|
HelloAGENTS does not treat “tests passed” and “task complete” as the same thing. Delivery can also require plan coverage, task checklist status, review evidence, advisor evidence, and visual evidence.
|
|
201
197
|
|
|
202
|
-
Runtime
|
|
198
|
+
Runtime state now stays intentionally small:
|
|
203
199
|
|
|
204
|
-
- `.helloagents/sessions/<workspace>/<session>/
|
|
205
|
-
- `.helloagents/sessions/<workspace>/<session>/events.jsonl`
|
|
200
|
+
- `.helloagents/sessions/<workspace>/<session>/STATE.md`
|
|
206
201
|
- `.helloagents/sessions/active.json`
|
|
207
|
-
- `.helloagents/sessions/<workspace>/<session>/artifacts/review.json`
|
|
202
|
+
- `.helloagents/sessions/<workspace>/<session>/artifacts/qa-review.json`
|
|
208
203
|
- `.helloagents/sessions/<workspace>/<session>/artifacts/advisor.json`
|
|
209
204
|
- `.helloagents/sessions/<workspace>/<session>/artifacts/visual.json`
|
|
210
205
|
- `.helloagents/sessions/<workspace>/<session>/artifacts/closeout.json`
|
|
211
|
-
-
|
|
206
|
+
- `~/.codex/.helloagents/notify-state.json` for Codex-native closeout de-duplication only
|
|
207
|
+
|
|
208
|
+
`turn-state`, route context, and the artifact index are stored inside `STATE.md` metadata instead of a separate `capsule.json`. `events.jsonl` is opt-in trace output, not a default runtime file.
|
|
212
209
|
|
|
213
|
-
Delivery gate, guard, and
|
|
210
|
+
Delivery gate, guard, and QA gate messages use action-oriented wording such as processing path, closeout action, and visual validation action, so blocked flows show what to do next without turning executable steps into optional suggestions. Final closeout also enforces a single HelloAGENTS wrapper, so one reply does not emit duplicate closeout headers.
|
|
214
211
|
That wrapper is now reserved for direct final-user delivery only. Intermediate reports, delegated task results, and sub-agent replies stay natural, and sub-agent stop hooks reject wrapped closeout replies.
|
|
215
212
|
|
|
216
213
|
### 7) Safer install, update, cleanup, and diagnostics
|
|
@@ -221,8 +218,8 @@ The CLI manages host files explicitly:
|
|
|
221
218
|
- `update` refreshes the selected target or all targets
|
|
222
219
|
- `cleanup` removes managed injections and links
|
|
223
220
|
- `uninstall` performs scoped cleanup before package removal
|
|
224
|
-
- `doctor` reports drift in carriers, links, hooks, config entries, plugin roots, cache copies, and versions
|
|
225
|
-
- per-host mode tracking is written only after
|
|
221
|
+
- `doctor` reports drift in carriers, links, hooks, config entries, plugin roots, cache copies, and versions; for Codex, it also surfaces native `codex doctor` output when available
|
|
222
|
+
- per-host mode tracking is written only after host setup succeeds, and failed native global cleanup keeps the host tracked as `global` instead of silently layering standby on top
|
|
226
223
|
|
|
227
224
|
## Quick Start
|
|
228
225
|
|
|
@@ -266,20 +263,14 @@ Type:
|
|
|
266
263
|
~help
|
|
267
264
|
```
|
|
268
265
|
|
|
269
|
-
You should see the
|
|
266
|
+
You should see the available chat commands and the current settings.
|
|
270
267
|
|
|
271
268
|
### 4) Create project knowledge
|
|
272
269
|
|
|
273
|
-
|
|
270
|
+
Initialize the project workflow:
|
|
274
271
|
|
|
275
272
|
```text
|
|
276
|
-
~
|
|
277
|
-
```
|
|
278
|
-
|
|
279
|
-
For project-level global mode:
|
|
280
|
-
|
|
281
|
-
```text
|
|
282
|
-
~global
|
|
273
|
+
~init
|
|
283
274
|
```
|
|
284
275
|
|
|
285
276
|
## CLI Management
|
|
@@ -313,7 +304,7 @@ If you omit `--standby` or `--global`, HelloAGENTS first reuses the tracked/dete
|
|
|
313
304
|
|
|
314
305
|
### npm and one-shot script entries
|
|
315
306
|
|
|
316
|
-
Use these when you do not want to depend on the `helloagents` binary being available during package updates. In `HELLOAGENTS=target[:mode]`, target can be `all`, `claude`, `gemini`, or `codex`; mode can be `standby` or `global`. For install, an omitted mode is treated as `standby`. For update, cleanup, uninstall, and branch switching, an omitted mode is forwarded unchanged so HelloAGENTS can reuse the tracked or detected mode for that CLI first.
|
|
307
|
+
Use these when you do not want to depend on the `helloagents` binary being available during package updates. In `HELLOAGENTS=target[:mode]`, target can be `all`, `claude`, `gemini`, or `codex`; mode can be `standby` or `global`. For install, an omitted mode is treated as `standby`. For update, cleanup, uninstall, and branch switching, an omitted mode is forwarded unchanged so HelloAGENTS can reuse the tracked or detected mode for that CLI first. For a custom tarball or package spec, set `HELLOAGENTS_PACKAGE` instead of `HELLOAGENTS_BRANCH`. For a guaranteed refresh of an already installed package, prefer `npm explore -g helloagents -- npm run sync-hosts -- ...` after the package command.
|
|
317
308
|
|
|
318
309
|
Host configs use the stable `helloagents-js` entrypoint and runtime root `~/.helloagents/helloagents`, so Node global package paths can change without breaking managed hooks or Codex `notify`. Codex hooks use standalone `~/.codex/hooks.json` instead of adding large hook blocks to `config.toml`, and Codex global plugin roots plus plugin cache now link back to that same stable runtime root.
|
|
319
310
|
|
|
@@ -328,11 +319,13 @@ HELLOAGENTS=codex npm install -g helloagents
|
|
|
328
319
|
# Install to Codex in global mode
|
|
329
320
|
HELLOAGENTS=codex:global npm install -g helloagents
|
|
330
321
|
|
|
331
|
-
# Update
|
|
332
|
-
|
|
322
|
+
# Update the package, then refresh Claude in standby mode
|
|
323
|
+
npm update -g helloagents
|
|
324
|
+
npm explore -g helloagents -- npm run sync-hosts -- claude --standby
|
|
333
325
|
|
|
334
|
-
# Switch to the beta branch
|
|
335
|
-
|
|
326
|
+
# Switch to the beta branch, then refresh all CLIs in standby mode
|
|
327
|
+
npm install -g https://github.com/hellowind777/helloagents/archive/refs/heads/beta.tar.gz
|
|
328
|
+
npm explore -g helloagents -- npm run sync-hosts -- --all --standby
|
|
336
329
|
|
|
337
330
|
# Clean Gemini integration before package uninstall
|
|
338
331
|
npm explore -g helloagents -- npm run uninstall -- gemini --standby
|
|
@@ -348,11 +341,13 @@ $env:HELLOAGENTS="codex"; npm install -g helloagents
|
|
|
348
341
|
# Install to Codex in global mode
|
|
349
342
|
$env:HELLOAGENTS="codex:global"; npm install -g helloagents
|
|
350
343
|
|
|
351
|
-
# Update
|
|
352
|
-
|
|
344
|
+
# Update the package, then refresh Claude in standby mode
|
|
345
|
+
npm update -g helloagents
|
|
346
|
+
npm explore -g helloagents -- npm run sync-hosts -- claude --standby
|
|
353
347
|
|
|
354
|
-
# Switch to the beta branch
|
|
355
|
-
|
|
348
|
+
# Switch to the beta branch, then refresh all CLIs in standby mode
|
|
349
|
+
npm install -g https://github.com/hellowind777/helloagents/archive/refs/heads/beta.tar.gz
|
|
350
|
+
npm explore -g helloagents -- npm run sync-hosts -- --all --standby
|
|
356
351
|
|
|
357
352
|
# Clean Gemini integration before package uninstall
|
|
358
353
|
npm explore -g helloagents -- npm run uninstall -- gemini --standby
|
|
@@ -365,9 +360,11 @@ After the package is installed, you can also call its npm scripts directly:
|
|
|
365
360
|
npm explore -g helloagents -- npm run deploy:global
|
|
366
361
|
npm explore -g helloagents -- npm run sync-hosts -- --all --standby
|
|
367
362
|
npm explore -g helloagents -- npm run cleanup-hosts -- codex --standby
|
|
368
|
-
npm explore -g helloagents -- npm run uninstall -- --all
|
|
363
|
+
npm explore -g helloagents -- npm run uninstall -- --all
|
|
369
364
|
```
|
|
370
365
|
|
|
366
|
+
Fresh installs can still use `HELLOAGENTS=target[:mode]` directly. For update, branch switching, or any forced host re-sync of an already installed package, the explicit `npm run sync-hosts` step above is the deterministic path.
|
|
367
|
+
|
|
371
368
|
#### One-shot scripts
|
|
372
369
|
|
|
373
370
|
macOS / Linux:
|
|
@@ -408,7 +405,7 @@ $env:HELLOAGENTS="codex:standby"; $env:HELLOAGENTS_ACTION="cleanup"; irm https:/
|
|
|
408
405
|
$env:HELLOAGENTS="gemini"; $env:HELLOAGENTS_ACTION="uninstall"; irm https://raw.githubusercontent.com/hellowind777/helloagents/main/install.ps1 | iex
|
|
409
406
|
```
|
|
410
407
|
|
|
411
|
-
The PowerShell
|
|
408
|
+
The shell and PowerShell wrappers now parse `HELLOAGENTS` once, clear lifecycle env before update, branch switching, and uninstall, and then run one explicit sync or cleanup path.
|
|
412
409
|
|
|
413
410
|
### Branch switching
|
|
414
411
|
|
|
@@ -425,7 +422,7 @@ Use normal npm commands when you only want to change the package and not sync ho
|
|
|
425
422
|
```bash
|
|
426
423
|
npm install -g https://github.com/hellowind777/helloagents/archive/refs/heads/beta.tar.gz
|
|
427
424
|
npm update -g helloagents
|
|
428
|
-
npm explore -g helloagents -- npm run uninstall -- --all
|
|
425
|
+
npm explore -g helloagents -- npm run uninstall -- --all
|
|
429
426
|
npm uninstall -g helloagents
|
|
430
427
|
```
|
|
431
428
|
|
|
@@ -455,6 +452,8 @@ gemini extensions install https://github.com/hellowind777/helloagents
|
|
|
455
452
|
|
|
456
453
|
For Claude Code, the CLI also tries the equivalent `claude plugin marketplace add ...` and `claude plugin install ...` commands. The marketplace is named `helloagents`, and the plugin is also named `helloagents`, so the install target is `helloagents@helloagents`. Restart the host CLI after a global install.
|
|
457
454
|
|
|
455
|
+
When you switch Claude or Gemini back to standby, HelloAGENTS first removes the native plugin or extension. If that cleanup fails, the host stays tracked as `global` instead of silently stacking standby on top.
|
|
456
|
+
|
|
458
457
|
Codex global mode is installed by HelloAGENTS automatically through the local-plugin path.
|
|
459
458
|
|
|
460
459
|
## Commands in Chat
|
|
@@ -468,17 +467,16 @@ Codex global mode is installed by HelloAGENTS automatically through the local-pl
|
|
|
468
467
|
| Review a plan before implementation | `~plan "refactor payment module"` |
|
|
469
468
|
| Implement from a clear request or active plan | `~build "finish task 2 in the plan"` |
|
|
470
469
|
| Build a full product requirement document | `~prd "modern dashboard for operations team"` |
|
|
471
|
-
|
|
|
472
|
-
|
|
|
473
|
-
|
|
|
474
|
-
| Validate current work | `~verify` |
|
|
470
|
+
| Run a long Codex task through `/goal -> ~auto -> ~qa` | `~loop "finish the auth refactor"` |
|
|
471
|
+
| Initialize or refresh the project workflow | `~init` |
|
|
472
|
+
| Validate current work | `~qa` |
|
|
475
473
|
| Generate commit message and sync knowledge | `~commit` |
|
|
476
474
|
|
|
477
|
-
###
|
|
475
|
+
### Project initialization vs host global deployment
|
|
478
476
|
|
|
479
|
-
In standby mode, projects that are not initialized get lighter rules and explicit `~command` entry points. A project
|
|
477
|
+
In standby mode, projects that are not initialized get lighter rules and explicit `~command` entry points. A project becomes initialized after `~init` writes the project-level `<!-- HELLOAGENTS_PROFILE: full -->` marker.
|
|
480
478
|
|
|
481
|
-
In global mode, HelloAGENTS applies full rules by default.
|
|
479
|
+
In global mode, HelloAGENTS applies full rules by default at the host level.
|
|
482
480
|
|
|
483
481
|
## Project Knowledge Base
|
|
484
482
|
|
|
@@ -503,11 +501,8 @@ When `project_store_mode = "repo-shared"`:
|
|
|
503
501
|
Runtime state and evidence remain local to the working project:
|
|
504
502
|
|
|
505
503
|
- `state_path`
|
|
506
|
-
- `.helloagents/sessions/<workspace>/<session>/capsule.json`
|
|
507
|
-
- `.helloagents/sessions/<workspace>/<session>/events.jsonl`
|
|
508
504
|
- `.helloagents/sessions/active.json`
|
|
509
505
|
- `.helloagents/sessions/<workspace>/<session>/artifacts/*.json`
|
|
510
|
-
- `.helloagents/sessions/<workspace>/<session>/artifacts/loop-results.tsv`
|
|
511
506
|
|
|
512
507
|
### Temporary sessions outside project-local storage
|
|
513
508
|
|
|
@@ -517,7 +512,7 @@ For read-only work with no local output, if neither the current directory nor it
|
|
|
517
512
|
~/.helloagents/runtime/<scope-key>/
|
|
518
513
|
```
|
|
519
514
|
|
|
520
|
-
This only stores short-lived `
|
|
515
|
+
This only stores short-lived `STATE.md` and `artifacts/`. Optional `events.jsonl` trace files are only written when trace mode is enabled. It is not project knowledge. Expired transient sessions are removed by TTL cleanup.
|
|
521
516
|
|
|
522
517
|
Once the task creates or modifies local files, or otherwise leaves local output in the current project, HelloAGENTS creates the project-local `.helloagents/sessions/.../STATE.md` automatically instead of keeping that task only in the user-level transient runtime.
|
|
523
518
|
|
|
@@ -525,11 +520,10 @@ Once the task creates or modifies local files, or otherwise leaves local output
|
|
|
525
520
|
|
|
526
521
|
| Command or setting | Behavior |
|
|
527
522
|
|--------------------|----------|
|
|
528
|
-
| `~
|
|
529
|
-
| `~global` | creates knowledge base plus project-level global-mode marker and package-root links |
|
|
523
|
+
| `~init` | initializes the project workflow and syncs the knowledge base |
|
|
530
524
|
| `kb_create_mode = 0` | disables automatic knowledge updates |
|
|
531
525
|
| `kb_create_mode = 1` | syncs knowledge automatically only when the KB already exists |
|
|
532
|
-
| `kb_create_mode = 2` | for coding tasks, auto-creates or syncs the KB when it already exists or the project is
|
|
526
|
+
| `kb_create_mode = 2` | for coding tasks, auto-creates or syncs the KB when it already exists or the project is initialized |
|
|
533
527
|
|
|
534
528
|
## Workflow and Delivery
|
|
535
529
|
|
|
@@ -538,7 +532,7 @@ Once the task creates or modifies local files, or otherwise leaves local output
|
|
|
538
532
|
HelloAGENTS uses this stage model for structured work:
|
|
539
533
|
|
|
540
534
|
```text
|
|
541
|
-
ROUTE / TIER → SPEC → PLAN → BUILD →
|
|
535
|
+
ROUTE / TIER → SPEC → PLAN → BUILD → QA → CONSOLIDATE
|
|
542
536
|
```
|
|
543
537
|
|
|
544
538
|
| Stage | Purpose |
|
|
@@ -547,7 +541,7 @@ ROUTE / TIER → SPEC → PLAN → BUILD → VERIFY → CONSOLIDATE
|
|
|
547
541
|
| `SPEC` | clarify goal, constraints, and success criteria |
|
|
548
542
|
| `PLAN` | prepare plan files and choose needed skills |
|
|
549
543
|
| `BUILD` | implement and run local checks |
|
|
550
|
-
| `
|
|
544
|
+
| `QA` | review, run commands, check contract and evidence |
|
|
551
545
|
| `CONSOLIDATE` | update state, knowledge, and closeout evidence |
|
|
552
546
|
|
|
553
547
|
### Delivery tiers
|
|
@@ -615,7 +609,7 @@ Default shape:
|
|
|
615
609
|
| `output_language` | `""` | follow the user language unless set |
|
|
616
610
|
| `output_format` | `true` | direct final-user closeout from the main agent uses the HelloAGENTS layout; intermediate, delegated, and sub-agent output stays natural |
|
|
617
611
|
| `notify_level` | `0` | `0` off, `1` desktop, `2` sound, `3` both |
|
|
618
|
-
| `ralph_loop_enabled` | `true` | run
|
|
612
|
+
| `ralph_loop_enabled` | `true` | run the QA stop gate for explicit `~qa` / `~loop` or required closeout gates |
|
|
619
613
|
| `guard_enabled` | `true` | block dangerous commands |
|
|
620
614
|
| `kb_create_mode` | `1` | `0` off, `1` sync existing KB automatically, `2` auto-create or sync the KB for coding tasks |
|
|
621
615
|
| `project_store_mode` | `"local"` | `local` or `repo-shared` |
|
|
@@ -634,6 +628,7 @@ Default shape:
|
|
|
634
628
|
- standby updates `~/.claude/settings.json` with managed hooks and permissions
|
|
635
629
|
- standby creates `~/.claude/helloagents -> ~/.helloagents/helloagents`
|
|
636
630
|
- global mode uses Claude Code's plugin system
|
|
631
|
+
- switching from global back to standby removes the native plugin first; if that cleanup fails, HelloAGENTS keeps Claude tracked as `global`
|
|
637
632
|
|
|
638
633
|
### Gemini CLI
|
|
639
634
|
|
|
@@ -641,6 +636,7 @@ Default shape:
|
|
|
641
636
|
- standby updates `~/.gemini/settings.json` with managed hooks
|
|
642
637
|
- standby creates `~/.gemini/helloagents -> ~/.helloagents/helloagents`
|
|
643
638
|
- global mode uses Gemini's extension system
|
|
639
|
+
- switching from global back to standby removes the native extension first; if that cleanup fails, HelloAGENTS keeps Gemini tracked as `global`
|
|
644
640
|
|
|
645
641
|
### Codex CLI
|
|
646
642
|
|
|
@@ -655,10 +651,12 @@ Codex is rules-file driven by default.
|
|
|
655
651
|
- that hook trust state is machine-local generated metadata derived from the current absolute `~/.codex/hooks.json` path; unlike `model_instructions_file = "~/.codex/AGENTS.md"`, it is not portable config and should be regenerated on each machine
|
|
656
652
|
- standby creates `~/.codex/helloagents -> ~/.helloagents/helloagents`
|
|
657
653
|
- global mode installs the native local-plugin chain, but keeps `~/.helloagents/helloagents` as the single managed runtime source by linking plugin roots, plugin cache, and `~/.codex/helloagents` back to it
|
|
654
|
+
- for Codex app/plugin discovery, `global` is the native path; `standby` remains the lighter default for explicit project work
|
|
658
655
|
- cleanup removes only the HelloAGENTS-managed hook trust entries and legacy managed notify residues, while keeping user-owned hook state untouched
|
|
659
656
|
- Codex hooks only synchronize runtime state and enforce Stop gates; they do not inject HelloAGENTS rules or route text through hook output
|
|
660
657
|
- Codex closeout de-duplicates Stop hooks and native `codex-notify`, so one turn does not notify twice, and clientless delegated child-completion events stay silent when the managed Stop hook is active
|
|
661
658
|
- `/goal` remains Codex-native. Enable it explicitly with `helloagents codex goals enable` when long-running plan execution is needed
|
|
659
|
+
- Current OpenAI docs still mark `/goal` as experimental, and Codex app support is still preview. HelloAGENTS therefore treats `/goal` as an opt-in Codex-native accelerator, not as a required runtime dependency
|
|
662
660
|
- Goal-aware commands resume from `tasks.md`, `contract.json`, and `state_path`; they do not create goals automatically or mark them complete before HelloAGENTS verification and closeout
|
|
663
661
|
|
|
664
662
|
## Verification
|
|
@@ -672,8 +670,8 @@ npm test
|
|
|
672
670
|
The current suite covers:
|
|
673
671
|
|
|
674
672
|
- install, update, cleanup, uninstall, branch switching, and mode switching
|
|
675
|
-
- one-shot shell and PowerShell lifecycle dispatch, plus wrapper mode-routing rules for install, update, cleanup, uninstall, and branch switching
|
|
676
|
-
- Claude, Gemini, and Codex host integration behavior
|
|
673
|
+
- one-shot shell and PowerShell lifecycle dispatch, plus wrapper env cleanup and mode-routing rules for install, update, cleanup, uninstall, and branch switching
|
|
674
|
+
- Claude, Gemini, and Codex host integration behavior, including global-to-standby cleanup and failed native cleanup tracking
|
|
677
675
|
- Codex managed `model_instructions_file`, `notify`, `hooks.json`, hook trust state, local plugin, marketplace, and cache behavior
|
|
678
676
|
- Codex cleanup of legacy managed notify variants on Windows and canonical managed notify restoration rules
|
|
679
677
|
- Codex `/goal` feature toggles, long-running route context, and goal-aware command contracts
|
|
@@ -698,17 +696,18 @@ Both.
|
|
|
698
696
|
- `skills/` defines task-specific behavior
|
|
699
697
|
- `scripts/` provides runtime helpers for routing, guard, notify, verification, state, and evidence
|
|
700
698
|
|
|
701
|
-
### Should I use `~
|
|
699
|
+
### Should I use `~init` or `--global`?
|
|
702
700
|
|
|
703
|
-
Use `~
|
|
701
|
+
Use `~init` inside a repo when you want to initialize that project workflow and sync project knowledge.
|
|
704
702
|
|
|
705
|
-
Use
|
|
703
|
+
Use `helloagents --global` when you want host-wide deployment across supported CLIs.
|
|
706
704
|
|
|
707
705
|
### What is the difference between standby and global?
|
|
708
706
|
|
|
709
|
-
`standby` is lighter and explicit. It deploys rules to selected CLIs
|
|
707
|
+
`standby` is lighter and explicit. It deploys rules to selected CLIs while leaving each repo uninitialized until you run `~init`.
|
|
710
708
|
|
|
711
|
-
`global` applies full rules broadly. Claude and Gemini use native plugin/extension installs. Codex uses the local-plugin path.
|
|
709
|
+
`global` applies full rules broadly at the host level. Claude and Gemini use native plugin/extension installs. Codex uses the local-plugin path.
|
|
710
|
+
If you mainly want Codex app/plugin discoverability, use `global`. If you mainly want a lighter, explicit project workflow, keep `standby`.
|
|
712
711
|
|
|
713
712
|
### Do Codex hooks show injected content?
|
|
714
713
|
|
|
@@ -723,7 +722,7 @@ Yes.
|
|
|
723
722
|
|
|
724
723
|
### Does `npm uninstall -g helloagents` remove project knowledge?
|
|
725
724
|
|
|
726
|
-
No. Run `npm explore -g helloagents -- npm run uninstall -- --all
|
|
725
|
+
No. Run `npm explore -g helloagents -- npm run uninstall -- --all` before package removal so HelloAGENTS can reuse the tracked or detected mode for each CLI and clean host integrations plus the stable runtime copy. Project `.helloagents/` files and `~/.helloagents/helloagents.json` are intentionally preserved unless you remove them yourself.
|
|
727
726
|
|
|
728
727
|
## Troubleshooting
|
|
729
728
|
|