@defai.digital/automatosx 11.2.6 → 11.2.8

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.
Files changed (31) hide show
  1. package/README.md +1 -1
  2. package/dist/index.js +289 -312
  3. package/dist/mcp/index.js +75 -72
  4. package/examples/providers/README.md +58 -169
  5. package/package.json +1 -1
  6. package/CHANGELOG.md +0 -41
  7. package/CODE_OF_CONDUCT.md +0 -133
  8. package/CONTRIBUTING.md +0 -427
  9. package/FAQ.md +0 -895
  10. package/TROUBLESHOOTING.md +0 -972
  11. package/templates/providers/README.md +0 -117
  12. /package/examples/{claude → providers/claude}/CLAUDE_INTEGRATION.md +0 -0
  13. /package/examples/{claude → providers/claude}/mcp/automatosx.json +0 -0
  14. /package/examples/{codex → providers/codex}/CODEX_INTEGRATION.md +0 -0
  15. /package/examples/{codex → providers/codex}/README.md +0 -0
  16. /package/examples/{codex → providers/codex}/usage-examples.ts +0 -0
  17. /package/examples/{gemini → providers/gemini}/GEMINI_INTEGRATION.md +0 -0
  18. /package/examples/{gemini → providers/gemini}/README.md +0 -0
  19. /package/examples/{integrations → providers}/openai-codex-example.ts +0 -0
  20. /package/{templates → examples}/specs/enterprise.yaml.mustache +0 -0
  21. /package/{templates → examples}/specs/government.yaml.mustache +0 -0
  22. /package/{templates → examples}/specs/minimal.yaml.mustache +0 -0
  23. /package/examples/{templates → workflows}/analyst.yaml +0 -0
  24. /package/examples/{templates → workflows}/assistant.yaml +0 -0
  25. /package/examples/{templates → workflows}/basic-agent.yaml +0 -0
  26. /package/examples/{templates → workflows}/code-reviewer.yaml +0 -0
  27. /package/examples/{templates → workflows}/debugger.yaml +0 -0
  28. /package/examples/{templates → workflows}/designer.yaml +0 -0
  29. /package/examples/{templates → workflows}/developer.yaml +0 -0
  30. /package/examples/{templates → workflows}/fullstack-developer.yaml +0 -0
  31. /package/examples/{templates → workflows}/qa-specialist.yaml +0 -0
