> ## Documentation Index
> Fetch the complete documentation index at: https://mintlify.com/SynkraAI/aiox-core/llms.txt
> Use this file to discover all available pages before exploring further.

# Introduction

> Synkra AIOX: AI-Orchestrated System for Full Stack Development - Transform your development workflow with specialized AI agents

<img className="block dark:hidden" src="https://media.brand.dev/5ffd6ce4-2434-4b4b-920a-f8cacac8b48b.svg" alt="Synkra AIOX Logo" />

<img className="hidden dark:block" src="https://media.brand.dev/5ffd6ce4-2434-4b4b-920a-f8cacac8b48b.svg" alt="Synkra AIOX Logo" />

# Welcome to Synkra AIOX

**Synkra AIOX** is an AI-Orchestrated System for Full Stack Development — a powerful framework that brings specialized AI agents, workflow orchestration, and story-driven development to your projects.

<CardGroup cols={2}>
  <Card title="Quick Start" icon="rocket" href="/quickstart">
    Get up and running with AIOX in minutes
  </Card>

  <Card title="Core Concepts" icon="lightbulb" href="/concepts/architecture">
    Understand the AIOX architecture and philosophy
  </Card>

  <Card title="Agents" icon="users" href="/agents/overview">
    Explore the 11 specialized AI agents
  </Card>

  <Card title="CLI Reference" icon="terminal" href="/cli/overview">
    Master the AIOX command-line interface
  </Card>
</CardGroup>

## What is AIOX?

AIOX is a **CLI-first framework** that provides:

* **12 Specialized AI Agents** — Each agent has a distinct role (dev, qa, architect, pm, po, sm, analyst, devops, data-engineer, ux-design-expert, squad-creator, aiox-master)
* **Story-Driven Development** — All development flows through structured user stories with acceptance criteria and quality gates
* **Workflow Orchestration** — Predefined workflows guide agents through planning, development, and deployment
* **Autonomous Development Engine (ADE)** — 7 epics that enable autonomous execution from requirements to working code
* **Multi-IDE Integration** — Works with Claude Code, Cursor, Codex CLI, Gemini CLI, and GitHub Copilot
* **Squad System** — Extend AIOX to any domain beyond software development

## Key Features

<CardGroup cols={3}>
  <Card title="CLI-First Architecture" icon="terminal">
    All functionality works 100% via CLI before any UI — dashboards only observe
  </Card>

  <Card title="Agent Authority" icon="shield-check">
    Each agent has exclusive authorities that cannot be violated by other agents
  </Card>

  <Card title="Quality Gates" icon="badge-check">
    Multiple validation layers ensure code quality at every step
  </Card>

  <Card title="Template System" icon="file-code">
    Self-contained templates embed both output structure and LLM instructions
  </Card>

  <Card title="Workflow Intelligence" icon="diagram-project">
    Predefined workflows for greenfield and brownfield projects
  </Card>

  <Card title="Memory Layer" icon="brain">
    Persistent memory of patterns and insights across sessions
  </Card>
</CardGroup>

## The AIOX Difference

<Note>
  AIOX is not just another AI coding assistant. It's a complete framework for agent-driven development with:

  * **Structured Planning** — Agents collaborate to create detailed PRD and Architecture documents
  * **Contextual Development** — Stories contain everything the dev agent needs (context, implementation details, architecture)
  * **Quality First** — Multiple quality gates block merges until standards are met
</Note>

## Two Core Innovations

### 1. Agentic Planning

Dedicated agents (analyst, pm, architect) collaborate with you to create detailed and consistent PRD and Architecture documents. Through advanced prompt engineering and human-in-the-loop refinement, these planning agents produce comprehensive specifications that go far beyond generic AI task generation.

### 2. Engineering-Contextualized Development

The sm (Scrum Master) agent transforms detailed plans into hyper-detailed development stories containing everything the dev agent needs — complete context, implementation details, and architectural guidance embedded directly in story files.

This two-phase approach eliminates both **planning inconsistency** and **context loss** — the biggest problems in AI-assisted development.

## How It Works

```mermaid theme={null}
graph LR
    A[Requirements] --> B[@analyst]
    B --> C[@pm / @architect]
    C --> D[@sm]
    D --> E[Story Files]
    E --> F[@dev]
    F --> G[@qa]
    G --> H[@devops]
    H --> I[Production]
```

<Steps>
  <Step title="Planning Phase">
    Use `@analyst`, `@pm`, and `@architect` agents to create PRD and architecture documents
  </Step>

  <Step title="Story Creation">
    The `@sm` agent transforms plans into detailed story files with acceptance criteria
  </Step>

  <Step title="Development">
    The `@dev` agent implements stories with full context — no guesswork
  </Step>

  <Step title="Quality Assurance">
    The `@qa` agent validates against acceptance criteria and runs quality gates
  </Step>

  <Step title="Deployment">
    The `@devops` agent handles git operations, releases, and deployment
  </Step>
</Steps>

## Prerequisites

Before installing AIOX, ensure you have:

* **Node.js** version 18.0.0 or higher (v20+ recommended)
* **npm** version 9.0.0 or higher
* **Git** for version control
* **GitHub CLI** (optional, for team collaboration)

## Installation

<CodeGroup>
  ```bash npm theme={null}
  npx aiox-core init my-project
  ```

  ```bash Existing Project theme={null}
  cd your-project
  npx aiox-core install
  ```
</CodeGroup>

<Tip>
  The installer includes a modern interactive wizard inspired by Vite and Next.js, with real-time validation, progress indicators, and multi-component selection.
</Tip>

## Next Steps

<CardGroup cols={2}>
  <Card title="Quickstart Guide" icon="rocket" href="/quickstart">
    Build your first AIOX project in 10 minutes
  </Card>

  <Card title="User Guide" icon="book-open" href="/guides/user-guide">
    Complete step-by-step walkthrough
  </Card>

  <Card title="Agent Overview" icon="users" href="/agents/overview">
    Learn about all 11 specialized agents
  </Card>

  <Card title="CLI Commands" icon="terminal" href="/cli/overview">
    Master the AIOX command-line interface
  </Card>
</CardGroup>

## Support & Community

<CardGroup cols={2}>
  <Card title="GitHub Repository" icon="github" href="https://github.com/SynkraAI/aiox-core">
    View source code, report issues, and contribute
  </Card>

  <Card title="Issue Tracker" icon="bug" href="https://github.com/SynkraAI/aiox-core/issues">
    Report bugs and request features
  </Card>
</CardGroup>

***

<Warning>
  **License**: AIOX Core is licensed under MIT. See the [LICENSE](https://github.com/SynkraAI/aiox-core/blob/main/LICENSE) file for details.
</Warning>
