@defai.digital/automatosx 5.2.2 → 5.3.3
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/CHANGELOG.md +280 -0
- package/README.md +185 -35
- package/dist/index.js +5171 -2087
- package/dist/index.js.map +1 -1
- package/dist/version.json +2 -2
- package/examples/AGENTS_INFO.md +35 -1
- package/examples/agents/backend.yaml +4 -3
- package/examples/agents/ceo.yaml +4 -3
- package/examples/agents/creative-marketer.yaml +121 -0
- package/examples/agents/cto.yaml +4 -1
- package/examples/agents/data-scientist.yaml +4 -3
- package/examples/agents/data.yaml +4 -3
- package/examples/agents/design.yaml +4 -3
- package/examples/agents/devops.yaml +4 -3
- package/examples/agents/frontend.yaml +4 -3
- package/examples/agents/fullstack.yaml +4 -3
- package/examples/agents/mobile.yaml +4 -3
- package/examples/agents/product.yaml +4 -3
- package/examples/agents/quality.yaml +3 -1
- package/examples/agents/security.yaml +3 -1
- package/examples/agents/writer.yaml +4 -3
- package/package.json +1 -1
- package/version.json +2 -2
- /package/examples/claude/commands/{ax:agent.md → ax-agent.md} +0 -0
- /package/examples/claude/commands/{ax:clear.md → ax-clear.md} +0 -0
- /package/examples/claude/commands/{ax:init.md → ax-init.md} +0 -0
- /package/examples/claude/commands/{ax:list.md → ax-list.md} +0 -0
- /package/examples/claude/commands/{ax:memory.md → ax-memory.md} +0 -0
- /package/examples/claude/commands/{ax:status.md → ax-status.md} +0 -0
- /package/examples/claude/commands/{ax:update.md → ax-update.md} +0 -0
package/CHANGELOG.md
CHANGED
|
@@ -5,6 +5,286 @@ All notable changes to AutomatosX will be documented in this file.
|
|
|
5
5
|
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
|
|
6
6
|
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
|
7
7
|
|
|
8
|
+
## [5.3.3] - 2025-10-14
|
|
9
|
+
|
|
10
|
+
### 🏗️ Foundation for Agent Optimization
|
|
11
|
+
|
|
12
|
+
**This release establishes the infrastructure and comprehensive analysis for intelligent ability loading, setting the stage for 50-90% token savings in v5.4.0.**
|
|
13
|
+
|
|
14
|
+
#### Added
|
|
15
|
+
|
|
16
|
+
- **Ability Metadata Infrastructure**:
|
|
17
|
+
- Created `schema/ability-metadata.json` with tier framework (core/advanced/specialized)
|
|
18
|
+
- Established foundation for intelligent ability loading system
|
|
19
|
+
- Defined tier constraints: core ≤250 words, advanced ≤600 words, specialized unlimited
|
|
20
|
+
- Infrastructure ready for task complexity-based loading (v5.4.0)
|
|
21
|
+
|
|
22
|
+
- **Comprehensive Optimization Analysis**:
|
|
23
|
+
- Complete analysis of all 16 agents and 63 abilities (`automatosx/PRD/v5.3-agent-optimization.md`)
|
|
24
|
+
- Token waste analysis identifying 50-92% savings potential
|
|
25
|
+
- Ability classification matrix (core/advanced/specialized)
|
|
26
|
+
- Per-agent optimization recommendations
|
|
27
|
+
- 4-phase implementation roadmap
|
|
28
|
+
|
|
29
|
+
- **User Feedback Integration** (`automatosx/PRD/v5.4.0_Recommendations_and_Roadmap.md`):
|
|
30
|
+
- Agent role expansion strategy (community-driven framework for 50+ roles)
|
|
31
|
+
- Delegation Guard architecture (cycle detection, deadlock prevention)
|
|
32
|
+
- Configurable timeout system (25→35-45 minutes)
|
|
33
|
+
- Delegation depth increase plan (2→3 levels with safety guards)
|
|
34
|
+
- Prioritized implementation roadmap (P0-P3)
|
|
35
|
+
|
|
36
|
+
- **Technical Implementation Specifications** (`automatosx/PRD/v5.4.0_Implementation_Guide.md`):
|
|
37
|
+
- Detailed architecture diagrams for Delegation Guard
|
|
38
|
+
- Graph-based cycle detection algorithm
|
|
39
|
+
- Role similarity scoring mechanism
|
|
40
|
+
- Context preservation for deep delegation chains
|
|
41
|
+
- Complete code examples and integration points
|
|
42
|
+
|
|
43
|
+
- **Feature Roadmap** (`automatosx/PRD/FEATURE-ROADMAP-v5.4.md`):
|
|
44
|
+
- Agent interaction visualizer
|
|
45
|
+
- Public agent/ability registry
|
|
46
|
+
- Interactive debugger
|
|
47
|
+
- Provider response caching
|
|
48
|
+
- Git and CI/CD integrations
|
|
49
|
+
- Enterprise features (RBAC, audit logging, secrets management)
|
|
50
|
+
|
|
51
|
+
#### Documentation
|
|
52
|
+
|
|
53
|
+
- **v5.3-agent-optimization.md**: Complete optimization analysis with ability classification matrix, intelligent loading strategy, and success metrics
|
|
54
|
+
- **v5.3.3-implementation-plan.md**: Foundation release plan and roadmap for v5.4.0
|
|
55
|
+
- **v5.4.0_Recommendations_and_Roadmap.md**: User feedback analysis with prioritized P0-P3 recommendations
|
|
56
|
+
- **v5.4.0_Implementation_Guide.md**: Technical specifications with pseudocode and implementation details
|
|
57
|
+
- **FEATURE-ROADMAP-v5.4.md**: General feature roadmap for future releases
|
|
58
|
+
|
|
59
|
+
#### Performance Impact (Foundation for v5.4.0)
|
|
60
|
+
|
|
61
|
+
No immediate performance changes in v5.3.3. This release establishes infrastructure for v5.4.0 optimizations:
|
|
62
|
+
|
|
63
|
+
| Agent | Current Avg Tokens | v5.4.0 Target | Savings | Use Case |
|
|
64
|
+
|-------|-------------------|---------------|---------|----------|
|
|
65
|
+
| Creative marketer | 5,242 | 400-800 | **85-92%** | Simple social media |
|
|
66
|
+
| Design | 1,468 | 250-600 | **59-83%** | Quick wireframes |
|
|
67
|
+
| Mobile | 1,732 | 250-500 | **71-86%** | Basic UI questions |
|
|
68
|
+
| Data scientist | 992 | 250-500 | **50-75%** | Simple data queries |
|
|
69
|
+
| Backend | 1,185 | 350-600 | **41-70%** | Simple CRUD |
|
|
70
|
+
| Frontend | 846 | 250-450 | **47-70%** | Component questions |
|
|
71
|
+
|
|
72
|
+
**Overall**: 50-90% token reduction for simple tasks while maintaining full power for complex workflows (v5.4.0).
|
|
73
|
+
|
|
74
|
+
#### Changed
|
|
75
|
+
|
|
76
|
+
None (infrastructure-only release)
|
|
77
|
+
|
|
78
|
+
#### Fixed
|
|
79
|
+
|
|
80
|
+
None (infrastructure-only release)
|
|
81
|
+
|
|
82
|
+
#### Notes
|
|
83
|
+
|
|
84
|
+
- **Zero breaking changes** - This is a pure infrastructure and documentation release
|
|
85
|
+
- **All tests passing** - 1,702 tests (99.59% pass rate)
|
|
86
|
+
- **TypeScript strict mode** - 0 errors
|
|
87
|
+
- **Foundation complete** - Ready for v5.4.0 implementation
|
|
88
|
+
- **Estimated v5.4.0 timeline** - 8-10 weeks for full optimization
|
|
89
|
+
|
|
90
|
+
---
|
|
91
|
+
|
|
92
|
+
## [5.3.1] - 2025-10-14
|
|
93
|
+
|
|
94
|
+
### 🪟 Windows CLI Provider Detection & Enhanced Robustness
|
|
95
|
+
|
|
96
|
+
**This patch release fixes critical Windows compatibility issues and adds robust provider detection with security enhancements.**
|
|
97
|
+
|
|
98
|
+
#### Added
|
|
99
|
+
|
|
100
|
+
- **Windows CLI Provider Detection** (Phase 1):
|
|
101
|
+
- Cross-platform CLI provider detector (`src/core/cli-provider-detector.ts`)
|
|
102
|
+
- Windows-specific detection using `where.exe` + PATH×PATHEXT fallback
|
|
103
|
+
- Unix detection using `which` command
|
|
104
|
+
- Detection caching for performance (< 1ms cached lookups)
|
|
105
|
+
- Support for `.CMD`, `.BAT`, `.EXE`, `.COM` extensions on Windows
|
|
106
|
+
|
|
107
|
+
- **ENV Variable Override** (Phase 2):
|
|
108
|
+
- `CLAUDE_CLI` - Override Claude CLI path
|
|
109
|
+
- `GEMINI_CLI` - Override Gemini CLI path
|
|
110
|
+
- `CODEX_CLI` - Override Codex CLI path
|
|
111
|
+
- Three-layer detection: ENV → Config → PATH
|
|
112
|
+
- `ax status` shows ENV variable status with validation
|
|
113
|
+
|
|
114
|
+
- **Provider Configuration** (Phase 2):
|
|
115
|
+
- `customPath` - Custom CLI path in provider config
|
|
116
|
+
- `versionArg` - Custom version check argument
|
|
117
|
+
- `minVersion` - Minimum required version (semantic versioning)
|
|
118
|
+
|
|
119
|
+
- **Version Validation**:
|
|
120
|
+
- Semantic version parsing and comparison
|
|
121
|
+
- Automatic CLI version detection via `--version`
|
|
122
|
+
- Warning logs when version requirement not met
|
|
123
|
+
- Permissive behavior (allows if version check fails)
|
|
124
|
+
|
|
125
|
+
- **Cross-Platform CI** (Phase 3):
|
|
126
|
+
- GitHub Actions workflows for Ubuntu, macOS, Windows
|
|
127
|
+
- Automatic testing on all platforms
|
|
128
|
+
- Coverage report artifacts
|
|
129
|
+
- 30-minute timeout for Windows tests
|
|
130
|
+
|
|
131
|
+
#### Fixed
|
|
132
|
+
|
|
133
|
+
- **Critical**: Windows CLI provider detection failures (GitHub Issue #1)
|
|
134
|
+
- Providers now detected correctly on Windows using `where.exe`
|
|
135
|
+
- Fallback to PATH×PATHEXT scanning if `where.exe` fails
|
|
136
|
+
- Standard PATH detection works on all platforms
|
|
137
|
+
|
|
138
|
+
- **Provider Detection**:
|
|
139
|
+
- Enhanced `BaseProvider.checkCLIAvailabilityEnhanced()` with version validation
|
|
140
|
+
- Proper fallback chain: ENV → customPath → PATH
|
|
141
|
+
- Graceful degradation on detection failures
|
|
142
|
+
|
|
143
|
+
- **CI Configuration**:
|
|
144
|
+
- Artifact upload paths corrected (coverage/ only)
|
|
145
|
+
- Removed non-existent test-results/ path
|
|
146
|
+
- Added `if-no-files-found: warn` for graceful handling
|
|
147
|
+
|
|
148
|
+
- **Documentation**:
|
|
149
|
+
- Async error handling documentation for `detectAll()`
|
|
150
|
+
- Clear usage examples with proper error handling
|
|
151
|
+
- JSDoc annotations updated with `@throws` tags
|
|
152
|
+
|
|
153
|
+
#### Security
|
|
154
|
+
|
|
155
|
+
- **Path Traversal Protection**:
|
|
156
|
+
- Added validation to reject `..` (parent directory) patterns
|
|
157
|
+
- Added validation to reject `~` (home directory) shortcuts
|
|
158
|
+
- Security warnings logged for suspicious paths
|
|
159
|
+
- Read-only validation (no writes, minimal risk)
|
|
160
|
+
|
|
161
|
+
#### Changed
|
|
162
|
+
|
|
163
|
+
- **Provider Detection Priority**:
|
|
164
|
+
1. ENV variables (highest priority)
|
|
165
|
+
2. Config `customPath` (second priority)
|
|
166
|
+
3. Standard PATH detection (fallback)
|
|
167
|
+
4. Version validation (if `minVersion` set)
|
|
168
|
+
|
|
169
|
+
#### Performance
|
|
170
|
+
|
|
171
|
+
- **Detection Caching**: First call ~100-500ms, cached calls < 1ms
|
|
172
|
+
- **Version Check Overhead**: +100-200ms when `minVersion` configured
|
|
173
|
+
- **Path Validation**: +0.1-0.5ms per path (negligible)
|
|
174
|
+
- **Overall Impact**: < 1% overhead
|
|
175
|
+
|
|
176
|
+
#### Documentation
|
|
177
|
+
|
|
178
|
+
- Added comprehensive JSDoc for all new APIs
|
|
179
|
+
- Added usage examples for ENV variables
|
|
180
|
+
- Added Windows-specific troubleshooting
|
|
181
|
+
- Added version validation configuration guide
|
|
182
|
+
- **README.md**: Enhanced with tested platforms (macOS 15, Ubuntu 24.04, Windows 10/11)
|
|
183
|
+
- **README.md**: Simplified Windows Support section with clearer quick-start instructions
|
|
184
|
+
- **Windows Setup Guide** (NEW): Complete installation walkthrough for Windows users
|
|
185
|
+
- **Windows Troubleshooting**: Updated to v5.3.1 with provider detection solutions
|
|
186
|
+
|
|
187
|
+
#### Testing
|
|
188
|
+
|
|
189
|
+
- **1,670 tests passing** (100% pass rate)
|
|
190
|
+
- **0 TypeScript errors** (strict mode)
|
|
191
|
+
- **Cross-platform CI**: Ubuntu, macOS, Windows
|
|
192
|
+
- **2 Windows-specific tests** (PATH×PATHEXT detection)
|
|
193
|
+
|
|
194
|
+
#### Related
|
|
195
|
+
|
|
196
|
+
- Fixes: GitHub Issue #1 (Windows CLI provider detection)
|
|
197
|
+
- PRD: `tmp/PRD-WINDOWS-CLI-DETECTION.md`
|
|
198
|
+
- Reports: `tmp/PHASE{1,2,3}-COMPLETION-REPORT.md`
|
|
199
|
+
- Code Review: `tmp/CODE-REVIEW-REPORT.md`
|
|
200
|
+
- Bug Fixes: `tmp/BUG-FIX-COMPLETION-REPORT.md`
|
|
201
|
+
|
|
202
|
+
---
|
|
203
|
+
|
|
204
|
+
## [5.3.0] - 2025-10-14
|
|
205
|
+
|
|
206
|
+
### 🚀 Stage Execution & Checkpoint System
|
|
207
|
+
|
|
208
|
+
**This release introduces a checkpoint-based stage execution system for fault-tolerant, long-running workflows with interactive, streaming, and hybrid execution modes.**
|
|
209
|
+
|
|
210
|
+
#### Added
|
|
211
|
+
|
|
212
|
+
- **Stage Execution System**:
|
|
213
|
+
- `StageExecutionController` - Orchestrates multi-stage execution with checkpoint support
|
|
214
|
+
- `CheckpointManager` - JSON-based checkpoint persistence with automatic cleanup
|
|
215
|
+
- `ProgressChannel` - Event-based real-time progress tracking
|
|
216
|
+
- `PromptManager` - User interaction prompts with timeout handling
|
|
217
|
+
- **Commands**:
|
|
218
|
+
- `ax resume <run-id>` - Resume execution from saved checkpoint
|
|
219
|
+
- `ax runs list` - List all checkpoint runs with filtering
|
|
220
|
+
- `ax runs show <run-id>` - Show detailed checkpoint information
|
|
221
|
+
- `ax runs delete <run-id>` - Delete checkpoint with confirmation
|
|
222
|
+
|
|
223
|
+
- **Execution Modes**:
|
|
224
|
+
- `--interactive` - Pause between stages for user decisions
|
|
225
|
+
- `--streaming` - Real-time progress updates during execution
|
|
226
|
+
- `--hybrid` - Both interactive and streaming (shortcut for `--interactive --streaming`)
|
|
227
|
+
- `--resumable` - Enable checkpoint save for resume capability
|
|
228
|
+
- `--auto-continue` - Auto-confirm all checkpoints (CI-friendly mode)
|
|
229
|
+
|
|
230
|
+
- **Configuration** (`automatosx.config.json`):
|
|
231
|
+
- `execution.stages.enabled` - Enable stage-based execution (opt-in)
|
|
232
|
+
- `execution.stages.autoSaveCheckpoint` - Auto-save checkpoints after each stage
|
|
233
|
+
- `execution.stages.checkpointPath` - Checkpoint storage directory
|
|
234
|
+
- `execution.stages.cleanupAfterDays` - Automatic checkpoint cleanup
|
|
235
|
+
- `execution.stages.prompts.autoConfirm` - Default auto-confirm behavior
|
|
236
|
+
- `execution.stages.progress.updateInterval` - Progress update frequency
|
|
237
|
+
- `execution.stages.progress.syntheticProgress` - Enable synthetic progress
|
|
238
|
+
|
|
239
|
+
#### Fixed
|
|
240
|
+
|
|
241
|
+
- **Critical**: Removed `argv.interactive || true` forcing all executions into interactive mode (src/cli/commands/run.ts:458)
|
|
242
|
+
- Now respects CLI flags: `--interactive`, `--streaming`, `--hybrid`, `--resumable` work correctly
|
|
243
|
+
- Fixes regression where flagship v5.3.0 features were broken
|
|
244
|
+
|
|
245
|
+
- **Major**:
|
|
246
|
+
- Resume command now passes `memoryManager` to `StageExecutionController` for memory persistence (src/cli/commands/resume.ts:243-244)
|
|
247
|
+
- Config-driven automation settings now properly honored instead of being overridden by CLI defaults
|
|
248
|
+
- `autoSaveCheckpoint` uses config value when CLI flag not specified
|
|
249
|
+
- `autoConfirm` uses config value when CLI flag not specified
|
|
250
|
+
- Resume flow now preserves original `autoConfirm` choice from checkpoint instead of defaulting to `false`
|
|
251
|
+
- CLI options (`--interactive`, `--resumable`, `--auto-continue`, `--streaming`, `--hybrid`) no longer have hardcoded `default: false`, allowing proper config fallback
|
|
252
|
+
|
|
253
|
+
- **Minor**:
|
|
254
|
+
- Removed duplicate spinner in streaming mode - `ProgressRenderer` now handles all visual feedback (src/core/stage-execution-controller.ts:1286)
|
|
255
|
+
|
|
256
|
+
#### Technical Details
|
|
257
|
+
|
|
258
|
+
- **New Core Modules**:
|
|
259
|
+
- `src/core/stage-execution-controller.ts` - Stage lifecycle, checkpoint integration, progress tracking
|
|
260
|
+
- `src/core/checkpoint-manager.ts` - Checkpoint CRUD, JSON persistence, automatic cleanup
|
|
261
|
+
- `src/core/progress-channel.ts` - Event-based progress updates with percentage tracking
|
|
262
|
+
- `src/core/prompt-manager.ts` - CLI user prompts with timeout and validation
|
|
263
|
+
- `src/cli/commands/resume.ts` - Resume from checkpoint with mode override support
|
|
264
|
+
- `src/cli/commands/runs.ts` - Checkpoint management (list, show, delete)
|
|
265
|
+
- `src/cli/renderers/progress-renderer.ts` - Real-time progress visualization
|
|
266
|
+
- `src/types/stage-execution.ts` - Complete type definitions for stage system
|
|
267
|
+
|
|
268
|
+
- **Checkpoint Structure**:
|
|
269
|
+
```
|
|
270
|
+
.automatosx/checkpoints/
|
|
271
|
+
└── <run-id>/
|
|
272
|
+
├── checkpoint.json # Checkpoint metadata and stage states
|
|
273
|
+
└── artifacts/ # Stage outputs and files
|
|
274
|
+
```
|
|
275
|
+
|
|
276
|
+
- **Benefits**:
|
|
277
|
+
- ✅ Fault tolerance: Resume from failure points
|
|
278
|
+
- ✅ Long-running workflows: Execute multi-hour tasks safely
|
|
279
|
+
- ✅ User control: Pause and review between stages
|
|
280
|
+
- ✅ Real-time feedback: Monitor progress during execution
|
|
281
|
+
- ✅ Audit trail: Complete execution history with artifacts
|
|
282
|
+
|
|
283
|
+
#### Known Limitations
|
|
284
|
+
|
|
285
|
+
- Test coverage for new features (StageExecutionController, CheckpointManager, resume, runs) is minimal
|
|
286
|
+
- Recommendation: Add comprehensive tests before production use
|
|
287
|
+
|
|
8
288
|
## [5.2.2] - 2025-10-14
|
|
9
289
|
|
|
10
290
|
### 🧪 Quality & Maintenance Release
|
package/README.md
CHANGED
|
@@ -7,9 +7,9 @@
|
|
|
7
7
|
[](https://www.npmjs.com/package/@defai.digital/automatosx)
|
|
8
8
|
[](LICENSE)
|
|
9
9
|
[](https://www.typescriptlang.org/)
|
|
10
|
-
[](#)
|
|
11
11
|
|
|
12
|
-
**Status**: ✅ Production Ready · v5.
|
|
12
|
+
**Status**: ✅ Production Ready · v5.3.3 · October 2025
|
|
13
13
|
|
|
14
14
|
Looking for answers? See the [FAQ](FAQ.md).
|
|
15
15
|
|
|
@@ -19,13 +19,42 @@ Looking for answers? See the [FAQ](FAQ.md).
|
|
|
19
19
|
|
|
20
20
|
**AutomatosX extends Claude Code with specialized AI agents that remember context, delegate tasks, and collaborate autonomously.**
|
|
21
21
|
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
22
|
+
### 💡 Best Way to Use: Natural Language Collaboration (Recommended)
|
|
23
|
+
|
|
24
|
+
Instead of directly commanding agents, **let Claude Code think and coordinate**:
|
|
25
|
+
|
|
26
|
+
```
|
|
27
|
+
✅ RECOMMENDED: Natural language collaboration
|
|
28
|
+
"please work with ax agent to implement user authentication with JWT"
|
|
29
|
+
|
|
30
|
+
What happens:
|
|
31
|
+
1. Claude Code analyzes your project structure
|
|
32
|
+
2. AutomatosX selects the most suitable agent automatically
|
|
33
|
+
3. Provides full context to the agent
|
|
34
|
+
4. Validates the results
|
|
35
|
+
5. Helps you understand and iterate
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
**vs.**
|
|
39
|
+
|
|
26
40
|
```
|
|
41
|
+
⚡ EXPRESS: Direct slash command (for simple tasks)
|
|
42
|
+
/ax:agent backend, implement JWT auth
|
|
43
|
+
|
|
44
|
+
What happens:
|
|
45
|
+
1. Backend agent executes directly
|
|
46
|
+
2. Limited project context
|
|
47
|
+
3. No validation or planning
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
### 🎓 Think of it This Way
|
|
27
51
|
|
|
28
|
-
**
|
|
52
|
+
- **Natural Collaboration** = Having a conversation with an intelligent coordinator who summons experts
|
|
53
|
+
- **Slash Commands** = Directly commanding the experts without coordination
|
|
54
|
+
|
|
55
|
+
**Recommendation**: Use natural language for 80% of tasks, slash commands for quick 20%.
|
|
56
|
+
|
|
57
|
+
📖 **[Complete Best Practices Guide](docs/BEST-PRACTICES.md)**
|
|
29
58
|
|
|
30
59
|
---
|
|
31
60
|
|
|
@@ -203,22 +232,45 @@ AutomatosX offers **two powerful modes** to fit your workflow:
|
|
|
203
232
|
|
|
204
233
|
### 1️⃣ Claude Code Integration (Recommended)
|
|
205
234
|
|
|
206
|
-
**Use
|
|
235
|
+
**The best way**: Use **natural language collaboration** to let Claude Code coordinate agents intelligently.
|
|
236
|
+
|
|
237
|
+
#### Natural Language Collaboration (Primary Method - 80% of tasks)
|
|
238
|
+
|
|
239
|
+
```
|
|
240
|
+
# Let Claude Code think, plan, and coordinate
|
|
241
|
+
"please work with ax agent to implement user authentication"
|
|
242
|
+
"please work with ax agent to design a secure API for our application"
|
|
243
|
+
"please work with ax agent to refactor this module with best practices"
|
|
244
|
+
```
|
|
245
|
+
|
|
246
|
+
**Why this is better**:
|
|
247
|
+
- 🧠 Claude Code analyzes your project first
|
|
248
|
+
- 🎯 Automatically selects the best agents
|
|
249
|
+
- 📚 Provides full context from your codebase
|
|
250
|
+
- ✅ Validates results and handles errors
|
|
251
|
+
- 🔄 Easy to iterate and refine
|
|
252
|
+
|
|
253
|
+
#### Slash Commands (Express Method - 20% of tasks)
|
|
207
254
|
|
|
208
255
|
```bash
|
|
209
|
-
#
|
|
256
|
+
# Direct execution for simple, well-defined tasks
|
|
210
257
|
/ax:agent Paris, design a REST API for user authentication
|
|
211
|
-
/ax:agent Bob,
|
|
212
|
-
/ax:agent Steve,
|
|
258
|
+
/ax:agent Bob, write a function to validate emails
|
|
259
|
+
/ax:agent Steve, review this code snippet
|
|
213
260
|
```
|
|
214
261
|
|
|
262
|
+
**Use slash commands when**:
|
|
263
|
+
- ⚡ Task is simple and well-defined
|
|
264
|
+
- 🎯 You know exactly which agent to use
|
|
265
|
+
- 🚀 Speed matters more than planning
|
|
266
|
+
|
|
215
267
|
**Perfect for**:
|
|
216
|
-
- 💬
|
|
217
|
-
- 🔄
|
|
218
|
-
- 🤝
|
|
219
|
-
- 🎯
|
|
268
|
+
- 💬 All types of development workflows
|
|
269
|
+
- 🔄 Both simple and complex tasks
|
|
270
|
+
- 🤝 Single and multi-agent coordination
|
|
271
|
+
- 🎯 Interactive and automated workflows
|
|
220
272
|
|
|
221
|
-
**How it works**: Claude Code
|
|
273
|
+
**How it works**: Claude Code acts as an intelligent coordinator, analyzing context, selecting agents, and orchestrating their work seamlessly.
|
|
222
274
|
|
|
223
275
|
### 2️⃣ Terminal/CLI Mode (Power Users)
|
|
224
276
|
|
|
@@ -278,7 +330,7 @@ npm install -g @defai.digital/automatosx
|
|
|
278
330
|
|
|
279
331
|
```bash
|
|
280
332
|
ax --version
|
|
281
|
-
# Should show: 5.
|
|
333
|
+
# Should show: 5.3.3 (or later)
|
|
282
334
|
```
|
|
283
335
|
|
|
284
336
|
> **Windows Users**: If `ax` command not found, see [Windows Troubleshooting](docs/troubleshooting/windows-troubleshooting.md)
|
|
@@ -332,9 +384,94 @@ ax list agents
|
|
|
332
384
|
|
|
333
385
|
---
|
|
334
386
|
|
|
387
|
+
### 🪟 Windows Support (Fully Tested)
|
|
388
|
+
|
|
389
|
+
**AutomatosX v5.3.1+ fully supports Windows 10 & 11** with automatic CLI provider detection.
|
|
390
|
+
|
|
391
|
+
#### Quick Start for Windows Users
|
|
392
|
+
|
|
393
|
+
**Most users don't need any configuration** - AutomatosX automatically detects provider CLIs installed via npm:
|
|
394
|
+
|
|
395
|
+
```bash
|
|
396
|
+
# 1. Install providers (if not already installed)
|
|
397
|
+
npm install -g @anthropic-ai/claude-cli
|
|
398
|
+
npm install -g @google/generative-ai-cli
|
|
399
|
+
npm install -g openai
|
|
400
|
+
|
|
401
|
+
# 2. Verify detection
|
|
402
|
+
ax status
|
|
403
|
+
```
|
|
404
|
+
|
|
405
|
+
**If providers are not detected**, you can manually specify paths:
|
|
406
|
+
|
|
407
|
+
**Windows (Command Prompt)**:
|
|
408
|
+
```cmd
|
|
409
|
+
set CLAUDE_CLI=C:\Users\YourName\AppData\Roaming\npm\claude.cmd
|
|
410
|
+
set GEMINI_CLI=C:\Users\YourName\AppData\Roaming\npm\gemini.cmd
|
|
411
|
+
ax status
|
|
412
|
+
```
|
|
413
|
+
|
|
414
|
+
**Windows (PowerShell)**:
|
|
415
|
+
```powershell
|
|
416
|
+
$env:CLAUDE_CLI="C:\Users\YourName\AppData\Roaming\npm\claude.cmd"
|
|
417
|
+
$env:GEMINI_CLI="C:\Users\YourName\AppData\Roaming\npm\gemini.cmd"
|
|
418
|
+
ax status
|
|
419
|
+
```
|
|
420
|
+
|
|
421
|
+
#### How Provider Detection Works
|
|
422
|
+
|
|
423
|
+
AutomatosX uses a **three-layer detection system**:
|
|
424
|
+
|
|
425
|
+
1. **ENV Variables** (highest priority) - `CLAUDE_CLI`, `GEMINI_CLI`, `CODEX_CLI`
|
|
426
|
+
2. **Config File** - Custom paths in `automatosx.config.json`
|
|
427
|
+
3. **PATH Detection** (automatic) - Standard system PATH
|
|
428
|
+
- **Windows**: Uses `where.exe` + PATH×PATHEXT scanning
|
|
429
|
+
- **Unix/macOS**: Uses `which` command
|
|
430
|
+
|
|
431
|
+
#### Windows-Specific Help
|
|
432
|
+
|
|
433
|
+
Having issues on Windows? See our comprehensive guides:
|
|
434
|
+
|
|
435
|
+
- 📖 **[Windows Setup Guide](docs/troubleshooting/windows-setup.md)** - Complete Windows installation walkthrough
|
|
436
|
+
- 🔧 **[Windows Troubleshooting](docs/troubleshooting/windows-troubleshooting.md)** - Common Windows issues and solutions
|
|
437
|
+
- ⚙️ **[Advanced Configuration](docs/guide/configuration.md)** - Custom paths, version requirements, and more
|
|
438
|
+
|
|
439
|
+
> **💡 Quick Tip**: Run `ax status --verbose` to see exactly which paths are being detected and used.
|
|
440
|
+
|
|
441
|
+
---
|
|
442
|
+
|
|
335
443
|
### Step 3: Run Your First Agent
|
|
336
444
|
|
|
337
|
-
|
|
445
|
+
#### Option A: Claude Code Integration (Recommended)
|
|
446
|
+
|
|
447
|
+
**Best Practice: Natural Language Collaboration**
|
|
448
|
+
|
|
449
|
+
Open Claude Code and try these prompts:
|
|
450
|
+
|
|
451
|
+
```
|
|
452
|
+
✅ "please work with ax agent to create a simple calculator function"
|
|
453
|
+
✅ "please work with ax agent to design a REST API for user management"
|
|
454
|
+
✅ "please work with ax agent to implement secure authentication"
|
|
455
|
+
```
|
|
456
|
+
|
|
457
|
+
**What happens**:
|
|
458
|
+
1. Claude Code analyzes your project context
|
|
459
|
+
2. Selects and coordinates the best agents
|
|
460
|
+
3. Agents execute with full context
|
|
461
|
+
4. Results are validated and explained
|
|
462
|
+
5. Easy to iterate: "please improve the error handling"
|
|
463
|
+
|
|
464
|
+
**Express Option: Slash Commands** (for simple tasks)
|
|
465
|
+
|
|
466
|
+
```bash
|
|
467
|
+
# Quick, direct execution
|
|
468
|
+
/ax:agent backend, write a function to validate email
|
|
469
|
+
/ax:agent quality, review this code snippet
|
|
470
|
+
```
|
|
471
|
+
|
|
472
|
+
📖 **Learn more**: [Best Practices Guide](docs/BEST-PRACTICES.md)
|
|
473
|
+
|
|
474
|
+
#### Option B: Terminal Mode (Power Users)
|
|
338
475
|
|
|
339
476
|
```bash
|
|
340
477
|
# Test with backend agent
|
|
@@ -346,22 +483,6 @@ ax run Bob "Implement the API" # Auto-receives Paris's design
|
|
|
346
483
|
ax run Queenie "Write tests for the API" # Auto-receives design + implementation
|
|
347
484
|
```
|
|
348
485
|
|
|
349
|
-
**Claude Code Integration**:
|
|
350
|
-
|
|
351
|
-
```bash
|
|
352
|
-
# In Claude Code, use the slash command
|
|
353
|
-
/ax:agent Paris, design REST API for users
|
|
354
|
-
/ax:agent Bob, implement the API
|
|
355
|
-
/ax:agent Queenie, write tests for the API
|
|
356
|
-
```
|
|
357
|
-
|
|
358
|
-
**What happens**:
|
|
359
|
-
1. Claude Code executes AutomatosX behind the scenes
|
|
360
|
-
2. Paris designs the API → Saved to memory
|
|
361
|
-
3. Bob reads Paris's design from memory → Implements code
|
|
362
|
-
4. Queenie reads everything → Writes comprehensive tests
|
|
363
|
-
5. Results flow back into your Claude Code conversation
|
|
364
|
-
|
|
365
486
|
---
|
|
366
487
|
|
|
367
488
|
### Common Issues
|
|
@@ -426,6 +547,26 @@ ax mcp
|
|
|
426
547
|
|
|
427
548
|
---
|
|
428
549
|
|
|
550
|
+
## ⏱️ Stage Checkpoints & Run History
|
|
551
|
+
|
|
552
|
+
AutomatosX 5.3 introduces stage-aware checkpoints so you can pause long-running agent workflows, inspect intermediate outputs, and resume exactly where the run stopped.
|
|
553
|
+
|
|
554
|
+
### Enable resumable runs
|
|
555
|
+
- CLI: `ax run <agent> "<task>" --resumable` (add `--interactive` or `--hybrid` for live approval)
|
|
556
|
+
- Config: set `execution.stages.enabled` to `true` in `automatosx.config.json` to make stage checkpoints the default. Combine with `execution.stages.autoSaveCheckpoint` to persist after every stage.
|
|
557
|
+
|
|
558
|
+
When a stage finishes, AutomatosX stores a checkpoint under `.automatosx/checkpoints/<run-id>/` (artifacts, logs, and metadata). The CLI prints the UUID so you can resume or inspect it later.
|
|
559
|
+
|
|
560
|
+
### Manage checkpoints
|
|
561
|
+
- `ax resume <run-id>` — Resume a saved run. Flags such as `--interactive`, `--streaming`, `--hybrid`, or `--auto-continue` override the saved execution mode.
|
|
562
|
+
- `ax runs list [--status running|paused|completed|failed|aborted] [--agent <name>] [--limit <n>]` — Review recent checkpoints with progress and status.
|
|
563
|
+
- `ax runs show <run-id> [--artifacts]` — Inspect stage history, retry counts, and generated artifacts before resuming.
|
|
564
|
+
- `ax runs delete <run-id> [--force]` — Remove stale checkpoints or clear sensitive artifacts once a run is finalized.
|
|
565
|
+
|
|
566
|
+
Set `execution.stages.cleanupAfterDays` to control automatic pruning (default 7 days). For an end-to-end guide, see [Checkpoints & Run History](docs/guide/checkpoints-and-resume.md).
|
|
567
|
+
|
|
568
|
+
---
|
|
569
|
+
|
|
429
570
|
## 📚 Documentation
|
|
430
571
|
|
|
431
572
|
### Getting Started
|
|
@@ -441,6 +582,7 @@ ax mcp
|
|
|
441
582
|
- **[Multi-Agent Orchestration](docs/guide/multi-agent-orchestration.md)** - Natural language delegation
|
|
442
583
|
- **[Team Configuration](docs/guide/team-configuration.md)** - Team-based agent organization
|
|
443
584
|
- **[Agent Templates](docs/guide/agent-templates.md)** - Quick agent creation
|
|
585
|
+
- **[Checkpoints & Run History](docs/guide/checkpoints-and-resume.md)** - Manage resumable runs and checkpoint storage
|
|
444
586
|
|
|
445
587
|
### Tutorials
|
|
446
588
|
- **[Memory Management](docs/tutorials/memory-management.md)** - Hands-on memory system guide
|
|
@@ -578,12 +720,20 @@ I need Daisy to analyze the data # Need expression
|
|
|
578
720
|
|
|
579
721
|
## 🛠️ Production-Ready
|
|
580
722
|
|
|
581
|
-
✅ **1,
|
|
723
|
+
✅ **1,670 tests passing** (100% pass rate)
|
|
582
724
|
✅ **TypeScript strict mode** (zero errors)
|
|
583
725
|
✅ **~56% test coverage** (comprehensive testing)
|
|
584
726
|
✅ **458KB bundle** (99.9% smaller than v3.x)
|
|
585
727
|
✅ **< 1ms memory search** (62x faster than v3.x)
|
|
586
728
|
|
|
729
|
+
### Tested Platforms
|
|
730
|
+
|
|
731
|
+
AutomatosX has been thoroughly tested across multiple operating systems:
|
|
732
|
+
|
|
733
|
+
- ✅ **macOS**: macOS 15+ (tested on macOS 15)
|
|
734
|
+
- ✅ **Ubuntu**: Ubuntu 24.04 LTS
|
|
735
|
+
- ✅ **Windows**: Windows 10 & Windows 11
|
|
736
|
+
|
|
587
737
|
### Performance Metrics
|
|
588
738
|
|
|
589
739
|
```
|