helloagents 2.3.4-beta.1 → 2.3.5-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 +328 -60
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -8,7 +8,7 @@
|
|
|
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)
|
|
@@ -24,10 +24,14 @@
|
|
|
24
24
|
|
|
25
25
|
---
|
|
26
26
|
|
|
27
|
+
> [!IMPORTANT]
|
|
28
|
+
> **Looking for the old version of HelloAGENTS?** The legacy codebase has been moved to a separate archive repository: [helloagents-archive](https://github.com/hellowind777/helloagents-archive)
|
|
29
|
+
|
|
27
30
|
## Table of Contents
|
|
28
31
|
|
|
29
32
|
- [Before and After](#before-and-after)
|
|
30
33
|
- [Core Features](#core-features)
|
|
34
|
+
- [Sub-Agent Native Mapping](#sub-agent-native-mapping)
|
|
31
35
|
- [Quick Start](#quick-start)
|
|
32
36
|
- [Configuration](#configuration)
|
|
33
37
|
- [How It Works](#how-it-works)
|
|
@@ -39,6 +43,7 @@
|
|
|
39
43
|
- [Version History](#version-history)
|
|
40
44
|
- [Contributing](#contributing)
|
|
41
45
|
- [License](#license)
|
|
46
|
+
- [Next Steps](#next-steps)
|
|
42
47
|
|
|
43
48
|
## Before and After
|
|
44
49
|
|
|
@@ -112,6 +117,26 @@ L0 user memory (global preferences), L1 project knowledge base (structured docs
|
|
|
112
117
|
**Your gain:** context survives across sessions and projects.
|
|
113
118
|
</td>
|
|
114
119
|
</tr>
|
|
120
|
+
<tr>
|
|
121
|
+
<td width="50%" valign="top">
|
|
122
|
+
<img src="./readme_images/02-feature-icon-installer.svg" width="48" align="left">
|
|
123
|
+
|
|
124
|
+
**Extensibility & Customization**
|
|
125
|
+
|
|
126
|
+
Voice notifications (5 event sounds), 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.
|
|
127
|
+
|
|
128
|
+
**Your gain:** tailor the workflow to your team's needs without forking the codebase.
|
|
129
|
+
</td>
|
|
130
|
+
<td width="50%" valign="top">
|
|
131
|
+
<img src="./readme_images/03-feature-icon-workflow.svg" width="48" align="left">
|
|
132
|
+
|
|
133
|
+
**Multi-CLI Support**
|
|
134
|
+
|
|
135
|
+
One rule set works across Claude Code, Codex CLI, OpenCode, Gemini CLI, Qwen CLI, and Grok CLI. Automatic feature detection and graceful degradation ensure consistent experience regardless of CLI capabilities.
|
|
136
|
+
|
|
137
|
+
**Your gain:** switch between CLIs without relearning workflows or reconfiguring rules.
|
|
138
|
+
</td>
|
|
139
|
+
</tr>
|
|
115
140
|
</table>
|
|
116
141
|
|
|
117
142
|
### Sub-Agent Native Mapping
|
|
@@ -125,10 +150,50 @@ L0 user memory (global preferences), L1 project knowledge base (structured docs
|
|
|
125
150
|
| Qwen CLI | Built-in tool calls | Fallback to sequential execution |
|
|
126
151
|
| Grok CLI | Built-in tool calls | Fallback to sequential execution |
|
|
127
152
|
|
|
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
|
|
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 | Built-in agent mode | Sequential execution fallback |
|
|
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** | Latest | Built-in tool calls | Sequential execution fallback |
|
|
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/Gemini/Qwen/Grok use sequential execution fallback
|
|
184
|
+
- All features work with graceful degradation
|
|
185
|
+
- Hooks may not be available on all platforms
|
|
186
|
+
|
|
187
|
+
</details>
|
|
129
188
|
|
|
130
189
|
## Quick Start
|
|
131
190
|
|
|
191
|
+
> 💡 **Choose your installation method:**
|
|
192
|
+
> - **First-time users** → Method A (one-line script, recommended)
|
|
193
|
+
> - **Node.js developers** → Method B (npx)
|
|
194
|
+
> - **Python developers** → Method D (pip)
|
|
195
|
+
> - **Need isolated environment** → Method C (UV)
|
|
196
|
+
|
|
132
197
|
> ⚠️ **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.
|
|
133
198
|
|
|
134
199
|
> ⚠️ **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).
|
|
@@ -260,6 +325,7 @@ Additionally, HelloAGENTS provides: **five-dimension routing scoring** (action n
|
|
|
260
325
|
> - Collab sub-agent scheduling requires Codex CLI feature gate to be enabled
|
|
261
326
|
>
|
|
262
327
|
> 💡 **Best practices:**
|
|
328
|
+
> - Codex 0.110+ recommended for full feature set (collaboration_modes, nickname_candidates)
|
|
263
329
|
> - 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
330
|
> - 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
|
|
265
331
|
|
|
@@ -324,33 +390,109 @@ Customize workflow behavior via `config.json` after installation. Only include k
|
|
|
324
390
|
|
|
325
391
|
> File missing or unparseable is silently skipped with defaults applied. Unknown keys produce a warning and are ignored.
|
|
326
392
|
|
|
393
|
+
### Common Configuration Scenarios
|
|
394
|
+
|
|
395
|
+
<details>
|
|
396
|
+
<summary>📝 English-only projects</summary>
|
|
397
|
+
|
|
398
|
+
```json
|
|
399
|
+
{
|
|
400
|
+
"OUTPUT_LANGUAGE": "en-US",
|
|
401
|
+
"BILINGUAL_COMMIT": 0
|
|
402
|
+
}
|
|
403
|
+
```
|
|
404
|
+
All AI outputs, KB files, and commit messages will be in English only.
|
|
405
|
+
</details>
|
|
406
|
+
|
|
407
|
+
<details>
|
|
408
|
+
<summary>🚫 Disable automatic KB creation</summary>
|
|
409
|
+
|
|
410
|
+
```json
|
|
411
|
+
{
|
|
412
|
+
"KB_CREATE_MODE": 0
|
|
413
|
+
}
|
|
414
|
+
```
|
|
415
|
+
Knowledge base won't be created automatically. Use `~init` command when needed.
|
|
416
|
+
</details>
|
|
417
|
+
|
|
418
|
+
<details>
|
|
419
|
+
<summary>⚡ High-concurrency batch processing (Codex CLI)</summary>
|
|
420
|
+
|
|
421
|
+
```json
|
|
422
|
+
{
|
|
423
|
+
"CSV_BATCH_MAX": 32
|
|
424
|
+
}
|
|
425
|
+
```
|
|
426
|
+
Increase parallel CSV batch processing from 16 to 32 (max 64). Requires Codex CLI with CSV orchestration enabled.
|
|
427
|
+
</details>
|
|
428
|
+
|
|
429
|
+
<details>
|
|
430
|
+
<summary>🔕 Disable update checks</summary>
|
|
431
|
+
|
|
432
|
+
```json
|
|
433
|
+
{
|
|
434
|
+
"UPDATE_CHECK": 0
|
|
435
|
+
}
|
|
436
|
+
```
|
|
437
|
+
Skip version update checks entirely (not recommended for production use).
|
|
438
|
+
</details>
|
|
439
|
+
|
|
440
|
+
<details>
|
|
441
|
+
<summary>💬 One-shot clarification mode</summary>
|
|
442
|
+
|
|
443
|
+
```json
|
|
444
|
+
{
|
|
445
|
+
"EVAL_MODE": 2
|
|
446
|
+
}
|
|
447
|
+
```
|
|
448
|
+
Ask all clarification questions at once (max 3) instead of progressive mode (1 question per round, max 5).
|
|
449
|
+
</details>
|
|
450
|
+
|
|
327
451
|
## How It Works
|
|
328
452
|
|
|
329
|
-
|
|
330
|
-
|
|
331
|
-
|
|
332
|
-
|
|
333
|
-
|
|
334
|
-
|
|
335
|
-
|
|
453
|
+
**In short:** HelloAGENTS automatically selects processing depth based on task complexity — simple questions get fast responses, complex tasks go through the full evaluate→design→develop flow, with safety checks and memory retention throughout.
|
|
454
|
+
|
|
455
|
+
**Detailed flow:**
|
|
456
|
+
|
|
457
|
+
1. **Install & Deploy** — Run `helloagents` to select target CLI, auto-deploys config files and hooks
|
|
458
|
+
2. **Smart Routing** — Every input is auto-scored; simple queries get direct answers, complex tasks enter structured workflow
|
|
459
|
+
3. **Stage Progression** — Complex tasks advance through "Evaluate → Design → Develop" stages, each with clear deliverables
|
|
460
|
+
4. **Auto Orchestration** — System dispatches sub-agents and specialized roles based on complexity, parallelizes when possible
|
|
461
|
+
5. **Safety Guard** — Each step scans for destructive operations, risky actions require user confirmation
|
|
462
|
+
6. **Memory Retention** — User preferences, project knowledge, session context persist across sessions
|
|
463
|
+
7. **Verified Completion** — Stage chain completes with verified output, auto-syncs knowledge base
|
|
336
464
|
|
|
337
465
|
## In-Chat Workflow Commands
|
|
338
466
|
|
|
339
467
|
These commands run inside AI chat, not your system shell.
|
|
340
468
|
|
|
469
|
+
**Common Commands:**
|
|
470
|
+
|
|
341
471
|
| Command | Purpose |
|
|
342
472
|
|---|---|
|
|
343
473
|
| ~auto | full autonomous workflow |
|
|
344
474
|
| ~plan | planning and package generation |
|
|
345
475
|
| ~exec | execute existing package |
|
|
346
476
|
| ~init | initialize knowledge base |
|
|
477
|
+
| ~commit | generate commit message from context |
|
|
478
|
+
| ~status / ~help | status and help |
|
|
479
|
+
|
|
480
|
+
**Quality Checks:**
|
|
481
|
+
|
|
482
|
+
| Command | Purpose |
|
|
483
|
+
|---|---|
|
|
484
|
+
| ~test | run project tests |
|
|
485
|
+
| ~review | code review |
|
|
486
|
+
| ~validatekb | validate knowledge base |
|
|
487
|
+
|
|
488
|
+
**Advanced Features:**
|
|
489
|
+
|
|
490
|
+
| Command | Purpose |
|
|
491
|
+
|---|---|
|
|
347
492
|
| ~upgradekb | upgrade knowledge structure |
|
|
348
493
|
| ~clean / ~cleanplan | cleanup workflow artifacts |
|
|
349
|
-
| ~test / ~review / ~validatekb | quality checks |
|
|
350
|
-
| ~commit | generate commit message from context |
|
|
351
494
|
| ~rollback | rollback workflow state |
|
|
352
495
|
| ~rlm | role orchestration (spawn / agents / resume / team) |
|
|
353
|
-
| ~status / ~help | status and help |
|
|
354
496
|
|
|
355
497
|
## Usage Guide
|
|
356
498
|
|
|
@@ -495,56 +637,186 @@ On the first response of each session, the system silently checks for new versio
|
|
|
495
637
|
|
|
496
638
|
- AGENTS.md: router and workflow protocol
|
|
497
639
|
- SKILL.md: skill discovery metadata for CLI targets
|
|
498
|
-
- pyproject.toml: package metadata (v2.3.
|
|
640
|
+
- pyproject.toml: package metadata (v2.3.5)
|
|
499
641
|
- helloagents/cli.py: CLI entry point
|
|
500
642
|
- helloagents/_common.py: shared constants and utilities
|
|
501
|
-
- helloagents/core/: CLI management modules (install, uninstall, update, status)
|
|
643
|
+
- helloagents/core/: CLI management modules (install, uninstall, update, status, dispatcher, hooks settings)
|
|
502
644
|
- helloagents/functions: command definitions (15)
|
|
503
645
|
- helloagents/stages: design, develop
|
|
504
646
|
- helloagents/services: knowledge, package, memory and support services
|
|
505
|
-
- helloagents/rules: state, cache, tools, scaling,
|
|
647
|
+
- helloagents/rules: state, cache, tools, scaling, sub-agent protocols
|
|
506
648
|
- helloagents/rlm: role library and orchestration helpers
|
|
507
|
-
- helloagents/hooks: Claude Code and
|
|
508
|
-
- helloagents/scripts: automation scripts
|
|
649
|
+
- helloagents/hooks: Claude Code, Codex CLI, Gemini CLI, and Grok CLI hooks configs
|
|
650
|
+
- helloagents/scripts: automation scripts (sound notify, progress snapshot, safety guard, etc.)
|
|
651
|
+
- helloagents/agents: sub-agent definitions (5 RLM roles)
|
|
652
|
+
- helloagents/commands: custom command templates
|
|
653
|
+
- helloagents/assets: sound resources (5 event sounds)
|
|
509
654
|
- helloagents/templates: KB and plan templates
|
|
510
655
|
|
|
511
656
|
## FAQ
|
|
512
657
|
|
|
513
|
-
|
|
514
|
-
|
|
658
|
+
**Q: Is this a Python CLI tool or prompt package?**
|
|
659
|
+
|
|
660
|
+
A: Both. The CLI manages installation and updates, while the workflow behavior comes from AGENTS.md and documentation files. Think of it as a delivery system + intelligent workflow protocol.
|
|
661
|
+
|
|
662
|
+
**Q: Which target should I install?**
|
|
663
|
+
|
|
664
|
+
A: Choose the CLI you're actively using: `codex` (Codex CLI), `claude` (Claude Code), `gemini` (Gemini CLI), `qwen` (Qwen CLI), `grok` (Grok CLI), or `opencode` (OpenCode). You can install to multiple targets with `helloagents install --all`. See [CLI Compatibility Quick Reference](#cli-compatibility-quick-reference) for details.
|
|
665
|
+
|
|
666
|
+
**Q: What if a rules file already exists?**
|
|
667
|
+
|
|
668
|
+
A: HelloAGENTS automatically backs up non-HelloAGENTS files before replacement. Backups are timestamped and stored in your CLI's config directory. You can restore them anytime if needed.
|
|
669
|
+
|
|
670
|
+
**Q: What is RLM?**
|
|
515
671
|
|
|
516
|
-
-
|
|
517
|
-
A: Use the CLI you run: codex, claude, gemini, qwen, grok, or opencode.
|
|
672
|
+
A: Role Language Model — HelloAGENTS's sub-agent orchestration system. It includes 5 specialized roles (reviewer, synthesizer, kb_keeper, pkg_keeper, writer) plus native CLI sub-agents. Tasks are scheduled via DAG dependency analysis with parallel execution when possible. Learn more in [Usage Guide](#usage-guide).
|
|
518
673
|
|
|
519
|
-
|
|
520
|
-
A: Non-HelloAGENTS files are backed up before replacement.
|
|
674
|
+
**Q: Where does project knowledge go?**
|
|
521
675
|
|
|
522
|
-
-
|
|
523
|
-
A: Role Language Model — a sub-agent orchestration system with 5 specialized roles + native CLI sub-agents, DAG-based parallel scheduling, and standardized prompt/return format.
|
|
676
|
+
A: In the project-local `.helloagents/` directory. The knowledge base auto-syncs when code changes (controlled by `KB_CREATE_MODE` config). It includes module docs, CHANGELOG, session summaries, and custom commands. See [KB Auto-Sync & CHANGELOG](#kb-auto-sync--changelog).
|
|
524
677
|
|
|
525
|
-
|
|
526
|
-
A: In the project-local `.helloagents/` directory, auto-synced when code changes.
|
|
678
|
+
**Q: Does memory persist across sessions?**
|
|
527
679
|
|
|
528
|
-
|
|
529
|
-
A: Yes. L0 user memory is global, L1 project KB is per-project, L2 session summaries are auto-saved at stage transitions.
|
|
680
|
+
A: Yes, through three layers: L0 user memory (global preferences in `~/.helloagents/`), L1 project KB (per-project in `.helloagents/`), and L2 session summaries (auto-saved at stage transitions). Context survives even if you close and reopen your CLI.
|
|
530
681
|
|
|
531
|
-
|
|
532
|
-
A: Lifecycle hooks auto-deployed during installation. Claude Code gets 9 event hooks (safety checks, progress snapshots, KB sync, etc.); Codex CLI gets a notify hook for update checks. All optional — features degrade gracefully without hooks.
|
|
682
|
+
**Q: What are Hooks?**
|
|
533
683
|
|
|
534
|
-
-
|
|
535
|
-
|
|
684
|
+
A: Lifecycle hooks auto-deployed during installation. Claude Code gets 11 event hooks (safety checks, dangerous command guard, progress snapshots, KB sync, sound notifications, tool failure recovery, etc.); Codex CLI gets a notify hook for update and sound notifications; Gemini CLI and Grok CLI get hooks for context injection, progress snapshots, and sound notifications. All optional — features degrade gracefully when hooks aren't available. No manual configuration needed.
|
|
685
|
+
|
|
686
|
+
**Q: What is Agent Teams?**
|
|
687
|
+
|
|
688
|
+
A: An experimental Claude Code feature where multiple Claude Code instances collaborate as teammates with shared task lists and mailbox communication. Enable with `CLAUDE_CODE_EXPERIMENTAL_AGENT_TEAMS=1`. When unavailable, HelloAGENTS falls back to standard Task sub-agents. See [Multi-Terminal Collaboration](#multi-terminal-collaboration).
|
|
536
689
|
|
|
537
690
|
## Troubleshooting
|
|
538
691
|
|
|
539
|
-
|
|
540
|
-
|
|
541
|
-
|
|
542
|
-
|
|
543
|
-
|
|
692
|
+
### Command not found
|
|
693
|
+
|
|
694
|
+
**Problem:** `helloagents: command not found` after installation
|
|
695
|
+
|
|
696
|
+
**Diagnosis:** Install path not in system PATH
|
|
697
|
+
|
|
698
|
+
**Solution:**
|
|
699
|
+
- UV: Restart terminal after UV installation
|
|
700
|
+
- pip: Check `pip show helloagents` for install location, add to PATH
|
|
701
|
+
- Verify with `which helloagents` (Unix) or `where helloagents` (Windows)
|
|
702
|
+
|
|
703
|
+
**Verification:** Run `helloagents version`
|
|
704
|
+
|
|
705
|
+
---
|
|
706
|
+
|
|
707
|
+
### Package version unknown
|
|
708
|
+
|
|
709
|
+
**Problem:** Version shows as "unknown"
|
|
710
|
+
|
|
711
|
+
**Diagnosis:** Package metadata not available
|
|
712
|
+
|
|
713
|
+
**Solution:** Install the package first: `pip install git+https://github.com/hellowind777/helloagents.git` or use UV/npx methods
|
|
714
|
+
|
|
715
|
+
**Verification:** Run `helloagents version` — should show current version number
|
|
716
|
+
|
|
717
|
+
---
|
|
718
|
+
|
|
719
|
+
### Target not detected
|
|
720
|
+
|
|
721
|
+
**Problem:** CLI target not found during installation
|
|
722
|
+
|
|
723
|
+
**Diagnosis:** Config directory doesn't exist yet
|
|
724
|
+
|
|
725
|
+
**Solution:** Launch the target CLI at least once to create its config directory, then retry `helloagents install <target>`
|
|
726
|
+
|
|
727
|
+
**Verification:** Check config paths:
|
|
728
|
+
- Codex CLI: `~/.codex/`
|
|
729
|
+
- Claude Code: `~/.claude/`
|
|
730
|
+
- Others: see CLI documentation
|
|
731
|
+
|
|
732
|
+
---
|
|
733
|
+
|
|
734
|
+
### Custom rules overwritten
|
|
735
|
+
|
|
736
|
+
**Problem:** Custom rules replaced by HelloAGENTS
|
|
737
|
+
|
|
738
|
+
**Diagnosis:** Installation replaces existing files
|
|
739
|
+
|
|
740
|
+
**Solution:** Restore from timestamped backup in CLI config directory (e.g., `~/.codex/rules/AGENTS.md.backup.20260304_132146`)
|
|
741
|
+
|
|
742
|
+
**Verification:** Check backup files in config directory
|
|
743
|
+
|
|
744
|
+
---
|
|
745
|
+
|
|
746
|
+
### Images not rendering
|
|
747
|
+
|
|
748
|
+
**Problem:** README images don't display
|
|
749
|
+
|
|
750
|
+
**Diagnosis:** Missing image files or incorrect paths
|
|
751
|
+
|
|
752
|
+
**Solution:**
|
|
753
|
+
- Keep relative paths in README (e.g., `./readme_images/`)
|
|
754
|
+
- Ensure `readme_images/` folder is committed to repository
|
|
755
|
+
- Verify image files exist locally
|
|
756
|
+
|
|
757
|
+
**Verification:** Check `ls readme_images/` shows all referenced images
|
|
758
|
+
|
|
759
|
+
---
|
|
760
|
+
|
|
761
|
+
### CCswitch replaces HelloAGENTS config
|
|
762
|
+
|
|
763
|
+
**Problem:** After switching CCswitch profiles, HelloAGENTS stops working (workflow commands unrecognized, hooks not firing, rules missing)
|
|
764
|
+
|
|
765
|
+
**Diagnosis:** CCswitch replaces the entire CLI config directory (e.g., `~/.claude/`) when switching profiles, overwriting HelloAGENTS's hooks, permissions, and rule files
|
|
766
|
+
|
|
767
|
+
**Solution:** After switching CCswitch profiles, run one of these commands to restore HelloAGENTS:
|
|
768
|
+
|
|
769
|
+
helloagents install claude # reinstall to specific CLI target
|
|
770
|
+
helloagents update # update + auto-sync all installed targets
|
|
771
|
+
|
|
772
|
+
**Prevention:** v2.3.5 adds automatic configuration integrity check on session start — if HelloAGENTS config is missing or corrupted, a warning is displayed with recovery instructions
|
|
773
|
+
|
|
774
|
+
**Verification:** Run `helloagents status` to confirm all targets show as installed
|
|
775
|
+
|
|
776
|
+
---
|
|
777
|
+
|
|
778
|
+
### CCswitch configuration conflict
|
|
779
|
+
|
|
780
|
+
**Problem:** HelloAGENTS config reappears after uninstall when switching CCswitch profiles
|
|
781
|
+
|
|
782
|
+
**Diagnosis:** CCswitch saved HelloAGENTS settings before uninstall
|
|
783
|
+
|
|
784
|
+
**Solution:** After uninstalling HelloAGENTS, manually clean up HelloAGENTS-related settings (hooks, permissions, rules) from all saved CCswitch profiles
|
|
785
|
+
|
|
786
|
+
**Verification:** Check CCswitch profile directories for HelloAGENTS remnants
|
|
544
787
|
|
|
545
788
|
## Version History
|
|
546
789
|
|
|
547
|
-
### v2.3.
|
|
790
|
+
### v2.3.5 (current)
|
|
791
|
+
|
|
792
|
+
**New Features:**
|
|
793
|
+
- Voice notification system with 5 event sounds (complete, idle, confirm, error, warning) across Windows/macOS/Linux, with smart two-layer routing (stop_reason + G3 format icon detection)
|
|
794
|
+
- Claude Code hooks expanded from 9 to 11 lifecycle event types: added dangerous command guard (PreToolUse), session end cleanup (SessionEnd), and tool failure recovery suggestions (PostToolUseFailure)
|
|
795
|
+
- Hooks support expanded to Gemini CLI and Grok CLI (SessionStart, BeforeAgent/AfterAgent, PreCompress, PreToolUse, PostToolUse)
|
|
796
|
+
- Codex CLI 0.110 features: `collaboration_modes` for TUI interactive selection, `nickname_candidates` for agent role identification
|
|
797
|
+
- Configuration integrity check on session start (auto-detect config corruption or replacement by CCswitch etc.)
|
|
798
|
+
- Context compression pre-save with automatic progress snapshot (pre_compact.py, progress_snapshot.py — actual implementations replacing placeholder hooks)
|
|
799
|
+
- User-defined tool registration and orchestration — intelligent invocation of custom sub-agents, skills, MCP servers, and plugins
|
|
800
|
+
- Custom command extension support via `.helloagents/commands/*.md`
|
|
801
|
+
|
|
802
|
+
**Improvements:**
|
|
803
|
+
- Comprehensive audit fixes (21 issues: 6 HIGH + 9 MEDIUM + 6 LOW)
|
|
804
|
+
- Code quality: extracted 5 shared utility functions, eliminated circular dependencies
|
|
805
|
+
- Cross-platform: unified platform detection, consistent encoding handling
|
|
806
|
+
- Security: configuration backup before overwrite, placeholder validation
|
|
807
|
+
- Documentation: configuration rationale, compatibility verification notes
|
|
808
|
+
- Core architecture: new dispatcher module, Codex roles definition, Claude rules management, hooks settings manager
|
|
809
|
+
- Install/update script refactoring with persistent configuration
|
|
810
|
+
- Voice notification accuracy and false positive reduction (Codex client filtering, Windows sync playback)
|
|
811
|
+
- Sub-agent nickname optimization across CLIs
|
|
812
|
+
- Codex CLI interactive menu, persistent memory, and context compression optimization
|
|
813
|
+
- R2 simplified flow and evaluation module re-integration
|
|
814
|
+
- Context compression state persistence optimization
|
|
815
|
+
- Tool/Shell usage optimization
|
|
816
|
+
- CCswitch compatibility notes for configuration cleanup after uninstall
|
|
817
|
+
- SKILL discovery entry optimization
|
|
818
|
+
|
|
819
|
+
### v2.3.4
|
|
548
820
|
|
|
549
821
|
- Split 3 oversized files (>450 lines) into 6 independent modules
|
|
550
822
|
- Consolidated 9 CLI management scripts into core/ subpackage
|
|
@@ -552,14 +824,6 @@ On the first response of each session, the system silently checks for new versio
|
|
|
552
824
|
- Removed redundant backward-compatible re-exports
|
|
553
825
|
- Elevated Codex CLI routing protocol priority to prevent system prompt override
|
|
554
826
|
|
|
555
|
-
### v2.3.3
|
|
556
|
-
|
|
557
|
-
- AGENTS.md slimmed from 1186 to ~700 lines (-41%), reducing risk of LLMs selectively ignoring rules
|
|
558
|
-
- G4 evaluation details, G9/G10 sub-agent protocols extracted to on-demand module files via G7
|
|
559
|
-
- Sub-agent rule file (subagent.md) reduced from 26KB to 1.4KB (-94%)
|
|
560
|
-
- Eliminated cross-module reference risks by inlining critical rules at usage sites
|
|
561
|
-
- inject_context.py gains module-load signals to ensure rule recovery after context compaction
|
|
562
|
-
|
|
563
827
|
### v2.3.0
|
|
564
828
|
|
|
565
829
|
- Comprehensive cross-audit fix: unified role output format, normalized path references, code-doc consistency alignment
|
|
@@ -572,19 +836,6 @@ On the first response of each session, the system silently checks for new versio
|
|
|
572
836
|
- Custom command extension (.helloagents/commands/)
|
|
573
837
|
- Auto-append Git author info to CHANGELOG entries
|
|
574
838
|
|
|
575
|
-
### v2.2.16
|
|
576
|
-
|
|
577
|
-
- 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
|
|
578
|
-
- 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
|
|
579
|
-
- Proposal evaluation criteria optimized: user value weight is always no less than any other single dimension, evaluation dimensions dynamically adjusted by project context
|
|
580
|
-
- Universal task type support: generalized evaluation, follow-up, and proposal design terminology from programming-specific to documents, design, general tasks and more
|
|
581
|
-
- Added sub-agent DAG dependency scheduling with topological sort, layer-by-layer parallel dispatch, and failure propagation
|
|
582
|
-
- Dynamic sub-agent parallel count based on independent work units, eliminated hardcoded limits
|
|
583
|
-
- Unified output format: structured display for score breakdowns, follow-up options, and confirmation messages
|
|
584
|
-
- Streamlined execution paths with shorter stage chains and step-level on-demand module loading
|
|
585
|
-
- Adjusted Codex CLI memory limit to 128 KiB to prevent rules file truncation
|
|
586
|
-
- Improved recommendation option generation rules, proposal differentiation requirements, and evaluation scoring criteria
|
|
587
|
-
|
|
588
839
|
## Contributing
|
|
589
840
|
|
|
590
841
|
See CONTRIBUTING.md for contribution rules and PR checklist.
|
|
@@ -593,6 +844,23 @@ See CONTRIBUTING.md for contribution rules and PR checklist.
|
|
|
593
844
|
|
|
594
845
|
This project is dual-licensed: Code under Apache-2.0, Documentation under CC BY 4.0. See [LICENSE.md](./LICENSE.md).
|
|
595
846
|
|
|
847
|
+
## Next Steps
|
|
848
|
+
|
|
849
|
+
**Getting Started:**
|
|
850
|
+
- Install HelloAGENTS using your preferred method: [Quick Start](#quick-start)
|
|
851
|
+
- Try `~auto` with a simple task to see the full workflow in action
|
|
852
|
+
- Explore `~plan` + `~exec` for more control over the process
|
|
853
|
+
|
|
854
|
+
**Learn More:**
|
|
855
|
+
- Read [Usage Guide](#usage-guide) for detailed workflow patterns
|
|
856
|
+
- Check [Configuration](#configuration) to customize behavior
|
|
857
|
+
- Review [In-Chat Workflow Commands](#in-chat-workflow-commands) reference
|
|
858
|
+
|
|
859
|
+
**Community & Support:**
|
|
860
|
+
- Star the repo if HelloAGENTS helps your workflow
|
|
861
|
+
- Report issues or request features on [GitHub Issues](https://github.com/hellowind777/helloagents/issues)
|
|
862
|
+
- Contribute improvements: see [CONTRIBUTING.md](./CONTRIBUTING.md)
|
|
863
|
+
|
|
596
864
|
---
|
|
597
865
|
|
|
598
866
|
<div align="center">
|