helloagents 2.3.7 → 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.
- package/.claude-plugin/marketplace.json +20 -0
- package/.claude-plugin/plugin.json +21 -0
- package/.codex-plugin/plugin.json +46 -0
- package/README.md +494 -625
- package/README_CN.md +770 -0
- package/assets/dogdoing/complete.wav +0 -0
- package/assets/dogdoing/confirm.wav +0 -0
- package/assets/dogdoing/error.wav +0 -0
- package/assets/dogdoing/idle.wav +0 -0
- package/assets/dogdoing/warning.wav +0 -0
- package/assets/icons/icon-large.png +0 -0
- package/assets/icons/icon.png +0 -0
- package/assets/sounds/complete.wav +0 -0
- package/assets/sounds/confirm.wav +0 -0
- package/assets/sounds/error.wav +0 -0
- package/assets/sounds/idle.wav +0 -0
- package/assets/sounds/warning.wav +0 -0
- package/bootstrap-lite.md +199 -0
- package/bootstrap.md +296 -0
- package/cli.mjs +453 -0
- package/gemini-extension.json +8 -0
- package/hooks/hooks-claude.json +88 -0
- package/hooks/hooks.json +76 -0
- package/package.json +36 -6
- package/scripts/cli-codex.mjs +445 -0
- package/scripts/cli-config.mjs +37 -0
- package/scripts/cli-hosts.mjs +75 -0
- package/scripts/cli-messages.mjs +92 -0
- package/scripts/cli-toml.mjs +251 -0
- package/scripts/cli-utils.mjs +139 -0
- package/scripts/guard.mjs +217 -0
- package/scripts/notify-context.mjs +123 -0
- package/scripts/notify-events.mjs +11 -0
- package/scripts/notify-shared.mjs +47 -0
- package/scripts/notify-ui.mjs +92 -0
- package/scripts/notify.mjs +219 -0
- package/scripts/ralph-loop.mjs +246 -0
- package/skills/_meta/SKILL.md +19 -0
- package/skills/commands/auto/SKILL.md +91 -0
- package/skills/commands/clean/SKILL.md +21 -0
- package/skills/commands/commit/SKILL.md +26 -0
- package/skills/commands/design/SKILL.md +108 -0
- package/skills/commands/help/SKILL.md +45 -0
- package/skills/commands/init/SKILL.md +60 -0
- package/skills/commands/loop/SKILL.md +98 -0
- package/skills/commands/prd/SKILL.md +151 -0
- package/skills/commands/review/SKILL.md +16 -0
- package/skills/commands/test/SKILL.md +16 -0
- package/skills/commands/verify/SKILL.md +21 -0
- package/skills/hello-api/SKILL.md +40 -0
- package/skills/hello-arch/SKILL.md +38 -0
- package/skills/hello-data/SKILL.md +39 -0
- package/skills/hello-debug/SKILL.md +58 -0
- package/skills/hello-errors/SKILL.md +39 -0
- package/skills/hello-perf/SKILL.md +40 -0
- package/skills/hello-reflect/SKILL.md +34 -0
- package/skills/hello-review/SKILL.md +33 -0
- package/skills/hello-security/SKILL.md +40 -0
- package/skills/hello-subagent/SKILL.md +32 -0
- package/skills/hello-test/SKILL.md +55 -0
- package/skills/hello-ui/SKILL.md +197 -0
- package/skills/hello-verify/SKILL.md +132 -0
- package/skills/hello-write/SKILL.md +33 -0
- package/skills/helloagents/SKILL.md +107 -0
- package/templates/CHANGELOG.md +5 -0
- package/templates/DESIGN.md +19 -0
- package/templates/STATE.md +19 -0
- package/templates/archive/_index.md +4 -0
- package/templates/context.md +19 -0
- package/templates/guidelines.md +15 -0
- package/templates/modules/module.md +13 -0
- package/templates/plans/decisions.md +10 -0
- package/templates/plans/design.md +14 -0
- package/templates/plans/prd/00-overview.md +23 -0
- package/templates/plans/prd/01-user-stories.md +19 -0
- package/templates/plans/prd/02-functional.md +30 -0
- package/templates/plans/prd/03-ui-design.md +31 -0
- package/templates/plans/prd/04-technical.md +25 -0
- package/templates/plans/prd/05-nonfunctional.md +28 -0
- package/templates/plans/prd/06-i18n-l10n.md +23 -0
- package/templates/plans/prd/07-accessibility.md +20 -0
- package/templates/plans/prd/08-content.md +20 -0
- package/templates/plans/prd/09-testing.md +22 -0
- package/templates/plans/prd/10-deployment.md +23 -0
- package/templates/plans/prd/11-legal-privacy.md +18 -0
- package/templates/plans/prd/12-timeline.md +21 -0
- package/templates/plans/requirements.md +18 -0
- package/templates/plans/tasks.md +10 -0
- package/templates/verify.yaml +9 -0
- package/bin/cli.mjs +0 -106
package/README.md
CHANGED
|
@@ -6,14 +6,14 @@
|
|
|
6
6
|
|
|
7
7
|
<div align="center">
|
|
8
8
|
|
|
9
|
-
**
|
|
9
|
+
**Quality-driven orchestration kernel for AI coding CLIs — 14 auto-activated skills, process discipline, and checklist gating.**
|
|
10
10
|
|
|
11
|
-
[](./package.json)
|
|
12
12
|
[](https://www.npmjs.com/package/helloagents)
|
|
13
|
-
[](./package.json)
|
|
14
|
+
[](./skills)
|
|
15
15
|
[](./LICENSE.md)
|
|
16
|
-
[](
|
|
16
|
+
[](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
|
|
29
|
-
|
|
30
|
-
## Table of Contents
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
- [
|
|
36
|
-
- [
|
|
37
|
-
- [
|
|
38
|
-
- [
|
|
39
|
-
- [
|
|
40
|
-
- [
|
|
41
|
-
- [
|
|
42
|
-
- [
|
|
43
|
-
- [
|
|
44
|
-
- [
|
|
45
|
-
- [
|
|
46
|
-
- [
|
|
47
|
-
|
|
48
|
-
|
|
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="
|
|
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="
|
|
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,827 +75,687 @@
|
|
|
68
75
|
|
|
69
76
|
| Challenge | Without HelloAGENTS | With HelloAGENTS |
|
|
70
77
|
|-----------|-------------------|-----------------|
|
|
71
|
-
| Stops at planning | Ends with suggestions | Pushes to implementation and
|
|
72
|
-
|
|
|
73
|
-
| Risky operations |
|
|
74
|
-
|
|
|
75
|
-
|
|
|
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
|
-
|
|
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
|
-
|
|
102
|
+
**🎯 14 Auto-Activated Quality Skills**
|
|
85
103
|
|
|
86
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
**
|
|
131
|
+
**Your gain:** safer defaults with zero-config protection, verified output every time.
|
|
114
132
|
|
|
115
|
-
L0 user memory (global preferences) and L1 project knowledge base (structured docs synced from code).
|
|
116
|
-
|
|
117
|
-
**Your gain:** context survives across sessions and projects.
|
|
118
133
|
</td>
|
|
119
|
-
</tr>
|
|
120
|
-
<tr>
|
|
121
134
|
<td width="50%" valign="top">
|
|
122
|
-
<img src="./readme_images/
|
|
123
|
-
|
|
124
|
-
**Extensibility & Customization**
|
|
125
|
-
|
|
126
|
-
Voice notifications (5 event sounds), custom command extension (`.helloagents/commands/*.md`), 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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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/Grok CLI 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, auto-memory | Requires `CLAUDE_CODE_EXPERIMENTAL_AGENT_TEAMS=1` for teams mode |
|
|
160
|
-
| **Codex CLI** | 0.110+ | spawn_agent, CSV batch, collaboration_modes | 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 `collaboration_modes` for TUI interactive selection (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 enabled by default
|
|
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
|
-
|
|
149
|
+
### 1) Install once
|
|
213
150
|
|
|
214
|
-
|
|
215
|
-
|
|
216
|
-
|
|
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)
|
|
243
|
-
|
|
244
|
-
**Step 0 — Install UV first (skip if already installed):**
|
|
245
|
-
|
|
246
|
-
# Windows PowerShell
|
|
247
|
-
irm https://astral.sh/uv/install.ps1 | iex
|
|
151
|
+
```bash
|
|
152
|
+
npm install -g helloagents
|
|
153
|
+
```
|
|
248
154
|
|
|
249
|
-
|
|
250
|
-
curl -LsSf https://astral.sh/uv/install.sh | sh
|
|
155
|
+
If your system already has another `helloagents` executable in `PATH`, use the bundled stable alias instead:
|
|
251
156
|
|
|
252
|
-
|
|
157
|
+
```bash
|
|
158
|
+
helloagents-js
|
|
159
|
+
```
|
|
253
160
|
|
|
254
|
-
|
|
161
|
+
`postinstall` now only installs the package and initializes `~/.helloagents/helloagents.json`. It **does not auto-deploy to any CLI target**.
|
|
255
162
|
|
|
256
|
-
|
|
163
|
+
After the package is installed, deploy explicitly to the targets you want:
|
|
257
164
|
|
|
258
|
-
|
|
165
|
+
```bash
|
|
166
|
+
helloagents install codex --standby
|
|
167
|
+
helloagents install --all --standby
|
|
168
|
+
```
|
|
259
169
|
|
|
260
|
-
|
|
170
|
+
> `npm install helloagents` without `-g` follows the same rule: it installs the package only and does not modify any CLI config automatically.
|
|
261
171
|
|
|
262
|
-
|
|
172
|
+
### 2) Choose your mode
|
|
263
173
|
|
|
264
|
-
|
|
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 |
|
|
265
180
|
|
|
266
|
-
###
|
|
181
|
+
### 2.1) Manage one CLI at a time
|
|
267
182
|
|
|
268
|
-
|
|
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
|
+
```
|
|
269
190
|
|
|
270
|
-
|
|
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
|
|
271
195
|
|
|
272
|
-
|
|
196
|
+
If you want full rules everywhere, switch to global mode:
|
|
273
197
|
|
|
274
|
-
|
|
198
|
+
```bash
|
|
199
|
+
helloagents --global
|
|
200
|
+
```
|
|
275
201
|
|
|
276
|
-
|
|
202
|
+
Then install the native plugin/extension for your CLI where required:
|
|
277
203
|
|
|
278
|
-
|
|
204
|
+
```bash
|
|
205
|
+
# Claude Code
|
|
206
|
+
/plugin marketplace add hellowind777/helloagents
|
|
279
207
|
|
|
280
|
-
|
|
208
|
+
# Gemini CLI
|
|
209
|
+
gemini extensions install https://github.com/hellowind777/helloagents
|
|
210
|
+
```
|
|
281
211
|
|
|
282
|
-
|
|
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`
|
|
283
217
|
|
|
284
|
-
|
|
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
|
|
218
|
+
### 3) Verify in chat
|
|
294
219
|
|
|
295
|
-
|
|
220
|
+
```bash
|
|
221
|
+
# In your AI CLI chat, type:
|
|
222
|
+
~help
|
|
223
|
+
```
|
|
296
224
|
|
|
297
|
-
**
|
|
225
|
+
**Expected output:**
|
|
226
|
+
```
|
|
227
|
+
💡【HelloAGENTS】- Help
|
|
298
228
|
|
|
299
|
-
|
|
300
|
-
# macOS / Linux
|
|
301
|
-
curl -fsSL https://raw.githubusercontent.com/hellowind777/helloagents/main/install.sh | bash
|
|
229
|
+
Available commands: ~auto, ~design, ~prd, ~loop, ~init, ~test, ~verify, ~review, ~commit, ~clean, ~help
|
|
302
230
|
|
|
303
|
-
|
|
304
|
-
|
|
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
|
+
```
|
|
305
233
|
|
|
306
|
-
|
|
307
|
-
npx helloagents install codex
|
|
234
|
+
### 4) First use
|
|
308
235
|
|
|
309
|
-
|
|
310
|
-
|
|
236
|
+
```bash
|
|
237
|
+
# Simple task — direct execution
|
|
238
|
+
"Fix the typo in src/utils.ts line 42"
|
|
311
239
|
|
|
312
|
-
|
|
313
|
-
|
|
240
|
+
# Complex task — use ~auto for full workflow
|
|
241
|
+
~auto "Add user authentication with JWT"
|
|
314
242
|
|
|
315
|
-
|
|
243
|
+
# Want to review the plan first?
|
|
244
|
+
~design "Refactor the payment module"
|
|
245
|
+
```
|
|
316
246
|
|
|
317
|
-
|
|
247
|
+
## 🔄 Installation Lifecycle & File Writes
|
|
318
248
|
|
|
319
|
-
|
|
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]` `sqlite = 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 (collaboration_modes, 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
|
|
249
|
+
HelloAGENTS touches different files depending on mode. The write/cleanup rules are predictable and reversible.
|
|
332
250
|
|
|
333
|
-
###
|
|
251
|
+
### Standby mode (default)
|
|
334
252
|
|
|
335
|
-
|
|
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 |
|
|
336
258
|
|
|
337
|
-
|
|
338
|
-
# macOS / Linux
|
|
339
|
-
curl -fsSL https://raw.githubusercontent.com/hellowind777/helloagents/main/install.sh | bash
|
|
259
|
+
### Global mode
|
|
340
260
|
|
|
341
|
-
|
|
342
|
-
|
|
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` |
|
|
343
266
|
|
|
344
|
-
|
|
345
|
-
npx helloagents install claude
|
|
267
|
+
### Update / reinstall / branch-switch behavior
|
|
346
268
|
|
|
347
|
-
|
|
348
|
-
|
|
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.
|
|
349
274
|
|
|
350
|
-
|
|
351
|
-
pip install git+https://github.com/hellowind777/helloagents.git && helloagents install claude
|
|
275
|
+
## 📖 Commands
|
|
352
276
|
|
|
353
|
-
|
|
277
|
+
All commands run inside AI chat with the `~` prefix:
|
|
354
278
|
|
|
355
|
-
|
|
279
|
+
**Workflow Commands:**
|
|
356
280
|
|
|
357
|
-
|
|
358
|
-
|
|
359
|
-
|
|
360
|
-
|
|
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 |
|
|
361
287
|
|
|
362
|
-
|
|
288
|
+
**Quality Commands:**
|
|
363
289
|
|
|
364
|
-
|
|
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 |
|
|
365
295
|
|
|
366
|
-
**
|
|
296
|
+
**Utility Commands:**
|
|
367
297
|
|
|
368
|
-
|
|
369
|
-
|
|
370
|
-
|
|
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 |
|
|
371
304
|
|
|
372
|
-
|
|
305
|
+
## 🔧 Configuration
|
|
373
306
|
|
|
374
|
-
|
|
375
|
-
|-----|------|---------|-------------|
|
|
376
|
-
| `OUTPUT_LANGUAGE` | string | `zh-CN` | Language for AI output and KB files |
|
|
377
|
-
| `KB_CREATE_MODE` | int | `2` | KB creation: `0`=OFF, `1`=on-demand (prompt ~init), `2`=auto on code changes, `3`=always auto |
|
|
378
|
-
| `BILINGUAL_COMMIT` | int | `1` | Commit language: `0`=OUTPUT_LANGUAGE only, `1`=OUTPUT_LANGUAGE + English |
|
|
379
|
-
| `EVAL_MODE` | int | `1` | Clarification mode: `1`=progressive (1 question/round, max 5), `2`=one-shot (all at once, max 3) |
|
|
380
|
-
| `UPDATE_CHECK` | int | `72` | Update check cache TTL in hours: `0`=OFF |
|
|
381
|
-
| `CSV_BATCH_MAX` | int | `16` | CSV batch max concurrency: `0`=OFF, cap 64 (Codex CLI only) |
|
|
307
|
+
Config file: `~/.helloagents/helloagents.json` (auto-created on install)
|
|
382
308
|
|
|
383
|
-
|
|
309
|
+
Only include keys you want to override — missing keys use defaults.
|
|
384
310
|
|
|
385
311
|
```json
|
|
386
312
|
{
|
|
387
|
-
"
|
|
388
|
-
"
|
|
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"
|
|
389
321
|
}
|
|
390
322
|
```
|
|
391
323
|
|
|
392
|
-
|
|
393
|
-
|
|
394
|
-
|
|
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 |
|
|
395
334
|
|
|
396
335
|
<details>
|
|
397
|
-
<summary>📝
|
|
336
|
+
<summary>📝 Common configuration scenarios</summary>
|
|
398
337
|
|
|
399
|
-
|
|
400
|
-
|
|
401
|
-
|
|
402
|
-
"BILINGUAL_COMMIT": 0
|
|
403
|
-
}
|
|
338
|
+
**Switch to global mode (full rules everywhere):**
|
|
339
|
+
```bash
|
|
340
|
+
helloagents --global
|
|
404
341
|
```
|
|
405
|
-
All AI outputs, KB files, and commit messages will be in English only.
|
|
406
|
-
</details>
|
|
407
342
|
|
|
408
|
-
|
|
409
|
-
|
|
343
|
+
**Switch back to standby mode (default):**
|
|
344
|
+
```bash
|
|
345
|
+
helloagents --standby
|
|
346
|
+
```
|
|
410
347
|
|
|
348
|
+
**English-only output:**
|
|
411
349
|
```json
|
|
412
|
-
{
|
|
413
|
-
"KB_CREATE_MODE": 0
|
|
414
|
-
}
|
|
350
|
+
{ "output_language": "en" }
|
|
415
351
|
```
|
|
416
|
-
Knowledge base won't be created automatically. Use `~init` command when needed.
|
|
417
|
-
</details>
|
|
418
|
-
|
|
419
|
-
<details>
|
|
420
|
-
<summary>⚡ High-concurrency batch processing (Codex CLI)</summary>
|
|
421
352
|
|
|
353
|
+
**Disable KB auto-creation:**
|
|
422
354
|
```json
|
|
423
|
-
{
|
|
424
|
-
"CSV_BATCH_MAX": 32
|
|
425
|
-
}
|
|
355
|
+
{ "kb_create_mode": 0 }
|
|
426
356
|
```
|
|
427
|
-
Increase parallel CSV batch processing from 16 to 32 (max 64). Requires Codex CLI with CSV orchestration enabled.
|
|
428
|
-
</details>
|
|
429
|
-
|
|
430
|
-
<details>
|
|
431
|
-
<summary>🔕 Disable update checks</summary>
|
|
432
357
|
|
|
358
|
+
**Enable desktop + sound notifications:**
|
|
433
359
|
```json
|
|
434
|
-
{
|
|
435
|
-
"UPDATE_CHECK": 0
|
|
436
|
-
}
|
|
360
|
+
{ "notify_level": 3 }
|
|
437
361
|
```
|
|
438
|
-
Skip version update checks entirely (not recommended for production use).
|
|
439
|
-
</details>
|
|
440
|
-
|
|
441
|
-
<details>
|
|
442
|
-
<summary>💬 One-shot clarification mode</summary>
|
|
443
362
|
|
|
363
|
+
**Disable guard (not recommended):**
|
|
444
364
|
```json
|
|
445
|
-
{
|
|
446
|
-
"EVAL_MODE": 2
|
|
447
|
-
}
|
|
365
|
+
{ "guard_enabled": false }
|
|
448
366
|
```
|
|
449
|
-
|
|
367
|
+
|
|
450
368
|
</details>
|
|
451
369
|
|
|
452
|
-
## How It Works
|
|
370
|
+
## ⚙️ How It Works
|
|
453
371
|
|
|
454
|
-
**
|
|
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.
|
|
455
373
|
|
|
456
|
-
**
|
|
374
|
+
**The 5-stage flow:**
|
|
457
375
|
|
|
458
|
-
1. **
|
|
459
|
-
2. **
|
|
460
|
-
3. **
|
|
461
|
-
4. **
|
|
462
|
-
5. **
|
|
463
|
-
6. **Memory Retention** — User preferences, project knowledge, session context persist across sessions
|
|
464
|
-
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
|
|
465
381
|
|
|
466
|
-
|
|
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`
|
|
467
385
|
|
|
468
|
-
|
|
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
|
|
469
390
|
|
|
470
|
-
|
|
391
|
+
### Standby vs Global Mode
|
|
471
392
|
|
|
472
|
-
|
|
473
|
-
|---|---|
|
|
474
|
-
| ~auto | full autonomous workflow |
|
|
475
|
-
| ~plan | planning and package generation |
|
|
476
|
-
| ~exec | execute existing package |
|
|
477
|
-
| ~init | initialize knowledge base |
|
|
478
|
-
| ~commit | generate commit message from context |
|
|
479
|
-
| ~status / ~help | status and help |
|
|
393
|
+
HelloAGENTS supports two installation modes with different installation methods:
|
|
480
394
|
|
|
481
|
-
|
|
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 |
|
|
482
399
|
|
|
483
|
-
|
|
484
|
-
|---|---|
|
|
485
|
-
| ~test | run project tests |
|
|
486
|
-
| ~review | code review |
|
|
487
|
-
| ~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.
|
|
488
401
|
|
|
489
|
-
|
|
402
|
+
Bulk switch via CLI: `helloagents --global` or `helloagents --standby`
|
|
490
403
|
|
|
491
|
-
|
|
492
|
-
|---|---|
|
|
493
|
-
| ~upgradekb | upgrade knowledge structure |
|
|
494
|
-
| ~clean / ~cleanplan | cleanup workflow artifacts |
|
|
495
|
-
| ~rollback | rollback workflow state |
|
|
496
|
-
| ~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.
|
|
497
405
|
|
|
498
|
-
## Usage Guide
|
|
406
|
+
## 📚 Usage Guide
|
|
499
407
|
|
|
500
408
|
### Three Workflow Modes
|
|
501
409
|
|
|
502
410
|
| Mode | Description | When to use |
|
|
503
411
|
|------|-------------|-------------|
|
|
504
|
-
| `~auto` | Full autonomous flow
|
|
505
|
-
| `~
|
|
506
|
-
| `~
|
|
507
|
-
|
|
508
|
-
Typical pattern: `~plan` first → review → `~exec` to implement. Or just `~auto` for one-shot delivery.
|
|
509
|
-
|
|
510
|
-
### Interactive vs Delegated Mode
|
|
511
|
-
|
|
512
|
-
When `~auto` or `~plan` presents its confirmation, you choose:
|
|
513
|
-
|
|
514
|
-
- **Interactive (default):** pauses at key decision points (plan selection, failure handling)
|
|
515
|
-
- **Delegated (fully automatic):** auto-advances all stages, auto-selects recommended options, only pauses on EHRB risk
|
|
516
|
-
- **Plan-only delegated:** fully automatic but stops after design, never enters development
|
|
517
|
-
|
|
518
|
-
Without `~` commands, plain-text input is automatically routed to R0–R3 based on complexity.
|
|
519
|
-
|
|
520
|
-
### Requirement Evaluation
|
|
521
|
-
|
|
522
|
-
Before R2/R3 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, total 10). Score ≥ 8 proceeds to confirmation; < 8 triggers clarifying questions:
|
|
523
|
-
|
|
524
|
-
- `EVAL_MODE=1` (default, progressive): asks 1 lowest-scoring dimension per round, up to 5 rounds
|
|
525
|
-
- `EVAL_MODE=2` (one-shot): asks all low-scoring dimensions at once, up to 3 rounds
|
|
526
|
-
|
|
527
|
-
Context inferred from the existing codebase counts toward the score automatically. Say "skip evaluation / just do it" to bypass the questioning phase.
|
|
528
|
-
|
|
529
|
-
### Parallel Design Proposals
|
|
412
|
+
| `~auto` | Full autonomous flow: evaluate → design → develop → verify | 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 |
|
|
530
415
|
|
|
531
|
-
|
|
416
|
+
Typical pattern: `~design` first → review plan → start coding. Or just `~auto` for one-shot delivery.
|
|
532
417
|
|
|
533
|
-
|
|
534
|
-
- Delegated mode: recommended proposal is auto-selected
|
|
535
|
-
- R2 simplified path skips multi-proposal comparison and goes directly to planning
|
|
418
|
+
### Quality Verification (Ralph Loop)
|
|
536
419
|
|
|
537
|
-
|
|
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)
|
|
538
424
|
|
|
539
|
-
|
|
425
|
+
### Knowledge Base (`.helloagents/`)
|
|
540
426
|
|
|
541
|
-
-
|
|
542
|
-
- New dependencies required by tasks: auto-added with declaration file updated
|
|
543
|
-
- Ambiguous dependencies: user is asked before installing
|
|
427
|
+
`~init` creates a project-local knowledge base. `STATE.md` is a project-level recovery snapshot, not a universal memory file for every interaction.
|
|
544
428
|
|
|
545
|
-
|
|
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`.
|
|
546
430
|
|
|
547
|
-
|
|
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 |
|
|
548
442
|
|
|
549
|
-
|
|
443
|
+
### Smart Commit (`~commit`)
|
|
550
444
|
|
|
551
|
-
|
|
552
|
-
|
|
553
|
-
|
|
554
|
-
|
|
555
|
-
|
|
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
|
|
556
450
|
|
|
557
|
-
###
|
|
451
|
+
### Autonomous Iteration (`~loop`)
|
|
558
452
|
|
|
559
|
-
|
|
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
|
|
560
457
|
|
|
561
|
-
|
|
562
|
-
.helloagents/commands/release.md → ~release
|
|
458
|
+
## 🧪 Verification
|
|
563
459
|
|
|
564
|
-
|
|
460
|
+
HelloAGENTS ships with Node's built-in test runner:
|
|
565
461
|
|
|
566
|
-
|
|
567
|
-
|
|
568
|
-
|
|
569
|
-
|
|
570
|
-
- Analyzes `git diff` to auto-generate Conventional Commits formatted messages
|
|
571
|
-
- Pre-commit quality checks (code-doc consistency, test coverage, verification commands)
|
|
572
|
-
- Auto-excludes sensitive files (`.env`, `*.pem`, `*.key`, etc.) — never runs `git add .`
|
|
573
|
-
- Shows file list before staging, supports exclusion
|
|
574
|
-
- Options: local commit only / commit + push / commit + push + create PR
|
|
575
|
-
- Bilingual commit messages when `BILINGUAL_COMMIT=1`
|
|
576
|
-
|
|
577
|
-
### Manual Sub-Agent Invocation
|
|
578
|
-
|
|
579
|
-
Beyond automatic dispatch, you can manually invoke specific roles:
|
|
580
|
-
|
|
581
|
-
~rlm spawn reviewer "review src/api/ for security issues"
|
|
582
|
-
~rlm spawn writer "generate API reference docs"
|
|
583
|
-
~rlm spawn reviewer,writer "analyze and document the auth module" # parallel
|
|
584
|
-
|
|
585
|
-
Available roles: `reviewer` (code review), `writer` (documentation), `brainstormer` (multi-proposal comparison).
|
|
586
|
-
|
|
587
|
-
### Multi-Terminal Collaboration
|
|
588
|
-
|
|
589
|
-
Multiple terminals (across different CLIs) can share a task list:
|
|
590
|
-
|
|
591
|
-
# Terminal A
|
|
592
|
-
hellotasks=my-project codex
|
|
593
|
-
|
|
594
|
-
# Terminal B
|
|
595
|
-
hellotasks=my-project claude
|
|
596
|
-
|
|
597
|
-
Commands once enabled:
|
|
598
|
-
|
|
599
|
-
~rlm tasks # view shared task list
|
|
600
|
-
~rlm tasks available # see unclaimed tasks
|
|
601
|
-
~rlm tasks claim <id> # claim a task
|
|
602
|
-
~rlm tasks complete <id> # mark done
|
|
603
|
-
~rlm tasks add "task title" # add a new task
|
|
604
|
-
|
|
605
|
-
Tasks are stored in `{KB_ROOT}/tasks/` with file locking to prevent concurrent conflicts.
|
|
606
|
-
|
|
607
|
-
### KB Auto-Sync & CHANGELOG
|
|
608
|
-
|
|
609
|
-
The knowledge base syncs automatically at these points:
|
|
610
|
-
|
|
611
|
-
- After every development stage, main agent syncs module docs to reflect actual code
|
|
612
|
-
- After every R1/R2/R3 task completion, CHANGELOG is auto-appended
|
|
613
|
-
- On session end (Claude Code Stop Hook), KB sync flag set asynchronously
|
|
614
|
-
|
|
615
|
-
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.
|
|
616
|
-
|
|
617
|
-
`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
|
+
```
|
|
618
465
|
|
|
619
|
-
|
|
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
|
|
620
472
|
|
|
621
|
-
|
|
473
|
+
## ❓ FAQ
|
|
622
474
|
|
|
623
|
-
|
|
475
|
+
<details>
|
|
476
|
+
<summary><strong>Q: Is this a CLI tool or a prompt framework?</strong></summary>
|
|
624
477
|
|
|
625
|
-
|
|
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>
|
|
626
480
|
|
|
627
|
-
|
|
628
|
-
|
|
629
|
-
|
|
630
|
-
|
|
631
|
-
-
|
|
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>
|
|
632
491
|
|
|
633
|
-
|
|
492
|
+
<details>
|
|
493
|
+
<summary><strong>Q: Which CLI should I use?</strong></summary>
|
|
634
494
|
|
|
635
|
-
|
|
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>
|
|
636
497
|
|
|
637
|
-
|
|
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>
|
|
638
519
|
|
|
639
|
-
|
|
640
|
-
|
|
641
|
-
- pyproject.toml: package metadata (v2.3.7)
|
|
642
|
-
- helloagents/cli.py: CLI entry point
|
|
643
|
-
- helloagents/_common.py: shared constants and utilities
|
|
644
|
-
- helloagents/core/: CLI management modules (install, uninstall, update, status, dispatcher, hooks settings)
|
|
645
|
-
- helloagents/functions: command definitions (15)
|
|
646
|
-
- helloagents/stages: design, develop
|
|
647
|
-
- helloagents/services: knowledge, package, memory and support services
|
|
648
|
-
- helloagents/rules: state, cache, tools, scaling, sub-agent protocols
|
|
649
|
-
- helloagents/rlm: role library and orchestration helpers
|
|
650
|
-
- helloagents/hooks: Claude Code, Codex CLI, Gemini CLI, and Grok CLI hooks configs
|
|
651
|
-
- helloagents/scripts: automation scripts (sound notify, progress snapshot, safety guard, etc.)
|
|
652
|
-
- helloagents/agents: sub-agent definitions (3 RLM roles)
|
|
653
|
-
- helloagents/user/commands: custom command templates
|
|
654
|
-
- helloagents/assets: sound resources (5 event sounds)
|
|
655
|
-
- helloagents/templates: KB and plan templates
|
|
520
|
+
<details>
|
|
521
|
+
<summary><strong>Q: What is standby vs global mode?</strong></summary>
|
|
656
522
|
|
|
657
|
-
|
|
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>
|
|
658
525
|
|
|
659
|
-
|
|
526
|
+
<details>
|
|
527
|
+
<summary><strong>Q: Where does project knowledge go?</strong></summary>
|
|
660
528
|
|
|
661
|
-
A
|
|
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>
|
|
662
531
|
|
|
663
|
-
|
|
532
|
+
<details>
|
|
533
|
+
<summary><strong>Q: What is the Guard system?</strong></summary>
|
|
664
534
|
|
|
665
|
-
A
|
|
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>
|
|
666
539
|
|
|
667
|
-
|
|
540
|
+
<details>
|
|
541
|
+
<summary><strong>Q: What does the bottom next-step bar mean when formatted output is enabled?</strong></summary>
|
|
668
542
|
|
|
669
|
-
A
|
|
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>
|
|
670
545
|
|
|
671
|
-
|
|
546
|
+
<details>
|
|
547
|
+
<summary><strong>Q: Can I disable features I don't need?</strong></summary>
|
|
672
548
|
|
|
673
|
-
A
|
|
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>
|
|
674
551
|
|
|
675
|
-
|
|
552
|
+
<details>
|
|
553
|
+
<summary><strong>Q: What is ~prd?</strong></summary>
|
|
676
554
|
|
|
677
|
-
A
|
|
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>
|
|
678
557
|
|
|
679
|
-
|
|
558
|
+
## 🛠️ Troubleshooting
|
|
680
559
|
|
|
681
|
-
|
|
560
|
+
### Plugin not loading (Claude Code)
|
|
682
561
|
|
|
683
|
-
**
|
|
562
|
+
**Problem:** `~help` not recognized after plugin installation
|
|
684
563
|
|
|
685
|
-
|
|
564
|
+
**Solution:** Restart Claude Code. If still not working, check `/plugin list` to verify installation.
|
|
686
565
|
|
|
687
|
-
|
|
566
|
+
---
|
|
688
567
|
|
|
689
|
-
|
|
568
|
+
### Extension not working (Gemini CLI)
|
|
690
569
|
|
|
691
|
-
|
|
570
|
+
**Problem:** `~help` not recognized after `gemini extensions install`
|
|
692
571
|
|
|
693
|
-
|
|
572
|
+
**Solution:** Restart Gemini CLI. Verify with `gemini extensions list`. Make sure the extension is enabled.
|
|
694
573
|
|
|
695
|
-
|
|
574
|
+
---
|
|
696
575
|
|
|
697
|
-
|
|
576
|
+
### File writes blocked outside workspace
|
|
698
577
|
|
|
699
|
-
**
|
|
700
|
-
- UV: Restart terminal after UV installation
|
|
701
|
-
- pip: Check `pip show helloagents` for install location, add to PATH
|
|
702
|
-
- 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.
|
|
703
579
|
|
|
704
|
-
**
|
|
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.
|
|
705
581
|
|
|
706
582
|
---
|
|
707
583
|
|
|
708
|
-
###
|
|
709
|
-
|
|
710
|
-
**Problem:** Version shows as "unknown"
|
|
711
|
-
|
|
712
|
-
**Diagnosis:** Package metadata not available
|
|
584
|
+
### Commands not found
|
|
713
585
|
|
|
714
|
-
**
|
|
586
|
+
**Problem:** `~help` not recognized after installation
|
|
715
587
|
|
|
716
|
-
**
|
|
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
|
|
717
594
|
|
|
718
595
|
---
|
|
719
596
|
|
|
720
|
-
###
|
|
721
|
-
|
|
722
|
-
**Problem:** CLI target not found during installation
|
|
723
|
-
|
|
724
|
-
**Diagnosis:** Config directory doesn't exist yet
|
|
597
|
+
### Local branch switched but Codex global plugin still uses old files
|
|
725
598
|
|
|
726
|
-
**
|
|
599
|
+
**Problem:** You changed branches or updated a linked local checkout, but Codex global mode is still running older copied files.
|
|
727
600
|
|
|
728
|
-
**
|
|
729
|
-
- Codex
|
|
730
|
-
-
|
|
731
|
-
- 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
|
|
732
604
|
|
|
733
605
|
---
|
|
734
606
|
|
|
735
|
-
###
|
|
607
|
+
### Guard blocking legitimate commands
|
|
736
608
|
|
|
737
|
-
**Problem:**
|
|
609
|
+
**Problem:** Guard blocks a command you actually want to run
|
|
738
610
|
|
|
739
|
-
**
|
|
740
|
-
|
|
741
|
-
**Solution:** Restore from timestamped backup in CLI config directory (e.g., `~/.codex/rules/AGENTS.md.backup.20260304_132146`)
|
|
742
|
-
|
|
743
|
-
**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`.
|
|
744
612
|
|
|
745
613
|
---
|
|
746
614
|
|
|
747
|
-
###
|
|
748
|
-
|
|
749
|
-
**Problem:** README images don't display
|
|
615
|
+
### Ralph Loop keeps failing
|
|
750
616
|
|
|
751
|
-
**
|
|
617
|
+
**Problem:** Verification loop won't pass
|
|
752
618
|
|
|
753
619
|
**Solution:**
|
|
754
|
-
-
|
|
755
|
-
-
|
|
756
|
-
-
|
|
757
|
-
|
|
758
|
-
**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
|
|
759
623
|
|
|
760
624
|
---
|
|
761
625
|
|
|
762
626
|
### CCswitch replaces HelloAGENTS config
|
|
763
627
|
|
|
764
|
-
**Problem:** After switching CCswitch profiles, HelloAGENTS stops working
|
|
628
|
+
**Problem:** After switching CCswitch profiles, HelloAGENTS stops working
|
|
765
629
|
|
|
766
|
-
**
|
|
630
|
+
**Solution:** Re-run `/plugin marketplace add hellowind777/helloagents` after switching profiles. CCswitch replaces the entire CLI config directory.
|
|
767
631
|
|
|
768
|
-
|
|
632
|
+
---
|
|
769
633
|
|
|
770
|
-
|
|
771
|
-
helloagents update # update + auto-sync all installed targets
|
|
634
|
+
### Notifications not working
|
|
772
635
|
|
|
773
|
-
**
|
|
636
|
+
**Problem:** No sound or desktop notifications
|
|
774
637
|
|
|
775
|
-
**
|
|
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
|
|
776
643
|
|
|
777
|
-
|
|
644
|
+
## 📈 Version History
|
|
778
645
|
|
|
779
|
-
###
|
|
646
|
+
### v3.0.1 (current)
|
|
780
647
|
|
|
781
|
-
**
|
|
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
|
|
782
654
|
|
|
783
|
-
|
|
655
|
+
### v3.0.0 🎉
|
|
784
656
|
|
|
785
|
-
**
|
|
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`
|
|
786
661
|
|
|
787
|
-
**
|
|
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
|
|
685
|
+
|
|
686
|
+
**Architecture Changes:**
|
|
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
|
|
788
693
|
|
|
789
|
-
|
|
694
|
+
**New Features:**
|
|
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
|
|
698
|
+
|
|
699
|
+
**Security:**
|
|
700
|
+
- Fixed path injection vulnerability in `shared_tasks.py`
|
|
701
|
+
- Fixed incomplete path traversal guard in `validate_package.py`
|
|
790
702
|
|
|
791
|
-
### v2.3.7
|
|
703
|
+
### v2.3.7
|
|
792
704
|
|
|
793
705
|
**Bug Fixes:**
|
|
794
|
-
- Fixed non-coding tasks incorrectly creating
|
|
795
|
-
- Fixed R2 standard flow redirecting to archive instead of DEVELOP after proposal selection
|
|
796
|
-
- Fixed non-coding tasks incorrectly creating plan packages
|
|
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
|
|
797
709
|
|
|
798
710
|
**Improvements:**
|
|
799
|
-
- Optimized implementation plan state recovery after context compression
|
|
800
|
-
- Optimized overall design flow
|
|
711
|
+
- 📦 Optimized implementation plan state recovery after context compression
|
|
712
|
+
- 📦 Optimized overall design flow
|
|
801
713
|
|
|
802
714
|
### v2.3.6
|
|
803
715
|
|
|
804
716
|
**New Features:**
|
|
805
|
-
- Sub-agent orchestration overhaul:
|
|
806
|
-
- Sub-agent blocking mechanism: auto-block and fallback
|
|
717
|
+
- ✨ Sub-agent orchestration overhaul: brainstormer sub-agent for parallel proposal ideation
|
|
718
|
+
- ✨ Sub-agent blocking mechanism: auto-block and fallback on failure/timeout
|
|
807
719
|
|
|
808
720
|
**Improvements:**
|
|
809
|
-
- Tool/Shell constraint optimization: allow fallback to Shell when built-in tools fail
|
|
810
|
-
- Shell encoding constraint refinement: explicit UTF-8 no-BOM requirement
|
|
811
|
-
-
|
|
812
|
-
- Removed session memory features that couldn't be fully implemented in CLI (session_summary template, SessionEnd memory sync), streamlined service layer
|
|
813
|
-
- Sub-agent consolidation: removed 3 redundant sub-agents (kb-keeper, pkg-keeper, synthesizer), functionality returned to main agent and RLM roles
|
|
814
|
-
- Sub-agent voice notification skip, task stability fixes
|
|
815
|
-
- Unified user config directory structure (user/memory/, user/commands/, user/sounds/)
|
|
816
|
-
- Uninstall script enhancements
|
|
817
|
-
- 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
|
|
818
724
|
|
|
819
725
|
### v2.3.5
|
|
820
726
|
|
|
821
727
|
**New Features:**
|
|
822
|
-
- Voice notification system with 5 event sounds
|
|
823
|
-
- Claude Code hooks expanded from 9 to 11 lifecycle event types
|
|
824
|
-
- Hooks support expanded to Gemini CLI and Grok CLI
|
|
825
|
-
-
|
|
826
|
-
-
|
|
827
|
-
-
|
|
828
|
-
- User-defined tool registration and orchestration — intelligent invocation of custom sub-agents, skills, MCP servers, and plugins
|
|
829
|
-
- Custom command extension support via `.helloagents/commands/*.md`
|
|
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
|
|
830
734
|
|
|
831
735
|
**Improvements:**
|
|
832
|
-
- Comprehensive audit fixes (21 issues: 6 HIGH + 9 MEDIUM + 6 LOW)
|
|
833
|
-
|
|
834
|
-
|
|
835
|
-
|
|
836
|
-
|
|
837
|
-
|
|
838
|
-
-
|
|
839
|
-
|
|
840
|
-
|
|
841
|
-
|
|
842
|
-
|
|
843
|
-
|
|
844
|
-
-
|
|
845
|
-
-
|
|
846
|
-
-
|
|
847
|
-
|
|
848
|
-
|
|
849
|
-
|
|
850
|
-
|
|
851
|
-
|
|
852
|
-
|
|
853
|
-
|
|
854
|
-
|
|
855
|
-
|
|
856
|
-
### v2.3.0
|
|
857
|
-
|
|
858
|
-
- Comprehensive cross-audit fix: unified role output format, normalized path references, code-doc consistency alignment
|
|
859
|
-
- Quality verification loop (Ralph Loop): auto-verify after sub-agent completion, block and feedback on failure
|
|
860
|
-
- Auto context injection for sub-agents and rule reinforcement for main agent
|
|
861
|
-
- Deep 5-dimension root cause analysis on repeated failures (break-loop)
|
|
862
|
-
- Auto-inject project technical guidelines before sub-agent development
|
|
863
|
-
- Pre-commit quality checks (code-doc consistency, test coverage, verification commands)
|
|
864
|
-
- Worktree isolation for parallel editing
|
|
865
|
-
- Custom command extension (.helloagents/commands/)
|
|
866
|
-
- Auto-append Git author info to CHANGELOG entries
|
|
867
|
-
|
|
868
|
-
## Contributing
|
|
869
|
-
|
|
870
|
-
See CONTRIBUTING.md for contribution rules and PR checklist.
|
|
871
|
-
|
|
872
|
-
## License
|
|
873
|
-
|
|
874
|
-
This project is dual-licensed: Code under Apache-2.0, Documentation under CC BY 4.0. See [LICENSE.md](./LICENSE.md).
|
|
875
|
-
|
|
876
|
-
## Next Steps
|
|
877
|
-
|
|
878
|
-
**Getting Started:**
|
|
879
|
-
- Install HelloAGENTS using your preferred method: [Quick Start](#quick-start)
|
|
880
|
-
- Try `~auto` with a simple task to see the full workflow in action
|
|
881
|
-
- Explore `~plan` + `~exec` for more control over the process
|
|
882
|
-
|
|
883
|
-
**Learn More:**
|
|
884
|
-
- Read [Usage Guide](#usage-guide) for detailed workflow patterns
|
|
885
|
-
- Check [Configuration](#configuration) to customize behavior
|
|
886
|
-
- Review [In-Chat Workflow Commands](#in-chat-workflow-commands) reference
|
|
887
|
-
|
|
888
|
-
**Community & Support:**
|
|
889
|
-
- Star the repo if HelloAGENTS helps your workflow
|
|
890
|
-
- Report issues or request features on [GitHub Issues](https://github.com/hellowind777/helloagents/issues)
|
|
891
|
-
- 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` |
|
|
892
759
|
|
|
893
760
|
---
|
|
894
761
|
|
|
@@ -898,4 +765,6 @@ If this project helps your workflow, a star is always appreciated.
|
|
|
898
765
|
|
|
899
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
|
|
900
767
|
|
|
768
|
+
[⬆ Back to top](#helloagents)
|
|
769
|
+
|
|
901
770
|
</div>
|