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

# CLI Commands Reference

> Complete reference for all AIOX CLI commands

Comprehensive reference for all AIOX CLI commands beyond `init` and `install`.

## System Commands

### doctor

Run health checks on your AIOX installation.

```bash theme={null}
aiox doctor [options]
```

<ParamField path="--fix" type="flag">
  Automatically fix detected issues.

  ```bash theme={null}
  aiox doctor --fix
  ```
</ParamField>

<ParamField path="--dry-run" type="flag">
  Show what `--fix` would do without making changes.

  ```bash theme={null}
  aiox doctor --fix --dry-run
  ```
</ParamField>

<ParamField path="--json" type="flag">
  Output results as structured JSON.

  ```bash theme={null}
  aiox doctor --json
  ```
</ParamField>

<ParamField path="--quiet" type="flag">
  Minimal output (exit code only).

  ```bash theme={null}
  aiox doctor --quiet
  ```
</ParamField>

**Checks performed:**

* Required directories exist (`.aiox-core/`, `.aiox/`)
* Configuration files are valid JSON/YAML
* Agent definitions are complete
* Task files have required fields
* Dependencies are installed

**Exit codes:**

* `0` - All checks passed (or issues fixed with `--fix`)
* `1` - Issues detected (run with `--fix` to repair)

**Examples:**

```bash theme={null}
# Run health check
aiox doctor

# Auto-fix detected issues
aiox doctor --fix

# Preview what would be fixed
aiox doctor --fix --dry-run
```

***

### info

Show system information about your AIOX installation.

```bash theme={null}
aiox info
```

Displays:

* AIOX version
* Platform and Node.js version
* Architecture
* Working directory
* Install location
* Component counts (agents, tasks, templates, workflows)
* AIOX Pro license status (if installed)

**Example output:**

```
📊 AIOX-FullStack System Information

Version: 4.0.0
Platform: linux
Node.js: v20.11.0
Architecture: x64
Working Directory: /home/user/project
Install Location: /home/user/.npm/_npx/aiox-core

✓ AIOX Core installed
  - Agents: 11
  - Tasks: 68
  - Templates: 23
  - Workflows: 15

✓ AIOX Pro installed
  - License: ✅ Active
  - Features: 12 available
```

***

### validate

Validate AIOX-Core installation integrity.

```bash theme={null}
aiox validate [options]
```

<ParamField path="--repair" type="flag">
  Repair missing or corrupted files.

  ```bash theme={null}
  aiox validate --repair
  ```
</ParamField>

<ParamField path="--dry-run" type="flag">
  Preview repairs without applying (use with `--repair`).

  ```bash theme={null}
  aiox validate --repair --dry-run
  ```
</ParamField>

<ParamField path="--detailed" type="flag">
  Show detailed file list.

  ```bash theme={null}
  aiox validate --detailed
  ```
</ParamField>

<ParamField path="--no-hash" type="flag">
  Skip hash verification (faster validation).

  ```bash theme={null}
  aiox validate --no-hash
  ```
</ParamField>

<ParamField path="--extras" type="flag">
  Detect extra files not in manifest.

  ```bash theme={null}
  aiox validate --extras
  ```
</ParamField>

<ParamField path="--json" type="flag">
  Output results as JSON for CI/CD.

  ```bash theme={null}
  aiox validate --json
  ```
</ParamField>

<ParamField path="--source" type="string">
  Source directory for repairs.

  ```bash theme={null}
  aiox validate --repair --source /path/to/aiox-core
  ```
</ParamField>

**Exit codes:**

* `0` - Validation passed
* `1` - Validation failed (missing/corrupted files)
* `2` - Validation error (could not complete)

**Examples:**

```bash theme={null}
# Validate current installation
aiox validate

# Validate with detailed file list
aiox validate --detailed

# Repair missing/corrupted files
aiox validate --repair

# Preview what would be repaired
aiox validate --repair --dry-run

# Quick validation (skip hash check)
aiox validate --no-hash

# Output as JSON for CI/CD
aiox validate --json
```

***

### update

Update AIOX to the latest version.

```bash theme={null}
aiox update [options]
```

<ParamField path="--check" type="flag">
  Check for updates without applying.

  ```bash theme={null}
  aiox update --check
  ```
</ParamField>

