@defai.digital/automatosx 12.8.7 → 13.1.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/LICENSE +1 -1
- package/README.md +48 -754
- package/dist/bin.d.ts +8 -0
- package/dist/bin.d.ts.map +1 -0
- package/dist/bin.js +16 -0
- package/dist/bin.js.map +1 -0
- package/dist/index.d.ts +8 -2
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +7 -74239
- package/dist/index.js.map +1 -0
- package/package.json +35 -160
- package/.github/assets/ax-cli.png +0 -0
- package/.github/assets/axlogo.png +0 -0
- package/CHANGELOG.md +0 -81
- package/SECURITY.md +0 -173
- package/dist/mcp/index.d.ts +0 -2
- package/dist/mcp/index.js +0 -43627
- package/examples/AGENTS_INFO.md +0 -187
- package/examples/README.md +0 -434
- package/examples/abilities/accessibility.md +0 -115
- package/examples/abilities/api-design.md +0 -168
- package/examples/abilities/best-practices.md +0 -102
- package/examples/abilities/caching-strategy.md +0 -165
- package/examples/abilities/ci-cd.md +0 -61
- package/examples/abilities/clean-code.md +0 -398
- package/examples/abilities/code-generation.md +0 -333
- package/examples/abilities/code-review.md +0 -51
- package/examples/abilities/component-architecture.md +0 -112
- package/examples/abilities/content-creation.md +0 -97
- package/examples/abilities/data-modeling.md +0 -171
- package/examples/abilities/data-validation.md +0 -50
- package/examples/abilities/db-modeling.md +0 -167
- package/examples/abilities/debugging.md +0 -52
- package/examples/abilities/design-patterns.md +0 -437
- package/examples/abilities/design-system-implementation.md +0 -126
- package/examples/abilities/documentation.md +0 -54
- package/examples/abilities/etl-pipelines.md +0 -44
- package/examples/abilities/feasibility-study.md +0 -20
- package/examples/abilities/general-assistance.md +0 -26
- package/examples/abilities/idea-evaluation.md +0 -21
- package/examples/abilities/infra-as-code.md +0 -57
- package/examples/abilities/job-orchestration.md +0 -44
- package/examples/abilities/literature-review.md +0 -19
- package/examples/abilities/longform-report.md +0 -25
- package/examples/abilities/mathematical-reasoning.md +0 -170
- package/examples/abilities/observability.md +0 -61
- package/examples/abilities/orbital-mechanics.md +0 -50
- package/examples/abilities/our-architecture-decisions.md +0 -180
- package/examples/abilities/our-code-review-checklist.md +0 -149
- package/examples/abilities/our-coding-standards.md +0 -369
- package/examples/abilities/our-project-structure.md +0 -183
- package/examples/abilities/performance.md +0 -89
- package/examples/abilities/problem-solving.md +0 -50
- package/examples/abilities/propulsion-systems.md +0 -50
- package/examples/abilities/quantum-algorithm-design.md +0 -54
- package/examples/abilities/quantum-error-correction.md +0 -56
- package/examples/abilities/quantum-frameworks-transpilation.md +0 -53
- package/examples/abilities/quantum-noise-modeling.md +0 -58
- package/examples/abilities/refactoring.md +0 -223
- package/examples/abilities/release-strategy.md +0 -58
- package/examples/abilities/secrets-policy.md +0 -61
- package/examples/abilities/secure-coding-review.md +0 -60
- package/examples/abilities/software-architecture.md +0 -394
- package/examples/abilities/solid-principles.md +0 -341
- package/examples/abilities/sql-optimization.md +0 -84
- package/examples/abilities/state-management.md +0 -96
- package/examples/abilities/task-planning.md +0 -65
- package/examples/abilities/technical-writing.md +0 -77
- package/examples/abilities/telemetry-diagnostics.md +0 -51
- package/examples/abilities/testing.md +0 -56
- package/examples/abilities/threat-modeling.md +0 -58
- package/examples/abilities/troubleshooting.md +0 -80
- package/examples/abilities/typescript-zod-validation.md +0 -830
- package/examples/agents/AGENTS_INTEGRATION.md +0 -99
- package/examples/agents/aerospace-scientist.yaml +0 -159
- package/examples/agents/architecture.yaml +0 -244
- package/examples/agents/automatosx.config.json +0 -286
- package/examples/agents/backend.yaml +0 -141
- package/examples/agents/ceo.yaml +0 -105
- package/examples/agents/creative-marketer.yaml +0 -173
- package/examples/agents/cto.yaml +0 -118
- package/examples/agents/data-scientist.yaml +0 -200
- package/examples/agents/data.yaml +0 -106
- package/examples/agents/design.yaml +0 -115
- package/examples/agents/devops.yaml +0 -124
- package/examples/agents/frontend.yaml +0 -171
- package/examples/agents/fullstack.yaml +0 -172
- package/examples/agents/mobile.yaml +0 -185
- package/examples/agents/product.yaml +0 -103
- package/examples/agents/quality.yaml +0 -117
- package/examples/agents/quantum-engineer.yaml +0 -166
- package/examples/agents/researcher.yaml +0 -122
- package/examples/agents/security.yaml +0 -115
- package/examples/agents/standard.yaml +0 -214
- package/examples/agents/writer.yaml +0 -122
- package/examples/providers/README.md +0 -117
- package/examples/providers/claude/CLAUDE_INTEGRATION.md +0 -302
- package/examples/providers/claude/mcp/automatosx.json +0 -244
- package/examples/providers/codex/CODEX_INTEGRATION.md +0 -593
- package/examples/providers/codex/README.md +0 -349
- package/examples/providers/codex/usage-examples.ts +0 -421
- package/examples/providers/gemini/GEMINI_INTEGRATION.md +0 -236
- package/examples/providers/gemini/README.md +0 -76
- package/examples/providers/openai-codex-example.ts +0 -421
- package/examples/pytorch_resnet50_training.py +0 -289
- package/examples/specs/automatosx-release.ax.yaml +0 -380
- package/examples/specs/enterprise.ax.yaml +0 -121
- package/examples/specs/enterprise.yaml.mustache +0 -121
- package/examples/specs/government.ax.yaml +0 -148
- package/examples/specs/government.yaml.mustache +0 -148
- package/examples/specs/minimal.ax.yaml +0 -21
- package/examples/specs/minimal.yaml.mustache +0 -21
- package/examples/teams/business.yaml +0 -56
- package/examples/teams/core.yaml +0 -60
- package/examples/teams/design.yaml +0 -58
- package/examples/teams/engineering.yaml +0 -69
- package/examples/teams/research.yaml +0 -56
- package/examples/use-cases/01-web-app-development.md +0 -374
- package/examples/workflows/analyst.yaml +0 -60
- package/examples/workflows/assistant.yaml +0 -48
- package/examples/workflows/basic-agent.yaml +0 -28
- package/examples/workflows/code-reviewer.yaml +0 -52
- package/examples/workflows/debugger.yaml +0 -63
- package/examples/workflows/designer.yaml +0 -69
- package/examples/workflows/developer.yaml +0 -60
- package/examples/workflows/fullstack-developer.yaml +0 -395
- package/examples/workflows/qa-specialist.yaml +0 -71
- package/schema/ability-metadata.json +0 -21
- package/schema/config.json +0 -703
- package/schema/spec-schema.json +0 -608
package/examples/AGENTS_INFO.md
DELETED
|
@@ -1,187 +0,0 @@
|
|
|
1
|
-
# AutomatosX Agent Directory
|
|
2
|
-
|
|
3
|
-
This document provides a comprehensive overview of the specialized AI agents available in the AutomatosX system. These agents are designed to collaborate on complex software engineering and business tasks, each with a unique role, set of skills, and a human-friendly name.
|
|
4
|
-
|
|
5
|
-
## 🤖 Quick Reference: All Agents
|
|
6
|
-
|
|
7
|
-
There are a total of 20 agents in the AutomatosX ecosystem, organized into specialized teams.
|
|
8
|
-
|
|
9
|
-
| Name | Agent ID | Role | Team |
|
|
10
|
-
|---|---|---|---|
|
|
11
|
-
| **Tony** | `cto` | Chief Technology Officer | Business/Leadership |
|
|
12
|
-
| **Eric** | `ceo` | Chief Executive Officer | Business/Leadership |
|
|
13
|
-
| **Paris** | `product` | Product Manager | Business/Leadership |
|
|
14
|
-
| **Candy** | `creative-marketer`| Creative Marketing Strategist | Marketing |
|
|
15
|
-
| **Oliver** | `devops` | DevOps Engineer | Engineering |
|
|
16
|
-
| **Dana** | `data-scientist` | Data Scientist | Data / Engineering |
|
|
17
|
-
| **Felix** | `fullstack` | Full-stack Developer | Engineering |
|
|
18
|
-
| **Maya** | `mobile` | Mobile Developer | Engineering |
|
|
19
|
-
| **Bob** | `backend` | Backend Engineer | Engineering |
|
|
20
|
-
| **Frank** | `frontend` | Frontend Engineer | Engineering |
|
|
21
|
-
| **Avery** | `architecture` | Senior Software Architect | Engineering |
|
|
22
|
-
| **Quinn** | `quantum-engineer` | Quantum Systems Engineer | Engineering |
|
|
23
|
-
| **Astrid** | `aerospace-scientist`| Aerospace Mission Scientist | Engineering |
|
|
24
|
-
| **Steve** | `security` | Security Engineer | Engineering |
|
|
25
|
-
| **Queenie** | `quality` | QA Engineer | Core/Quality |
|
|
26
|
-
| **Stan** | `standard` | Software Standards Expert | Core/Quality |
|
|
27
|
-
| **Daisy** | `data` | Data Engineer | Data |
|
|
28
|
-
| **Debbee** | `design` | UX/UI Designer | Design/Content |
|
|
29
|
-
| **Wendy** | `writer` | Technical Writer | Design/Content |
|
|
30
|
-
| **Rodman** | `researcher` | Researcher | Research |
|
|
31
|
-
|
|
32
|
-
---
|
|
33
|
-
|
|
34
|
-
## 💡 How to Use Agents
|
|
35
|
-
|
|
36
|
-
### Recommended: Natural Language Collaboration
|
|
37
|
-
|
|
38
|
-
For best results, collaborate with agents using natural language. This allows the system to analyze your project, provide context, and validate results.
|
|
39
|
-
|
|
40
|
-
```
|
|
41
|
-
✅ BEST: "please work with the backend agent to implement user authentication"
|
|
42
|
-
✅ BEST: "please discuss with the backend and security agents to design our API"
|
|
43
|
-
✅ BEST: "please plan with the engineering team to refactor this module"
|
|
44
|
-
```
|
|
45
|
-
|
|
46
|
-
### Express Method: Direct Commands
|
|
47
|
-
|
|
48
|
-
For simple, well-defined tasks, you can use direct commands.
|
|
49
|
-
|
|
50
|
-
```bash
|
|
51
|
-
# Use the agent's role name
|
|
52
|
-
ax run backend "Design a RESTful API for user management"
|
|
53
|
-
|
|
54
|
-
# Or use their human-friendly display name
|
|
55
|
-
ax run Bob "Design a RESTful API for user management"
|
|
56
|
-
```
|
|
57
|
-
|
|
58
|
-
📖 **[See the Complete Best Practices Guide](../docs/BEST-PRACTICES.md)**
|
|
59
|
-
|
|
60
|
-
---
|
|
61
|
-
|
|
62
|
-
## 🎯 Detailed Agent Directory
|
|
63
|
-
|
|
64
|
-
Agents are organized into teams, each with a specific provider configuration to optimize performance and reliability.
|
|
65
|
-
|
|
66
|
-
### 💻 Engineering Team
|
|
67
|
-
|
|
68
|
-
- **Primary Provider**: 🟢 Codex (OpenAI)
|
|
69
|
-
- **Fallback Chain**: Codex → Gemini → Claude
|
|
70
|
-
- **Why**: Optimized for code generation, testing, and implementation.
|
|
71
|
-
|
|
72
|
-
| Name | Agent ID | Expertise | Best For |
|
|
73
|
-
|---|---|---|---|
|
|
74
|
-
| **Oliver** | `devops` | Infrastructure as code, CI/CD, K8s | Complex multi-stage deployments |
|
|
75
|
-
| **Dana** | `data-scientist` | ML modeling, statistical analysis | End-to-end ML pipelines |
|
|
76
|
-
| **Felix** | `fullstack` | End-to-end features, API integration | Full-stack features |
|
|
77
|
-
| **Maya** | `mobile` | Native iOS/Android, React Native | Mobile app development |
|
|
78
|
-
| **Bob** | `backend` | API design, DB modeling, Go, Rust | Backend development, systems programming |
|
|
79
|
-
| **Frank** | `frontend` | React, Next.js, Swift, component architecture | Frontend development, iOS/web apps |
|
|
80
|
-
| **Avery** | `architecture` | System architecture, ADR management | Architecture governance, technical debt |
|
|
81
|
-
| **Quinn** | `quantum-engineer` | Quantum algorithms, Qiskit/Cirq | Quantum computing projects |
|
|
82
|
-
| **Astrid** | `aerospace-scientist` | Orbital mechanics, mission analysis | Aerospace projects |
|
|
83
|
-
| **Steve** | `security` | Security reviews, threat modeling | Security audits and code reviews |
|
|
84
|
-
|
|
85
|
-
### 🎯 Core/Quality Team
|
|
86
|
-
|
|
87
|
-
- **Primary Provider**: 🟢 Codex (OpenAI)
|
|
88
|
-
- **Fallback Chain**: Codex → Gemini → Claude
|
|
89
|
-
- **Why**: Optimized for code review, quality assurance, and detailed analysis.
|
|
90
|
-
|
|
91
|
-
| Name | Agent ID | Expertise | Best For |
|
|
92
|
-
|---|---|---|---|
|
|
93
|
-
| **Queenie** | `quality` | QA, debugging, testing | Multi-layer QA workflows, test coordination |
|
|
94
|
-
| **Stan** | `standard` | SOLID, design patterns, clean code | Code reviews, architecture validation |
|
|
95
|
-
|
|
96
|
-
### 💾 Data Team
|
|
97
|
-
|
|
98
|
-
- **Primary Provider**: 🟢 Codex (OpenAI)
|
|
99
|
-
- **Fallback Chain**: Codex → Gemini → Claude
|
|
100
|
-
- **Why**: Optimized for data processing and ML tasks.
|
|
101
|
-
|
|
102
|
-
| Name | Agent ID | Expertise | Best For |
|
|
103
|
-
|---|---|---|---|
|
|
104
|
-
| **Dana** | `data-scientist` | Statistical analysis, ML modeling | Complete ML pipelines |
|
|
105
|
-
| **Daisy** | `data` | ETL pipelines, data infrastructure | Data engineering tasks |
|
|
106
|
-
|
|
107
|
-
### 🎨 Design/Content Team
|
|
108
|
-
|
|
109
|
-
- **Primary Provider**: 🔵 Gemini
|
|
110
|
-
- **Fallback Chain**: Gemini → Claude → Codex
|
|
111
|
-
- **Why**: Optimized for creative content, UX/UI design, and technical writing.
|
|
112
|
-
|
|
113
|
-
| Name | Agent ID | Expertise | Best For |
|
|
114
|
-
|---|---|---|---|
|
|
115
|
-
| **Debbee** | `design` | UX research, wireframes, design systems | UX/UI design |
|
|
116
|
-
| **Wendy** | `writer` | API docs, ADRs, release notes | Technical writing |
|
|
117
|
-
|
|
118
|
-
### 📊 Business/Leadership Team
|
|
119
|
-
|
|
120
|
-
- **Primary Provider**: 🟣 Claude
|
|
121
|
-
- **Fallback Chain**: Claude → Codex → Gemini
|
|
122
|
-
- **Why**: Optimized for strategic planning, business analysis, and executive decision-making.
|
|
123
|
-
|
|
124
|
-
| Name | Agent ID | Expertise | Best For |
|
|
125
|
-
|---|---|---|---|
|
|
126
|
-
| **Tony** | `cto` | Architecture governance, tech strategy | Technology roadmap, platform decisions |
|
|
127
|
-
| **Eric** | `ceo` | Business strategy, market analysis | Strategic decisions, organizational leadership |
|
|
128
|
-
| **Paris** | `product` | User research, feature planning | Product strategy, roadmap planning |
|
|
129
|
-
|
|
130
|
-
### 🔬 Research Team
|
|
131
|
-
|
|
132
|
-
- **Primary Provider**: 🟠 OpenAI
|
|
133
|
-
- **Fallback Chain**: OpenAI → Gemini-CLI → Claude
|
|
134
|
-
- **Why**: Optimized for structured research, analysis, and evidence-based decision making.
|
|
135
|
-
|
|
136
|
-
| Name | Agent ID | Expertise | Best For |
|
|
137
|
-
|---|---|---|---|
|
|
138
|
-
| **Rodman** | `researcher` | Idea validation, feasibility analysis | Research reports, literature review |
|
|
139
|
-
|
|
140
|
-
### 📈 Marketing Team
|
|
141
|
-
|
|
142
|
-
- **Primary Provider**: 🟣 Claude
|
|
143
|
-
- **Fallback Chain**: Claude → Codex → Gemini
|
|
144
|
-
- **Why**: Aligned with the Business team for strategic collaboration.
|
|
145
|
-
|
|
146
|
-
| Name | Agent ID | Expertise | Best For |
|
|
147
|
-
|---|---|---|---|
|
|
148
|
-
| **Candy** | `creative-marketer` | GenAI prompting, digital marketing | Marketing campaigns, content creation |
|
|
149
|
-
|
|
150
|
-
---
|
|
151
|
-
|
|
152
|
-
## ⚙️ Advanced Concepts
|
|
153
|
-
|
|
154
|
-
### Delegation Architecture
|
|
155
|
-
|
|
156
|
-
AutomatosX uses a tiered **Delegation Depth** model to manage complex workflows and prevent infinite loops.
|
|
157
|
-
|
|
158
|
-
- **Depth 3 (Strategic Coordinators)**: Orchestrate complex, multi-layer workflows across several teams.
|
|
159
|
-
- *Agents*: Tony (cto), Oliver (devops), Dana (data-scientist)
|
|
160
|
-
- **Depth 2 (Tactical Coordinators)**: Coordinate workflows within a domain, where sub-delegation to a specialist is required.
|
|
161
|
-
- *Agent*: Queenie (quality)
|
|
162
|
-
- **Depth 1 (Simple Coordinators/Specialists)**: Can delegate simple tasks to implementers but cannot sub-delegate. Most specialists fall here.
|
|
163
|
-
- *Agents*: Paris, Felix, Maya, Eric, Candy, Bob, Frank, Avery, Quinn, Astrid, Stan
|
|
164
|
-
- **Depth 0 (Pure Implementers)**: Execute tasks directly with deep expertise and no delegation capabilities.
|
|
165
|
-
- *Agents*: Steve, Daisy, Debbee, Wendy, Rodman
|
|
166
|
-
|
|
167
|
-
### Provider Configuration and Fallback System
|
|
168
|
-
|
|
169
|
-
Each team is assigned a primary AI provider optimized for its tasks. To ensure 99.9% uptime, a 3-layer fallback system is in place:
|
|
170
|
-
1. **Primary Provider**: The default, team-optimized provider.
|
|
171
|
-
2. **Fallback Chain**: A pre-configured sequence of alternative providers.
|
|
172
|
-
3. **Router Fallback**: If all else fails, the system auto-routes to any available provider.
|
|
173
|
-
|
|
174
|
-
### Customizing Agents
|
|
175
|
-
|
|
176
|
-
You can create new agents or customize existing ones.
|
|
177
|
-
```bash
|
|
178
|
-
# Create a new agent from a template
|
|
179
|
-
ax agent create my-assistant --template assistant --interactive
|
|
180
|
-
|
|
181
|
-
# Or copy and edit an existing agent's configuration file
|
|
182
|
-
cp examples/agents/backend.yaml .automatosx/agents/my-backend.yaml
|
|
183
|
-
vim .automatosx/agents/my-backend.yaml
|
|
184
|
-
```
|
|
185
|
-
To customize, modify the agent's `.yaml` file in your `.automatosx/agents/` directory.
|
|
186
|
-
|
|
187
|
-
---
|
package/examples/README.md
DELETED
|
@@ -1,434 +0,0 @@
|
|
|
1
|
-
# AutomatosX Examples
|
|
2
|
-
|
|
3
|
-
This directory contains example agents, abilities, and usage patterns to help you get started with AutomatosX.
|
|
4
|
-
|
|
5
|
-
## Directory Structure
|
|
6
|
-
|
|
7
|
-
```
|
|
8
|
-
examples/
|
|
9
|
-
├── agents/ # Example agent profiles (YAML)
|
|
10
|
-
├── abilities/ # Example ability definitions (Markdown)
|
|
11
|
-
├── use-cases/ # Complete usage scenarios
|
|
12
|
-
└── README.md # This file
|
|
13
|
-
```
|
|
14
|
-
|
|
15
|
-
## Quick Start
|
|
16
|
-
|
|
17
|
-
### 1. Using Example Agents
|
|
18
|
-
|
|
19
|
-
Copy an example agent to your project:
|
|
20
|
-
|
|
21
|
-
```bash
|
|
22
|
-
# Copy all example agents
|
|
23
|
-
cp -r examples/agents/* .automatosx/agents/
|
|
24
|
-
|
|
25
|
-
# Or copy a specific agent
|
|
26
|
-
cp examples/agents/backend.yaml .automatosx/agents/
|
|
27
|
-
|
|
28
|
-
# Test the agent
|
|
29
|
-
automatosx run backend "Hello, introduce yourself"
|
|
30
|
-
```
|
|
31
|
-
|
|
32
|
-
### 2. Using Example Abilities
|
|
33
|
-
|
|
34
|
-
Copy example abilities to your project:
|
|
35
|
-
|
|
36
|
-
```bash
|
|
37
|
-
# Copy all abilities
|
|
38
|
-
cp -r examples/abilities/* .automatosx/abilities/
|
|
39
|
-
|
|
40
|
-
# Or copy specific abilities
|
|
41
|
-
cp examples/abilities/code-review.md .automatosx/abilities/
|
|
42
|
-
cp examples/abilities/debugging.md .automatosx/abilities/
|
|
43
|
-
```
|
|
44
|
-
|
|
45
|
-
### 3. Customizing Agents
|
|
46
|
-
|
|
47
|
-
Edit agent profiles to customize behavior:
|
|
48
|
-
|
|
49
|
-
```bash
|
|
50
|
-
# Edit agent profile
|
|
51
|
-
vim .automatosx/agents/backend.yaml
|
|
52
|
-
|
|
53
|
-
# Customize:
|
|
54
|
-
# - name: Unique identifier
|
|
55
|
-
# - description: Agent's purpose
|
|
56
|
-
# - model: AI model to use
|
|
57
|
-
# - temperature: Creativity level (0.0-1.0)
|
|
58
|
-
# - abilities: List of abilities to enable
|
|
59
|
-
# - systemPrompt: Detailed instructions
|
|
60
|
-
```
|
|
61
|
-
|
|
62
|
-
## Agent Names
|
|
63
|
-
|
|
64
|
-
**AutomatosX agents have human-friendly names!** 🎉
|
|
65
|
-
|
|
66
|
-
Instead of remembering technical roles, you can use memorable names:
|
|
67
|
-
|
|
68
|
-
- 👨💻 **Bob** - Backend Engineer
|
|
69
|
-
- 👨💻 **Frank** - Frontend Developer
|
|
70
|
-
- 🔒 **Steve** - Security Engineer
|
|
71
|
-
- 🎨 **Debbee** - UX/UI Designer
|
|
72
|
-
- 📊 **Daisy** - Data Scientist
|
|
73
|
-
|
|
74
|
-
See [AGENTS_INFO.md](./AGENTS_INFO.md) for the complete directory.
|
|
75
|
-
|
|
76
|
-
## Available Agents
|
|
77
|
-
|
|
78
|
-
### backend.yaml - Bob
|
|
79
|
-
|
|
80
|
-
**Purpose**: Backend development specialist for API and server-side tasks
|
|
81
|
-
|
|
82
|
-
**Best for**:
|
|
83
|
-
|
|
84
|
-
- API design and implementation
|
|
85
|
-
- Database modeling
|
|
86
|
-
- Server-side logic
|
|
87
|
-
|
|
88
|
-
**Example**:
|
|
89
|
-
|
|
90
|
-
```bash
|
|
91
|
-
# Using role name
|
|
92
|
-
automatosx run backend "Create a REST API endpoint for user management"
|
|
93
|
-
|
|
94
|
-
# Using display name (easier to remember!)
|
|
95
|
-
automatosx run Bob "Create a REST API endpoint for user management"
|
|
96
|
-
```
|
|
97
|
-
|
|
98
|
-
### quality.yaml - Queenie
|
|
99
|
-
|
|
100
|
-
**Purpose**: Quality assurance and code review
|
|
101
|
-
|
|
102
|
-
**Best for**:
|
|
103
|
-
|
|
104
|
-
- Code review and analysis
|
|
105
|
-
- Debugging and testing
|
|
106
|
-
- Quality assurance
|
|
107
|
-
|
|
108
|
-
**Example**:
|
|
109
|
-
|
|
110
|
-
```bash
|
|
111
|
-
automatosx run backend "Create a React component for user authentication"
|
|
112
|
-
```
|
|
113
|
-
|
|
114
|
-
### quality.yaml
|
|
115
|
-
|
|
116
|
-
**Purpose**: Code review and quality analysis
|
|
117
|
-
|
|
118
|
-
**Best for**:
|
|
119
|
-
|
|
120
|
-
- Reviewing pull requests
|
|
121
|
-
- Finding bugs and issues
|
|
122
|
-
- Suggesting improvements
|
|
123
|
-
|
|
124
|
-
**Example**:
|
|
125
|
-
|
|
126
|
-
```bash
|
|
127
|
-
automatosx run quality "Review the code in src/components/Auth.tsx"
|
|
128
|
-
```
|
|
129
|
-
|
|
130
|
-
### debugger.yaml
|
|
131
|
-
|
|
132
|
-
**Purpose**: Debugging and troubleshooting
|
|
133
|
-
|
|
134
|
-
**Best for**:
|
|
135
|
-
|
|
136
|
-
- Analyzing error messages
|
|
137
|
-
- Finding root causes
|
|
138
|
-
- Suggesting fixes
|
|
139
|
-
|
|
140
|
-
**Example**:
|
|
141
|
-
|
|
142
|
-
```bash
|
|
143
|
-
automatosx run debugger "Help me debug this error: TypeError: Cannot read property 'name' of undefined"
|
|
144
|
-
```
|
|
145
|
-
|
|
146
|
-
### writer.yaml
|
|
147
|
-
|
|
148
|
-
**Purpose**: Technical writing and documentation
|
|
149
|
-
|
|
150
|
-
**Best for**:
|
|
151
|
-
|
|
152
|
-
- Writing documentation
|
|
153
|
-
- Creating tutorials
|
|
154
|
-
- Explaining concepts
|
|
155
|
-
|
|
156
|
-
**Example**:
|
|
157
|
-
|
|
158
|
-
```bash
|
|
159
|
-
automatosx run writer "Write API documentation for the User authentication module"
|
|
160
|
-
```
|
|
161
|
-
|
|
162
|
-
## Available Abilities
|
|
163
|
-
|
|
164
|
-
### Code-Related
|
|
165
|
-
|
|
166
|
-
- **code-generation.md**: Generate new code from requirements
|
|
167
|
-
- **code-review.md**: Review code for quality and issues
|
|
168
|
-
- **refactoring.md**: Improve existing code structure
|
|
169
|
-
- **debugging.md**: Debug and fix code issues
|
|
170
|
-
- **testing.md**: Write and improve tests
|
|
171
|
-
|
|
172
|
-
### Analysis
|
|
173
|
-
|
|
174
|
-
- **error-analysis.md**: Analyze error messages and logs
|
|
175
|
-
- **performance-analysis.md**: Identify performance bottlenecks
|
|
176
|
-
- **security-audit.md**: Check for security vulnerabilities
|
|
177
|
-
|
|
178
|
-
### Documentation
|
|
179
|
-
|
|
180
|
-
- **documentation.md**: Write technical documentation
|
|
181
|
-
- **technical-writing.md**: Create technical content
|
|
182
|
-
- **content-creation.md**: Generate articles and guides
|
|
183
|
-
|
|
184
|
-
### Problem Solving
|
|
185
|
-
|
|
186
|
-
- **problem-solving.md**: Break down and solve problems
|
|
187
|
-
- **task-planning.md**: Plan and organize tasks
|
|
188
|
-
- **troubleshooting.md**: Diagnose and fix issues
|
|
189
|
-
- **best-practices.md**: Apply industry best practices
|
|
190
|
-
|
|
191
|
-
## Usage Patterns
|
|
192
|
-
|
|
193
|
-
### Pattern 1: Interactive Development
|
|
194
|
-
|
|
195
|
-
```bash
|
|
196
|
-
# Start with planning
|
|
197
|
-
automatosx chat backend
|
|
198
|
-
> "I need to build a REST API for user management"
|
|
199
|
-
|
|
200
|
-
# Generate code
|
|
201
|
-
automatosx run backend "Create Express.js routes for user CRUD operations"
|
|
202
|
-
|
|
203
|
-
# Review code
|
|
204
|
-
automatosx run quality "Review the user routes I just created"
|
|
205
|
-
|
|
206
|
-
# Debug issues
|
|
207
|
-
automatosx run debugger "The POST /users endpoint returns 500 error"
|
|
208
|
-
```
|
|
209
|
-
|
|
210
|
-
### Pattern 2: Code Review Workflow
|
|
211
|
-
|
|
212
|
-
```bash
|
|
213
|
-
# Review specific file
|
|
214
|
-
automatosx run quality "Review src/api/users.ts"
|
|
215
|
-
|
|
216
|
-
# Review entire directory
|
|
217
|
-
automatosx run quality "Review all files in src/api/"
|
|
218
|
-
|
|
219
|
-
# Security audit
|
|
220
|
-
automatosx run quality "Check src/api/auth.ts for security issues" \
|
|
221
|
-
--abilities security-audit
|
|
222
|
-
```
|
|
223
|
-
|
|
224
|
-
### Pattern 3: Documentation Generation
|
|
225
|
-
|
|
226
|
-
```bash
|
|
227
|
-
# Generate README
|
|
228
|
-
automatosx run writer "Create a README.md for this project"
|
|
229
|
-
|
|
230
|
-
# API documentation
|
|
231
|
-
automatosx run writer "Document all API endpoints in src/routes/"
|
|
232
|
-
|
|
233
|
-
# Code comments
|
|
234
|
-
automatosx run backend "Add JSDoc comments to src/utils/helpers.ts"
|
|
235
|
-
```
|
|
236
|
-
|
|
237
|
-
### Pattern 4: Learning and Exploration
|
|
238
|
-
|
|
239
|
-
```bash
|
|
240
|
-
# Understand codebase
|
|
241
|
-
automatosx chat backend
|
|
242
|
-
> "Explain the architecture of this project"
|
|
243
|
-
|
|
244
|
-
# Learn specific concepts
|
|
245
|
-
automatosx run backend "How does the authentication flow work?"
|
|
246
|
-
|
|
247
|
-
# Get examples
|
|
248
|
-
automatosx run backend "Show me examples of using the memory system"
|
|
249
|
-
```
|
|
250
|
-
|
|
251
|
-
## Creating Custom Agents
|
|
252
|
-
|
|
253
|
-
### Step 1: Create Profile
|
|
254
|
-
|
|
255
|
-
```yaml
|
|
256
|
-
# .automatosx/agents/my-agent.yaml
|
|
257
|
-
name: my-agent
|
|
258
|
-
description: Custom agent for specific tasks
|
|
259
|
-
model: claude-3-sonnet-20240229
|
|
260
|
-
temperature: 0.7
|
|
261
|
-
maxTokens: 4096
|
|
262
|
-
timeout: 60000
|
|
263
|
-
|
|
264
|
-
abilities:
|
|
265
|
-
- code-generation
|
|
266
|
-
- debugging
|
|
267
|
-
- best-practices
|
|
268
|
-
|
|
269
|
-
systemPrompt: |
|
|
270
|
-
You are a specialized assistant for [your specific domain].
|
|
271
|
-
|
|
272
|
-
Your key responsibilities:
|
|
273
|
-
1. [Responsibility 1]
|
|
274
|
-
2. [Responsibility 2]
|
|
275
|
-
3. [Responsibility 3]
|
|
276
|
-
|
|
277
|
-
Guidelines:
|
|
278
|
-
- Follow [specific style guide]
|
|
279
|
-
- Prioritize [specific aspect]
|
|
280
|
-
- Always [specific behavior]
|
|
281
|
-
```
|
|
282
|
-
|
|
283
|
-
### Step 2: Test Agent
|
|
284
|
-
|
|
285
|
-
```bash
|
|
286
|
-
automatosx run my-agent "Test prompt"
|
|
287
|
-
```
|
|
288
|
-
|
|
289
|
-
### Step 3: Iterate
|
|
290
|
-
|
|
291
|
-
- Test with various prompts
|
|
292
|
-
- Adjust temperature for creativity
|
|
293
|
-
- Add/remove abilities as needed
|
|
294
|
-
- Refine systemPrompt for better results
|
|
295
|
-
|
|
296
|
-
## Creating Custom Abilities
|
|
297
|
-
|
|
298
|
-
### Step 1: Create Ability File
|
|
299
|
-
|
|
300
|
-
```markdown
|
|
301
|
-
<!-- .automatosx/abilities/my-ability.md -->
|
|
302
|
-
# My Custom Ability
|
|
303
|
-
|
|
304
|
-
Brief description of what this ability does.
|
|
305
|
-
|
|
306
|
-
## Purpose
|
|
307
|
-
|
|
308
|
-
Detailed explanation of when and why to use this ability.
|
|
309
|
-
|
|
310
|
-
## Usage Guidelines
|
|
311
|
-
|
|
312
|
-
1. First step
|
|
313
|
-
2. Second step
|
|
314
|
-
3. Third step
|
|
315
|
-
|
|
316
|
-
## Best Practices
|
|
317
|
-
|
|
318
|
-
- Best practice 1
|
|
319
|
-
- Best practice 2
|
|
320
|
-
|
|
321
|
-
## Examples
|
|
322
|
-
|
|
323
|
-
### Example 1: [Scenario]
|
|
324
|
-
[Detailed example with input and expected output]
|
|
325
|
-
|
|
326
|
-
### Example 2: [Scenario]
|
|
327
|
-
[Another example]
|
|
328
|
-
|
|
329
|
-
## Common Pitfalls
|
|
330
|
-
|
|
331
|
-
- Pitfall 1 and how to avoid it
|
|
332
|
-
- Pitfall 2 and how to avoid it
|
|
333
|
-
```
|
|
334
|
-
|
|
335
|
-
### Step 2: Reference in Agent
|
|
336
|
-
|
|
337
|
-
```yaml
|
|
338
|
-
# my-agent.yaml
|
|
339
|
-
abilities:
|
|
340
|
-
- my-ability
|
|
341
|
-
```
|
|
342
|
-
|
|
343
|
-
### Step 3: Test
|
|
344
|
-
|
|
345
|
-
```bash
|
|
346
|
-
automatosx run my-agent "Use my custom ability to..."
|
|
347
|
-
```
|
|
348
|
-
|
|
349
|
-
## Tips and Best Practices
|
|
350
|
-
|
|
351
|
-
### Agent Design
|
|
352
|
-
|
|
353
|
-
1. **Single Responsibility**: Each agent should have a clear, focused purpose
|
|
354
|
-
2. **Descriptive Names**: Use names that clearly indicate the agent's role
|
|
355
|
-
3. **Specific System Prompts**: Provide detailed instructions for consistent behavior
|
|
356
|
-
4. **Appropriate Temperature**:
|
|
357
|
-
- 0.0-0.3: Deterministic, factual tasks
|
|
358
|
-
- 0.4-0.7: Balanced creativity and accuracy
|
|
359
|
-
- 0.8-1.0: Creative, varied outputs
|
|
360
|
-
|
|
361
|
-
### Ability Design
|
|
362
|
-
|
|
363
|
-
1. **Clear Purpose**: Each ability should solve a specific problem
|
|
364
|
-
2. **Detailed Examples**: Show concrete usage patterns
|
|
365
|
-
3. **Best Practices**: Include dos and don'ts
|
|
366
|
-
4. **Composable**: Abilities should work well together
|
|
367
|
-
|
|
368
|
-
### Usage Tips
|
|
369
|
-
|
|
370
|
-
1. **Start Simple**: Begin with example agents, customize as needed
|
|
371
|
-
2. **Iterate Quickly**: Test agents with real tasks, refine based on results
|
|
372
|
-
3. **Use Memory**: Let agents remember context across sessions
|
|
373
|
-
4. **Combine Abilities**: Mix and match abilities for complex tasks
|
|
374
|
-
5. **Debug Mode**: Use `--debug` flag to see what's happening
|
|
375
|
-
|
|
376
|
-
## Troubleshooting
|
|
377
|
-
|
|
378
|
-
### Agent Not Found
|
|
379
|
-
|
|
380
|
-
```bash
|
|
381
|
-
# List available agents
|
|
382
|
-
automatosx list agents
|
|
383
|
-
|
|
384
|
-
# Verify agent file exists
|
|
385
|
-
ls .automatosx/agents/
|
|
386
|
-
```
|
|
387
|
-
|
|
388
|
-
### Abilities Not Working
|
|
389
|
-
|
|
390
|
-
```bash
|
|
391
|
-
# List available abilities
|
|
392
|
-
automatosx list abilities
|
|
393
|
-
|
|
394
|
-
# Check agent profile includes the ability
|
|
395
|
-
cat .automatosx/agents/my-agent.yaml
|
|
396
|
-
```
|
|
397
|
-
|
|
398
|
-
### Unexpected Behavior
|
|
399
|
-
|
|
400
|
-
1. Check agent's systemPrompt for clarity
|
|
401
|
-
2. Adjust temperature (lower = more focused)
|
|
402
|
-
3. Enable debug mode: `--debug`
|
|
403
|
-
4. Review memory context: `automatosx memory list`
|
|
404
|
-
|
|
405
|
-
## Real-World Use Cases
|
|
406
|
-
|
|
407
|
-
See `examples/use-cases/` for complete scenarios:
|
|
408
|
-
|
|
409
|
-
- Web application development
|
|
410
|
-
- API design and implementation
|
|
411
|
-
- Code migration and refactoring
|
|
412
|
-
- Security audit workflow
|
|
413
|
-
- Documentation generation
|
|
414
|
-
|
|
415
|
-
## Community Examples
|
|
416
|
-
|
|
417
|
-
Share your agents and abilities:
|
|
418
|
-
|
|
419
|
-
1. Fork the repository
|
|
420
|
-
2. Add your examples to this directory
|
|
421
|
-
3. Submit a pull request
|
|
422
|
-
4. Include description and usage instructions
|
|
423
|
-
|
|
424
|
-
## Resources
|
|
425
|
-
|
|
426
|
-
- [Main Documentation](../README.md)
|
|
427
|
-
- [Configuration Guide](../docs/configuration.md)
|
|
428
|
-
- [API Reference](../docs/api.md)
|
|
429
|
-
- [FAQ](../FAQ.md)
|
|
430
|
-
- [Troubleshooting](../TROUBLESHOOTING.md)
|
|
431
|
-
|
|
432
|
-
---
|
|
433
|
-
|
|
434
|
-
**Need help?** Open an issue at [GitHub Issues](https://github.com/defai-digital/automatosx/issues) - for bugs, questions, or feature requests (use "enhancement" label for wishlist items).
|