package/FAQ.md DELETED
@@ -1,895 +0,0 @@
1
- # Frequently Asked Questions (FAQ)
2
-
3
- Note: This FAQ applies to AutomatosX v11.0.1. For detailed release notes, see [GitHub Releases](https://github.com/defai-digital/automatosx/releases).
4
-
5
- ## Contents
6
- - [General Questions](#general-questions)
7
- - [What AI providers are supported?](#what-ai-providers-are-supported)
8
- - [What happens if OpenAI or Gemini is not installed?](#what-happens-if-openai-or-gemini-is-not-installed)
9
- - [Does AutomatosX require Claude Code? Can Gemini or Codex CLI be the primary?](#does-automatosx-require-claude-code-can-gemini-or-openai-codex-be-the-primary)
10
- - [Do I need to run AutomatosX inside the Claude/Gemini/Codex CLI?](#do-i-need-to-run-automatosx-inside-the-claudegeminicodex-cli)
11
- - [Can I run AutomatosX with a fully offline model?](#can-i-run-automatosx-with-a-fully-offline-model)
12
- - [Installation & Setup](#installation--setup)
13
- - [I'm on Windows and AutomatosX is not working](#im-on-windows-and-automatosx-is-not-working)
14
- - [What are the system requirements?](#what-are-the-system-requirements)
15
- - [How do I install AutomatosX?](#how-do-i-install-automatosx)
16
- - [How do I set up authentication?](#how-do-i-set-up-authentication)
17
- - [Can I use AutomatosX without any provider CLIs?](#can-i-use-automatosx-without-any-provider-clis)
18
- - [Configuration](#configuration)
19
- - [Agents & Abilities](#agents--abilities)
20
- - [Memory System](#memory-system)
21
- - [Do I need any API for memory search?](#do-i-need-any-api-for-memory-search)
22
- - [Why don’t you use a vector database or Graphiti in the open-source edition?](#why-dont-you-use-a-vector-database-or-graphiti-in-the-open-source-edition)
23
- - [Performance](#performance)
24
- - [Development & Contributing](#development--contributing)
25
- - [Security & Privacy](#security--privacy)
26
- - [Licensing & Usage](#licensing--usage)
27
-
28
- ## General Questions
29
-
30
- ### What is AutomatosX?
31
-
32
- AutomatosX is an AI agent orchestration platform that allows you to create, configure, and run AI agents with different capabilities and behaviors. It supports multiple AI providers (Claude, Gemini, Codex) with intelligent fallback, and features a powerful memory system with SQLite FTS5 full-text search.
33
-
34
- <!-- Version-specific release notes removed to keep FAQ focused. See GitHub Releases for details. -->
35
-
36
- ### Can I migrate from older major versions?
37
-
38
- Major version upgrades may include breaking changes (database schema, configuration format, directory structure). The recommended approach is to set up a fresh project and reconfigure agents/teams. For specifics, refer to the Migration notes in [GitHub Releases](https://github.com/defai-digital/automatosx/releases).
39
-
40
- ### What AI providers are supported?
41
-
42
- AutomatosX supports multiple AI providers through their official CLI tools:
43
-
44
- - **Claude** (via `claude` CLI): Latest Sonnet and other Claude models
45
- - **Gemini** (via `gemini` CLI): gemini-1.5-pro, gemini-1.5-flash, and newer models
46
- - **OpenAI** (via `codex` CLI): GPT-4, GPT-3.5, and other OpenAI models
47
-
48
- **How it works**: AutomatosX calls your installed CLI commands (`claude`, `gemini`, `codex`). Each CLI uses its own authentication and automatically updates to the latest models.
49
-
50
- You can use multiple providers simultaneously with automatic fallback.
51
-
52
- ### Can I run AutomatosX with a fully offline model?
53
-
54
- Short answer: Not yet in the open-source edition. AutomatosX Community relies on provider CLIs (Claude, Gemini, OpenAI) which require internet access.
55
-
56
- - Today (Community): The memory system is fully local, but model inference is done via cloud provider CLIs. Mock mode (`AX_MOCK_PROVIDERS=true`) is available for testing, but it does not run a real model.
57
- - AutomatosX Pro: DEFAI offers offline model support (local inference) in the Pro edition.
58
- - Roadmap: We plan to release offline provider support to open source in v6.0.
59
-
60
- Considerations for offline inference:
61
- - Hardware: Adequate CPU/GPU and RAM/VRAM for chosen models.
62
- - Storage: Model checkpoints can be large (multi‑GB).
63
- - Licensing: Ensure local models’ licenses permit your use case.
64
-
65
- ### What happens if OpenAI or Gemini is not installed?
66
-
67
- As long as at least one provider CLI is installed and enabled (e.g., Claude/`claude`), AutomatosX will still run. The system automatically falls back to any available provider based on this priority:
68
-
69
- - CLI override (`--provider`) → Team provider (with `fallbackChain`) → Agent provider (deprecated) → Global Router priority
70
-
71
- If all configured providers are missing or disabled, execution fails with an error indicating that no providers are available.
72
-
73
- Check availability and health:
74
-
75
- ```bash
76
- ax status # Shows available providers and priorities
77
- ax run <agent> "task" --provider claude-code # Force a specific provider
78
- ```
79
-
80
- Notes:
81
- - Mock mode (`AX_MOCK_PROVIDERS=true`) returns mock responses but does not bypass provider availability checks. If no CLI is installed, providers remain unavailable.
82
- - Team-level `fallbackChain` (e.g., `openai → gemini-cli → claude`) ensures robust failover when the primary CLI is missing or unhealthy.
83
-
84
- ### How do I enable/disable providers?
85
-
86
- Edit `ax.config.json` and toggle the `enabled` flag under `providers`:
87
-
88
- ```json
89
- {
90
- "providers": {
91
- "openai": { "enabled": true },
92
- "gemini-cli": { "enabled": false },
93
- "claude-code": { "enabled": true }
94
- }
95
- }
96
- ```
97
-
98
- Troubleshooting checklist:
99
- - Ensure the CLI is installed and in `PATH` (`claude --version`, `gemini --version`, `codex --version`).
100
- - Verify the provider is `enabled` in `ax.config.json`.
101
- - Use `--provider` to override selection temporarily.
102
-
103
- ### Does AutomatosX require Claude Code? Can Gemini or Codex CLI be the primary?
104
-
105
- No. AutomatosX is provider-agnostic. Any supported provider can be primary. Set it at the team level (recommended) or override per command:
106
-
107
- ```yaml
108
- # .automatosx/teams/engineering.yaml (Gemini as primary)
109
- provider:
110
- primary: gemini-cli
111
- fallbackChain: [gemini-cli, openai, claude]
112
-
113
- # .automatosx/teams/core.yaml (OpenAI as primary)
114
- provider:
115
- primary: openai
116
- fallbackChain: [openai, gemini-cli, claude]
117
- ```
118
-
119
- Per-command override:
120
- ```bash
121
- ax run backend "implement API" --provider gemini-cli
122
- ax run writer "draft ADR" --provider openai
123
- ```
124
-
125
- Note: In the open-source edition, Claude Code is currently the most mature option and often recommended as default. We plan deeper first-class integration for Gemini and Codex in v6+.
126
-
127
- ### Do I need to run AutomatosX inside the Claude/Gemini/Codex CLI?
128
-
129
- No. AutomatosX is a standalone CLI (`ax`) that orchestrates agents and invokes provider CLIs under the hood. You typically run:
130
-
131
- ```bash
132
- ax run <agent> "your task" # AutomatosX orchestrates
133
- ax run <agent> "task" --provider openai
134
- ```
135
-
136
- You can run provider CLIs by themselves (e.g., `gemini "prompt"`, `codex exec "prompt"`, `claude -p "prompt" --print`), but doing so bypasses AutomatosX features such as stages, abilities injection, memory, delegation, and sessions.
137
-
138
- Roadmap: VS Code extension targeted for v5.5; deeper Gemini/Codex integration in v6+.
139
-
140
- ### How much does it cost to use?
141
-
142
- AutomatosX itself is **free and open-source** (Apache-2.0 license).
143
-
144
- **Pricing model**:
145
- - You pay only for what you use via your existing CLI subscriptions
146
- - No API keys stored in AutomatosX
147
- - No additional subscription fees
148
- - **10× more cost-effective** than expensive assistant APIs
149
-
150
- **Provider costs** (pay directly to provider):
151
- - **Claude**: ~$3-15 per 1M tokens (varies by model)
152
- - **Gemini**: Free tier available, paid tier ~$0.35-7 per 1M tokens
153
- - **OpenAI**: ~$0.02-0.06 per 1M tokens (via Codex CLI)
154
-
155
- Actual costs depend on your usage patterns and chosen models.
156
-
157
- ## Installation & Setup
158
-
159
- ### I'm on Windows and AutomatosX is not working
160
-
161
- See the [Windows Quick Fix Guide](docs/troubleshooting/windows-quick-fix.md) for common Windows issues and quick solutions.
162
-
163
- For comprehensive Windows troubleshooting, see the [Windows Troubleshooting Guide](docs/troubleshooting/windows-troubleshooting.md).
164
-
165
- ### What are the system requirements?
166
-
167
- - **Node.js**: 24.0.0 or higher
168
- - **OS**: macOS, Linux, or Windows
169
- - **Memory**: 512MB RAM minimum, 2GB recommended
170
- - **Disk**: 100MB for installation
171
-
172
- ### How do I install AutomatosX?
173
-
174
- ```bash
175
- # Step 1: Install AutomatosX CLI
176
- npm install -g @defai.digital/automatosx
177
-
178
- # Step 2: Install at least one provider CLI
179
- # Option A: Claude Code CLI
180
- npm install -g @anthropic-ai/claude-code
181
- # Or: curl -fsSL https://claude.ai/install.sh | bash
182
- # Or: brew install --cask claude-code
183
-
184
- # Option B: Gemini CLI
185
- npm install -g @google/gemini-cli
186
-
187
- # Option C: Codex CLI (OpenAI)
188
- npm install -g @openai/codex
189
- # Or: brew install codex
190
- # Docs: https://github.com/openai/codex
191
-
192
- # Step 3: Verify installation
193
- ax --version
194
- ```
195
-
196
- **Alternative (no installation)**:
197
- ```bash
198
- npx @defai.digital/automatosx --help
199
- ```
200
-
201
- ### How do I set up authentication?
202
-
203
- AutomatosX uses CLI tools, which handle authentication separately:
204
-
205
- ```bash
206
- # Each CLI has its own auth setup:
207
-
208
- # Claude CLI
209
- claude auth login
210
- # Follow the prompts to authenticate
211
-
212
- # Gemini CLI
213
- gemini auth login
214
- # Follow the prompts to authenticate
215
-
216
- # Codex CLI (requires git repository)
217
- codex auth login
218
- # Follow the prompts to authenticate
219
- # ⚠️ Important: Codex requires your project to have git initialized
220
- # Run 'git init' if not already a git repository
221
- ```
222
-
223
- **No API keys needed in AutomatosX** - the CLI tools handle all authentication!
224
-
225
- If you used API keys directly before, follow each provider’s CLI authentication guide instead.
226
-
227
- ### Can I use AutomatosX without any provider CLIs?
228
-
229
- No, you need at least one provider CLI installed and authenticated:
230
-
231
- - **Recommended**: Install `claude` CLI (most capable)
232
- - **Free option**: Gemini CLI offers generous free tier
233
- - **For testing**: Use mock providers (`AX_MOCK_PROVIDERS=true`)
234
-
235
- **Important**: Codex CLI CLI requires your project to be a git repository (`git init`). Other providers don't have this requirement.
236
-
237
- ```bash
238
- # Test without real providers
239
- export AX_MOCK_PROVIDERS=true
240
- ax run backend "Hello"
241
- ```
242
-
243
- ## Configuration
244
-
245
- ### Where should I put my config file?
246
-
247
- AutomatosX looks for config in this order:
248
-
249
- 1. `.automatosx/config.json` (project-specific) ⭐ **Recommended**
250
- 2. `ax.config.json` (project root)
251
- 3. `~/.automatosx/config.json` (user global)
252
-
253
- Create project-specific config:
254
-
255
- ```bash
256
- automatosx init
257
- ```
258
-
259
- ### How do I change the default provider?
260
-
261
- Configure at team level:
262
-
263
- ```bash
264
- # Edit team configuration
265
- # .automatosx/teams/engineering.yaml
266
- provider:
267
- primary: codex
268
- fallbackChain: [codex, gemini, claude]
269
- ```
270
-
271
- **Per-command override**:
272
-
273
- ```bash
274
- # Specify provider for single command
275
- ax run backend "hello" --provider gemini
276
-
277
- # Provider selection priority:
278
- # 1. CLI option (--provider)
279
- # 2. Team config
280
- # 3. Agent config (deprecated)
281
- # 4. Router fallback
282
- ```
283
-
284
- ### Can I have different configs for different projects?
285
-
286
- Yes! Each project can have its own `.automatosx/config.json`:
287
-
288
- ```bash
289
- cd project-a
290
- automatosx init # Creates .automatosx/config.json
291
-
292
- cd ../project-b
293
- automatosx init # Creates separate .automatosx/config.json
294
- ```
295
-
296
- ### How do I reset configuration to defaults?
297
-
298
- ```bash
299
- automatosx config --reset
300
- ```
301
-
302
- ## Agents & Abilities
303
-
304
- ### What are agent templates?
305
-
306
- **Agent templates** are pre-configured agent blueprints that let you create new agents in seconds instead of writing YAML from scratch.
307
-
308
- **5 Built-in Templates**:
309
- - `basic-agent` - Minimal configuration (core team)
310
- - `developer` - Software development (engineering team)
311
- - `analyst` - Business analysis (business team)
312
- - `designer` - UI/UX design (design team)
313
- - `qa-specialist` - Quality assurance (core team)
314
-
315
- **Quick Start**:
316
- ```bash
317
- # Interactive creation (guided prompts)
318
- ax agent create my-agent --template developer --interactive
319
-
320
- # One-line creation
321
- ax agent create backend --template developer \
322
- --display-name "Bob" \
323
- --role "Backend Engineer" \
324
- --team engineering
325
- ```
326
-
327
- **Benefits**:
328
- - ✅ 10-20x faster than manual creation
329
- - ✅ Consistent structure and best practices
330
- - ✅ Auto-assigned to appropriate teams
331
- - ✅ Beginner-friendly with interactive mode
332
-
333
- See [Agent Templates Guide](docs/guide/agent-templates.md) for details.
334
-
335
- ### What is team-based configuration?
336
-
337
- **Team-based configuration** organizes agents into teams with shared settings, eliminating configuration duplication.
338
-
339
- **4 Built-in Teams**:
340
- - **core** - QA specialists (primary: claude)
341
- - **engineering** - Software development (primary: codex)
342
- - **business** - Product & planning (primary: gemini)
343
- - **design** - Design & content (primary: gemini)
344
-
345
- **Example**:
346
- ```yaml
347
- # Agent inherits provider + shared abilities from team
348
- name: backend
349
- team: engineering # Inherits codex provider + team abilities
350
- role: Backend Engineer
351
- abilities:
352
- - backend-development # Agent-specific abilities
353
- ```
354
-
355
- **Benefits**:
356
- - ✅ No provider configuration duplication
357
- - ✅ Change provider for entire team at once
358
- - ✅ Shared abilities automatically included
359
- - ✅ Clear organizational structure
360
-
361
- See [Team Configuration Guide](docs/guide/team-configuration.md) for details.
362
-
363
- ### What's the difference between agents and abilities?
364
-
365
- - **Agents**: High-level personas with goals and behaviors (YAML files)
366
- - **Abilities**: Specific skills or tools agents can use (Markdown files)
367
-
368
- Example:
369
-
370
- ```yaml
371
- # Agent: .automatosx/agents/researcher.yaml
372
- name: researcher
373
- description: Research and analysis specialist
374
- abilities:
375
- - web_search # Ability
376
- - summarize # Ability
377
- - code_analysis # Ability
378
- ```
379
-
380
- ### How do I update my agents to use teams?
381
-
382
- **Migration Steps**:
383
-
384
- 1. **Identify common configurations** across your agents
385
- 2. **Choose appropriate team** (core, engineering, business, design)
386
- 3. **Update agent profile**:
387
-
388
- ```yaml
389
- # Before
390
- name: backend
391
- provider: codex
392
- temperature: 0.7
393
- abilities:
394
- - code-generation
395
- - backend-development
396
-
397
- # After
398
- name: backend
399
- team: engineering # Add this line
400
- abilities:
401
- - backend-development # Remove duplicated abilities
402
- ```
403
-
404
- 4. **Test the agent**:
405
- ```bash
406
- ax agent show backend # Verify team assignment
407
- ax run backend "test" # Test execution
408
- ```
409
-
410
- Team abilities (like `code-generation`) are automatically inherited.
411
-
412
- ### How do I create a custom agent?
413
-
414
- **Recommended**: Use agent templates:
415
-
416
- ```bash
417
- # Interactive mode - guided creation
418
- ax agent create my-agent --template developer --interactive
419
-
420
- # One-line creation
421
- ax agent create my-agent \
422
- --template developer \
423
- --display-name "Mike" \
424
- --role "Senior Backend Engineer" \
425
- --team engineering
426
-
427
- # List available templates
428
- ax agent templates
429
-
430
- # Available templates: developer, analyst, designer, qa-specialist, basic-agent
431
- ```
432
-
433
- **Manual creation (advanced)**:
434
-
435
- ```bash
436
- # 1. Create agent profile (team-based config)
437
- cat > .automatosx/agents/my-agent.yaml << EOF
438
- name: my-agent
439
- team: engineering # Inherits provider from team
440
- displayName: "Mike"
441
- description: My custom agent
442
- abilities:
443
- - search
444
- - code_analysis
445
- systemPrompt: |
446
- You are a helpful assistant specialized in...
447
- EOF
448
-
449
- # 2. Test agent
450
- ax run my-agent "Hello, introduce yourself"
451
- # Or use display name: ax run Mike "..."
452
- ```
453
-
454
- See [examples/agents/](./examples/agents/) for more examples.
455
-
456
- ### How do I create custom abilities?
457
-
458
- ```bash
459
- # Create ability file
460
- cat > .automatosx/abilities/my-ability.md << EOF
461
- # My Ability
462
-
463
- Description of what this ability does.
464
-
465
- ## Usage
466
- \`\`\`
467
- Example usage instructions
468
- \`\`\`
469
-
470
- ## Examples
471
- Concrete examples of using this ability
472
- EOF
473
- ```
474
-
475
- Abilities are referenced in agent profiles and injected into prompts.
476
-
477
- ### Can agents access my files?
478
-
479
- Yes, but with security restrictions (v5.2+):
480
-
481
- - **Read access**: Validated paths within your project directory
482
- - **Write access**: Only to `automatosx/PRD/` and `automatosx/tmp/` (with path validation)
483
- - **Prevented**: Path traversal attacks (`../../etc/passwd`), absolute paths, empty paths
484
-
485
- This ensures agents can read your code but only write to controlled workspace directories.
486
-
487
- ## Memory System
488
-
489
- ### How does the memory system work?
490
-
491
- AutomatosX uses pure SQLite FTS5 full-text search:
492
-
493
- - **Storage**: `.automatosx/memory/memories.db`
494
- - **Search**: FTS5 full-text search (< 1ms average)
495
- - **No embeddings**: Removed OpenAI embedding dependency
496
- - **Cost**: Zero - all local, no API calls
497
- - **Privacy**: All data stays on your machine
498
-
499
- Memories persist across sessions and can be searched instantly.
500
-
501
- ### How do I search memories?
502
-
503
- ```bash
504
- # Full-text search
505
- ax memory search "how to implement authentication"
506
-
507
- # List all memories
508
- ax memory list
509
-
510
- # Limit results
511
- ax memory search "query" --limit 10
512
-
513
- # Special characters are automatically handled
514
- ax memory search "config.json settings" # Works!
515
- ax memory search "coverage: 95%" # Works!
516
- ax memory search "timeout (300ms)" # Works!
517
- ```
518
-
519
- ### Can I export/import memories?
520
-
521
- ```bash
522
- # Export to JSON
523
- ax memory export --output backup.json
524
-
525
- # Import from JSON
526
- ax memory import --input backup.json
527
-
528
- # Clear all memories
529
- ax memory clear
530
- ```
531
-
532
- ### How do I clear old memories?
533
-
534
- ```bash
535
- # Clear all memories
536
- ax memory clear
537
-
538
- # Backup before clearing
539
- ax memory export --output backup.json
540
- ax memory clear
541
-
542
- # Delete database manually (advanced)
543
- rm -rf .automatosx/memory/
544
- # Will be recreated on next use
545
- ```
546
-
547
- ### Do I need any API for memory search?
548
-
549
- **No!**
550
-
551
- - Memory search uses **pure SQLite FTS5** (local, no API calls)
552
- - No embedding costs
553
- - No external dependencies
554
- - All data stays on your machine
555
- - Blazing fast (< 1ms average)
556
-
557
- External embedding APIs are not required.
558
-
559
- ### Why don’t you use a vector database or Graphiti in the open-source edition?
560
-
561
- Short answer: cost-effectiveness, simplicity, and zero‑config. We previously used Milvus Lite; while semantic search is powerful, it introduces embedding costs, extra services, and operational complexity. For most AutomatosX Community use cases, SQLite FTS5 delivers excellent local performance at zero cost and with no background services.
562
-
563
- - Cost & complexity: Vector search requires embeddings (paid) and heavier infra. Open-source users often value “install and go” with no fees.
564
- - Offline/local-first: FTS5 works fully offline with minimal footprint and great speed.
565
- - Scope fit: Most tasks benefit from fast keyword/context recall rather than full semantic retrieval.
566
-
567
- When is Graphiti (graph DB) more suitable for OSS users?
568
- - You need first-class relationship queries (e.g., delegation chains, cross‑artifact lineage, decision→rationale→outputs).
569
- - You want path/graph analytics (impact analysis, neighborhoods, cycle checks beyond our built-in safeguards).
570
- - You curate a knowledge graph (entities/relations) that must power reasoning or advanced navigation.
571
-
572
- Pro vs. Community
573
- - AutomatosX Pro: We justify vector DB + graph DB for advanced recall and reasoning at scale.
574
- - Community (open source): Default remains SQLite FTS5 to keep zero‑config, zero‑cost, and portability.
575
-
576
- Roadmap
577
- - Before v6: Stay on SQLite FTS5 (Community default).
578
- - v6+: Release offline LLM support with optional vector DB + graph DB backends.
579
- - v7+: Release advanced knowledge management tooling (graph/semantic curation, richer retrieval/reranking).
580
-
581
- ## Performance
582
-
583
- ### Why is startup slow?
584
-
585
- First run loads dependencies and initializes the database. Subsequent runs should be faster due to:
586
-
587
- - Lazy loading (on-demand module loading)
588
- - Filesystem caching
589
- - Pre-warmed configurations
590
-
591
- To warm the cache:
592
-
593
- ```bash
594
- automatosx status
595
- ```
596
-
597
- ### How can I improve performance?
598
-
599
- ```bash
600
- # Enable all performance optimizations
601
- automatosx config --set performance.lazyLoad --value true
602
- automatosx config --set performance.cache.enabled --value true
603
-
604
- # Reduce memory limit if experiencing high RAM usage
605
- automatosx config --set memory.maxEntries --value 5000
606
-
607
- # Use faster models
608
- automatosx config --set providers.claude.model --value claude-3-haiku-20240307
609
- ```
610
-
611
- ### Is there a rate limit?
612
-
613
- AutomatosX itself has no rate limits, but AI providers do:
614
-
615
- - **Claude**: 50 requests/min (tier 1), higher for paid tiers
616
- - **Gemini**: 60 requests/min (free), higher for paid
617
- - **OpenAI**: Varies by tier
618
-
619
- AutomatosX has built-in retry logic with exponential backoff.
620
-
621
- ## Troubleshooting
622
-
623
- ### Tests are failing during installation
624
-
625
- ```bash
626
- # Tests require mock providers
627
- export AX_MOCK_PROVIDERS=true
628
- npm test
629
- ```
630
-
631
- See [TROUBLESHOOTING.md](./TROUBLESHOOTING.md) for more solutions.
632
-
633
- ### `Error: database is locked`
634
-
635
- Another AutomatosX process is using the database:
636
-
637
- ```bash
638
- # Find and kill processes
639
- ps aux | grep automatosx
640
- pkill -f automatosx
641
- ```
642
-
643
- ### Configuration not being applied
644
-
645
- Check which config file is being used:
646
-
647
- ```bash
648
- automatosx config # Shows config path
649
- ```
650
-
651
- Ensure you're editing the right file based on priority order.
652
-
653
- ### Agent tasks timeout with "Request timeout after 300000ms"
654
-
655
- **Problem**: Complex agent tasks fail with timeout errors even though the default agent timeout is longer.
656
-
657
- **Cause**: Provider timeout is shorter than agent timeout, causing the provider to timeout first.
658
-
659
- **Solution**: Update to the latest version, or manually update your config:
660
-
661
- ```bash
662
- # Check your current version
663
- automatosx --version
664
-
665
- # Manually ensure provider timeouts are aligned with agent timeout:
666
- automatosx config set providers.claude-code.timeout 1500000
667
- automatosx config set providers.gemini-cli.timeout 1500000
668
- automatosx config set providers.openai.timeout 1500000
669
-
670
- # Or update to the latest version:
671
- npm install -g @defai.digital/automatosx@latest
672
- ```
673
-
674
- **Verify the fix**:
675
- ```bash
676
- # Check provider timeout settings
677
- automatosx config show | grep -A2 "timeout"
678
- # Should show 1500000 (25 minutes) for all providers
679
- ```
680
-
681
- ### Agents delegate to wrong agents or delegation cycles occur
682
-
683
- **Problem**: Agents incorrectly parse documentation examples as actual delegation requests, causing unwanted delegation cycles.
684
-
685
- **Example Error**:
686
- ```
687
- [ERROR] Delegation cycle detected: quality -> frontend -> frontend
688
- [INFO] Parsed 6 delegation(s) # Should be 0
689
- ```
690
-
691
- **Cause**: Delegation parser was too aggressive and parsed quoted examples or numbered lists as real delegations.
692
-
693
- **Solution**: Update to the latest version which includes improved delegation parsing and agent governance:
694
-
695
- ```bash
696
- npm install -g @defai.digital/automatosx@latest
697
- ```
698
-
699
- **Verification**:
700
- ```bash
701
- # Test delegation parsing with documentation
702
- ax run coordinator "Explain delegation syntax with examples"
703
- # Should not trigger any false delegations
704
- ```
705
-
706
- ### FTS5 search fails with "syntax error near" message
707
-
708
- **Problem**: Memory search fails with errors like `fts5: syntax error near "."` when query contains special characters.
709
-
710
- **Cause**: FTS5 search used to not sanitize special characters properly in older builds.
711
-
712
- **Solution**: Update to the latest version which includes enhanced FTS5 sanitization:
713
-
714
- ```bash
715
- npm install -g @defai.digital/automatosx@latest
716
- ```
717
-
718
- **Workaround (if can't update)**:
719
- ```bash
720
- # Avoid special characters in memory searches
721
- # Instead of: "config.json settings"
722
- # Use: "config json settings"
723
- ```
724
-
725
- ### AutomatosX not working after upgrading from an older version
726
-
727
- If you're experiencing errors or unexpected behavior after upgrading, it may be due to:
728
-
729
- - **Old agent profiles** (YAML format or schema changes)
730
- - **Outdated configuration** (incompatible settings from previous versions)
731
- - **Old database format** (migration required)
732
-
733
- **Solution**: Reinitialize your AutomatosX setup with the force flag:
734
-
735
- ```bash
736
- # Force reinitialize (overwrites existing configuration)
737
- ax init -f
738
-
739
- # This will:
740
- # - Create fresh .automatosx/ directory structure
741
- # - Generate updated agent profiles
742
- # - Create new SQLite database
743
- # - Reset configuration to defaults
744
- ```
745
-
746
- **⚠️ Warning**: This will overwrite existing configuration. If you have custom agents or abilities, back them up first:
747
-
748
- ```bash
749
- # Backup custom files before reinitializing
750
- cp -r .automatosx/agents ./backup-agents
751
- cp -r .automatosx/abilities ./backup-abilities
752
- cp .automatosx/config.json ./backup-config.json
753
-
754
- # Reinitialize
755
- ax init -f
756
-
757
- # Restore custom agents/abilities if needed
758
- cp ./backup-agents/* .automatosx/agents/
759
- cp ./backup-abilities/* .automatosx/abilities/
760
- ```
761
-
762
- ### Memory search returns no results
763
-
764
- Verify memories exist:
765
-
766
- ```bash
767
- ax memory list
768
-
769
- # If empty, try storing a memory first
770
- ax run backend "Remember: Project Alpha launches Q1 2025"
771
-
772
- # Then search
773
- ax memory search "when does Alpha launch"
774
- ```
775
-
776
- Note: AutomatosX uses FTS5 text search (no embedding API needed).
777
-
778
- ## Development & Contributing
779
-
780
- ### How do I contribute to AutomatosX?
781
-
782
- See [CONTRIBUTING.md](./CONTRIBUTING.md) for detailed guidelines.
783
-
784
- Quick start:
785
-
786
- ```bash
787
- git clone https://github.com/defai-digital/automatosx.git
788
- cd automatosx
789
- npm install
790
- npm test
791
- ```
792
-
793
- ### How do I run tests?
794
-
795
- ```bash
796
- # All tests
797
- npm test
798
-
799
- # Unit tests only
800
- npm run test:unit
801
-
802
- # Integration tests
803
- npm run test:integration
804
-
805
- # With coverage
806
- npm run test:coverage
807
-
808
- # Specific test
809
- npm test memory-manager
810
- ```
811
-
812
- ### Where is the documentation?
813
-
814
- - **README.md**: Quick start and overview
815
- - **[GitHub Releases](https://github.com/defai-digital/automatosx/releases)**: Version history and release notes
816
- - **FAQ.md**: This file
817
- - **TROUBLESHOOTING.md**: Problem solving guide
818
- - **API docs**: In `docs/` directory
819
- - **Examples**: In `examples/` directory
820
-
821
- ### How do I report a bug?
822
-
823
- 1. Check [existing issues](https://github.com/defai-digital/automatosx/issues)
824
- 2. Create a [new issue](https://github.com/defai-digital/automatosx/issues/new)
825
- 3. Include:
826
- - AutomatosX version (`automatosx --version`)
827
- - Node version (`node --version`)
828
- - Steps to reproduce
829
- - Error messages with `--debug` flag
830
-
831
- ## Security & Privacy
832
-
833
- ### Is my data safe?
834
-
835
- AutomatosX:
836
-
837
- - Stores data locally in `.automatosx/` directory
838
- - Only sends data to AI providers you configure
839
- - Never sends data to third parties
840
- - Uses path validation to prevent unauthorized file access
841
-
842
- ### Can agents access sensitive files?
843
-
844
- No. AutomatosX implements security boundaries:
845
-
846
- - Agents can only read files within project directory
847
- - Path traversal attacks are prevented
848
- - Agent writes are isolated to workspace directories
849
-
850
- ### Should I commit `.automatosx/` to git?
851
-
852
- **No, add to .gitignore**:
853
-
854
- ```bash
855
- echo ".automatosx/" >> .gitignore
856
- ```
857
-
858
- The `.automatosx/` directory contains:
859
-
860
- - Local database
861
- - Conversation history
862
- - Agent workspaces
863
- - Session data
864
-
865
- Note: API keys are not stored by AutomatosX (provider CLIs handle auth separately)
866
-
867
- **Do commit**: Example agent profiles and abilities in `examples/` directory if you want to share them.
868
-
869
- ## Licensing & Usage
870
-
871
- ### What license does AutomatosX use?
872
-
873
- Apache License 2.0 - free for commercial and personal use.
874
-
875
- ### Can I use AutomatosX commercially?
876
-
877
- Yes! Apache 2.0 license allows commercial use with no restrictions.
878
-
879
- ### Do I need to credit AutomatosX?
880
-
881
- Not required, but appreciated! You can mention:
882
-
883
- ```
884
- Powered by AutomatosX (https://github.com/defai-digital/automatosx)
885
- ```
886
-
887
- ---
888
-
889
- ## Still Have Questions?
890
-
891
- - **GitHub Issues**: [Report bugs, ask questions, or request features](https://github.com/defai-digital/automatosx/issues)
892
- - 🐛 Bug reports: Use the bug report template
893
- - ✨ Feature requests/Wishlist: Use the "enhancement" label
894
- - ❓ Questions: Use the "question" label
895
- - **Email**: <support@defai.digital> for private inquiries