helloagents 2.3.8 → 3.0.1-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.
Files changed (90) hide show
  1. package/.claude-plugin/marketplace.json +20 -0
  2. package/.claude-plugin/plugin.json +21 -0
  3. package/.codex-plugin/plugin.json +46 -0
  4. package/README.md +488 -638
  5. package/README_CN.md +770 -0
  6. package/assets/dogdoing/complete.wav +0 -0
  7. package/assets/dogdoing/confirm.wav +0 -0
  8. package/assets/dogdoing/error.wav +0 -0
  9. package/assets/dogdoing/idle.wav +0 -0
  10. package/assets/dogdoing/warning.wav +0 -0
  11. package/assets/icons/icon-large.png +0 -0
  12. package/assets/icons/icon.png +0 -0
  13. package/assets/sounds/complete.wav +0 -0
  14. package/assets/sounds/confirm.wav +0 -0
  15. package/assets/sounds/error.wav +0 -0
  16. package/assets/sounds/idle.wav +0 -0
  17. package/assets/sounds/warning.wav +0 -0
  18. package/bootstrap-lite.md +199 -0
  19. package/bootstrap.md +296 -0
  20. package/cli.mjs +453 -0
  21. package/gemini-extension.json +8 -0
  22. package/hooks/hooks-claude.json +88 -0
  23. package/hooks/hooks.json +76 -0
  24. package/package.json +36 -6
  25. package/scripts/cli-codex.mjs +445 -0
  26. package/scripts/cli-config.mjs +37 -0
  27. package/scripts/cli-hosts.mjs +75 -0
  28. package/scripts/cli-messages.mjs +92 -0
  29. package/scripts/cli-toml.mjs +251 -0
  30. package/scripts/cli-utils.mjs +139 -0
  31. package/scripts/guard.mjs +217 -0
  32. package/scripts/notify-context.mjs +123 -0
  33. package/scripts/notify-events.mjs +11 -0
  34. package/scripts/notify-shared.mjs +47 -0
  35. package/scripts/notify-ui.mjs +92 -0
  36. package/scripts/notify.mjs +219 -0
  37. package/scripts/ralph-loop.mjs +246 -0
  38. package/skills/_meta/SKILL.md +19 -0
  39. package/skills/commands/auto/SKILL.md +91 -0
  40. package/skills/commands/clean/SKILL.md +21 -0
  41. package/skills/commands/commit/SKILL.md +26 -0
  42. package/skills/commands/design/SKILL.md +108 -0
  43. package/skills/commands/help/SKILL.md +45 -0
  44. package/skills/commands/init/SKILL.md +60 -0
  45. package/skills/commands/loop/SKILL.md +98 -0
  46. package/skills/commands/prd/SKILL.md +151 -0
  47. package/skills/commands/review/SKILL.md +16 -0
  48. package/skills/commands/test/SKILL.md +16 -0
  49. package/skills/commands/verify/SKILL.md +21 -0
  50. package/skills/hello-api/SKILL.md +40 -0
  51. package/skills/hello-arch/SKILL.md +38 -0
  52. package/skills/hello-data/SKILL.md +39 -0
  53. package/skills/hello-debug/SKILL.md +58 -0
  54. package/skills/hello-errors/SKILL.md +39 -0
  55. package/skills/hello-perf/SKILL.md +40 -0
  56. package/skills/hello-reflect/SKILL.md +34 -0
  57. package/skills/hello-review/SKILL.md +33 -0
  58. package/skills/hello-security/SKILL.md +40 -0
  59. package/skills/hello-subagent/SKILL.md +32 -0
  60. package/skills/hello-test/SKILL.md +55 -0
  61. package/skills/hello-ui/SKILL.md +197 -0
  62. package/skills/hello-verify/SKILL.md +132 -0
  63. package/skills/hello-write/SKILL.md +33 -0
  64. package/skills/helloagents/SKILL.md +107 -0
  65. package/templates/CHANGELOG.md +5 -0
  66. package/templates/DESIGN.md +19 -0
  67. package/templates/STATE.md +19 -0
  68. package/templates/archive/_index.md +4 -0
  69. package/templates/context.md +19 -0
  70. package/templates/guidelines.md +15 -0
  71. package/templates/modules/module.md +13 -0
  72. package/templates/plans/decisions.md +10 -0
  73. package/templates/plans/design.md +14 -0
  74. package/templates/plans/prd/00-overview.md +23 -0
  75. package/templates/plans/prd/01-user-stories.md +19 -0
  76. package/templates/plans/prd/02-functional.md +30 -0
  77. package/templates/plans/prd/03-ui-design.md +31 -0
  78. package/templates/plans/prd/04-technical.md +25 -0
  79. package/templates/plans/prd/05-nonfunctional.md +28 -0
  80. package/templates/plans/prd/06-i18n-l10n.md +23 -0
  81. package/templates/plans/prd/07-accessibility.md +20 -0
  82. package/templates/plans/prd/08-content.md +20 -0
  83. package/templates/plans/prd/09-testing.md +22 -0
  84. package/templates/plans/prd/10-deployment.md +23 -0
  85. package/templates/plans/prd/11-legal-privacy.md +18 -0
  86. package/templates/plans/prd/12-timeline.md +21 -0
  87. package/templates/plans/requirements.md +18 -0
  88. package/templates/plans/tasks.md +10 -0
  89. package/templates/verify.yaml +9 -0
  90. package/bin/cli.mjs +0 -106
package/README.md CHANGED
@@ -6,14 +6,14 @@
6
6
 
7
7
  <div align="center">
8
8
 
9
- **Let AI go beyond analysis keep pushing until implementation and verification are done.**
9
+ **Quality-driven orchestration kernel for AI coding CLIs14 auto-activated skills, process discipline, and checklist gating.**
10
10
 
