Skip to main content

​
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

1

Install AIOX

Choose one of the following installation methods:
Create a new project with AIOX:
npx aiox-core init my-project
cd my-project
The installer will guide you through an interactive setup with:
  • Project name selection
  • Component selection
  • IDE configuration
  • Dependency installation
2

Verify Installation

Confirm AIOX is installed correctly:
npx aiox-core doctor
This command checks:
  • Node.js and npm versions
  • AIOX framework files
  • Agent definitions
  • Configuration files
3

Configure Your IDE

Choose your IDE and follow the setup:
Codex CLI reads from AGENTS.md at the project root.Generate skills for local activation:
npm run sync:skills:codex
Activate agents using the /skills command in Codex.
  1. Open Cursor settings
  2. Navigate to User Rules
  3. Copy contents from .cursor/global-rules.md
  4. Paste in rules section and save
Sync agents and hooks:
npm run sync:ide:gemini
Use slash commands like /aiox-dev or /aiox-architect to activate agents.
4

Activate Your First Agent

Let’s activate the dev agent to see AIOX in action:
@dev
You should see a greeting message from Dex, the dev agent.
5

Try Your First Command

Once an agent is activated, try getting help:
*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

​
Next Steps

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

Core Concepts

Understand AIOX architecture and principles

Agents Overview

Learn about all 11 specialized agents

CLI Reference

Master the AIOX command-line interface

First Project

Build your first project with AIOX

​
Available Agents

AIOX includes 11 specialized agents for different roles:

@dev

Developer - Code implementation

@qa

Quality Assurance - Testing

@architect

Architect - System design

@pm

Product Manager - Strategy

@po

Product Owner - Backlog

@sm

Scrum Master - Facilitation

@analyst

Analyst - Research

@devops

DevOps - Operations

@data-engineer

Data Engineer - Databases

​
Troubleshooting

AIOX requires Node.js 18.0.0 or higher. Update Node.js:
# Using nvm
nvm install 20
nvm use 20

# Or download from nodejs.org
Try running with npx instead of global install:
npx aiox-core install
Or fix npm permissions: https://docs.npmjs.com/resolving-eacces-permissions-errors
  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
  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

​
Need Help?

Full Installation Guide

Detailed installation instructions for all platforms

User Guide

Complete walkthrough of AIOX features

GitHub Issues

Report bugs or request features

Troubleshooting Guide

Solve common installation problems

Build docs developers (and LLMs) love

Get started for freeTalk to us