# AIW - AI CLI & MCP Unified Gateway
<div align="center">
**Unified Router & Proxy for AI CLI Tools and MCP Servers**
</div>
## What is AIW?
AIW is a **unified gateway** that acts as:
| **AI CLI Proxy** | Router + Proxy | Route requests to claude/codex/gemini with provider switching, role injection, and transparent parameter forwarding |
| **MCP Proxy** | Router + Proxy | Route tool calls to multiple MCP servers with intelligent selection, plugin marketplace, and hot-reload |
```
┌─────────────────────────────────────────────────────────────┐
│ AIW Gateway │
├─────────────────────────────────────────────────────────────┤
│ │
│ ┌─────────────────────┐ ┌─────────────────────────────┐ │
│ │ AI CLI Router │ │ MCP Router │ │
│ │ │ │ │ │
│ │ aiw claude ... ───┼───►│ Claude CLI │ │
│ │ aiw codex ... ───┼───►│ Codex CLI │ │
│ │ aiw gemini ... ───┼───►│ Gemini CLI │ │
│ │ │ │ │ │
│ │ + Provider Switch │ │ aiw mcp serve ────────────►│ │
│ │ + Role Injection │ │ ├─► filesystem server │ │
│ │ + Param Forwarding │ │ ├─► git server │ │
│ │ + CWD Control │ │ ├─► database server │ │
│ │ │ │ └─► ... (plugin market) │ │
│ └─────────────────────┘ └─────────────────────────────┘ │
│ │
└─────────────────────────────────────────────────────────────┘
```
## Installation
```bash
# Install from NPM
npm install -g @putao520/aiw
# Verify installation
aiw --version
```
## AI CLI Router & Proxy
### Basic Usage
```bash
# Route to specific AI CLI
aiw claude "explain this code"
aiw codex "write tests"
aiw gemini "translate to Chinese"
# Auto mode: automatic failover across AI CLIs
aiw auto "fix this bug" # Try CLIs in order, auto-switch on failure
aiw auto -p auto "implement feature" # Auto-switch CLIs + auto-select provider
# Route to multiple AI CLIs
aiw all "review this code" # All available CLIs
### Provider Switching (-p)
```bash
# Switch API provider without changing AI CLI
aiw claude -p openrouter "explain this"
aiw claude -p glm "explain this"
aiw claude -p anthropic "explain this"
# Auto-select compatible provider
aiw claude -p auto "explain this" # Randomly select compatible provider
aiw auto -p auto "implement feature" # Auto CLI + auto provider
# Provider config: ~/.aiw/providers.json
```
### Auto Mode (Automatic Failover)
```bash
# Auto mode tries CLI+Provider combinations in configured order, switches on failure
aiw auto "fix this bug"
# Configure CLI+Provider execution order
aiw config cli-order # TUI to manage order (↑/↓ move, r reset, q save)
```
**How it works**:
1. Reads `auto_execution_order` from `~/.aiw/config.json`
2. Tries each CLI+Provider combination in order (e.g., codex+auto → gemini+auto → claude+auto)
3. Judges success/failure by exit code (0 = success)
4. Switches to next combination if current fails
5. Failed combinations enter 30-second cooldown period
**Configuration** (`~/.aiw/config.json`):
```json
{
"auto_execution_order": [
{"cli": "codex", "provider": "auto"},
{"cli": "gemini", "provider": "auto"},
{"cli": "claude", "provider": "glm"},
{"cli": "claude", "provider": "local"},
{"cli": "claude", "provider": "official"}
]
}
```
**Features**:
- Same CLI can be configured with multiple providers (e.g., claude+glm → claude+local → claude+official)
- Each CLI+Provider combination has independent cooldown (30 seconds after failure)
- Provider "auto" means use the CLI's default provider selection
- Order can be fully customized via TUI or direct config editing
### Role Injection (-r)
```bash
# Inject role prompt before task
aiw claude -r common "write a function"
aiw claude -r security "review this code"
aiw claude -r debugger "fix this bug"
# 22 built-in roles + custom roles in ~/.aiw/role/*.md
aiw roles list
```
### Working Directory (-C)
```bash
# Start AI CLI in specific directory
aiw claude -C /path/to/project "implement feature"
aiw claude -r common -C ~/myproject "fix the bug"
```
### Git Worktree (Isolated Execution)
**New in v0.5.49**: AIW automatically creates a git worktree for isolated AI CLI execution.
When you run AIW in a git repository, it:
1. Validates the directory is a git repository
2. Creates a worktree at `/tmp/aiw-worktree-<8hex>`
3. Executes the AI CLI in the isolated worktree
4. Outputs worktree information after task completion
```bash
# AIW automatically creates worktree for git repositories
aiw codex -C /path/to/repo "implement feature"
# After completion, AIW outputs:
# === AIW WORKTREE END ===
# Worktree: /tmp/aiw-worktree-a1b2c3d4
# Branch: main
# Commit: abc123def456
```
**Benefits**:
- 🛡️ **Isolation**: AI CLI works in a temporary worktree, keeping your working directory clean
- 🔍 **Traceability**: Worktree path, branch, and commit are logged for review
- 🧹 **No Cleanup**: Worktree remains for manual review; you can merge changes or delete it
**Error Handling**:
- Non-git directory → AIW refuses to run with clear error message
- Worktree already exists → AIW reports the conflict and exits
### Transparent Parameter Forwarding
```bash
# All unknown flags forwarded to AI CLI
aiw claude -p glm --model sonnet --debug api "explain this"
aiw claude -r security --print --output-format json "review"
# Order: aiw flags (-r, -p, -C) → AI CLI flags → prompt
```
### Combined Example
```bash
# Full example with all options
aiw claude -r common -p glm -C ~/project --model sonnet "implement REQ-001"
# ^^^^^^^^ ^^^^^ ^^^^^^^^^^^ ^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^
# role provider cwd forwarded prompt
```
## MCP Router & Proxy
### Start MCP Server
```bash
# Start AIW as MCP server
aiw mcp serve
# Configure in Claude Code (~/.claude/settings.json)
{
"mcpServers": {
"aiw": {
"command": "aiw",
"args": ["mcp", "serve"]
}
}
}
```
### MCP Server Management
```bash
# List configured MCP servers
aiw mcp list
# Add MCP server
aiw mcp add filesystem npx -- -y @modelcontextprotocol/server-filesystem $HOME
# Enable/disable servers (hot-reload)
aiw mcp enable filesystem
aiw mcp disable git
# Edit config directly
aiw mcp edit
```
### MCP Registry (Search & Install)
```bash
# Browse all available MCP servers (interactive TUI)
aiw mcp browse
# Search across registries (Official + Smithery)
aiw mcp search "git"
aiw mcp search "database" --source official
# Get server info
aiw mcp info @anthropic/filesystem
# Install server
aiw mcp install @anthropic/filesystem
aiw mcp install @anthropic/filesystem --env API_KEY=xxx
```
### Plugin Marketplace
```bash
# Browse MCP plugins (interactive TUI)
aiw plugin browse
# Search plugins
aiw plugin search "playwright"
# Install plugin
aiw plugin install playwright@claude-code-official
# List/manage installed plugins
aiw plugin list
aiw plugin enable playwright
aiw plugin disable serena
aiw plugin remove playwright
# Manage marketplace sources
aiw plugin marketplace list
aiw plugin marketplace add my-market https://github.com/user/plugins
```
## Task Monitoring
```bash
# Show task status
aiw status
# Wait for all AI CLI tasks to complete
aiw wait
# Wait for specific process
aiw pwait <PID>
```
## Update
```bash
# Update AIW and all AI CLI tools
aiw update
```
## Configuration Files
| `~/.aiw/config.json` | AIW global configuration |
| `~/.aiw/providers.json` | AI provider configurations |
| `~/.aiw/mcp.json` | MCP server configurations |
| `~/.aiw/role/*.md` | Custom role prompts |
| `~/.aiw/settings.json` | Plugin marketplace settings |
| `~/.aiw/plugins.json` | Installed plugin records |
### Global Configuration (~/.aiw/config.json)
```json
{
"user_roles_dir": "~/.claude/roles",
"auto_execution_order": [
{"cli": "codex", "provider": "auto"},
{"cli": "gemini", "provider": "auto"},
{"cli": "claude", "provider": "auto"}
]
}
```
| `user_roles_dir` | string | Custom directory for user roles (supports `~` expansion). If set, AIW will load user roles from this directory instead of `~/.aiw/role/` |
| `auto_execution_order` | array | CLI+Provider combinations for auto mode. Each entry has `cli` (codex/gemini/claude) and `provider` (provider name or "auto"). Use `aiw config cli-order` TUI to manage |
This allows you to manage all your roles in a single location, such as `~/.claude/roles/`, and share them across different tools.
## Quick Reference
```bash
# AI CLI routing
aiw <cli> [-r role] [-p provider] [-C cwd] [cli-args...] "prompt"
aiw auto [-p provider] "prompt" # Auto mode with failover
# Configuration
aiw config cli-order # Manage CLI execution order (TUI)
# MCP commands
aiw mcp serve # Start MCP server
aiw mcp install|info # Install servers
# Plugin commands
aiw plugin list|enable|disable
# Other commands
aiw status # Task status
aiw wait # Wait for tasks
aiw update # Update tools
aiw roles list # List roles
aiw help <command> # Detailed help
```
## License
MIT License - see [LICENSE](LICENSE) file for details.
---
[GitHub](https://github.com/putao520/agentic-warden) | [NPM](https://www.npmjs.com/package/@putao520/aiw)