Quick Start
Prerequisites
Before using AIOX, ensure you have:- Node.js version 18.0.0 or higher
- npm version 8.0.0 or higher
- Git for version control
- An AI provider API key (Anthropic, OpenAI, or compatible)
Installation
First Steps
Core Concepts
Philosophy
“Structure is Sacred. Tone is Flexible.”AIOX provides orchestrated structure while allowing flexibility in communication. This means:
- Fixed: Template positions, section order, metric formats, file structure, workflows
- Flexible: Status messages, vocabulary choices, emoji usage, personality, tone
The AIOX Difference
| Traditional AI Dev | AIOX |
|---|---|
| Uncoordinated agents | 11 specialized agents with clear roles |
| Inconsistent results | Structured workflows with quality gates |
| Context lost between sessions | Persistent memory and learning |
| Reinventing the wheel | Reusable tasks, workflows, and squads |
Agents
AIOX includes 11 specialized agents, each with a distinct role and personality:| Agent | ID | Archetype | Responsibility |
|---|---|---|---|
| Dex | @dev | Builder | Code implementation |
| Quinn | @qa | Guardian | Quality assurance |
| Aria | @architect | Architect | Technical architecture |
| Nova | @po | Visionary | Product backlog |
| Kai | @pm | Balancer | Product strategy |
| River | @sm | Facilitator | Process facilitation |
| Zara | @analyst | Explorer | Business analysis |
| Dara | @data-engineer | Architect | Data engineering |
| Felix | @devops | Optimizer | CI/CD and operations |
| Uma | @ux-expert | Creator | User experience |
| Pax | @aiox-master | Orchestrator | Framework orchestration |
Agent Activation
Command Visibility Levels
Agent commands use visibility levels to control when they appear:| Level | Name | Description |
|---|---|---|
key | Key | Critical commands shown in minimal greeting |
quick | Quick | Essential commands shown in quick reference |
full | Full | All commands shown in *help output |
| Command | Owner | Others Should… |
|---|---|---|
*create-prd | @pm | Delegate to @pm |
*create-epic | @pm | Delegate to @pm |
*draft | @sm | Use @sm for stories |
*develop | @dev | Use @dev for code |
*review | @qa | Use @qa for review |
Tasks
Tasks are the primary entry point in AIOX. Everything is a task.Task-First Architecture
Executing Tasks
Task Categories
| Category | Examples |
|---|---|
| Development | develop-story, code-review, refactor |
| Quality | run-tests, validate-code, security-scan |
| Documentation | generate-docs, update-readme |
| Workflow | create-story, manage-sprint |
Workflows
Workflows orchestrate multiple tasks and agents for complex operations.Available Workflows
| Workflow | Use Case | Agents Involved |
|---|---|---|
greenfield-fullstack | New full-stack project | All agents |
brownfield-integration | Add AIOX to existing | dev, architect |
fork-join | Parallel task execution | Multiple |
organizer-worker | Delegated execution | po, dev |
data-pipeline | ETL workflows | data-engineer, qa |
Executing Workflows
Squads
Squads are modular teams of AI agents that extend AIOX functionality.What is a Squad?
A squad is a self-contained package containing:| Component | Purpose |
|---|---|
| Agents | Domain-specific AI personas |
| Tasks | Executable workflows |
| Workflows | Multi-step orchestrations |
| Config | Coding standards, tech stack |
| Templates | Document generation templates |
| Tools | Custom tool integrations |
Distribution Levels
Using Squads
Basic Usage
Project Structure
Common Commands
Story-Driven Development
- Create a story - Use
*create-storyto define requirements - Work from stories - All development starts with a story in
docs/stories/ - Update progress - Mark checkboxes as tasks complete:
[ ]—>[x] - Track changes - Maintain the File List section in the story
- Follow criteria - Implement exactly what the acceptance criteria specify
Configuration
Main Configuration File
The primary configuration is in.aiox-core/core/config/:
Environment Variables
IDE Integration
AIOX supports multiple IDEs. Configuration is synchronized across:- Claude Code (
.claude/) - Cursor (
.cursor/) - VS Code (
.vscode/)
Best Practices
1. Start with Stories
Always create a story before implementing features:2. Use the Right Agent
Choose the appropriate agent for each task:| Task | Agent |
|---|---|
| Write code | @dev |
| Review code | @qa |
| Design system | @architect |
| Define requirements | @po |
3. Follow Quality Gates
AIOX implements 3-layer quality gates:- Layer 1 (Local): Pre-commit hooks, linting, type checking
- Layer 2 (CI/CD): Automated tests, CodeRabbit review
- Layer 3 (Human): Architecture review, final approval
4. Keep Context
Maintain context through sessions by:- Using story-driven development
- Updating progress checkboxes
- Documenting decisions in stories
5. Leverage Squads
Don’t reinvent the wheel - check for existing squads:Next Steps
Learning Path
- Quick Start - Follow this guide to get up and running
- First Project - Create your first AIOX project
- Development Workflow - Learn the story-driven development process
- Squads - Extend functionality with squads
Advanced Topics
- Quality Gates Guide
- Multi-Repo Strategy
- MCP Integration
- IDE Integration