<ParamField path="--dry-run" type="flag">
  Preview what would be updated.

  ```bash theme={null}
  aiox update --dry-run
  ```
</ParamField>

<ParamField path="--force" type="flag">
  Force update even if already up-to-date.

  ```bash theme={null}
  aiox update --force
  ```
</ParamField>

<ParamField path="--verbose" type="flag">
  Show detailed output during update.

  ```bash theme={null}
  aiox update --verbose
  ```
</ParamField>

**Examples:**

```bash theme={null}
# Update to latest version
aiox update

# Check for updates without applying
aiox update --check

# Preview what would be updated
aiox update --dry-run

# Force update even if up-to-date
aiox update --force

# Show detailed output
aiox update --verbose
```

***

### uninstall

Remove AIOX from the current project.

```bash theme={null}
aiox uninstall [options]
```

<ParamField path="--force" type="flag">
  Skip confirmation prompt.

  ```bash theme={null}
  aiox uninstall --force
  ```
</ParamField>

<ParamField path="--keep-data" type="flag">
  Keep `.aiox/` directory (settings and history).

  ```bash theme={null}
  aiox uninstall --keep-data
  ```
</ParamField>

<ParamField path="--dry-run" type="flag">
  Show what would be removed without removing.

  ```bash theme={null}
  aiox uninstall --dry-run
  ```
</ParamField>

**What gets removed:**

* `.aiox-core/` - Framework core files
* `docs/stories/` - Story files (if created by AIOX)
* `squads/` - Squad definitions
* `.gitignore` - AIOX-added entries only

**What is preserved (with `--keep-data`):**

* `.aiox/` - Project settings and agent history

**Exit codes:**

* `0` - Uninstall successful
* `1` - Uninstall failed or cancelled

**Examples:**

```bash theme={null}
# Interactive uninstall (with confirmation)
aiox uninstall

# Force uninstall without prompts
aiox uninstall --force

# See what would be removed
aiox uninstall --dry-run

# Uninstall but keep project data
aiox uninstall --keep-data
```

***

## Configuration Commands

### config show

Show resolved configuration from layered config files.

```bash theme={null}
aiox config show [options]
```

<ParamField path="--level" type="string">
  Show specific level (1, 2, pro, 3, 4) without merging.

  ```bash theme={null}
  aiox config show --level 2
  ```
</ParamField>

<ParamField path="--app" type="string">
  Include app-specific config (L3).

  ```bash theme={null}
  aiox config show --app my-app
  ```
</ParamField>

<ParamField path="--debug" type="flag">
  Show source annotations for each value.

  ```bash theme={null}
  aiox config show --debug
  ```
</ParamField>

**Examples:**

```bash theme={null}
# Show full resolved config
aiox config show

# Show only framework config (L1)
aiox config show --level 1

# Show with source annotations
aiox config show --debug
```

***

### config diff

Compare configuration between two levels.

```bash theme={null}
aiox config diff --levels <a>,<b> [options]
```

<ParamField path="--levels" type="string" required>
  Two levels to compare (e.g., "1,2" or "framework,project").

  ```bash theme={null}
  aiox config diff --levels 1,2
  ```
</ParamField>

<ParamField path="--app" type="string">
  Include app-specific context.

  ```bash theme={null}
  aiox config diff --levels 1,2 --app my-app
  ```
</ParamField>

**Examples:**

```bash theme={null}
# Compare framework and project configs
aiox config diff --levels 1,2

# Compare project and local configs
aiox config diff --levels project,local
```

***

### config migrate

Migrate monolithic `core-config.yaml` to layered files.

```bash theme={null}
aiox config migrate [options]
```

<ParamField path="--dry-run" type="flag">
  Preview without writing files.

  ```bash theme={null}
  aiox config migrate --dry-run
  ```
</ParamField>

<ParamField path="--force" type="flag">
  Overwrite existing split files.

  ```bash theme={null}
  aiox config migrate --force
  ```
</ParamField>

**Examples:**

```bash theme={null}
# Preview migration
aiox config migrate --dry-run

# Perform migration
aiox config migrate

# Force overwrite existing files
aiox config migrate --force
```

***

### config validate

Validate YAML syntax and lint config files.

```bash theme={null}
aiox config validate [options]
```

