◆ APEX v2.0.0

The universal AI coding agent. Every model. One terminal.

Install · Docs · CLI · Security · Models · Sponsor

---

APEX runs any LLM in your terminal as a coding agent — Anthropic, OpenAI, Google, Groq, Mistral, DeepSeek, Ollama (local), and 170+ more via litellm. Switch models mid-session. Track costs live. Never leave your terminal.

---

✨ Why APEX?

	APEX	OpenCode	Claude Code	Aider
Every model (170+)	✅	⚠️	❌	⚠️
11 specialized agents	✅	✅	❌	❌
Primary + Subagent system	✅	✅	❌	❌
Hierarchical JSON config	✅	✅	❌	❌
12 themes (dark/light)	✅	✅	❌	❌
Session sharing (URL)	✅	✅	❌	❌
Auto-formatting	✅	✅	❌	❌
Custom commands (.md)	✅	✅	❌	❌
Switch model mid-session	✅	❌	❌	❌
Works offline (Ollama)	✅	❌	❌	✅
Leader key shortcuts	✅	✅	❌	❌
Command palette (Ctrl+P)	✅	✅	❌	❌
@file references / !bash	✅	✅	❌	❌
Beautiful Ink TUI + WebSocket EventBus

---

🚀 Quick Start

# 1. Set your API key
export ANTHROPIC_API_KEY=sk-ant-...

# 2. Launch APEX (TUI auto-starts)
apex

# 3. Ask anything
> fix the authentication bug in auth.py
> add TypeScript types to all functions
> write tests for the payment module

Switch models / agents anytime:

apex --model gpt-4o            # Start with GPT-4o
apex --model ollama-llama3      # Local, no API key needed
apex --agent architect          # Start in read-only architect mode
apex --continue                 # Resume last session
apex --session mysession        # Load a specific session

---

🎨 TUI — Terminal User Interface

APEX features a modern terminal UI built with Ink (React for terminals). The TUI connects to the APEX backend via HTTP SSE for real-time token streaming, live cost tracking, and context percentage monitoring. The backend runs on a random localhost port with a WebSocket EventBus for real-time state synchronization, following the OpenCode architecture pattern.

apex              # Launch TUI (default)
apex --model gpt-4o            # Start with GPT-4o

Keybindings

Key	Action
Tab / Shift+Tab	Cycle agents
Ctrl+P	Command palette
Ctrl+K	Model selector
Ctrl+X	Leader key (prefix)
Ctrl+X N	New session
Ctrl+X U	Undo
Ctrl+X R	Redo
Ctrl+X C	Compact context
Ctrl+X M	List models
Ctrl+X T	Theme selector
Ctrl+X S	Status overview
Ctrl+X A	Agent list
Ctrl+X L	Sessions list
Ctrl+X B	Toggle sidebar
Ctrl+X E	Open editor
Ctrl+X X	Export session
Ctrl+X Q	Quit
@	File references (fuzzy search)
!	Bash commands inline
?	Help panel
Ctrl+O	Toggle sidebar
Ctrl+L	Clear messages
Ctrl+T	Cycle reasoning variants
Escape	Close overlay
Ctrl+Q	Quit

Features

• 11 Agents: 4 primary (Tab) + 4 subagents (@mention) + 3 system
• 170+ Models: OpenAI, Anthropic, Google, Meta, Mistral, DeepSeek, xAI, etc.
• Live Metrics: Token streaming, per-message cost, total spent, context %
• 12 Themes: apex, nord, catppuccin, tokyonight, gruvbox, matrix, etc.
• Agent Theming: Title bar and status bar change color per agent
• 75+ Tools: File, Code, Shell, Git, Web, Database, Docker, K8s, Security
• MCP/LSP: Server status monitoring
• Leader Keys: Ctrl+X + mnemonic for all actions
• Command Palette: Ctrl+P with fuzzy search
• @ References: Fuzzy file search with @filename
• ! Bash: Run shell commands inline with !command
• HTTP Backend: Local SSE server on random port with WebSocket EventBus

---

🎮 Agents

APEX has 11 specialized agents organized by type:

Primary Agents (Tab to cycle)

Agent	Color	Description
Coder	Cyan	Full-access development agent with all tools
Architect	Purple	Architecture analysis & design (read-only)
Planner	Yellow	Planning & strategy (read-only)
Shell	Orange	Infrastructure, DevOps, CI/CD

Subagents (@mention to invoke)

Agent	Description
@reviewer	Code review & audit specialist
@general	General-purpose multi-task assistant
@explore	Fast read-only codebase exploration
@scout	External docs & dependency research

System Agents (automatic, hidden)

Agent	Role
@compaction	Context window compression
@title	Session title generation
@summary	Session summary generation