11
- [![Version](https://img.shields.io/badge/version-2.3.8-orange.svg)](./pyproject.toml)
11
+ [![Version](https://img.shields.io/badge/version-3.0.1-orange.svg)](./package.json)
12
12
  [![npm](https://img.shields.io/npm/v/helloagents.svg)](https://www.npmjs.com/package/helloagents)
13
- [![Python](https://img.shields.io/badge/python-%3E%3D3.10-3776AB.svg)](./pyproject.toml)
14
- [![Commands](https://img.shields.io/badge/commands-15-6366f1.svg)](./helloagents/functions)
13
+ [![Node](https://img.shields.io/badge/node-%3E%3D18-339933.svg)](./package.json)
14
+ [![Skills](https://img.shields.io/badge/skills-14-6366f1.svg)](./skills)
15
15
  [![License](https://img.shields.io/badge/license-Apache--2.0-blue.svg)](./LICENSE.md)
16
- [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](./CONTRIBUTING.md)
16
+ [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/hellowind777/helloagents/issues)
17
17
 
18
18
  </div>
19
19
 
@@ -25,27 +25,34 @@
25
25
  ---
26
26
 
27
27
  > [!IMPORTANT]
28
- > **Looking for the old version of HelloAGENTS?** The legacy codebase has been moved to a separate archive repository: [helloagents-archive](https://github.com/hellowind777/helloagents-archive)
29
-
30
- ## Table of Contents
31
-
32
- - [Before and After](#before-and-after)
33
- - [Core Features](#core-features)
34
- - [Sub-Agent Native Mapping](#sub-agent-native-mapping)
35
- - [Quick Start](#quick-start)
36
- - [Configuration](#configuration)
37
- - [How It Works](#how-it-works)
38
- - [In-Chat Workflow Commands](#in-chat-workflow-commands)
39
- - [Usage Guide](#usage-guide)
40
- - [Repository Guide](#repository-guide)
41
- - [FAQ](#faq)
42
- - [Troubleshooting](#troubleshooting)
43
- - [Version History](#version-history)
44
- - [Contributing](#contributing)
45
- - [License](#license)
46
- - [Next Steps](#next-steps)
47
-
48
- ## Before and After
28
+ > **Looking for v2.x?** The legacy Python-based codebase has been moved to a separate archive repository: [helloagents-archive](https://github.com/hellowind777/helloagents-archive). The v3 line is a complete rewrite — pure Node.js/Markdown architecture, no Python dependency.
29
+
30
+ ## 📑 Table of Contents
31
+
32
+ <details>
33
+ <summary><strong>Click to expand</strong></summary>
34
+
35
+ - [🎯 Why HelloAGENTS?](#-why-helloagents)
36
+ - [✨ Core Features](#-core-features)
37
+ - [🚀 Quick Start](#-quick-start)
38
+ - [🔄 Installation Lifecycle & File Writes](#-installation-lifecycle--file-writes)
39
+ - [📖 Commands](#-commands)
40
+ - [🔧 Configuration](#-configuration)
41
+ - [⚙️ How It Works](#️-how-it-works)
42
+ - [📚 Usage Guide](#-usage-guide)
43
+ - [🧪 Verification](#-verification)
44
+ - [❓ FAQ](#-faq)
45
+ - [🛠️ Troubleshooting](#️-troubleshooting)
46
+ - [📈 Version History](#-version-history)
47
+ - [📜 License](#-license)
48
+
49
+ </details>
50
+
51
+ ## 🎯 Why HelloAGENTS?
52
+
53
+ 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
+ HelloAGENTS fixes that. It's an orchestration layer that sits on top of your AI CLI and enforces quality at every step.
49
56
 
50
57
  <table>
51
58
  <tr>
@@ -53,14 +60,14 @@
53
60
 
54
61
  **Without HelloAGENTS**
55
62
 
56
- <img src="./readme_images/08-demo-snake-without-helloagents.png" alt="Snake demo without HelloAGENTS" width="520">
63
+ <img src="./readme_images/08-demo-snake-without-helloagents.png" alt="Without HelloAGENTS" width="520">
57
64
 
58
65
  </td>
59
66
  <td width="50%" valign="top" align="center">
60
67
 
61
68
  **With HelloAGENTS**
62
69
 
63
- <img src="./readme_images/07-demo-snake-with-helloagents.png" alt="Snake demo with HelloAGENTS" width="520">
70
+ <img src="./readme_images/07-demo-snake-with-helloagents.png" alt="With HelloAGENTS" width="520">
64
71
 
65
72
  </td>
66
73
  </tr>
@@ -68,846 +75,687 @@
68
75
 
69
76
  | Challenge | Without HelloAGENTS | With HelloAGENTS |
70
77
  |-----------|-------------------|-----------------|
71
- | Stops at planning | Ends with suggestions | Pushes to implementation and validation |
72
- | Output drift | Different structure every prompt | Unified routing and stage chain |
73
- | Risky operations | Easier to make destructive mistakes | EHRB risk detection and escalation |
74
- | Knowledge continuity | Context gets scattered | Built-in KB and session memory |
75
- | Reusability | Prompt-by-prompt effort | Commandized reusable workflow |
78
+ | **Stops at planning** | Ends with suggestions | Pushes through to implementation and verification |
79
+ | **Quality inconsistency** | Varies by prompt | 14 skills auto-activate based on task type |
80
+ | **Risky operations** | Easy to make destructive mistakes | Guard system blocks dangerous commands |
81
+ | **No verification** | "It should work" | Ralph Loop runs lint/test/build before completion |
82
+ | **Knowledge loss** | Context scattered across sessions | Project KB persists and grows |
83
+
84
+ ### 💡 Best For
85
+ - ✅ **Developers using AI CLIs** who want consistent, verified output
86
+ - ✅ **Teams** that need quality guardrails on AI-assisted coding
87
+ - ✅ **Complex projects** requiring structured design → develop → verify workflows
88
+
89
+ ### ⚠️ Not For
90
+ - ❌ Simple one-off questions (HelloAGENTS adds process overhead)
91
+ - ❌ Non-coding tasks (optimized for software engineering)
92
+
93
+ ## ✨ Core Features
76
94
 
77
- ## Core Features
95
+ HelloAGENTS enforces quality through three mechanisms working together:
78
96
 
79
97
  <table>
80
98
  <tr>
81
99
  <td width="50%" valign="top">
82
100
  <img src="./readme_images/02-feature-icon-installer.svg" width="48" align="left">
83
101
 
84
- **RLM Sub-Agent Orchestration**
102
+ **🎯 14 Auto-Activated Quality Skills**
85
103
 
86
- 3 specialized roles (reviewer / writer / brainstormer) plus host CLI native sub-agents (explore / code / brainstorm) are dispatched automatically based on task complexity. Tasks are scheduled via DAG dependency analysis with topological sort and layer-by-layer parallel dispatch. Supports cross-CLI parallel scheduling and Agent Teams collaboration.
104
+ Skills activate automatically based on what you're building no configuration needed.
105
+ - UI, Security, API, Architecture, Performance
106
+ - Testing, Error Handling, Data, Code Review
107
+ - Debugging, Subagents, Documentation, Verification, Reflection
108
+
109
+ **Your gain:** every task gets the right quality checks without you remembering to ask.
87
110
 
88
- **Your gain:** complex tasks are broken down and handled by the right specialist, with parallel execution when possible.
89
111
  </td>
90
112
  <td width="50%" valign="top">
91
113
  <img src="./readme_images/03-feature-icon-workflow.svg" width="48" align="left">
92
114
 
93
- **Structured Workflow (Evaluate → Design → Develop)**
115
+ **📋 Checklist Gate Control**
116
+
117
+ After coding, HelloAGENTS collects delivery checklists from all activated skills and verifies each item before reporting completion.
94
118
 
95
- Every input is scored on five dimensions and routed to R0 direct response, R1 fast flow, or R2 standard flow. R2 enters the full stage chain with explicit entry conditions, deliverables, and verification gates. Supports interactive and fully delegated modes.
119
+ **Your gain:** nothing ships until it actually passes quality checks not just "looks done."
96
120
 
97
- **Your gain:** proportional effort — simple queries stay fast, complex tasks get full process with verification at every step.
98
121
  </td>
99
122
  </tr>
100
123
  <tr>
101
124
  <td width="50%" valign="top">
102
125
  <img src="./readme_images/04-feature-icon-safety.svg" width="48" align="left">
103
126
 
104
- **Three-Layer Safety Detection (EHRB)**
105
-
106
- Keyword scan, semantic analysis, and tool-output inspection catch destructive operations before execution. Interactive and delegated modes enforce user confirmation.
127
+ **🛡️ Guard System + Ralph Loop**
107
128
 
108
- **Your gain:** safer defaults with zero-config protection.
109
- </td>
110
- <td width="50%" valign="top">
111
- <img src="./readme_images/05-feature-icon-compat.svg" width="48" align="left">
129
+ L1 blocks destructive commands (`rm -rf /`, `git push --force`, `DROP DATABASE`). L2 scans for hardcoded secrets and security patterns. Ralph Loop auto-runs verification commands after every task.
112
130
 
113
- **Project Knowledge Base**
131
+ **Your gain:** safer defaults with zero-config protection, verified output every time.
114
132
 
115
- L1 project knowledge base (structured docs synced from code), context survives across sessions.
116
-
117
- **Your gain:** project context persists across sessions — no need to re-explain.
118
133
  </td>
119
- </tr>
120
- <tr>
121
134
  <td width="50%" valign="top">
122
- <img src="./readme_images/02-feature-icon-installer.svg" width="48" align="left">
123
-
124
- **Extensibility & Customization**
125
-
126
- Voice notifications (5 event sounds), user-defined tool orchestration (sub-agents, skills, MCP servers, plugins), and flexible configuration options. All features work across 6 CLI targets with graceful degradation.
135
+ <img src="./readme_images/05-feature-icon-compat.svg" width="48" align="left">
127
136
 
128
- **Your gain:** tailor the workflow to your team's needs without forking the codebase.
129
- </td>
130
- <td width="50%" valign="top">
131
- <img src="./readme_images/03-feature-icon-workflow.svg" width="48" align="left">
137
+ **⚡ Structured Workflow**
132
138
 
133
- **Multi-CLI Support**
139
+ Simple tasks get direct execution. Complex tasks go through ORIENT → CLARIFY → PLAN → EXECUTE → VALIDATE with interactive design, solution proposals, and plan packages.
134
140
 
135
- One rule set works across Claude Code, Codex CLI, OpenCode, Gemini CLI, Qwen CLI, and Grok CLI (Experimental/Community). Automatic feature detection and graceful degradation ensure consistent experience regardless of CLI capabilities.
141
+ **Your gain:** proportional effort quick tasks stay fast, complex tasks get full process.
136
142
 
137
- **Your gain:** switch between CLIs without relearning workflows or reconfiguring rules.
138
143
  </td>
139
144
  </tr>
140
145
  </table>
141
146
 
142
- ### Sub-Agent Native Mapping
143
-
144
- | CLI | Native Sub-Agent Mechanism | RLM Mapping |
145
- |-----|---------------------------|-------------|
146
- | Claude Code | Agent tool (explore / code / shell) | Direct mapping, supports Agent Teams |
147
- | Codex CLI | spawn_agent / Collab (multi-thread) | spawn_agent parallel scheduling, CSV batch orchestration |
148
- | OpenCode | Task tool (build / plan / general / explore) | Direct sub-agent mapping |
149
- | Gemini CLI | Built-in tool calls | Fallback to sequential execution |
150
- | Qwen CLI | Built-in tool calls | Fallback to sequential execution |
151
- | Grok CLI (Experimental) | Built-in tool calls | Fallback to sequential execution |
152
-
153
- Additionally, HelloAGENTS provides: **five-dimension routing scoring** (action need, target clarity, decision scope, impact range, EHRB risk) to automatically determine processing depth for each input; **6 CLI targets** (Claude Code / Codex CLI / OpenCode / Gemini CLI / Qwen CLI / Grok CLI) with one rule set across all; **Hooks integration** (Claude Code 11 lifecycle hooks + Codex CLI notify hook + Gemini CLI 6 hooks + Grok CLI 3 hooks) with automatic graceful degradation when unavailable.
154
-
155
- ### CLI Compatibility Quick Reference
156
-
157
- | CLI | Recommended Version | Key Features | Configuration Notes |
158
- |-----|-------------------|--------------|---------------------|
159
- | **Claude Code** | Latest | Agent Teams, 11 lifecycle hooks | Requires `CLAUDE_CODE_EXPERIMENTAL_AGENT_TEAMS=1` for teams mode |
160
- | **Codex CLI** | 0.110+ | spawn_agent, CSV batch, enable_fanout | Enable sub-agents, CSV orchestration, set `project_doc_max_bytes >= 131072` |
161
- | **OpenCode** | Latest | Task tool, custom agents, MCP | Supports primary agents (build/plan) + subagents (general/explore) |
162
- | **Gemini CLI** | Latest | Built-in tool calls | Sequential execution fallback |
163
- | **Qwen CLI** | Latest | Built-in tool calls | Sequential execution fallback |
164
- | **Grok CLI** (Experimental) | Latest | Built-in tool calls | Community wrapper, hooks not fully verified |
165
-
166
- <details>
167
- <summary>📋 Detailed CLI-specific notes (click to expand)</summary>
168
-
169
- **Codex CLI Configuration:**
170
- - Enable sub-agents and CSV orchestration features
171
- - Set `project_doc_max_bytes = 131072` in config.toml
172
- - Configure `developer_instructions` for routing protocol priority
173
- - Enable `enable_fanout` for CSV batch orchestration (v0.110+)
174
- - Configure `nickname_candidates` for agent role identification
175
- - Configure CSV batch processing if using parallel workflows
176
-
177
- **Claude Code Setup:**
178
- - Set `CLAUDE_CODE_EXPERIMENTAL_AGENT_TEAMS=1` environment variable for Agent Teams
179
- - 11 lifecycle hooks auto-configured during installation (SessionStart, UserPromptSubmit, SubagentStart/Stop, PostToolUse, Stop, TeammateIdle, PreCompact, PreToolUse, SessionEnd, PostToolUseFailure)
180
- - Auto-memory feature disabled during installation (prevents conflicts with AGENTS.md rules)
181
-
182
- **Other CLIs:**
183
- - OpenCode supports Task tool with primary agents (build/plan) and subagents (general/explore)
184
- - Gemini/Qwen/Grok use sequential execution fallback
185
- - All features work with graceful degradation
186
- - Hooks may not be available on all platforms
187
-
188
- </details>
189
-
190
- ## Quick Start
191
-
192
- > 💡 **Choose your installation method:**
193
- > - **First-time users** → Method A (one-line script, recommended)
194
- > - **Node.js developers** → Method B (npx)
195
- > - **Python developers** → Method D (pip)
196
- > - **Need isolated environment** → Method C (UV)
197
-
198
- > ⚠️ **Prerequisite:** All AI CLIs (Codex CLI / Claude Code, etc.) should be upgraded to the latest version with relevant feature flags enabled (e.g., sub-agents, CSV orchestration) to access all HelloAGENTS capabilities. VSCode extensions for these CLIs update more slowly — some newer features may require waiting for the extension to catch up. See CLI-specific compatibility notes below.
199
-
200
- > ⚠️ **Windows PowerShell 5.1** does not support `&&`. Run commands on each side of `&&` separately, or upgrade to [PowerShell 7+](https://learn.microsoft.com/powershell/scripting/install/installing-powershell-on-windows).
201
-
202
- ### Method A: One-line install script (recommended)
203
-
204
- **macOS / Linux:**
205
-
206
- curl -fsSL https://raw.githubusercontent.com/hellowind777/helloagents/main/install.sh | bash
207
-
208
- **Windows PowerShell:**
209
-
210
- irm https://raw.githubusercontent.com/hellowind777/helloagents/main/install.ps1 | iex
147
+ ## 🚀 Quick Start
211
148
 
212
- > The script auto-detects `uv` or `pip`, installs the HelloAGENTS package, and launches an interactive menu for you to select target CLIs. Re-running performs an update.
149
+ ### 1) Install once
213
150
 
214
- **Update:** re-run the install command above.
215
-
216
- **Uninstall:** `uv tool uninstall helloagents` or `pip uninstall helloagents` (depends on what the script detected)
217
-
218
- **Switch branch:**
219
-
220
- # macOS / Linux
221
- curl -fsSL https://raw.githubusercontent.com/hellowind777/helloagents/beta/install.sh | HELLOAGENTS_BRANCH=beta bash
222
-
223
- # Windows PowerShell
224
- $env:HELLOAGENTS_BRANCH="beta"; irm https://raw.githubusercontent.com/hellowind777/helloagents/beta/install.ps1 | iex
225
-
226
- ### Method B: npx (Node.js >= 16)
227
-
228
- npx helloagents
229
-
230
- > Installs the Python package via pip and launches an interactive menu. You can also specify directly: `npx helloagents install codex` (or use `npx -y` to auto-download without prompting)
231
-
232
- > Requires Python >= 3.10. After first install, use the native `helloagents` command directly.
233
-
234
- > **Acknowledgment:** Thanks to @setsuna1106 for generously transferring the npm `helloagents` package ownership.
235
-
236
- **Update:** `npx helloagents@latest`
237
-
238
- **Uninstall:** `pip uninstall helloagents`
239
-
240
- **Switch branch:** `npx helloagents@beta`
241
-
242
- ### Method C: UV (isolated environment)
151
+ ```bash
152
+ npm install -g helloagents
153
+ ```
243
154
 
244
- **Step 0 Install UV first (skip if already installed):**
155
+ If your system already has another `helloagents` executable in `PATH`, use the bundled stable alias instead:
245
156
 
246
- # Windows PowerShell
247
- irm https://astral.sh/uv/install.ps1 | iex
157
+ ```bash
158
+ helloagents-js
159
+ ```
248
160
 
249
- # macOS / Linux
250
- curl -LsSf https://astral.sh/uv/install.sh | sh
161
+ `postinstall` now only installs the package and initializes `~/.helloagents/helloagents.json`. It **does not auto-deploy to any CLI target**.
251
162
 
252
- > After installing UV, restart your terminal to make the `uv` command available.
163
+ After the package is installed, deploy explicitly to the targets you want:
253
164
 
254
- **Install and select targets (one command):**
165
+ ```bash
166
+ helloagents install codex --standby
167
+ helloagents install --all --standby
168
+ ```
255
169
 
256
- uv tool install --from git+https://github.com/hellowind777/helloagents helloagents && helloagents
170
+ > `npm install helloagents` without `-g` follows the same rule: it installs the package only and does not modify any CLI config automatically.
257
171
 
258
- > Installs the package and launches an interactive menu for you to select target CLIs. You can also specify directly: `helloagents install codex`
172
+ ### 2) Choose your mode
259
173
 
260
- **Update:** `uv tool install --from git+https://github.com/hellowind777/helloagents helloagents --force`
174
+ | Goal | What to run | What happens |
175
+ |------|-------------|--------------|
176
+ | Install the package without touching hosts yet | `npm install -g helloagents` | Installs the command and `~/.helloagents/helloagents.json` only |
177
+ | Keep HelloAGENTS light by default | `helloagents install --all --standby` | **Standby mode** explicitly deploys lite rules to the target CLIs |
178
+ | Enable full rules everywhere | `helloagents install --all --global` or `helloagents --global` | Switches to **global mode**; Claude/Gemini use native plugin/extension installs, Codex gets the native local-plugin chain automatically |
179
+ | Re-sync after local branch switch / file updates | `helloagents update codex`, `helloagents install --all --standby`, or `helloagents --global` | Refreshes injected/copied files for the target or current mode |
261
180
 
262
- **Uninstall:** `uv tool uninstall helloagents`
181
+ ### 2.1) Manage one CLI at a time
263
182
 
264
- **Switch branch:** `uv tool install --from git+https://github.com/hellowind777/helloagents@beta helloagents --force`
183
+ ```bash
184
+ helloagents install codex --standby
185
+ helloagents install --all --global
186
+ helloagents update codex
187
+ helloagents cleanup claude --global
188
+ helloagents uninstall gemini
189
+ ```
265
190
 
266
- ### Method D: pip (Python >= 3.10)
191
+ - Supported targets: `claude`, `gemini`, `codex`, or `--all`
192
+ - If you omit `--standby` / `--global`, HelloAGENTS reuses the tracked/detected mode for that CLI and falls back to `standby`
193
+ - `install` / `update` affect only the selected CLI; use `--all` when you want an explicit bulk deploy
194
+ - Claude Code / Gemini CLI still require native plugin/extension install or uninstall commands in `global` mode; Codex CLI is still handled automatically
267
195
 
268
- **Install and select targets (one command):**
196
+ If you want full rules everywhere, switch to global mode:
269
197
 
270
- pip install git+https://github.com/hellowind777/helloagents.git && helloagents
198
+ ```bash
199
+ helloagents --global
200
+ ```
271
201
 
272
- > Installs the package and launches an interactive menu for you to select target CLIs. You can also specify directly: `helloagents install codex`
202
+ Then install the native plugin/extension for your CLI where required:
273
203
 
274
- **Update:** `pip install --upgrade git+https://github.com/hellowind777/helloagents.git`
204
+ ```bash
205
+ # Claude Code
206
+ /plugin marketplace add hellowind777/helloagents
275
207
 
276
- **Uninstall:** `pip uninstall helloagents`
208
+ # Gemini CLI
209
+ gemini extensions install https://github.com/hellowind777/helloagents
210
+ ```
277
211
 
278
- **Switch branch:** `pip install --upgrade git+https://github.com/hellowind777/helloagents.git@beta`
212
+ Codex CLI does not need a manual plugin command. `helloagents --global` now installs the native local-plugin chain automatically by writing:
213
+ - `~/.agents/plugins/marketplace.json`
214
+ - `~/plugins/helloagents/`
215
+ - `~/.codex/plugins/cache/local-plugins/helloagents/local/`
216
+ - `helloagents@local-plugins` in `~/.codex/config.toml`
279
217
 
280
- ### HelloAGENTS commands (after installation)
218
+ ### 3) Verify in chat
281
219
 
282
- > ⚠️ These commands depend on the installed package. If a remote update causes issues, use the native install/update/uninstall commands from your installation method above.
220
+ ```bash
221
+ # In your AI CLI chat, type:
222
+ ~help
223
+ ```
283
224
 
284
- helloagents # interactive menu
285
- helloagents install codex # specify target directly
286
- helloagents install --all # install to all detected CLIs
287
- helloagents status # check installation status
288
- helloagents version # check version
289
- helloagents update # update + auto-sync all targets
290
- helloagents update beta # switch branch + auto-sync
291
- helloagents uninstall codex # uninstall from a CLI target
292
- helloagents uninstall --all # uninstall from all targets
293
- helloagents clean # clean caches
225
+ **Expected output:**
226
+ ```
227
+ 💡【HelloAGENTS】- Help
294
228
 
295
- ### Codex CLI example
229
+ Available commands: ~auto, ~design, ~prd, ~loop, ~init, ~test, ~verify, ~review, ~commit, ~clean, ~help
296
230
 
297
- **First install:**
231
+ 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
+ ```
298
233
 
299
- # One-line script (recommended, auto-launches interactive menu after install)
300
- # macOS / Linux
301
- curl -fsSL https://raw.githubusercontent.com/hellowind777/helloagents/main/install.sh | bash
234
+ ### 4) First use
302
235
 
303
- # Windows PowerShell
304
- irm https://raw.githubusercontent.com/hellowind777/helloagents/main/install.ps1 | iex
236
+ ```bash
237
+ # Simple task — direct execution
238
+ "Fix the typo in src/utils.ts line 42"
305
239
 
306
- # npx (or use npx -y to auto-download without prompting)
307
- npx helloagents install codex
240
+ # Complex task use ~auto for full workflow
241
+ ~auto "Add user authentication with JWT"
308
242
 
309
- # UV
310
- uv tool install --from git+https://github.com/hellowind777/helloagents helloagents && helloagents install codex
243
+ # Want to review the plan first?
244
+ ~design "Refactor the payment module"
245
+ ```
311
246
 
312
- # pip
313
- pip install git+https://github.com/hellowind777/helloagents.git && helloagents install codex
247
+ ## 🔄 Installation Lifecycle & File Writes
314
248
 
315
- **Update later (auto-syncs installed targets):**
249
+ HelloAGENTS touches different files depending on mode. The write/cleanup rules are predictable and reversible.
316
250
 
317
- helloagents update
251
+ ### Standby mode (default)
318
252
 
319
- > ⚠️ **Codex CLI config.toml compatibility notes:** The following settings may affect HelloAGENTS:
320
- > - `[features]` `child_agents_md = true` — experimental, injects extra instructions that may conflict with HelloAGENTS
321
- > - `project_doc_max_bytes` too low default 32KB, AGENTS.md will be truncated (auto-set to 131072 during install)
322
- > - `agent_max_depth = 1` limits sub-agent nesting depth, recommend keeping default or ≥2
323
- > - `agent_max_threads` too low default 6, lower values limit parallel sub-agent scheduling (CSV batch mode recommends ≥16)
324
- > - `[features]` `multi_agent = true` — must be enabled for sub-agent orchestration to work
325
- > - `[features]` `enable_fanout = true` — must be enabled for CSV batch orchestration (spawn_agents_on_csv)
326
- > - Collab sub-agent scheduling requires Codex CLI feature gate to be enabled
327
- >
328
- > 💡 **Best practices:**
329
- > - Codex 0.110+ recommended for full feature set (enable_fanout, nickname_candidates)
330
- > - HelloAGENTS is optimized for Codex CLI — supports `high` and below reasoning effort levels. `xhigh` reasoning is **not supported** and may cause instruction-following issues
331
- > - Use the terminal/CLI version of Codex for the best experience. The VSCode extension updates lag behind the CLI — newer features (e.g., CSV batch orchestration, Collab multi-agent) may require waiting for the extension to catch up
253
+ | CLI | Files HelloAGENTS writes or updates | What it preserves | What uninstall / mode switch cleans |
254
+ |-----|-------------------------------------|-------------------|-------------------------------------|
255
+ | Claude Code | `~/.claude/CLAUDE.md`, `~/.claude/settings.json`, `~/.claude/helloagents -> <package-root>` | Existing non-HelloAGENTS markdown, settings, permissions, and hooks | Removes injected marker block, HelloAGENTS hooks/permissions, and symlink |
256
+ | Gemini CLI | `~/.gemini/GEMINI.md`, `~/.gemini/settings.json`, `~/.gemini/helloagents -> <package-root>` | Existing markdown, hooks, and unrelated settings | Removes injected marker block, HelloAGENTS hooks, and symlink |
257
+ | Codex CLI | `~/.codex/AGENTS.md`, `~/.codex/config.toml`, timestamped backups like `~/.codex/config.toml_YYYYMMDD-HHMMSS.bak`, `~/.codex/helloagents -> <package-root>` | Existing top-level TOML keys and unrelated sections via backup/restore | Removes injected marker block, HelloAGENTS config keys, symlink, and the latest HelloAGENTS-managed backup |
332
258
 
333
- ### Claude Code example
259
+ ### Global mode
334
260
 
335
- **First install:**
261
+ | CLI | How installation works | Files involved |
262
+ |-----|------------------------|----------------|
263
+ | Claude Code | Native plugin install (manual CLI command) | Managed by Claude's plugin system |
264
+ | Gemini CLI | Native extension install (manual CLI command) | Managed by Gemini's extension system |
265
+ | Codex CLI | Native local-plugin chain (automatic) | `~/.agents/plugins/marketplace.json`, `~/plugins/helloagents/`, `~/.codex/plugins/cache/local-plugins/helloagents/local/`, `~/.codex/config.toml` |
336
266
 
337
- # One-line script (recommended, auto-launches interactive menu after install)
338
- # macOS / Linux
339
- curl -fsSL https://raw.githubusercontent.com/hellowind777/helloagents/main/install.sh | bash
267
+ ### Update / reinstall / branch-switch behavior
340
268
 
341
- # Windows PowerShell
342
- irm https://raw.githubusercontent.com/hellowind777/helloagents/main/install.ps1 | iex
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 carrier files (`CLAUDE.md`, `GEMINI.md`, `AGENTS.md`) are still snapshots and must be refreshed after bootstrap or branch changes.
270
+ - **Codex global mode** uses copied runtime files. Re-running `helloagents --global` refreshes both `~/plugins/helloagents/` and the Codex cache copy.
271
+ - Re-running the current mode command is supported intentionally: `helloagents --standby` and `helloagents --global` both act as **switch-or-refresh** commands.
272
+ - For deterministic manual cleanup, run `helloagents cleanup` before `npm uninstall -g helloagents`.
273
+ - `npm uninstall -g helloagents` removes the package; `~/.helloagents/helloagents.json` is intentionally preserved.
343
274
 
344
- # npx (or use npx -y to auto-download without prompting)
345
- npx helloagents install claude
275
+ ## 📖 Commands
346
276
 
347
- # UV
348
- uv tool install --from git+https://github.com/hellowind777/helloagents helloagents && helloagents install claude
277
+ All commands run inside AI chat with the `~` prefix:
349
278
 
350
- # pip
351
- pip install git+https://github.com/hellowind777/helloagents.git && helloagents install claude
279
+ **Workflow Commands:**
352
280
 
353
- **Update later (auto-syncs installed targets):**
281
+ | Command | Purpose |
282
+ |---------|---------|
283
+ | `~auto` | Full autonomous workflow — AI judges complexity, auto-plans and executes |
284
+ | `~design` | Deep interactive design — requirement gathering + solution proposals + plan package |
285
+ | `~prd` | Complete PRD — 13-dimension brainstorm-style exploration, generates product requirements |
286
+ | `~loop` | Autonomous iteration — set a target + metric, AI loops until goal is met |
354
287
 
355
- helloagents update
288
+ **Quality Commands:**
356
289
 
357
- > 💡 **Claude Code sub-agent orchestration tips:**
358
- > - Sub-agents (Agent tool) work out of the box, no extra configuration needed
359
- > - Agent Teams collaboration mode requires environment variable: `CLAUDE_CODE_EXPERIMENTAL_AGENT_TEAMS=1`
360
- > - Parallel sub-agent count is managed automatically by the model, no user-side limit config needed
290
+ | Command | Purpose |
291
+ |---------|---------|
292
+ | `~test` | Write complete tests (TDD: Red Green → Refactor) |
293
+ | `~verify` | Run all verification commands (lint/test/build/typecheck) |
294
+ | `~review` | Code review with severity classification |
361
295
 
362
- ## Configuration
296
+ **Utility Commands:**
363
297
 
364
- Customize workflow behavior via `~/.helloagents/helloagents.json` after installation. Only include keys you want to override — missing keys use defaults.
298
+ | Command | Purpose |
299
+ |---------|---------|
300
+ | `~init` | Initialize project knowledge base (`.helloagents/`) |
301
+ | `~commit` | Generate conventional commit message + KB sync |
302
+ | `~clean` | Archive completed plans, clean temp files |
303
+ | `~help` | Show all commands and current config |
365
304
 
366
- **Available keys:**
305
+ ## 🔧 Configuration
367
306
 
368
- | Key | Type | Default | Description |
369
- |-----|------|---------|-------------|
370
- | `OUTPUT_LANGUAGE` | string | `zh-CN` | Language for AI output and KB files |
371
- | `KB_CREATE_MODE` | int | `2` | KB creation: `0`=OFF, `1`=on-demand (prompt ~init), `2`=auto on code changes, `3`=always auto |
372
- | `BILINGUAL_COMMIT` | int | `1` | Commit language: `0`=OUTPUT_LANGUAGE only, `1`=OUTPUT_LANGUAGE + English |
373
- | `EVAL_MODE` | int | `1` | Clarification mode: `1`=progressive (1 question/round, max 4), `2`=one-shot (all at once, max 2) |
374
- | `UPDATE_CHECK` | int | `72` | Update check cache TTL in hours: `0`=OFF |
375
- | `CSV_BATCH_MAX` | int | `16` | CSV batch max concurrency: `0`=OFF, cap 64 (Codex CLI only) |
376
- | `notify_level` | int | `0` | Notification mode: `0`=OFF, `1`=desktop, `2`=sound, `3`=desktop+sound |
307
+ Config file: `~/.helloagents/helloagents.json` (auto-created on install)
377
308
 
378
- **Example:**
309
+ Only include keys you want to override — missing keys use defaults.
379
310
 
380
311
  ```json
381
312
  {
382
- "KB_CREATE_MODE": 0,
383
- "EVAL_MODE": 2
313
+ "output_language": "",
314
+ "output_format": true,
315
+ "notify_level": 0,
316
+ "ralph_loop_enabled": true,
317
+ "guard_enabled": true,
318
+ "kb_create_mode": 1,
319
+ "commit_attribution": "",
320
+ "install_mode": "standby"
384
321
  }
385
322
  ```
386
323
 
387
- > File missing or unparseable is silently skipped with defaults applied. Unknown keys produce a warning and are ignored.
388
-
389
- ### Common Configuration Scenarios
324
+ | Key | Default | Description |
325
+ |-----|---------|-------------|
326
+ | `output_language` | `""` | Empty = follow user language. Set `zh-CN`, `en`, etc. to override |
327
+ | `output_format` | `true` | `true` = only the main agent's final closing reply after streaming ends may use the HelloAGENTS layout; all streaming/progress/intermediate output and all subagent replies stay natural, `false` = natural output |
328
+ | `notify_level` | `0` | `0`=off, `1`=desktop, `2`=sound, `3`=both |
329
+ | `ralph_loop_enabled` | `true` | Auto-run verification after task completion |
330
+ | `guard_enabled` | `true` | Block dangerous commands |
331
+ | `kb_create_mode` | `1` | `0`=off, `1`=auto on coding tasks, `2`=always |
332
+ | `commit_attribution` | `""` | Empty = no attribution. Set text to append to commit messages |
333
+ | `install_mode` | `"standby"` | `"standby"` = per-project activation (lite rules), `"global"` = full rules for all projects |
390
334
 
391
335
  <details>
392
- <summary>📝 English-only projects</summary>
336
+ <summary>📝 Common configuration scenarios</summary>
393
337
 
394
- ```json
395
- {
396
- "OUTPUT_LANGUAGE": "en-US",
397
- "BILINGUAL_COMMIT": 0
398
- }
338
+ **Switch to global mode (full rules everywhere):**
339
+ ```bash
340
+ helloagents --global
399
341
  ```
400
- All AI outputs, KB files, and commit messages will be in English only.
401
- </details>
402
342
 
403
- <details>
404
- <summary>🚫 Disable automatic KB creation</summary>
343
+ **Switch back to standby mode (default):**
344
+ ```bash
345
+ helloagents --standby
346
+ ```
405
347
 
348
+ **English-only output:**
406
349
  ```json
407
- {
408
- "KB_CREATE_MODE": 0
409
- }
350
+ { "output_language": "en" }
410
351
  ```
411
- Knowledge base won't be created automatically. Use `~init` command when needed.
412
- </details>
413
-
414
- <details>
415
- <summary>⚡ High-concurrency batch processing (Codex CLI)</summary>
416
352
 
353
+ **Disable KB auto-creation:**
417
354
  ```json
418
- {
419
- "CSV_BATCH_MAX": 32
420
- }
355
+ { "kb_create_mode": 0 }
421
356
  ```
422
- Increase parallel CSV batch processing from 16 to 32 (max 64). Requires Codex CLI with CSV orchestration enabled.
423
- </details>
424
-
425
- <details>
426
- <summary>🔕 Disable update checks</summary>
427
357
 
358
+ **Enable desktop + sound notifications:**
428
359
  ```json
429
- {
430
- "UPDATE_CHECK": 0
431
- }
360
+ { "notify_level": 3 }
432
361
  ```
433
- Skip version update checks entirely (not recommended for production use).
434
- </details>
435
-
436
- <details>
437
- <summary>💬 One-shot clarification mode</summary>
438
362
 
363
+ **Disable guard (not recommended):**
439
364
  ```json
440
- {
441
- "EVAL_MODE": 2
442
- }
365
+ { "guard_enabled": false }
443
366
  ```
444
- Ask all clarification questions at once (max 2 rounds) instead of progressive mode (1 question per round, max 4).
367
+
445
368
  </details>
446
369
 
447
- ## How It Works
370
+ ## ⚙️ How It Works
448
371
 
449
- **In short:** HelloAGENTS automatically selects processing depth based on task complexity simple questions get fast responses, complex tasks go through the full evaluate→design→develop flow, with safety checks and memory retention throughout.
372
+ **Short version:** HelloAGENTS selects execution depth based on task complexity. Simple tasks run directly; complex tasks use the full 5-stage flow with verification at every step. Once the requirement and execution direction are clear, it prefers direct completion over repeated confirmation.
450
373
 
451
- **Detailed flow:**
374
+ **The 5-stage flow:**
452
375
 
453
- 1. **Install & Deploy** — Run `helloagents` to select target CLI, auto-deploys config files and hooks
454
- 2. **Smart Routing** — Every input is auto-scored; simple queries get direct answers, complex tasks enter structured workflow
455
- 3. **Stage Progression** — Complex tasks advance through "Evaluate Design Develop" stages, each with clear deliverables
456
- 4. **Auto Orchestration** — System dispatches sub-agents and specialized roles based on complexity, parallelizes when possible
457
- 5. **Safety Guard** — Each step scans for destructive operations, risky actions require user confirmation
458
- 6. **Memory Retention** — User preferences, project knowledge, session context persist across sessions
459
- 7. **Verified Completion** — Stage chain completes with verified output, auto-syncs knowledge base
376
+ 1. **ORIENT** — Read project context (`.helloagents/context.md`, `guidelines.md`, `DESIGN.md`), scan relevant code
377
+ 2. **CLARIFY** — Eliminate ambiguity. Simple tasks skip this. Complex tasks confirm key decisions
378
+ 3. **PLAN** — Mark which quality skills are needed, generate design/plan if using `~design` or `~prd`
379
+ 4. **EXECUTE** — Implement with TDD (test code refactor), verify after each step
380
+ 5. **VALIDATE** — Run Ralph Loop (lint/test/build), collect delivery checklists from all activated skills, verify each item
460
381
 
461
- ## In-Chat Workflow Commands
382
+ **Routing rules:**
383
+ - Simple tasks (single file, clear fix) → Direct execution
384
+ - Complex tasks (3+ files, architecture change, new project) → Full 5-stage flow via `~design` or `~auto`
462
385
 
463
- These commands run inside AI chat, not your system shell.
386
+ **Quality skills auto-activate based on task type:**
387
+ - Writing UI code? → `hello-ui` activates (design tokens, accessibility, responsive)
388
+ - Touching API endpoints? → `hello-api` activates (REST conventions, validation, error format)
389
+ - Any code change? → `hello-test`, `hello-verify`, `hello-review` activate
464
390
 
465
- **Common Commands:**
391
+ ### Standby vs Global Mode
466
392
 
467
- | Command | Purpose |
468
- |---|---|
469
- | ~auto | full autonomous workflow |
470
- | ~plan | planning and package generation |
471
- | ~exec | execute existing package |
472
- | ~init | initialize knowledge base |
473
- | ~commit | generate commit message from context |
474
- | ~status / ~help | status and help |
393
+ HelloAGENTS supports two installation modes with different installation methods:
475
394
 
476
- **Quality Checks:**
395
+ | Mode | Install Method | Rules | Skills | Best For |
396
+ |------|---------------|-------|--------|----------|
397
+ | **Standby** (default) | `helloagents install <target> --standby` or `helloagents install --all --standby` | `bootstrap-lite.md` (lite rules) | `~command` on demand, `~init` for full activation | Selective use, keeping other projects unaffected |
398
+ | **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 |
477
399
 
478
- | Command | Purpose |
479
- |---|---|
480
- | ~test | run project tests |
481
- | ~review | code review |
482
- | ~validatekb | validate knowledge base |
400
+ Standby mode injects rules into `~/.claude/CLAUDE.md`, `~/.gemini/GEMINI.md`, and `~/.codex/AGENTS.md`; Codex then loads that local merged file via `model_instructions_file` in `~/.codex/config.toml`. 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 rules file plus a static runtime-context block 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`) without plugin hooks.
483
401
 
484
- **Advanced Features:**
402
+ Bulk switch via CLI: `helloagents --global` or `helloagents --standby`
485
403
 
486
- | Command | Purpose |
487
- |---|---|
488
- | ~upgradekb | upgrade knowledge structure |
489
- | ~clean / ~cleanplan | cleanup workflow artifacts |
490
- | ~rollback | rollback workflow state |
491
- | ~rlm | role orchestration (spawn / agents / resume / team) |
404
+ Re-running the same mode command is also valid. It refreshes the current mode's injected/copied files after branch switches, local development changes, or manual cleanup.
492
405
 
493
- ## Usage Guide
406
+ ## 📚 Usage Guide
494
407
 
495
408
  ### Three Workflow Modes
496
409
 
497
410
  | Mode | Description | When to use |
498
411
  |------|-------------|-------------|
499
- | `~auto` | Full autonomous flow from requirement to verified implementation (Evaluate DesignDevelopVerify) | Clear requirement, want end-to-end delivery |
500
- | `~plan` | Planning only, generates a proposal package then stops — no code written | Want to review the plan before committing |
501
- | `~exec` | Skip evaluation and design, execute an existing plan package directly | After `~plan` review, ready to implement |
502
-
503
- Typical pattern: `~plan` first → review → `~exec` to implement. Or just `~auto` for one-shot delivery.
504
-
505
- ### Interactive vs Delegated Mode
506
-
507
- When `~auto` or `~plan` presents its confirmation, you choose:
508
-
509
- - **Interactive (default):** pauses at key decision points (plan selection, failure handling)
510
- - **Delegated (fully automatic):** auto-advances all stages, auto-selects recommended options, only pauses on EHRB risk
511
- - **Plan-only delegated:** fully automatic but stops after design, never enters development
512
-
513
- Without `~` commands, plain-text input is automatically routed to R0–R2 based on complexity.
514
-
515
- ### Requirement Evaluation
516
-
517
- Before R2 tasks enter execution, the system scores requirements on four dimensions (scope 0–3, deliverable spec 0–3, implementation conditions 0–2, acceptance criteria 0–2). The pass condition is based on core dimension sufficiency (scope ≥ 3, implementation conditions ≥ 1, deliverable spec ≥ 1) rather than a fixed total score threshold. Dimensions below the sufficiency line trigger clarifying questions:
518
-
519
- - `EVAL_MODE=1` (default, progressive): asks 1 insufficient dimension per round, up to 4 rounds
520
- - `EVAL_MODE=2` (one-shot): asks all insufficient dimensions at once, up to 2 rounds
521
-
522
- The last round of questioning is combined with confirmation (question + execution mode selection), reducing standalone confirmation steps. Context inferred from the existing codebase counts toward the score automatically. Say "skip evaluation / just do it" to bypass the questioning phase.
523
-
524
- ### Parallel Design Proposals
525
-
526
- In the R2 standard path, the design stage dispatches 3–6 sub-agents to independently generate competing implementation proposals. The main agent evaluates all proposals across four dimensions: user value, solution soundness, risk (including EHRB), and implementation cost. Weights are dynamically adjusted based on project characteristics (e.g., performance-critical systems weight soundness higher; MVPs weight cost higher).
412
+ | `~auto` | Full autonomous flow: evaluatedesigndevelopverify | Clear requirement, want end-to-end delivery |
413
+ | `~design` | Interactive design only, generates plan package | Want to review the plan before coding |
414
+ | `~prd` | 13-dimension PRD generation | Need comprehensive product requirements |
527
415
 
528
- - Interactive mode: user selects a proposal or requests re-generation (max 1 retry)
529
- - Delegated mode: recommended proposal is auto-selected
530
- - R2 standard path: complex tasks go through multi-proposal comparison; simple tasks skip it and go directly to planning
416
+ Typical pattern: `~design` first review plan start coding. Or just `~auto` for one-shot delivery.
531
417
 
532
- ### Auto Dependency Management
418
+ ### Quality Verification (Ralph Loop)
533
419
 
534
- During development, the system auto-detects the project's package manager via lockfiles (`yarn.lock` → yarn, `uv.lock` → uv, `Gemfile.lock` → bundler, etc.) and handles dependencies:
420
+ After every task, Ralph Loop auto-runs your project's verification commands:
421
+ - Priority: `.helloagents/verify.yaml` → `package.json` scripts → auto-detected
422
+ - All pass? → Collect skill checklists → Verify → Done
423
+ - Any fail? → Reflect → Fix → Re-run (circuit breaker after 3 failures)
535
424
 
536
- - Declared but missing dependencies: auto-installed
537
- - New dependencies required by tasks: auto-added with declaration file updated
538
- - Ambiguous dependencies: user is asked before installing
425
+ ### Knowledge Base (`.helloagents/`)
539
426
 
540
- ### Quality Verification (Ralph Loop & Break-loop)
427
+ `~init` creates a project-local knowledge base. `STATE.md` is a project-level recovery snapshot, not a universal memory file for every interaction.
541
428
 
542
- **Ralph Loop** (Claude Code, via SubagentStop Hook): after a sub-agent completes code changes, the project's verification command runs automatically. On failure, the sub-agent is blocked from exiting and must fix the issue (max 1 retry loop). Verification command priority: `.helloagents/verify.yaml` → `package.json` scripts → auto-detected.
429
+ It is created and continuously updated for long-running project workflows such as `~init`, `~design`, `~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`.
543
430
 
544
- **Break-loop** (deep root cause analysis): triggered when a task fails repeatedly (after Ralph Loop + at least 1 manual fix attempt), performing five-dimension root cause analysis:
431
+ | File | Purpose |
432
+ |------|---------|
433
+ | `STATE.md` | Project-level recovery snapshot (≤50 lines, survives compression) |
434
+ | `DESIGN.md` | Design system (UI projects only) |
435
+ | `context.md` | Project architecture, tech stack, conventions |
436
+ | `guidelines.md` | Non-obvious coding rules |
437
+ | `verify.yaml` | Verification commands |
438
+ | `CHANGELOG.md` | Change history |
439
+ | `modules/*.md` | Module documentation + experience |
440
+ | `plans/` | Active plan packages |
441
+ | `archive/` | Completed plan packages |
545
442
 
546
- 1. Root cause classification (logic error / type mismatch / missing dependency / environment / design flaw)
547
- 2. Why previous fixes didn't work
548
- 3. Prevention mechanism suggestions
549
- 4. Systemic scan — same issue in other modules?
550
- 5. Lessons learned recorded in the acceptance report
443
+ ### Smart Commit (`~commit`)
551
444
 
552
- ### Smart Commit (~commit)
445
+ - Analyzes `git diff` to generate Conventional Commits messages
446
+ - Pre-commit quality checks (code-doc consistency, test coverage)
447
+ - Auto-excludes sensitive files (`.env`, `*.pem`, `*.key`)
448
+ - Respects `commit_attribution` config
449
+ - Syncs KB per `kb_create_mode` setting
553
450
 
554
- `~commit` does more than generate a message:
451
+ ### Autonomous Iteration (`~loop`)
555
452
 
556
- - Analyzes `git diff` to auto-generate Conventional Commits formatted messages
557
- - Pre-commit quality checks (code-doc consistency, test coverage, verification commands)
558
- - Auto-excludes sensitive files (`.env`, `*.pem`, `*.key`, etc.) — never runs `git add .`
559
- - Shows file list before staging, supports exclusion
560
- - Options: local commit only / commit + push / commit + push + create PR
561
- - Bilingual commit messages when `BILINGUAL_COMMIT=1`
453
+ Set a target and metric, then let AI iterate:
454
+ 1. Review Ideate Modify Commit Verify → Decide → Log → Repeat
455
+ 2. Results tracked in `.helloagents/loop-results.tsv`
456
+ 3. Uses `git revert` for clean rollback on failed experiments
562
457
 
563
- ### Manual Sub-Agent Invocation
458
+ ## 🧪 Verification
564
459
 
565
- Beyond automatic dispatch, you can manually invoke specific roles:
460
+ HelloAGENTS ships with Node's built-in test runner:
566
461
 
567
- ~rlm spawn reviewer "review src/api/ for security issues"
568
- ~rlm spawn writer "generate API reference docs"
569
- ~rlm spawn reviewer,writer "analyze and document the auth module" # parallel
570
-
571
- Available roles: `reviewer` (code review), `writer` (documentation), `brainstormer` (multi-proposal comparison).
572
-
573
- ### Multi-Terminal Collaboration
574
-
575
- Multiple terminals (across different CLIs) can share a task list:
576
-
577
- # Terminal A
578
- hellotasks=my-project codex
579
-
580
- # Terminal B
581
- hellotasks=my-project claude
582
-
583
- Commands once enabled:
584
-
585
- ~rlm tasks # view shared task list
586
- ~rlm tasks available # see unclaimed tasks
587
- ~rlm tasks claim <id> # claim a task
588
- ~rlm tasks complete <id> # mark done
589
- ~rlm tasks add "task title" # add a new task
590
-
591
- Tasks are stored in `{KB_ROOT}/tasks/` with file locking to prevent concurrent conflicts.
592
-
593
- ### KB Auto-Sync & CHANGELOG
594
-
595
- The knowledge base syncs automatically at these points:
596
-
597
- - After every development stage, main agent syncs module docs to reflect actual code
598
- - After every R1/R2 task completion, CHANGELOG is auto-appended
599
- - On session end (Claude Code Stop Hook), KB sync flag set asynchronously
600
-
601
- CHANGELOG uses semantic versioning (X.Y.Z). Version source priority: user-specified → project file (package.json, pyproject.toml, etc., supporting 15+ languages/frameworks) → git tag → last CHANGELOG entry → 0.1.0. R1 fast-path changes are recorded under a "Quick Modifications" category with file:line range.
602
-
603
- `KB_CREATE_MODE` controls automatic behavior: `0`=off, `1`=prompt on demand, `2`=auto on code changes (default), `3`=always auto.
462
+ ```bash
463
+ npm test
464
+ ```
604
465
 
605
- ### Worktree Isolation
466
+ The test suite validates:
467
+ - standby/global install, reinstall, refresh, uninstall, and cross-mode switching
468
+ - Claude/Gemini/Codex config file merge, restore, and cleanup behavior
469
+ - Codex local-plugin refresh after local branch or file changes
470
+ - runtime inject/route/guard/Ralph Loop chains
471
+ - cleanup when Codex global artifacts exist but `~/.codex/` is already gone
606
472
 
607
- When multiple sub-agents need to modify different regions of the same file simultaneously (Claude Code only), the system automatically uses `Task(isolation="worktree")` to create an independent git worktree for each sub-agent, preventing Edit tool conflicts. The main agent merges all worktree changes in the consolidation phase. Only activated when sub-agents have overlapping file writes; read-only tasks don't use it.
473
+ ## FAQ
608
474
 
609
- ### CSV Batch Orchestration (Codex CLI)
475
+ <details>
476
+ <summary><strong>Q: Is this a CLI tool or a prompt framework?</strong></summary>
610
477
 
611
- When ≥6 structurally identical tasks exist in the same execution layer, the system auto-converts `tasks.md` into a task CSV and dispatches via `spawn_agents_on_csv`. Each worker receives its row data + instruction template, executes independently, and reports results.
478
+ **A:** Both. The CLI (`cli.mjs`) handles installation, mode switching, and CLI configuration. The actual workflow comes from `bootstrap.md` / `bootstrap-lite.md` rules, quality skills, and host-appropriate runtime helpers. On Claude/Gemini that includes hook scripts such as `notify.mjs`, `guard.mjs`, and `ralph-loop.mjs`; on Codex the default path is rules-file driven to keep TUI output quiet. Think of it as a delivery system + intelligent quality protocol.
479
+ </details>
612
480
 
613
- - Progress tracked in real-time via `agent_job_progress` events (pending/running/completed/failed/ETA)
614
- - State persisted in SQLite for crash recovery
615
- - Partial failures still export results with failure summary
616
- - Heterogeneous tasks automatically fall back to `spawn_agent` sequential dispatch
617
- - Configure concurrency via `CSV_BATCH_MAX` (default 16, max 64, set to 0 to disable)
481
+ <details>
482
+ <summary><strong>Q: What changed from v2.x to v3.x?</strong></summary>
483
+
484
+ **A:** Everything. The v3 line is a complete rewrite:
485
+ - Python package pure Node.js/Markdown architecture
486
+ - 15 commands → 11 commands + 14 auto-activated quality skills
487
+ - 6 CLI targets → 3 (Claude Code + Codex CLI + Gemini CLI)
488
+ - New: checklist gate control, guard system, ~prd, ~loop, ~verify, design system generation
489
+ - See [Version History](#-version-history) for full details.
490
+ </details>
618
491
 
619
- ### Update Check
492
+ <details>
493
+ <summary><strong>Q: Which CLI should I use?</strong></summary>
620
494
 
621
- On the first response of each session, the system silently checks for new versions. Results are cached at `~/.helloagents/.update_cache`, valid for the duration set by `UPDATE_CHECK` (default 72 hours, set to 0 to disable). When a new version is available, `⬆️ New version {version} available` appears in the response footer. Any errors during the check are silently skipped and never interrupt normal usage.
495
+ **A:** Claude Code gets the best experience (plugin system, 11 lifecycle hooks, Agent Teams support). Gemini CLI works via extension system. Codex CLI works well too. Install the package first, then deploy explicitly to the CLI you want with `helloagents install <target> --standby` or `helloagents install --all --standby`.
496
+ </details>
622
497
 
623
- ## Repository Guide
498
+ <details>
499
+ <summary><strong>Q: What are the 14 quality skills?</strong></summary>
500
+
501
+ **A:** They auto-activate based on task type:
502
+ - **hello-ui**: UI construction (design tokens, accessibility, responsive, animation)
503
+ - **hello-api**: API design (REST, validation, error format, rate limiting)
504
+ - **hello-security**: Security (auth, input validation, XSS/CSRF, secrets management)
505
+ - **hello-test**: Testing (TDD workflow, boundary cases, AAA pattern)
506
+ - **hello-verify**: Verification gate (Ralph Loop, circuit breaker)
507
+ - **hello-errors**: Error handling (structured errors, logging, recovery)
508
+ - **hello-perf**: Performance (N+1, caching, code splitting, virtual scroll)
509
+ - **hello-data**: Database (migrations, transactions, indexes, integrity)
510
+ - **hello-arch**: Architecture (SOLID, boundaries, code volume limits)
511
+ - **hello-debug**: Debugging (4-stage process, escalation on stuck)
512
+ - **hello-subagent**: Subagent orchestration (dispatch, coordination, review)
513
+ - **hello-review**: Code review (logic, security, performance, maintainability)
514
+ - **hello-write**: Documentation (pyramid principle, audience-aware)
515
+ - **hello-reflect**: Experience capture (lessons learned → KB)
516
+
517
+ Subagents may skip workflow packaging such as routing, interaction flow, and output formatting, but they still follow core rules such as coding principles, safety constraints, and failure handling.
518
+ </details>
624
519
 
625
- - AGENTS.md: router and workflow protocol
626
- - SKILL.md: skill discovery metadata for CLI targets
627
- - pyproject.toml: package metadata (v2.3.8)
628
- - helloagents/cli.py: CLI entry point
629
- - helloagents/_common.py: shared constants and utilities
630
- - helloagents/core/: CLI management modules (install, uninstall, update, status, dispatcher, hooks settings)
631
- - helloagents/functions: command definitions (15)
632
- - helloagents/stages: design, develop
633
- - helloagents/services: knowledge, package, memory and support services
634
- - helloagents/rules: state, cache, tools, scaling, sub-agent protocols
635
- - helloagents/rlm: role library and orchestration helpers
636
- - helloagents/hooks: Claude Code, Codex CLI, Gemini CLI, and Grok CLI hooks configs
637
- - helloagents/scripts: automation scripts (sound notify, progress snapshot, safety guard, etc.)
638
- - helloagents/agents: sub-agent definitions (3 RLM roles)
639
- - helloagents/assets: sound resources (5 event sounds)
640
- - helloagents/templates: KB and plan templates
520
+ <details>
521
+ <summary><strong>Q: What is standby vs global mode?</strong></summary>
641
522
 
642
- ## FAQ
523
+ **A:** Standby mode (default) deploys lite rules to the targets you choose, typically with `helloagents install <target> --standby` or `helloagents install --all --standby`. Projects need `~init` to activate full features. Global mode uses each CLI's native plugin/extension system for full rules everywhere; deploy it with `helloagents install <target> --global`, `helloagents install --all --global`, or bulk-switch with `helloagents --global`.
524
+ </details>
643
525
 
644
- **Q: Is this a Python CLI tool or prompt package?**
526
+ <details>
527
+ <summary><strong>Q: Where does project knowledge go?</strong></summary>
645
528
 
646
- A: Both. The CLI manages installation and updates, while the workflow behavior comes from AGENTS.md and documentation files. Think of it as a delivery system + intelligent workflow protocol.
529
+ **A:** In the project-local `.helloagents/` directory. Created by `~init`, auto-synced on code changes (controlled by `kb_create_mode`). `STATE.md` is used as a concise recovery snapshot for long-running workflows, not as a catch-all memory file for every interaction.
530
+ </details>
647
531
 
648
- **Q: Which target should I install?**
532
+ <details>
533
+ <summary><strong>Q: What is the Guard system?</strong></summary>
649
534
 
650
- A: Choose the CLI you're actively using: `codex` (Codex CLI), `claude` (Claude Code), `gemini` (Gemini CLI), `qwen` (Qwen CLI), `grok` (Grok CLI), or `opencode` (OpenCode). You can install to multiple targets with `helloagents install --all`. See [CLI Compatibility Quick Reference](#cli-compatibility-quick-reference) for details.
535
+ **A:** Two-layer safety:
536
+ - **L1 Blocking**: Stops destructive commands before execution (`rm -rf /`, `git push --force`, `DROP DATABASE`, `chmod 777`, `FLUSHALL`)
537
+ - **L2 Advisory**: Scans file writes for hardcoded secrets, API keys, .env exposure — warns but doesn't block
538
+ </details>
651
539
 
652
- **Q: What if a rules file already exists?**
540
+ <details>
541
+ <summary><strong>Q: What does the bottom next-step bar mean when formatted output is enabled?</strong></summary>
653
542
 
654
- A: HelloAGENTS automatically backs up non-HelloAGENTS files before replacement. Backups are timestamped and stored in your CLI's config directory. You can restore them anytime if needed.
543
+ **A:** It always shows the most appropriate next action. If a natural follow-up exists, HelloAGENTS states it directly. If the current task is fully complete with no meaningful follow-up, it falls back to a completion/waiting status instead of empty filler.
544
+ </details>
655
545
 
656
- **Q: What is RLM?**
546
+ <details>
547
+ <summary><strong>Q: Can I disable features I don't need?</strong></summary>
657
548
 
658
- A: Role Language Model HelloAGENTS's sub-agent orchestration system. It includes 3 specialized roles (reviewer, writer, brainstormer) plus native CLI sub-agents. Tasks are scheduled via DAG dependency analysis with parallel execution when possible. Learn more in [Usage Guide](#usage-guide).
549
+ **A:** Yes. Set `guard_enabled: false` to disable the guard, `ralph_loop_enabled: false` to skip verification, `kb_create_mode: 0` to disable KB. Quality skills auto-activate but don't add overhead for unrelated tasks.
550
+ </details>
659
551
 
660
- **Q: Where does project knowledge go?**
552
+ <details>
553
+ <summary><strong>Q: What is ~prd?</strong></summary>
661
554
 
662
- A: In the project-local `.helloagents/` directory. The knowledge base auto-syncs when code changes (controlled by `KB_CREATE_MODE` config). It includes module docs and CHANGELOG. See [KB Auto-Sync & CHANGELOG](#kb-auto-sync--changelog).
555
+ **A:** A 13-dimension PRD generator. It walks through product overview, user stories, functional requirements, UI/UX design, technical architecture, non-functional requirements, i18n, accessibility, content strategy, testing, deployment, legal/privacy, and timeline brainstorm-style, one dimension at a time.
556
+ </details>
663
557
 
664
- **Q: Does knowledge persist across sessions?**
558
+ ## 🛠️ Troubleshooting
665
559
 
666
- A: Yes. The project knowledge base is stored in the project-local `.helloagents/` directory. Context survives even if you close and reopen your CLI.
560
+ ### Plugin not loading (Claude Code)
667
561
 
668
- **Q: What are Hooks?**
562
+ **Problem:** `~help` not recognized after plugin installation
669
563
 
670
- A: Lifecycle hooks auto-deployed during installation. Claude Code gets 11 event hooks (safety checks, dangerous command guard, progress snapshots, KB sync, sound notifications, tool failure recovery, etc.); Codex CLI gets a notify hook for update and sound notifications; Gemini CLI gets 6 hooks (context injection, progress snapshots, sound notifications, pre-compression snapshots); Grok CLI gets 3 hooks (context injection, safety guard, progress snapshots). All optional — features degrade gracefully when hooks aren't available. No manual configuration needed.
564
+ **Solution:** Restart Claude Code. If still not working, check `/plugin list` to verify installation.
671
565
 
672
- **Q: What is Agent Teams?**
566
+ ---
673
567
 
674
- A: An experimental Claude Code feature where multiple Claude Code instances collaborate as teammates with shared task lists and mailbox communication. Enable with `CLAUDE_CODE_EXPERIMENTAL_AGENT_TEAMS=1`. When unavailable, HelloAGENTS falls back to standard Task sub-agents. See [Multi-Terminal Collaboration](#multi-terminal-collaboration).
568
+ ### Extension not working (Gemini CLI)
675
569
 
676
- ## Troubleshooting
570
+ **Problem:** `~help` not recognized after `gemini extensions install`
677
571
 
678
- ### Command not found
572
+ **Solution:** Restart Gemini CLI. Verify with `gemini extensions list`. Make sure the extension is enabled.
679
573
 
680
- **Problem:** `helloagents: command not found` after installation
574
+ ---
681
575
 
682
- **Diagnosis:** Install path not in system PATH
576
+ ### File writes blocked outside workspace
683
577
 
684
- **Solution:**
685
- - UV: Restart terminal after UV installation
686
- - pip: Check `pip show helloagents` for install location, add to PATH
687
- - Verify with `which helloagents` (Unix) or `where helloagents` (Windows)
578
+ **Problem:** Gemini CLI or Codex CLI reports that a file path is outside the allowed workspace.
688
579
 
689
- **Verification:** Run `helloagents version`
580
+ **Solution:** Write files inside the current project workspace, or inside the CLI's temporary workspace directory. In headless verification, prefer paths under the current repo instead of arbitrary absolute paths.
690
581
 
691
582
  ---
692
583
 
693
- ### Package version unknown
694
-
695
- **Problem:** Version shows as "unknown"
584
+ ### Commands not found
696
585
 
697
- **Diagnosis:** Package metadata not available
586
+ **Problem:** `~help` not recognized after installation
698
587
 
699
- **Solution:** Install the package first: `pip install git+https://github.com/hellowind777/helloagents.git` or use UV/npx methods
700
-
701
- **Verification:** Run `helloagents version` should show current version number
588
+ **Solution:**
589
+ - Verify installation: `npm list -g helloagents`
590
+ - Claude Code: check `~/.claude/CLAUDE.md` contains HelloAGENTS markers
591
+ - Gemini CLI: check `~/.gemini/GEMINI.md` contains HelloAGENTS markers
592
+ - Codex CLI: check `~/.codex/config.toml` has `model_instructions_file` pointing to `~/.codex/AGENTS.md` in standby mode, or to plugin `AGENTS.md` in global mode
593
+ - Restart your CLI
702
594
 
703
595
  ---
704
596
 
705
- ### Target not detected
706
-
707
- **Problem:** CLI target not found during installation
597
+ ### Local branch switched but Codex global plugin still uses old files
708
598
 
709
- **Diagnosis:** Config directory doesn't exist yet
599
+ **Problem:** You changed branches or updated a linked local checkout, but Codex global mode is still running older copied files.
710
600
 
711
- **Solution:** Launch the target CLI at least once to create its config directory, then retry `helloagents install <target>`
712
-
713
- **Verification:** Check config paths:
714
- - Codex CLI: `~/.codex/`
715
- - Claude Code: `~/.claude/`
716
- - Others: see CLI documentation
601
+ **Solution:** Re-run the current mode command:
602
+ - `helloagents --global` → refreshes `~/plugins/helloagents/` and the Codex cache copy
603
+ - `helloagents --standby` → refreshes injected files and symlinks for standby mode
717
604
 
718
605
  ---
719
606
 
720
- ### Custom rules overwritten
721
-
722
- **Problem:** Custom rules replaced by HelloAGENTS
607
+ ### Guard blocking legitimate commands
723
608
 
724
- **Diagnosis:** Installation replaces existing files
609
+ **Problem:** Guard blocks a command you actually want to run
725
610
 
726
- **Solution:** Restore from timestamped backup in CLI config directory (e.g., `~/.codex/AGENTS_20260304132146_bak.md`)
727
-
728
- **Verification:** Check backup files in config directory
611
+ **Solution:** Set `guard_enabled: false` in `~/.helloagents/helloagents.json`. Or review the blocked command — the guard only blocks truly destructive operations like `rm -rf /` and `git push --force`.
729
612
 
730
613
  ---
731
614
 
732
- ### Images not rendering
733
-
734
- **Problem:** README images don't display
615
+ ### Ralph Loop keeps failing
735
616
 
736
- **Diagnosis:** Missing image files or incorrect paths
617
+ **Problem:** Verification loop won't pass
737
618
 
738
619
  **Solution:**
739
- - Keep relative paths in README (e.g., `./readme_images/`)
740
- - Ensure `readme_images/` folder is committed to repository
741
- - Verify image files exist locally
742
-
743
- **Verification:** Check `ls readme_images/` shows all referenced images
620
+ - Check `.helloagents/verify.yaml` for correct commands
621
+ - Run the verification commands manually to see actual errors
622
+ - Circuit breaker activates after 3 consecutive failures — `hello-debug` escalation kicks in
744
623
 
745
624
  ---
746
625
 
747
626
  ### CCswitch replaces HelloAGENTS config
748
627
 
749
- **Problem:** After switching CCswitch profiles, HelloAGENTS stops working (workflow commands unrecognized, hooks not firing, rules missing)
628
+ **Problem:** After switching CCswitch profiles, HelloAGENTS stops working
750
629
 
751
- **Diagnosis:** CCswitch replaces the entire CLI config directory (e.g., `~/.claude/`) when switching profiles, overwriting HelloAGENTS's hooks, permissions, and rule files
630
+ **Solution:** Re-run `/plugin marketplace add hellowind777/helloagents` after switching profiles. CCswitch replaces the entire CLI config directory.
752
631
 
753
- **Solution:** After switching CCswitch profiles, run one of these commands to restore HelloAGENTS:
754
-
755
- helloagents install claude # reinstall to specific CLI target
756
- helloagents update # update + auto-sync all installed targets
632
+ ---
757
633
 
758
- **Prevention:** Since v2.3.5, automatic configuration integrity check on session start — if HelloAGENTS config is missing or corrupted, a warning is displayed with recovery instructions
634
+ ### Notifications not working
759
635
 
760
- **Verification:** Run `helloagents status` to confirm all targets show as installed
636
+ **Problem:** No sound or desktop notifications
761
637
 
762
- ---
763
-
764
- ### CCswitch configuration conflict
638
+ **Solution:**
639
+ - Check `notify_level` in config (0=off by default)
640
+ - Windows: Ensure PowerShell can access `System.Media.SoundPlayer`
641
+ - macOS: Ensure `afplay` is available
642
+ - Linux: Ensure `aplay` or `paplay` is installed
765
643
 
766
- **Problem:** HelloAGENTS config reappears after uninstall when switching CCswitch profiles
644
+ ## 📈 Version History
767
645
 
768
- **Diagnosis:** CCswitch saved HelloAGENTS settings before uninstall
646
+ ### v3.0.1 (current)
769
647
 
770
- **Solution:** After uninstalling HelloAGENTS, manually clean up HelloAGENTS-related settings (hooks, permissions, rules) from all saved CCswitch profiles
648
+ **Fixes and verification:**
649
+ - 🔧 `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
650
+ - 🔧 Codex cleanup now removes empty `~/.agents/plugins/marketplace.json` residue and ignores contaminated legacy `developer_instructions` backups during config restore
651
+ - 🔧 Scoped `update` continues to reuse the detected host mode even when tracked config is stale, matching the intended `helloagents update <cli>` behavior
652
+ - 🔧 Standby branch/bootstrap refresh semantics are now documented precisely: symlinked package files update immediately, while injected carrier files refresh on `install` / `update` / mode-refresh commands
653
+ - 🧪 Added lifecycle coverage for standby carrier refresh, stale-mode inference, empty Codex marketplace cleanup, contaminated Codex backup recovery, and version-agnostic npm pack testing
771
654
 
772
- **Verification:** Check CCswitch profile directories for HelloAGENTS remnants
655
+ ### v3.0.0 🎉
773
656
 
774
- ## Version History
657
+ **Breaking Changes:**
658
+ - 🔴 Complete rewrite: Python package → pure Node.js/Markdown architecture. `pip`/`uv` installation no longer available
659
+ - 🔴 Commands renamed/removed: `~plan` → `~design`, removed `~exec`/`~rollback`/`~rlm`/`~status`/`~validatekb`/`~upgradekb`/`~cleanplan`
660
+ - 🔴 Configuration keys changed from uppercase to lowercase. Removed: `BILINGUAL_COMMIT`, `EVAL_MODE`, `UPDATE_CHECK`, `CSV_BATCH_MAX`
775
661
 
776
- ### v2.3.8 (current)
662
+ **New Features:**
663
+ - ✨ 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
664
+ - ✨ 3 supported CLIs: Claude Code (plugin/marketplace), Gemini CLI (extension), Codex CLI (npm)
665
+ - ✨ Checklist gate control: all activated skills must pass delivery checklist before task completion
666
+ - ✨ `~prd` command: 13-dimension brainstorm-style PRD framework
667
+ - ✨ `~loop` command: autonomous iteration optimization with metric tracking and git-based rollback
668
+ - ✨ `~verify` command: auto-detect and run all verification commands
669
+ - ✨ Guard system (`guard.mjs`): L1 blocking for destructive commands + L2 advisory for security patterns
670
+ - ✨ Standby/Global mode: `install_mode` config for per-project or global activation
671
+ - ✨ Flow state management (`STATE.md`): AI context compression snapshot (≤50 lines)
672
+ - ✨ Design system generation (`DESIGN.md`): auto-created for UI projects
673
+ - ✨ Plan package system: `requirements.md` + `design.md` + `tasks.md`
674
+
675
+ **Architecture:**
676
+ - 📦 Unified 5-stage execution flow: ORIENT → CLARIFY → PLAN → EXECUTE → VALIDATE
677
+ - 📦 Simplified configuration: 8 lowercase keys with sensible defaults
678
+ - 📦 Dual-mode installation: standby (explicit non-plugin deploy) / global (plugin/extension)
679
+ - 📦 Modular script architecture: `cli-utils.mjs` (shared utilities), `notify-ui.mjs` (cross-platform sound/desktop), `guard.mjs` (security), `ralph-loop.mjs` (verification)
680
+ - 📦 Cross-platform hook compatibility: dynamic event name resolution (Claude Code / Gemini CLI / Codex CLI) via environment variables or CLI argument inference
681
+ - 📦 Standby mode routing isolation: new project detection only triggers in global mode or activated projects, keeping unactivated projects undisturbed
682
+ - 📦 Notification system with cross-platform sound + desktop support (Windows toast, macOS osascript, Linux notify-send)
683
+
684
+ ### v2.3.8
777
685
 
778
686
  **Architecture Changes:**
779
- - Routing tier consolidation: removed R2 simplified flow and R3 standard flow, unified to R0/R1/R2 three-tier routing. New R2 standard flow merges use cases from both old R2 and R3
780
- - Evaluation now driven by dimension sufficiency (scope ≥ 3, implementation conditions ≥ 1, deliverable spec ≥ 1), replacing fixed total score threshold (previously "score ≥ 8")
781
- - Last-round question+confirmation combined: clarifying question + execution mode selection in the same turn, reducing standalone confirmation steps
782
- - DESIGN multi-proposal comparison now triggered by TASK_COMPLEXITY (complex → multi-proposal, simple/moderate → skip), replacing route-level triggering
783
- - Removed L0 user memory system and custom command extension (`user/` directory): simplified to single-layer project knowledge model (L1 project KB only)
784
- - Config system consolidation: migrated from two-tier priority config (`config.json` at project + global level) to single `~/.helloagents/helloagents.json` with auto-sync on install
785
- - Added code size control rules: warning threshold (file/class 300 lines, function 40 lines), mandatory split threshold (file/class 400 lines, function 60 lines)
687
+ - Routing tier consolidation: removed R2 simplified flow and R3 standard flow, unified to R0/R1/R2 three-tier routing
688
+ - Evaluation driven by dimension sufficiency, replacing fixed total score threshold
689
+ - Last-round question+confirmation combined, reducing standalone confirmation steps
690
+ - Removed L0 user memory system and custom command extension
691
+ - Config system consolidation: single `~/.helloagents/helloagents.json`
692
+ - Added code size control rules: warning 300/40 lines, mandatory split 400/60 lines
786
693
 
787
694
  **New Features:**
788
- - Added 5 new workflow commands: `~test`, `~rollback`, `~validatekb`, `~upgradekb`, `~cleanplan`
789
- - Added notify_level config key (0=off, 1=desktop, 2=sound, 3=both) for notification behavior control
790
- - Added standalone config reader module (`scripts/_config.py`) for hook scripts
791
- - Brainstormer sub-agent output format enhanced: added `key_findings` field for proposal highlights
695
+ - 5 new workflow commands: `~test`, `~rollback`, `~validatekb`, `~upgradekb`, `~cleanplan`
696
+ - `notify_level` config key for notification behavior control
697
+ - Standalone config reader module for hook scripts
792
698
 
793
699
  **Security:**
794
- - Fixed path injection vulnerability in shared_tasks.py: `list_id` from environment variable now sanitized before use in file path construction
795
- - Fixed incomplete path traversal guard in validate_package.py: `relative_to()` failure now properly exits with error instead of falling through
796
-
797
- **Bug Fixes:**
798
- - Fixed Gemini/Grok hooks PostToolUse matcher missing NotebookEdit (now `Write|Edit|NotebookEdit`, consistent with Claude Code)
799
- - Fixed pre_compact.py still using deprecated LIVE_STATUS HTML comments while progress_snapshot.py had migrated to .status.json
800
- - Fixed pre_compact.py `_get_current_task` regex only matching numbered lists, now supports unordered lists
801
- - Fixed progress_snapshot.py docstring incorrectly stating Grok uses async=true (actual config is async=false)
802
- - Fixed dispatcher update check cache_ttl default from None to 72 hours
803
- - Fixed utils.py incorrectly treating Python package source directories as legacy KB directories during migration
804
- - Fixed cli.py error recovery passing args as branch name when dispatcher is broken
805
-
806
- **Improvements:**
807
- - Codex CLI feature flags updated: replaced `sqlite`+`collaboration_modes` with `enable_fanout` for CSV batch orchestration
808
- - Added Windows UTF-8 encoding block to codex_notify.py (all other hook scripts already had it)
809
- - Extended stop_sound_router.py UTF-8 encoding to cover stdout/stderr (previously only stdin)
810
- - Added NOTE comments across all intentionally duplicated functions for cross-file sync awareness
811
- - Added yearly changelog archive template (`CHANGELOG_{YYYY}.md`)
700
+ - Fixed path injection vulnerability in `shared_tasks.py`
701
+ - Fixed incomplete path traversal guard in `validate_package.py`
812
702
 
813
703
  ### v2.3.7
814
704
 
815
705
  **Bug Fixes:**
816
- - Fixed non-coding tasks incorrectly creating knowledge base when KB_CREATE_MODE=2 (added programming task check in design.md Phase1 step 1)
817
- - Fixed R2 standard flow redirecting to archive instead of DEVELOP after proposal selection (constrained overview type to ~exec entry only)
818
- - Fixed non-coding tasks incorrectly creating plan packages (added programming task precondition to package.md create() interface)
706
+ - Fixed non-coding tasks incorrectly creating KB when `KB_CREATE_MODE=2`
707
+ - Fixed R2 standard flow redirecting to archive instead of DEVELOP after proposal selection
708
+ - Fixed non-coding tasks incorrectly creating plan packages
819
709
 
820
710
  **Improvements:**
821
- - Optimized implementation plan state recovery after context compression
822
- - Optimized overall design flow
711
+ - 📦 Optimized implementation plan state recovery after context compression
712
+ - 📦 Optimized overall design flow
823
713
 
824
714
  ### v2.3.6
825
715
 
826
716
  **New Features:**
827
- - Sub-agent orchestration overhaul: added brainstormer sub-agent for independent parallel proposal ideation during DESIGN multi-proposal comparison
828
- - Sub-agent blocking mechanism: auto-block and fallback to main agent on sub-agent failure or timeout
717
+ - Sub-agent orchestration overhaul: brainstormer sub-agent for parallel proposal ideation
718
+ - Sub-agent blocking mechanism: auto-block and fallback on failure/timeout
829
719
 
830
720
  **Improvements:**
831
- - Tool/Shell constraint optimization: allow fallback to Shell when built-in tools fail (fixes Codex CLI Windows apply_patch repeated failures)
832
- - Shell encoding constraint refinement: explicit UTF-8 no-BOM requirement, separate read/write encoding handling for PowerShell
833
- - Added batch file write rule (merge ≥3 files into a single temp script to avoid sandbox per-command blocking)
834
- - Removed session memory features that couldn't be fully implemented in CLI (session_summary template, SessionEnd memory sync), streamlined service layer
835
- - Sub-agent consolidation: removed 3 redundant sub-agents (kb-keeper, pkg-keeper, synthesizer), functionality returned to main agent and RLM roles
836
- - Sub-agent voice notification skip, task stability fixes
837
- - Uninstall script enhancements
838
- - Visual verification gap and UI quality fixes
721
+ - 📦 Tool/Shell constraint optimization: allow fallback to Shell when built-in tools fail
722
+ - 📦 Shell encoding constraint refinement: explicit UTF-8 no-BOM requirement
723
+ - 📦 Removed 3 redundant sub-agents, functionality returned to main agent and RLM roles
839
724
 
840
725
  ### v2.3.5
841
726
 
842
727
  **New Features:**
843
- - Voice notification system with 5 event sounds (complete, idle, confirm, error, warning) across Windows/macOS/Linux, with smart two-layer routing (stop_reason + G3 format icon detection)
844
- - Claude Code hooks expanded from 9 to 11 lifecycle event types: added dangerous command guard (PreToolUse), session end cleanup (SessionEnd), and tool failure recovery suggestions (PostToolUseFailure)
845
- - Hooks support expanded to Gemini CLI (SessionStart, BeforeAgent/AfterAgent, PreCompress, PreToolUse, PostToolUse) and Grok CLI (UserPromptSubmit, PreToolUse, PostToolUse)
846
- - Codex CLI 0.110 features: `enable_fanout` for CSV batch orchestration, `nickname_candidates` for agent role identification
847
- - Configuration integrity check on session start (auto-detect config corruption or replacement by CCswitch etc.)
848
- - Context compression pre-save with automatic progress snapshot (pre_compact.py, progress_snapshot.py — actual implementations replacing placeholder hooks)
849
- - User-defined tool registration and orchestration — intelligent invocation of custom sub-agents, skills, MCP servers, and plugins
728
+ - Voice notification system with 5 event sounds across Windows/macOS/Linux
729
+ - Claude Code hooks expanded from 9 to 11 lifecycle event types
730
+ - Hooks support expanded to Gemini CLI and Grok CLI
731
+ - Configuration integrity check on session start
732
+ - Recovery snapshot injection before context compaction
733
+ - User-defined tool registration and orchestration
850
734
 
851
735
  **Improvements:**
852
- - Comprehensive audit fixes (21 issues: 6 HIGH + 9 MEDIUM + 6 LOW)
853
- - Code quality: extracted 5 shared utility functions, eliminated circular dependencies
854
- - Cross-platform: unified platform detection, consistent encoding handling
855
- - Security: configuration backup before overwrite, placeholder validation
856
- - Documentation: configuration rationale, compatibility verification notes
857
- - Core architecture: new dispatcher module, Codex roles definition, Claude rules management, hooks settings manager
858
- - Install/update script refactoring with persistent configuration
859
- - Voice notification accuracy and false positive reduction (Codex client filtering, Windows sync playback)
860
- - Sub-agent nickname optimization across CLIs
861
- - Codex CLI interactive menu, persistent memory, and context compression optimization
862
- - R2 flow and evaluation module re-integration
863
- - Context compression state persistence optimization
864
- - Tool/Shell usage optimization
865
- - CCswitch compatibility notes for configuration cleanup after uninstall
866
- - SKILL discovery entry optimization
867
-
868
- ### v2.3.4
869
-
870
- - Split 3 oversized files (>450 lines) into 6 independent modules
871
- - Consolidated 9 CLI management scripts into core/ subpackage
872
- - Extracted shared constants and utilities into dedicated module, eliminating circular dependencies
873
- - Removed redundant backward-compatible re-exports
874
- - Elevated Codex CLI routing protocol priority to prevent system prompt override
875
-
876
- ### v2.3.0
877
-
878
- - Comprehensive cross-audit fix: unified role output format, normalized path references, code-doc consistency alignment
879
- - Quality verification loop (Ralph Loop): auto-verify after sub-agent completion, block and feedback on failure
880
- - Auto context injection for sub-agents and rule reinforcement for main agent
881
- - Deep 5-dimension root cause analysis on repeated failures (break-loop)
882
- - Auto-inject project technical guidelines before sub-agent development
883
- - Pre-commit quality checks (code-doc consistency, test coverage, verification commands)
884
- - Worktree isolation for parallel editing
885
- - Auto-append Git author info to CHANGELOG entries
886
-
887
- ## Contributing
888
-
889
- See CONTRIBUTING.md for contribution rules and PR checklist.
890
-
891
- ## License
892
-
893
- This project is dual-licensed: Code under Apache-2.0, Documentation under CC BY 4.0. See [LICENSE.md](./LICENSE.md).
894
-
895
- ## Next Steps
896
-
897
- **Getting Started:**
898
- - Install HelloAGENTS using your preferred method: [Quick Start](#quick-start)
899
- - Try `~auto` with a simple task to see the full workflow in action
900
- - Explore `~plan` + `~exec` for more control over the process
901
-
902
- **Learn More:**
903
- - Read [Usage Guide](#usage-guide) for detailed workflow patterns
904
- - Check [Configuration](#configuration) to customize behavior
905
- - Review [In-Chat Workflow Commands](#in-chat-workflow-commands) reference
906
-
907
- **Community & Support:**
908
- - Star the repo if HelloAGENTS helps your workflow
909
- - Report issues or request features on [GitHub Issues](https://github.com/hellowind777/helloagents/issues)
910
- - Contribute improvements: see [CONTRIBUTING.md](./CONTRIBUTING.md)
736
+ - 📦 Comprehensive audit fixes (21 issues: 6 HIGH + 9 MEDIUM + 6 LOW)
737
+ - 📦 Core architecture: new dispatcher module, Codex roles, Claude rules management
738
+ - 📦 Install/update script refactoring with persistent configuration
739
+
740
+ ## 📜 License
741
+
742
+ This project is dual-licensed: Code under [Apache-2.0](./LICENSE.md), Documentation under CC BY 4.0.
743
+
744
+ See [LICENSE.md](./LICENSE.md) for full details.
745
+
746
+ ## 🤝 Contributing
747
+
748
+ - 🐛 **Bug reports**: [Create an issue](https://github.com/hellowind777/helloagents/issues)
749
+ - 💡 **Feature requests**: [Start a discussion](https://github.com/hellowind777/helloagents/issues)
750
+ - 📖 **Documentation**: PRs welcome
751
+
752
+ ## Supported CLIs
753
+
754
+ | CLI | Standby Install (default) | Global Install (plugin) | Uninstall |
755
+ |-----|--------------------------|------------------------|-----------|
756
+ | Claude Code | `helloagents install claude --standby` | `/plugin marketplace add hellowind777/helloagents` | `npm uninstall -g helloagents` (+ `/plugin remove helloagents` if global) |
757
+ | Gemini CLI | `helloagents install gemini --standby` | `gemini extensions install https://github.com/hellowind777/helloagents` | `npm uninstall -g helloagents` (+ `gemini extensions uninstall helloagents` if global) |
758
+ | Codex CLI | `helloagents install codex --standby` | `helloagents install codex --global` | `npm uninstall -g helloagents` |
911
759
 
912
760
  ---
913
761
 
@@ -917,4 +765,6 @@ If this project helps your workflow, a star is always appreciated.
917
765
 
918
766
  Thanks to <a href="https://codexzh.com/?ref=EEABC8">codexzh.com</a> / <a href="https://ccodezh.com">ccodezh.com</a> for supporting this project
919
767
 
768
+ [⬆ Back to top](#helloagents)
769
+
920
770
  </div>