<ParamField path="--level" type="string">
  Validate specific level only.

  ```bash theme={null}
  aiox config validate --level 2
  ```
</ParamField>

**Examples:**

```bash theme={null}
# Validate all config levels
aiox config validate

# Validate only project config
aiox config validate --level project
```

***

### config init-local

Create `local-config.yaml` from template.

```bash theme={null}
aiox config init-local
```

Creates `.aiox-core/local-config.yaml` from `.aiox-core/local-config.yaml.template` and updates `.gitignore`.

***

## Workers Discovery

### workers search

Search for workers matching a query.

```bash theme={null}
aiox workers search <query> [options]
```

<ParamField path="query" type="string" required>
  Search query (supports multi-word queries).

  ```bash theme={null}
  aiox workers search "json transformation"
  ```
</ParamField>

<ParamField path="--category" type="string">
  Filter by category.

  ```bash theme={null}
  aiox workers search "transform" --category=data
  ```
</ParamField>

<ParamField path="--tags" type="string">
  Filter by tags (comma-separated).

  ```bash theme={null}
  aiox workers search "api" --tags=rest,graphql
  ```
</ParamField>

<ParamField path="--format" type="string">
  Output format (table, json).

  ```bash theme={null}
  aiox workers search "json" --format=json
  ```
</ParamField>

**Examples:**

```bash theme={null}
# Search for workers
aiox workers search "json transformation"

# Search with category filter
aiox workers search "data" --category=etl

# Search with tags
aiox workers search "transform" --tags=etl,data

# JSON output
aiox workers search "api" --format=json
```

***

### workers list

List all workers grouped by category.

```bash theme={null}
aiox workers list [options]
```

<ParamField path="--category" type="string">
  Filter by category.

  ```bash theme={null}
  aiox workers list --category=testing
  ```
</ParamField>

<ParamField path="--format" type="string">
  Output format (table, json).

  ```bash theme={null}
  aiox workers list --format=table
  ```
</ParamField>

<ParamField path="--page" type="number">
  Page number for pagination.

  ```bash theme={null}
  aiox workers list --page=2
  ```
</ParamField>

**Examples:**

```bash theme={null}
# List all workers
aiox workers list

# List workers in testing category
aiox workers list --category=testing

# Table format with pagination
aiox workers list --format=table --page=2
```

***

### workers info

Show detailed information about a worker.

```bash theme={null}
aiox workers info <id> [options]
```

<ParamField path="id" type="string" required>
  Worker ID.

  ```bash theme={null}
  aiox workers info json-csv-transformer
  ```
</ParamField>

<ParamField path="--format" type="string">
  Output format (json, yaml).

  ```bash theme={null}
  aiox workers info architect-checklist --format=json
  ```
</ParamField>

**Examples:**

```bash theme={null}
# Show worker details
aiox workers info json-csv-transformer

# JSON output
aiox workers info architect-checklist --format=json
```

***

## Pro Features

### pro activate

Activate AIOX Pro license.

```bash theme={null}
aiox pro activate --key <license-key>
```

***

### pro status

Show AIOX Pro license status.

```bash theme={null}
aiox pro status
```

***

### pro deactivate

Deactivate AIOX Pro license.

```bash theme={null}
aiox pro deactivate
```

***

### pro features

List available Pro features.

```bash theme={null}
aiox pro features
```

***

## Version Information

### --version

Show installed version.

```bash theme={null}
aiox --version
```

**Output:**

```
4.0.0
```

***

### --version -d

Show detailed version information.

```bash theme={null}
aiox --version -d
```

**Output:**

```
AIOX-FullStack v4.0.0
Package: aiox-core

📦 Local Installation:
  Version:    4.0.0
  Mode:       project-development
  Installed:  3/5/2024
  Updated:    3/5/2024
  Files:      150 tracked
  Customized: 0 files

✅ Up to date
```

***

## Exit Codes

Consistent exit codes across all commands:

* **0** - Success
* **1** - Validation/check failed
* **2** - Error (command could not complete)

## Global Help

Get help for any command:

```bash theme={null}
aiox --help
aiox <command> --help
aiox <command> <subcommand> --help
```

**Examples:**

```bash theme={null}
aiox --help
aiox config --help
aiox config show --help
aiox workers search --help
```