Custom agents via Markdown files in .apex/agents/*.md or ~/.config/apex/agents/*.md.

---

📋 CLI Commands

apex                          # Launch TUI (default)
apex run <prompt>             # Non-interactive mode
apex serve                    # Start headless HTTP API server
apex web                      # Server + web interface
apex gateway start            # Start APEX Gateway (proxy + auth + rate limits)
apex gateway key <tier>       # Generate a gateway API key
apex gateway status           # Show gateway keys and usage
apex auth login               # Interactive provider login
apex auth list                # List configured providers
apex auth logout              # Remove provider config
apex agent create             # Interactive agent wizard
apex agent list               # List all agents
apex session list             # List sessions
apex session delete <id>      # Delete a session
apex stats                    # Token usage & cost stats
apex export <id>              # Export session as JSON
apex import <file|url>        # Import session
apex upgrade                  # Upgrade APEX
apex uninstall                # Remove APEX
apex mcp add                  # Add MCP server
apex mcp list                 # List MCP servers
apex mcp auth <name>          # Authenticate MCP server
apex db path                  # Show database path
apex pr <number>              # Fetch & checkout PR
apex attach <url>             # Attach to remote backend
apex connect                  # Interactive provider config
apex init                     # Initialize project
apex compact                  # Compact context
apex details                  # Toggle tool output
apex thinking                 # Toggle reasoning blocks
apex models [provider]        # List models
apex --model <name>           # Set model
apex --agent <name>           # Set agent
apex --continue               # Resume last session

---

🔧 Configuration

APEX uses hierarchical JSON/JSONC config (like OpenCode):

# Global config
~/.config/apex/apex.json       # Main config
~/.config/apex/tui.json        # TUI-specific config

# Project config (overrides global)
./apex.json
./apex.jsonc

# Env vars (inline override)
APEX_CONFIG=./custom.json
APEX_CONFIG_CONTENT='{"model": "gpt-4o"}'

apex.json schema

{
  "$schema": "https://apex-ai.dev/config.json",
  "model": "claude-sonnet-4-5",
  "theme": "nord",
  "agent": {
    "code-reviewer": {
      "description": "Reviews code for best practices",
      "mode": "subagent",
      "permission": { "edit": "deny" }
    }
  },
  "command": {
    "test": {
      "template": "Run tests with coverage",
      "description": "Run tests"
    }
  },
  "permission": { "edit": "ask", "bash": "ask" },
  "formatter": true,
  "lsp": true,
  "share": "manual",
  "snapshot": true,
  "server": { "port": 0, "hostname": "127.0.0.1" },
  "watcher": {
    "ignore": ["**/node_modules/**", "**/.git/**"]
  }
}

Variables in config

{
  "model": "{env:APEX_MODEL}",
  "provider": {
    "anthropic": { "apiKey": "{file:~/.secrets/anthropic-key}" }
  }
}

---

🛠️ What APEX Can Do

• Read & edit files — understands your whole codebase
• Run commands — tests, builds, installs, git
• Search code — grep-style across your project
• 11 agents — specialized for different tasks
• Subagents — invoke via @mention for parallel tasks
• Custom commands — define via .apex/commands/*.md
• Auto-formatting — ruff, prettier, gofmt, rustfmt, etc.
• File watching — configurable ignore patterns
• Session sharing — public URLs for collaboration
• Fix bugs — diagnoses, patches, and verifies
• Write features — complete implementations
• Refactor code — preserves your style
• Write tests — pytest, jest, go test, and more
• Explain code — line by line if needed

---

🎭 Themes

12 built-in themes with dark/light mode support:

apex          ayu           catppuccin    catppuccin-macchiato
everforest    gruvbox       kanagawa      matrix
nord          one-dark      system        tokyonight

# Via TUI
Ctrl+X T         # Theme selector

# Via config
echo '{"theme": "nord"}' > ~/.config/apex/tui.json

Custom themes in ~/.config/apex/themes/*.json or .apex/themes/*.json.

---

🔗 Session Sharing

Share conversations with your team:

/share          # Create shareable URL → https://apex-ai.dev/s/abc123
/unshare        # Remove shared session

Modes: manual (default) | auto | disabled (set in config)

---

🎨 Formatters

Auto-formatting support for 11 languages:

Python:     ruff
JS/TS/JSON: prettier
Rust:       rustfmt
Go:         gofmt
Java:       google-java-format
C/C++:      clang-format
Ruby:       rubocop
Scala:      scalafmt
Kotlin:     ktlint
Swift:      swift-format
Zig:        zig fmt

# Enable all formatters
echo '{"formatter": true}' > apex.json

# Per-formatter config
echo '{"formatter": {"prettier": {"disabled": true}}}' > apex.json

---

🔒 Security

APEX includes comprehensive security features:

Shell Command Analysis

Blocks dangerous patterns: rm -rf /, curl | sh, fork bombs, disk writes.

Permission System

Fine-grained ALLOW/DENY/ASK per tool with glob pattern support.

Rate Limiting & API Keys

Database-backed rate limiting with workspace-based API keys.

HTTP API Security

Bearer token auth on all endpoints, configurable via config.

---

⚡ Installation

One-line install

macOS / Linux:

curl -fsSL https://raw.githubusercontent.com/Ggboykxz/APEX/main/install.sh | bash

Windows (PowerShell):

irm https://raw.githubusercontent.com/Ggboykxz/APEX/main/install.ps1 | iex

Package managers

Method	Command
uv (fastest)	uv tool install apex-ai
pipx (isolated)	pipx install apex-ai
pip	pip install apex-ai
Docker	docker run -it -v $(pwd):/workspace ghcr.io/ggboykxz/apex

From source

git clone https://github.com/Ggboykxz/APEX
cd APEX
pip install -e ".[dev]"

---

⚡ APEX Gateway (Zero-Config Free Models)

APEX Gateway is a built