> ## 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.

# Quickstart

> Get up and running with Synkra AIOX in 10 minutes

# Quickstart Guide

Get Synkra AIOX installed and running in under 10 minutes. This guide will walk you through installation, first agent activation, and your first commands.

## Prerequisites

Before you begin, ensure you have:

* **Node.js** version 18.0.0 or higher (v20+ recommended)
* **npm** version 9.0.0 or higher
* A terminal/command line interface

## Installation

<Steps>
  <Step title="Install AIOX">
    Choose one of the following installation methods:

    <Tabs>
      <Tab title="New Project">
        Create a new project with AIOX:

        ```bash theme={null}
        npx aiox-core init my-project
        cd my-project
        ```
      </Tab>

      <Tab title="Existing Project">
        Install AIOX in an existing project:

        ```bash theme={null}
        cd your-existing-project
        npx aiox-core install
        ```
      </Tab>
    </Tabs>

    The installer will guide you through an interactive setup with:

    * Project name selection
    * Component selection
    * IDE configuration
    * Dependency installation
  </Step>

  <Step title="Verify Installation">
    Confirm AIOX is installed correctly:

    ```bash theme={null}
    npx aiox-core doctor
    ```

    This command checks:

    * Node.js and npm versions
    * AIOX framework files
    * Agent definitions
    * Configuration files
  </Step>

  <Step title="Configure Your IDE">
    Choose your IDE and follow the setup:

    <Accordion title="Claude Code (Recommended)">
      Claude Code auto-loads AIOX configuration from `.claude/CLAUDE.md`. No additional setup needed!

      The configuration is automatically detected when you open your project in Claude Code.
    </Accordion>

    <Accordion title="Codex CLI">
      Codex CLI reads from `AGENTS.md` at the project root.

      Generate skills for local activation:

      ```bash theme={null}
      npm run sync:skills:codex
      ```

      Activate agents using the `/skills` command in Codex.
    </Accordion>

    <Accordion title="Cursor">
      1. Open Cursor settings
      2. Navigate to **User Rules**
      3. Copy contents from `.cursor/global-rules.md`
      4. Paste in rules section and save
    </Accordion>

    <Accordion title="Gemini CLI">
      Sync agents and hooks:

      ```bash theme={null}
      npm run sync:ide:gemini
      ```

      Use slash commands like `/aiox-dev` or `/aiox-architect` to activate agents.
    </Accordion>
  </Step>

  <Step title="Activate Your First Agent">
    Let's activate the dev agent to see AIOX in action:

    <CodeGroup>
      ```bash Claude Code theme={null}
      @dev
      ```

      ```bash Codex CLI theme={null}
      /skills
      # Select: aiox-dev
      ```

      ```bash Gemini CLI theme={null}
      /aiox-dev
      ```

      ```bash Cursor theme={null}
      @dev
      ```
    </CodeGroup>

    You should see a greeting message from Dex, the dev agent.
  </Step>

  <Step title="Try Your First Command">
    Once an agent is activated, try getting help:

    ```bash theme={null}
    *help
    ```

    This displays all available commands for the active agent.

    Common commands to try:

    * `*help` - Show available commands
    * `*status` - Check current agent status
    * `*agents` - List all available agents
  </Step>
</Steps>

## Next Steps

Now that AIOX is installed and you've activated your first agent, explore these areas:

<CardGroup cols={2}>
  <Card title="Core Concepts" icon="book" href="/concepts/architecture">
    Understand AIOX architecture and principles
  </Card>

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

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

  <Card title="First Project" icon="rocket" href="/guides/first-project">
    Build your first project with AIOX
  </Card>
</CardGroup>

## Available Agents

AIOX includes 11 specialized agents for different roles:

<CardGroup cols={3}>
  <Card title="@dev" icon="code" href="/agents/dev">
    Developer - Code implementation
  </Card>

  <Card title="@qa" icon="check" href="/agents/qa">
    Quality Assurance - Testing
  </Card>

  <Card title="@architect" icon="diagram-project" href="/agents/architect">
    Architect - System design
  </Card>

  <Card title="@pm" icon="list-check" href="/agents/pm">
    Product Manager - Strategy
  </Card>

  <Card title="@po" icon="clipboard-list" href="/agents/po">
    Product Owner - Backlog
  </Card>

  <Card title="@sm" icon="users-gear" href="/agents/sm">
    Scrum Master - Facilitation
  </Card>

  <Card title="@analyst" icon="chart-line" href="/agents/analyst">
    Analyst - Research
  </Card>

  <Card title="@devops" icon="server" href="/agents/devops">
    DevOps - Operations
  </Card>

  <Card title="@data-engineer" icon="database" href="/agents/data-engineer">
    Data Engineer - Databases
  </Card>
</CardGroup>

## Troubleshooting

<Accordion title="Node.js version error">
  AIOX requires Node.js 18.0.0 or higher. Update Node.js:

  ```bash theme={null}
  # Using nvm
  nvm install 20
  nvm use 20

  # Or download from nodejs.org
  ```
</Accordion>

<Accordion title="Permission denied errors">
  Try running with npx instead of global install:

  ```bash theme={null}
  npx aiox-core install
  ```

  Or fix npm permissions: [https://docs.npmjs.com/resolving-eacces-permissions-errors](https://docs.npmjs.com/resolving-eacces-permissions-errors)
</Accordion>

<Accordion title="Agent not responding">
  1. Verify agent activation syntax for your IDE
  2. Check that AIOX is properly installed: `npx aiox-core doctor`
  3. Review IDE-specific setup in the [IDE Integration guide](/advanced/ide-integration)
</Accordion>

<Accordion title="Installation fails">
  1. Clear npm cache: `npm cache clean --force`
  2. Delete node\_modules: `rm -rf node_modules package-lock.json`
  3. Reinstall: `npm install`
  4. Try again: `npx aiox-core install`
</Accordion>

## Need Help?

<CardGroup cols={2}>
  <Card title="Full Installation Guide" icon="book-open" href="/installation">
    Detailed installation instructions for all platforms
  </Card>

  <Card title="User Guide" icon="map" href="/guides/user-guide">
    Complete walkthrough of AIOX features
  </Card>

  <Card title="GitHub Issues" icon="github" href="https://github.com/SynkraAI/aiox-core/issues">
    Report bugs or request features
  </Card>

  <Card title="Troubleshooting Guide" icon="wrench" href="/guides/installation-troubleshooting">
    Solve common installation problems
  </Card>
</CardGroup>