helloagents 2.2.16 → 2.3.3-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/README.md +290 -197
- package/package.json +13 -2
package/README.md
CHANGED
|
@@ -6,9 +6,9 @@
|
|
|
6
6
|
|
|
7
7
|
<div align="center">
|
|
8
8
|
|
|
9
|
-
**
|
|
9
|
+
**Let AI go beyond analysis — keep pushing until implementation and verification are done.**
|
|
10
10
|
|
|
11
|
-
[](./pyproject.toml)
|
|
12
12
|
[](https://www.npmjs.com/package/helloagents)
|
|
13
13
|
[](./pyproject.toml)
|
|
14
14
|
[](./helloagents/functions)
|
|
@@ -26,83 +26,77 @@
|
|
|
26
26
|
|
|
27
27
|
## Table of Contents
|
|
28
28
|
|
|
29
|
-
- [
|
|
30
|
-
- [
|
|
31
|
-
- [Features](#features)
|
|
32
|
-
- [Before and After (Snake Demo)](#before-and-after-snake-demo)
|
|
29
|
+
- [Before and After](#before-and-after)
|
|
30
|
+
- [Core Features](#core-features)
|
|
33
31
|
- [Quick Start](#quick-start)
|
|
32
|
+
- [Configuration](#configuration)
|
|
34
33
|
- [How It Works](#how-it-works)
|
|
35
|
-
- [Repository Guide](#repository-guide)
|
|
36
34
|
- [In-Chat Workflow Commands](#in-chat-workflow-commands)
|
|
35
|
+
- [Usage Guide](#usage-guide)
|
|
36
|
+
- [Repository Guide](#repository-guide)
|
|
37
37
|
- [FAQ](#faq)
|
|
38
38
|
- [Troubleshooting](#troubleshooting)
|
|
39
39
|
- [Version History](#version-history)
|
|
40
40
|
- [Contributing](#contributing)
|
|
41
41
|
- [License](#license)
|
|
42
42
|
|
|
43
|
-
##
|
|
43
|
+
## Before and After
|
|
44
|
+
|
|
45
|
+
<table>
|
|
46
|
+
<tr>
|
|
47
|
+
<td width="50%" valign="top" align="center">
|
|
48
|
+
|
|
49
|
+
**Without HelloAGENTS**
|
|
50
|
+
|
|
51
|
+
<img src="./readme_images/08-demo-snake-without-helloagents.png" alt="Snake demo without HelloAGENTS" width="520">
|
|
44
52
|
|
|
45
|
-
|
|
53
|
+
</td>
|
|
54
|
+
<td width="50%" valign="top" align="center">
|
|
55
|
+
|
|
56
|
+
**With HelloAGENTS**
|
|
57
|
+
|
|
58
|
+
<img src="./readme_images/07-demo-snake-with-helloagents.png" alt="Snake demo with HelloAGENTS" width="520">
|
|
59
|
+
|
|
60
|
+
</td>
|
|
61
|
+
</tr>
|
|
62
|
+
</table>
|
|
46
63
|
|
|
47
64
|
| Challenge | Without HelloAGENTS | With HelloAGENTS |
|
|
48
|
-
|
|
65
|
+
|-----------|-------------------|-----------------|
|
|
49
66
|
| Stops at planning | Ends with suggestions | Pushes to implementation and validation |
|
|
50
67
|
| Output drift | Different structure every prompt | Unified routing and stage chain |
|
|
51
68
|
| Risky operations | Easier to make destructive mistakes | EHRB risk detection and escalation |
|
|
52
69
|
| Knowledge continuity | Context gets scattered | Built-in KB and session memory |
|
|
53
70
|
| Reusability | Prompt-by-prompt effort | Commandized reusable workflow |
|
|
54
71
|
|
|
55
|
-
|
|
56
|
-
<img src="./readme_images/06-divider.svg" width="420" alt="divider">
|
|
57
|
-
</div>
|
|
58
|
-
|
|
59
|
-
## What Changed vs Legacy Repo
|
|
60
|
-
|
|
61
|
-
Compared with legacy multi-bundle releases, the v2.x line is now package-first with a fundamentally different architecture.
|
|
62
|
-
|
|
63
|
-
| Area | Legacy repo | Current repo |
|
|
64
|
-
|---|---|---|
|
|
65
|
-
| Distribution | Multiple bundle folders per CLI | One Python package + installer CLI |
|
|
66
|
-
| Installation | Manual copy of config and skill folders | pip/uv install + `helloagents` interactive menu |
|
|
67
|
-
| Routing | Three-layer (Context → Tools → Intent) | Five-dimension scoring (R0–R3) |
|
|
68
|
-
| Workflow stages | 4 stages (Evaluate, Analyze, Design, Develop) | 3 stages (Evaluate, Design, Develop) + R1 fast flow, with sub-agent dispatch |
|
|
69
|
-
| Agent system | None | RLM with 5 specialized roles + native sub-agents and session isolation |
|
|
70
|
-
| Memory | No persistence | Three-layer: L0 user, L1 project KB, L2 session |
|
|
71
|
-
| Safety | Basic EHRB | Three-layer EHRB (keyword + semantic + tool output) |
|
|
72
|
-
| Hooks | None | Auto-deploy lifecycle hooks (Claude Code 9 events + Codex CLI notify) |
|
|
73
|
-
| CLI targets | 5 visible bundle targets | 6 targets: codex, claude, gemini, qwen, grok, opencode |
|
|
74
|
-
| Commands | 12 | 15 workflow commands |
|
|
75
|
-
|
|
76
|
-
> ⚠️ **Migration notice:** Because repository structure and installation workflow changed in v2.x, legacy versions were moved to **helloagents-archive**: https://github.com/hellowind777/helloagents-archive
|
|
77
|
-
|
|
78
|
-
## Features
|
|
72
|
+
## Core Features
|
|
79
73
|
|
|
80
74
|
<table>
|
|
81
75
|
<tr>
|
|
82
76
|
<td width="50%" valign="top">
|
|
83
77
|
<img src="./readme_images/02-feature-icon-installer.svg" width="48" align="left">
|
|
84
78
|
|
|
85
|
-
**RLM
|
|
79
|
+
**RLM Sub-Agent Orchestration**
|
|
86
80
|
|
|
87
|
-
5 specialized roles (reviewer
|
|
81
|
+
5 specialized roles (reviewer / synthesizer / kb_keeper / pkg_keeper / writer) plus host CLI native sub-agents (explore / implement / test / design) 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.
|
|
88
82
|
|
|
89
83
|
**Your gain:** complex tasks are broken down and handled by the right specialist, with parallel execution when possible.
|
|
90
84
|
</td>
|
|
91
85
|
<td width="50%" valign="top">
|
|
92
86
|
<img src="./readme_images/03-feature-icon-workflow.svg" width="48" align="left">
|
|
93
87
|
|
|
94
|
-
**
|
|
88
|
+
**Structured Workflow (Evaluate → Design → Develop)**
|
|
95
89
|
|
|
96
|
-
Every input is scored on
|
|
90
|
+
Every input is scored on five dimensions and routed to R0 direct response, R1 fast flow, R2 simplified flow, or R3 standard flow. R2/R3 enter the full stage chain with explicit entry conditions, deliverables, and verification gates. Supports interactive and fully delegated modes.
|
|
97
91
|
|
|
98
|
-
**Your gain:** proportional effort — simple queries stay fast, complex tasks get full process.
|
|
92
|
+
**Your gain:** proportional effort — simple queries stay fast, complex tasks get full process with verification at every step.
|
|
99
93
|
</td>
|
|
100
94
|
</tr>
|
|
101
95
|
<tr>
|
|
102
96
|
<td width="50%" valign="top">
|
|
103
97
|
<img src="./readme_images/04-feature-icon-safety.svg" width="48" align="left">
|
|
104
98
|
|
|
105
|
-
**Three-
|
|
99
|
+
**Three-Layer Safety Detection (EHRB)**
|
|
106
100
|
|
|
107
101
|
Keyword scan, semantic analysis, and tool-output inspection catch destructive operations before execution. Interactive and delegated modes enforce user confirmation.
|
|
108
102
|
|
|
@@ -111,7 +105,7 @@ Keyword scan, semantic analysis, and tool-output inspection catch destructive op
|
|
|
111
105
|
<td width="50%" valign="top">
|
|
112
106
|
<img src="./readme_images/05-feature-icon-compat.svg" width="48" align="left">
|
|
113
107
|
|
|
114
|
-
**Three-
|
|
108
|
+
**Three-Layer Memory Model**
|
|
115
109
|
|
|
116
110
|
L0 user memory (global preferences), L1 project knowledge base (structured docs synced from code), and L2 session summaries (auto-persisted at stage transitions).
|
|
117
111
|
|
|
@@ -120,40 +114,24 @@ L0 user memory (global preferences), L1 project knowledge base (structured docs
|
|
|
120
114
|
</tr>
|
|
121
115
|
</table>
|
|
122
116
|
|
|
123
|
-
###
|
|
124
|
-
|
|
125
|
-
- 6 CLI targets from helloagents/cli.py
|
|
126
|
-
- 15 workflow commands from helloagents/functions
|
|
127
|
-
- 5 RLM roles from helloagents/rlm/roles
|
|
128
|
-
- 2 stage definitions from helloagents/stages
|
|
129
|
-
- 5 core services from helloagents/services
|
|
130
|
-
- 4 rule modules from helloagents/rules
|
|
131
|
-
- 9 helper scripts from helloagents/scripts
|
|
132
|
-
- 2 hooks configs from helloagents/hooks
|
|
133
|
-
- 10 KB/plan templates from helloagents/templates
|
|
134
|
-
|
|
135
|
-
## Before and After (Snake Demo)
|
|
117
|
+
### Sub-Agent Native Mapping
|
|
136
118
|
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
119
|
+
| CLI | Native Sub-Agent Mechanism | RLM Mapping |
|
|
120
|
+
|-----|---------------------------|-------------|
|
|
121
|
+
| Claude Code | Task tool (explore / code / shell) | Direct mapping, supports Agent Teams |
|
|
122
|
+
| Codex CLI | spawn_agent / Collab (multi-thread) | spawn_agent parallel scheduling, CSV batch orchestration |
|
|
123
|
+
| OpenCode | Built-in agent mode | Fallback to sequential execution |
|
|
124
|
+
| Gemini CLI | Built-in tool calls | Fallback to sequential execution |
|
|
125
|
+
| Qwen CLI | Built-in tool calls | Fallback to sequential execution |
|
|
126
|
+
| Grok CLI | Built-in tool calls | Fallback to sequential execution |
|
|
140
127
|
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
<img src="./readme_images/08-demo-snake-without-helloagents.png" alt="Snake demo without HelloAGENTS" width="520">
|
|
128
|
+
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 9 lifecycle hooks + Codex CLI notify hook) with automatic graceful degradation when unavailable.
|
|
144
129
|
|
|
145
|
-
|
|
146
|
-
<td width="50%" valign="top" align="center">
|
|
147
|
-
|
|
148
|
-
**With HelloAGENTS**
|
|
149
|
-
|
|
150
|
-
<img src="./readme_images/07-demo-snake-with-helloagents.png" alt="Snake demo with HelloAGENTS" width="520">
|
|
130
|
+
## Quick Start
|
|
151
131
|
|
|
152
|
-
|
|
153
|
-
</tr>
|
|
154
|
-
</table>
|
|
132
|
+
> ⚠️ **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.
|
|
155
133
|
|
|
156
|
-
|
|
134
|
+
> ⚠️ **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).
|
|
157
135
|
|
|
158
136
|
### Method A: One-line install script (recommended)
|
|
159
137
|
|
|
@@ -167,20 +145,34 @@ L0 user memory (global preferences), L1 project knowledge base (structured docs
|
|
|
167
145
|
|
|
168
146
|
> 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.
|
|
169
147
|
|
|
170
|
-
**Update:**
|
|
148
|
+
**Update:** re-run the install command above.
|
|
171
149
|
|
|
172
|
-
|
|
150
|
+
**Uninstall:** `uv tool uninstall helloagents` or `pip uninstall helloagents` (depends on what the script detected)
|
|
151
|
+
|
|
152
|
+
**Switch branch:**
|
|
153
|
+
|
|
154
|
+
# macOS / Linux
|
|
155
|
+
curl -fsSL https://raw.githubusercontent.com/hellowind777/helloagents/beta/install.sh | HELLOAGENTS_BRANCH=beta bash
|
|
156
|
+
|
|
157
|
+
# Windows PowerShell
|
|
158
|
+
$env:HELLOAGENTS_BRANCH="beta"; irm https://raw.githubusercontent.com/hellowind777/helloagents/beta/install.ps1 | iex
|
|
173
159
|
|
|
174
160
|
### Method B: npx (Node.js >= 16)
|
|
175
161
|
|
|
176
162
|
npx helloagents
|
|
177
163
|
|
|
178
|
-
> Installs the Python package and launches an interactive menu. You can also specify directly: `npx helloagents install codex` (or use `npx -y` to auto-download without prompting)
|
|
164
|
+
> 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)
|
|
179
165
|
|
|
180
166
|
> Requires Python >= 3.10. After first install, use the native `helloagents` command directly.
|
|
181
167
|
|
|
182
168
|
> **Acknowledgment:** Thanks to @setsuna1106 for generously transferring the npm `helloagents` package ownership.
|
|
183
169
|
|
|
170
|
+
**Update:** `npx helloagents@latest`
|
|
171
|
+
|
|
172
|
+
**Uninstall:** `pip uninstall helloagents`
|
|
173
|
+
|
|
174
|
+
**Switch branch:** `npx helloagents@beta`
|
|
175
|
+
|
|
184
176
|
### Method C: UV (isolated environment)
|
|
185
177
|
|
|
186
178
|
**Step 0 — Install UV first (skip if already installed):**
|
|
@@ -193,17 +185,17 @@ L0 user memory (global preferences), L1 project knowledge base (structured docs
|
|
|
193
185
|
|
|
194
186
|
> After installing UV, restart your terminal to make the `uv` command available.
|
|
195
187
|
|
|
196
|
-
> ⚠️ Windows PowerShell 5.1 does not support `&&`. Please run commands separately, or upgrade to [PowerShell 7+](https://learn.microsoft.com/powershell/scripting/install/installing-powershell-on-windows).
|
|
197
|
-
|
|
198
188
|
**Install and select targets (one command):**
|
|
199
189
|
|
|
200
190
|
uv tool install --from git+https://github.com/hellowind777/helloagents helloagents && helloagents
|
|
201
191
|
|
|
202
192
|
> Installs the package and launches an interactive menu for you to select target CLIs. You can also specify directly: `helloagents install codex`
|
|
203
193
|
|
|
204
|
-
**Update:**
|
|
194
|
+
**Update:** `uv tool install --from git+https://github.com/hellowind777/helloagents helloagents --force`
|
|
205
195
|
|
|
206
|
-
|
|
196
|
+
**Uninstall:** `uv tool uninstall helloagents`
|
|
197
|
+
|
|
198
|
+
**Switch branch:** `uv tool install --from git+https://github.com/hellowind777/helloagents@beta helloagents --force`
|
|
207
199
|
|
|
208
200
|
### Method D: pip (Python >= 3.10)
|
|
209
201
|
|
|
@@ -213,33 +205,26 @@ L0 user memory (global preferences), L1 project knowledge base (structured docs
|
|
|
213
205
|
|
|
214
206
|
> Installs the package and launches an interactive menu for you to select target CLIs. You can also specify directly: `helloagents install codex`
|
|
215
207
|
|
|
216
|
-
**Update:**
|
|
208
|
+
**Update:** `pip install --upgrade git+https://github.com/hellowind777/helloagents.git`
|
|
217
209
|
|
|
218
|
-
|
|
210
|
+
**Uninstall:** `pip uninstall helloagents`
|
|
219
211
|
|
|
220
|
-
|
|
212
|
+
**Switch branch:** `pip install --upgrade git+https://github.com/hellowind777/helloagents.git@beta`
|
|
221
213
|
|
|
222
|
-
|
|
214
|
+
### HelloAGENTS commands (after installation)
|
|
223
215
|
|
|
224
|
-
|
|
216
|
+
> ⚠️ 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.
|
|
225
217
|
|
|
218
|
+
helloagents # interactive menu
|
|
219
|
+
helloagents install codex # specify target directly
|
|
226
220
|
helloagents install --all # install to all detected CLIs
|
|
227
|
-
|
|
228
|
-
|
|
229
|
-
|
|
230
|
-
helloagents
|
|
231
|
-
|
|
232
|
-
helloagents
|
|
233
|
-
|
|
234
|
-
### Uninstall
|
|
235
|
-
|
|
236
|
-
helloagents uninstall codex
|
|
237
|
-
|
|
238
|
-
helloagents uninstall --all
|
|
239
|
-
|
|
240
|
-
### Clean caches
|
|
241
|
-
|
|
242
|
-
helloagents clean
|
|
221
|
+
helloagents status # check installation status
|
|
222
|
+
helloagents version # check version
|
|
223
|
+
helloagents update # update + auto-sync all targets
|
|
224
|
+
helloagents update beta # switch branch + auto-sync
|
|
225
|
+
helloagents uninstall codex # uninstall from a CLI target
|
|
226
|
+
helloagents uninstall --all # uninstall from all targets
|
|
227
|
+
helloagents clean # clean caches
|
|
243
228
|
|
|
244
229
|
### Codex CLI example
|
|
245
230
|
|
|
@@ -266,13 +251,17 @@ L0 user memory (global preferences), L1 project knowledge base (structured docs
|
|
|
266
251
|
helloagents update
|
|
267
252
|
|
|
268
253
|
> ⚠️ **Codex CLI config.toml compatibility notes:** The following settings may affect HelloAGENTS:
|
|
269
|
-
> - `[features]` `steer = true` — changes input submission behavior, may interfere with workflow interaction
|
|
270
254
|
> - `[features]` `child_agents_md = true` — experimental, injects extra instructions that may conflict with HelloAGENTS
|
|
271
255
|
> - `project_doc_max_bytes` too low — default 32KB, AGENTS.md will be truncated (auto-set to 131072 during install)
|
|
272
256
|
> - `agent_max_depth = 1` — limits sub-agent nesting depth, recommend keeping default or ≥2
|
|
273
|
-
> - `agent_max_threads` too low — default 6, lower values limit parallel sub-agent scheduling
|
|
257
|
+
> - `agent_max_threads` too low — default 6, lower values limit parallel sub-agent scheduling (CSV batch mode recommends ≥16)
|
|
274
258
|
> - `[features]` `multi_agent = true` — must be enabled for sub-agent orchestration to work
|
|
275
|
-
> -
|
|
259
|
+
> - `[features]` `sqlite = true` — must be enabled for CSV batch orchestration (spawn_agents_on_csv)
|
|
260
|
+
> - Collab sub-agent scheduling requires Codex CLI feature gate to be enabled
|
|
261
|
+
>
|
|
262
|
+
> 💡 **Best practices:**
|
|
263
|
+
> - HelloAGENTS is optimized for Codex CLI — supports `high` and below reasoning effort levels. `xhigh` reasoning is **not supported** and may cause instruction-following issues
|
|
264
|
+
> - 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
|
|
276
265
|
|
|
277
266
|
### Claude Code example
|
|
278
267
|
|
|
@@ -303,25 +292,37 @@ L0 user memory (global preferences), L1 project knowledge base (structured docs
|
|
|
303
292
|
> - Agent Teams collaboration mode requires environment variable: `CLAUDE_CODE_EXPERIMENTAL_AGENT_TEAMS=1`
|
|
304
293
|
> - Parallel sub-agent count is managed automatically by the model, no user-side limit config needed
|
|
305
294
|
|
|
306
|
-
|
|
295
|
+
## Configuration
|
|
307
296
|
|
|
308
|
-
|
|
297
|
+
Customize workflow behavior via `config.json` after installation. Only include keys you want to override — missing keys use defaults.
|
|
309
298
|
|
|
310
|
-
|
|
311
|
-
# macOS / Linux
|
|
312
|
-
curl -fsSL https://raw.githubusercontent.com/hellowind777/helloagents/beta/install.sh | HELLOAGENTS_BRANCH=beta bash
|
|
299
|
+
**Storage locations (highest priority first):**
|
|
313
300
|
|
|
314
|
-
|
|
315
|
-
|
|
301
|
+
1. Project-level: `{project_root}/.helloagents/config.json` — current project only
|
|
302
|
+
2. Global: `~/.helloagents/config.json` — all projects
|
|
303
|
+
3. Built-in defaults
|
|
316
304
|
|
|
317
|
-
|
|
318
|
-
npx helloagents@beta
|
|
305
|
+
**Available keys:**
|
|
319
306
|
|
|
320
|
-
|
|
321
|
-
|
|
307
|
+
| Key | Type | Default | Description |
|
|
308
|
+
|-----|------|---------|-------------|
|
|
309
|
+
| `OUTPUT_LANGUAGE` | string | `zh-CN` | Language for AI output and KB files |
|
|
310
|
+
| `KB_CREATE_MODE` | int | `2` | KB creation: `0`=OFF, `1`=on-demand (prompt ~init), `2`=auto on code changes, `3`=always auto |
|
|
311
|
+
| `BILINGUAL_COMMIT` | int | `1` | Commit language: `0`=OUTPUT_LANGUAGE only, `1`=OUTPUT_LANGUAGE + English |
|
|
312
|
+
| `EVAL_MODE` | int | `1` | Clarification mode: `1`=progressive (1 question/round, max 5), `2`=one-shot (all at once, max 3) |
|
|
313
|
+
| `UPDATE_CHECK` | int | `72` | Update check cache TTL in hours: `0`=OFF |
|
|
314
|
+
| `CSV_BATCH_MAX` | int | `16` | CSV batch max concurrency: `0`=OFF, cap 64 (Codex CLI only) |
|
|
322
315
|
|
|
323
|
-
|
|
324
|
-
|
|
316
|
+
**Example:**
|
|
317
|
+
|
|
318
|
+
```json
|
|
319
|
+
{
|
|
320
|
+
"KB_CREATE_MODE": 0,
|
|
321
|
+
"EVAL_MODE": 2
|
|
322
|
+
}
|
|
323
|
+
```
|
|
324
|
+
|
|
325
|
+
> File missing or unparseable is silently skipped with defaults applied. Unknown keys produce a warning and are ignored.
|
|
325
326
|
|
|
326
327
|
## How It Works
|
|
327
328
|
|
|
@@ -333,21 +334,6 @@ To install from the `beta` branch, append `@beta` to the repository URL:
|
|
|
333
334
|
6. Three-layer memory (user / project KB / session) preserves context across sessions.
|
|
334
335
|
7. Stage chain completes with verified output and optional knowledge base sync.
|
|
335
336
|
|
|
336
|
-
## Repository Guide
|
|
337
|
-
|
|
338
|
-
- AGENTS.md: router and workflow protocol
|
|
339
|
-
- SKILL.md: skill discovery metadata for CLI targets
|
|
340
|
-
- pyproject.toml: package metadata (v2.2.16)
|
|
341
|
-
- helloagents/cli.py: installer entry
|
|
342
|
-
- helloagents/functions: workflow commands
|
|
343
|
-
- helloagents/stages: design, develop
|
|
344
|
-
- helloagents/services: knowledge, package, memory and support services
|
|
345
|
-
- helloagents/rules: state, cache, tools, scaling
|
|
346
|
-
- helloagents/rlm: role library and orchestration helpers
|
|
347
|
-
- helloagents/hooks: Claude Code and Codex CLI hooks configs
|
|
348
|
-
- helloagents/scripts: automation scripts
|
|
349
|
-
- helloagents/templates: KB and plan templates
|
|
350
|
-
|
|
351
337
|
## In-Chat Workflow Commands
|
|
352
338
|
|
|
353
339
|
These commands run inside AI chat, not your system shell.
|
|
@@ -366,6 +352,160 @@ These commands run inside AI chat, not your system shell.
|
|
|
366
352
|
| ~rlm | role orchestration (spawn / agents / resume / team) |
|
|
367
353
|
| ~status / ~help | status and help |
|
|
368
354
|
|
|
355
|
+
## Usage Guide
|
|
356
|
+
|
|
357
|
+
### Three Workflow Modes
|
|
358
|
+
|
|
359
|
+
| Mode | Description | When to use |
|
|
360
|
+
|------|-------------|-------------|
|
|
361
|
+
| `~auto` | Full autonomous flow from requirement to verified implementation (Evaluate → Design → Develop → Verify) | Clear requirement, want end-to-end delivery |
|
|
362
|
+
| `~plan` | Planning only, generates a proposal package then stops — no code written | Want to review the plan before committing |
|
|
363
|
+
| `~exec` | Skip evaluation and design, execute an existing plan package directly | After `~plan` review, ready to implement |
|
|
364
|
+
|
|
365
|
+
Typical pattern: `~plan` first → review → `~exec` to implement. Or just `~auto` for one-shot delivery.
|
|
366
|
+
|
|
367
|
+
### Interactive vs Delegated Mode
|
|
368
|
+
|
|
369
|
+
When `~auto` or `~plan` presents its confirmation, you choose:
|
|
370
|
+
|
|
371
|
+
- **Interactive (default):** pauses at key decision points (plan selection, failure handling)
|
|
372
|
+
- **Delegated (fully automatic):** auto-advances all stages, auto-selects recommended options, only pauses on EHRB risk
|
|
373
|
+
- **Plan-only delegated:** fully automatic but stops after design, never enters development
|
|
374
|
+
|
|
375
|
+
Without `~` commands, plain-text input is automatically routed to R0–R3 based on complexity.
|
|
376
|
+
|
|
377
|
+
### Requirement Evaluation
|
|
378
|
+
|
|
379
|
+
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:
|
|
380
|
+
|
|
381
|
+
- `EVAL_MODE=1` (default, progressive): asks 1 lowest-scoring dimension per round, up to 5 rounds
|
|
382
|
+
- `EVAL_MODE=2` (one-shot): asks all low-scoring dimensions at once, up to 3 rounds
|
|
383
|
+
|
|
384
|
+
Context inferred from the existing codebase counts toward the score automatically. Say "skip evaluation / just do it" to bypass the questioning phase.
|
|
385
|
+
|
|
386
|
+
### Parallel Design Proposals
|
|
387
|
+
|
|
388
|
+
In the R3 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).
|
|
389
|
+
|
|
390
|
+
- Interactive mode: user selects a proposal or requests re-generation (max 1 retry)
|
|
391
|
+
- Delegated mode: recommended proposal is auto-selected
|
|
392
|
+
- R2 simplified path skips multi-proposal comparison and goes directly to planning
|
|
393
|
+
|
|
394
|
+
### Auto Dependency Management
|
|
395
|
+
|
|
396
|
+
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:
|
|
397
|
+
|
|
398
|
+
- Declared but missing dependencies: auto-installed
|
|
399
|
+
- New dependencies required by tasks: auto-added with declaration file updated
|
|
400
|
+
- Ambiguous dependencies: user is asked before installing
|
|
401
|
+
|
|
402
|
+
### Quality Verification (Ralph Loop & Break-loop)
|
|
403
|
+
|
|
404
|
+
**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.
|
|
405
|
+
|
|
406
|
+
**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:
|
|
407
|
+
|
|
408
|
+
1. Root cause classification (logic error / type mismatch / missing dependency / environment / design flaw)
|
|
409
|
+
2. Why previous fixes didn't work
|
|
410
|
+
3. Prevention mechanism suggestions
|
|
411
|
+
4. Systemic scan — same issue in other modules?
|
|
412
|
+
5. Lessons learned recorded in the acceptance report
|
|
413
|
+
|
|
414
|
+
### Custom Command Extension
|
|
415
|
+
|
|
416
|
+
Create `.helloagents/commands/` in your project and drop in Markdown files — the filename becomes the command name:
|
|
417
|
+
|
|
418
|
+
.helloagents/commands/deploy.md → ~deploy
|
|
419
|
+
.helloagents/commands/release.md → ~release
|
|
420
|
+
|
|
421
|
+
File content defines the execution rules. The system applies a lightweight gate (requirement understanding + EHRB check).
|
|
422
|
+
|
|
423
|
+
### Smart Commit (~commit)
|
|
424
|
+
|
|
425
|
+
`~commit` does more than generate a message:
|
|
426
|
+
|
|
427
|
+
- Analyzes `git diff` to auto-generate Conventional Commits formatted messages
|
|
428
|
+
- Pre-commit quality checks (code-doc consistency, test coverage, verification commands)
|
|
429
|
+
- Auto-excludes sensitive files (`.env`, `*.pem`, `*.key`, etc.) — never runs `git add .`
|
|
430
|
+
- Shows file list before staging, supports exclusion
|
|
431
|
+
- Options: local commit only / commit + push / commit + push + create PR
|
|
432
|
+
- Bilingual commit messages when `BILINGUAL_COMMIT=1`
|
|
433
|
+
|
|
434
|
+
### Manual Sub-Agent Invocation
|
|
435
|
+
|
|
436
|
+
Beyond automatic dispatch, you can manually invoke specific roles:
|
|
437
|
+
|
|
438
|
+
~rlm spawn reviewer "review src/api/ for security issues"
|
|
439
|
+
~rlm spawn writer "generate API reference docs"
|
|
440
|
+
~rlm spawn reviewer,synthesizer "analyze and summarize the auth module" # parallel
|
|
441
|
+
|
|
442
|
+
Available roles: `reviewer` (code review), `synthesizer` (multi-source synthesis), `kb_keeper` (KB maintenance), `pkg_keeper` (plan package management), `writer` (documentation).
|
|
443
|
+
|
|
444
|
+
### Multi-Terminal Collaboration
|
|
445
|
+
|
|
446
|
+
Multiple terminals (across different CLIs) can share a task list:
|
|
447
|
+
|
|
448
|
+
# Terminal A
|
|
449
|
+
hellotasks=my-project codex
|
|
450
|
+
|
|
451
|
+
# Terminal B
|
|
452
|
+
hellotasks=my-project claude
|
|
453
|
+
|
|
454
|
+
Commands once enabled:
|
|
455
|
+
|
|
456
|
+
~rlm tasks # view shared task list
|
|
457
|
+
~rlm tasks available # see unclaimed tasks
|
|
458
|
+
~rlm tasks claim <id> # claim a task
|
|
459
|
+
~rlm tasks complete <id> # mark done
|
|
460
|
+
~rlm tasks add "task title" # add a new task
|
|
461
|
+
|
|
462
|
+
Tasks are stored in `{KB_ROOT}/tasks/` with file locking to prevent concurrent conflicts.
|
|
463
|
+
|
|
464
|
+
### KB Auto-Sync & CHANGELOG
|
|
465
|
+
|
|
466
|
+
The knowledge base syncs automatically at these points:
|
|
467
|
+
|
|
468
|
+
- After every development stage, `kb_keeper` sub-agent syncs module docs to reflect actual code
|
|
469
|
+
- After every R1/R2/R3 task completion, CHANGELOG is auto-appended
|
|
470
|
+
- On session end (Claude Code Stop Hook), KB sync + L2 session summary write triggered asynchronously
|
|
471
|
+
|
|
472
|
+
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.
|
|
473
|
+
|
|
474
|
+
`KB_CREATE_MODE` controls automatic behavior: `0`=off, `1`=prompt on demand, `2`=auto on code changes (default), `3`=always auto.
|
|
475
|
+
|
|
476
|
+
### Worktree Isolation
|
|
477
|
+
|
|
478
|
+
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.
|
|
479
|
+
|
|
480
|
+
### CSV Batch Orchestration (Codex CLI)
|
|
481
|
+
|
|
482
|
+
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.
|
|
483
|
+
|
|
484
|
+
- Progress tracked in real-time via `agent_job_progress` events (pending/running/completed/failed/ETA)
|
|
485
|
+
- State persisted in SQLite for crash recovery
|
|
486
|
+
- Partial failures still export results with failure summary
|
|
487
|
+
- Heterogeneous tasks automatically fall back to `spawn_agent` sequential dispatch
|
|
488
|
+
- Configure concurrency via `CSV_BATCH_MAX` (default 16, max 64, set to 0 to disable)
|
|
489
|
+
|
|
490
|
+
### Update Check
|
|
491
|
+
|
|
492
|
+
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.
|
|
493
|
+
|
|
494
|
+
## Repository Guide
|
|
495
|
+
|
|
496
|
+
- AGENTS.md: router and workflow protocol
|
|
497
|
+
- SKILL.md: skill discovery metadata for CLI targets
|
|
498
|
+
- pyproject.toml: package metadata (v2.3.3)
|
|
499
|
+
- helloagents/cli.py: installer entry
|
|
500
|
+
- helloagents/functions: workflow commands (15)
|
|
501
|
+
- helloagents/stages: design, develop
|
|
502
|
+
- helloagents/services: knowledge, package, memory and support services
|
|
503
|
+
- helloagents/rules: state, cache, tools, scaling, evaluation, sub-agent protocols
|
|
504
|
+
- helloagents/rlm: role library and orchestration helpers
|
|
505
|
+
- helloagents/hooks: Claude Code and Codex CLI hooks configs
|
|
506
|
+
- helloagents/scripts: automation scripts
|
|
507
|
+
- helloagents/templates: KB and plan templates
|
|
508
|
+
|
|
369
509
|
## FAQ
|
|
370
510
|
|
|
371
511
|
- Q: Is this a Python CLI tool or prompt package?
|
|
@@ -402,7 +542,27 @@ These commands run inside AI chat, not your system shell.
|
|
|
402
542
|
|
|
403
543
|
## Version History
|
|
404
544
|
|
|
405
|
-
### v2.
|
|
545
|
+
### v2.3.3 (current)
|
|
546
|
+
|
|
547
|
+
- AGENTS.md slimmed from 1186 to ~700 lines (-41%), reducing risk of LLMs selectively ignoring rules
|
|
548
|
+
- G4 evaluation details, G9/G10 sub-agent protocols extracted to on-demand module files via G7
|
|
549
|
+
- Sub-agent rule file (subagent.md) reduced from 26KB to 1.4KB (-94%)
|
|
550
|
+
- Eliminated cross-module reference risks by inlining critical rules at usage sites
|
|
551
|
+
- inject_context.py gains module-load signals to ensure rule recovery after context compaction
|
|
552
|
+
|
|
553
|
+
### v2.3.0
|
|
554
|
+
|
|
555
|
+
- Comprehensive cross-audit fix: unified role output format, normalized path references, code-doc consistency alignment
|
|
556
|
+
- Quality verification loop (Ralph Loop): auto-verify after sub-agent completion, block and feedback on failure
|
|
557
|
+
- Auto context injection for sub-agents and rule reinforcement for main agent
|
|
558
|
+
- Deep 5-dimension root cause analysis on repeated failures (break-loop)
|
|
559
|
+
- Auto-inject project technical guidelines before sub-agent development
|
|
560
|
+
- Pre-commit quality checks (code-doc consistency, test coverage, verification commands)
|
|
561
|
+
- Worktree isolation for parallel editing
|
|
562
|
+
- Custom command extension (.helloagents/commands/)
|
|
563
|
+
- Auto-append Git author info to CHANGELOG entries
|
|
564
|
+
|
|
565
|
+
### v2.2.16
|
|
406
566
|
|
|
407
567
|
- Refactored evaluation dimension system with dimension isolation rule, pass threshold tuned to 8/10. Options are user-need-driven, organized by style direction rather than complexity tiers (e.g. UI design offers different styles instead of simple/medium/complex); recommended option points to the most complete deliverable, derived from recommendation principles and scoring criteria rather than hardcoded
|
|
408
568
|
- Proposal design requires both implementation path and deliverable design direction to differ across alternatives, each sub-agent independently outputs a complete proposal including presentation direction, style, and experience
|
|
@@ -415,73 +575,6 @@ These commands run inside AI chat, not your system shell.
|
|
|
415
575
|
- Adjusted Codex CLI memory limit to 128 KiB to prevent rules file truncation
|
|
416
576
|
- Improved recommendation option generation rules, proposal differentiation requirements, and evaluation scoring criteria
|
|
417
577
|
|
|
418
|
-
### v2.2.14
|
|
419
|
-
|
|
420
|
-
- DAG dependency scheduling for task execution (depends_on, topological sort, layer-by-layer parallel dispatch with failure propagation)
|
|
421
|
-
- Graded retry and standardized sub-agent return format with scope verification
|
|
422
|
-
- Sub-agent orchestration paradigm: four-step method, prompt template, behavior constraints (route-skip, output format)
|
|
423
|
-
- Execution path hardening: explicit R1 upgrade triggers, DESIGN retry limits, DEVELOP entry/exit conditions
|
|
424
|
-
- Workflow rule audit: terminology and format consistency, redundancy cleanup
|
|
425
|
-
|
|
426
|
-
### v2.2.13
|
|
427
|
-
|
|
428
|
-
- R3 design proposals default ≥3 parallel, parallel batch limit ≤6, explicit sub-agent count principle (count = independent work units, no vague wording), add sub-agent orchestration config tips to README
|
|
429
|
-
|
|
430
|
-
### v2.2.12
|
|
431
|
-
|
|
432
|
-
- Comprehensive parallel sub-agent orchestration across all flows and commands, extend G10 coverage, eliminate hardcoded agent counts, add universal parallel information gathering principle
|
|
433
|
-
|
|
434
|
-
### v2.2.11
|
|
435
|
-
|
|
436
|
-
- Three-stage gate model: merge analysis into design stage (EVALUATE → DESIGN → DEVELOP), optimize stop points and fix sub-agent orchestration consistency
|
|
437
|
-
|
|
438
|
-
### v2.2.10
|
|
439
|
-
|
|
440
|
-
- Streamline sub-agent roles and integrate native multi-agent orchestration for all supported CLIs
|
|
441
|
-
|
|
442
|
-
### v2.2.9
|
|
443
|
-
|
|
444
|
-
- Comprehensive Windows file-locking fix: preemptive unlock and rename-aside fallback for install/update/uninstall/clean
|
|
445
|
-
|
|
446
|
-
### v2.2.8
|
|
447
|
-
|
|
448
|
-
- Codex CLI attention optimization for more stable HelloAGENTS execution
|
|
449
|
-
|
|
450
|
-
### v2.2.7
|
|
451
|
-
|
|
452
|
-
- **G12 Hooks integration spec:** 9 Claude Code lifecycle hooks + Codex CLI notify hook
|
|
453
|
-
- **Auto-deploy Hooks:** auto-deploy and clean up Hooks config during install/uninstall
|
|
454
|
-
- **Codex CLI native sub-agent:** G10 adds spawn_agent protocol with cross-CLI parallel scheduling
|
|
455
|
-
- **Agent Teams protocol:** G10 adds Claude Code multi-role collaboration protocol
|
|
456
|
-
- **SKILL integration:** auto-deploy SKILL.md to skills discovery directory for all CLI targets
|
|
457
|
-
- **RLM command expansion:** add ~rlm agents/resume/team subcommands with parallel multi-role dispatch
|
|
458
|
-
- **Stage parallel optimization:** parallel rules for develop stage, serial annotation for design
|
|
459
|
-
- **Memory v2 bridge:** add Codex Memory v2 bridge protocol
|
|
460
|
-
- **Script modularization:** extract config_helpers.py module
|
|
461
|
-
|
|
462
|
-
### v2.2.5
|
|
463
|
-
|
|
464
|
-
- **RLM sub-agent system:** 5 specialized roles + native sub-agents with automatic dispatch and session isolation
|
|
465
|
-
- **Five-dimension routing (R0–R3):** replaces legacy three-layer routing
|
|
466
|
-
- **Four-stage workflow + R1 fast flow:** stage chain (Evaluate → Analyze → Design → Develop) with R1 fast flow for single-point operations
|
|
467
|
-
- **Three-layer memory:** L0 user preferences, L1 project knowledge base, L2 session summaries
|
|
468
|
-
- **Three-layer EHRB:** keyword + semantic + tool-output safety detection
|
|
469
|
-
- **Package-first installer:** pip/uv install with `helloagents` interactive menu
|
|
470
|
-
- **15 workflow commands:** added ~rlm, ~validatekb, ~status
|
|
471
|
-
- **6 CLI targets:** added OpenCode support
|
|
472
|
-
- **Interactive installation menu:** multi-select target CLIs with one command
|
|
473
|
-
- **Auto locale detection:** CLI messages switch between Chinese and English based on system locale
|
|
474
|
-
- **Windows encoding fix:** UTF-8 safe subprocess handling on all platforms
|
|
475
|
-
- **Knowledge base service:** structured project docs auto-synced from code changes
|
|
476
|
-
- **Attention service:** live status tracking and progress snapshots
|
|
477
|
-
|
|
478
|
-
### v2.0.1 (legacy multi-bundle baseline)
|
|
479
|
-
|
|
480
|
-
- Multi-bundle distribution with manual copy-based installation
|
|
481
|
-
- Three-layer routing (Context → Tools → Intent)
|
|
482
|
-
- 4 workflow stages, 12 commands, 5 CLI targets
|
|
483
|
-
- No sub-agent system, no persistent memory
|
|
484
|
-
|
|
485
578
|
## Contributing
|
|
486
579
|
|
|
487
580
|
See CONTRIBUTING.md for contribution rules and PR checklist.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "helloagents",
|
|
3
|
-
"version": "2.
|
|
3
|
+
"version": "2.3.3-beta.1",
|
|
4
4
|
"type": "module",
|
|
5
5
|
"description": "HelloAGENTS - AI-native sub-agent orchestration framework for multi-CLI environments",
|
|
6
6
|
"author": "HelloWind",
|
|
@@ -16,7 +16,18 @@
|
|
|
16
16
|
"files": [
|
|
17
17
|
"bin/"
|
|
18
18
|
],
|
|
19
|
-
"keywords": [
|
|
19
|
+
"keywords": [
|
|
20
|
+
"ai",
|
|
21
|
+
"agent",
|
|
22
|
+
"claude",
|
|
23
|
+
"codex",
|
|
24
|
+
"gemini",
|
|
25
|
+
"qwen",
|
|
26
|
+
"grok",
|
|
27
|
+
"opencode",
|
|
28
|
+
"cli",
|
|
29
|
+
"workflow"
|
|
30
|
+
],
|
|
20
31
|
"engines": {
|
|
21
32
|
"node": ">=16"
|
|
22
33
|
}
|