CLI Reference
Complete reference for RAPID CLI commands.
Installation
Section titled “Installation”npm install -g @a3t/rapidGlobal Options
Section titled “Global Options”These options work with all commands:
| Option | Description |
|---|---|
--help, -h | Show help |
--version, -v | Show version |
--config <path> | Path to rapid.json |
--verbose | Verbose output |
--quiet, -q | Minimal output |
rapid init
Section titled “rapid init”Initialize RAPID in a project.
rapid init [options]Options
Section titled “Options”| Option | Default | Description |
|---|---|---|
--template <name> | default | Template to use |
--force | false | Overwrite existing files |
--no-devcontainer | false | Skip devcontainer creation |
--agent <name> | claude | Default agent to configure |
Examples
Section titled “Examples”# Basic initializationrapid init
# Use TypeScript templaterapid init --template typescript
# Initialize with OpenCode as defaultrapid init --agent opencode
# Force overwrite existing configrapid init --forceCreated Files
Section titled “Created Files”project/├── rapid.json # RAPID configuration├── AGENTS.md # Generic agent instructions├── CLAUDE.md # Claude-specific instructions└── .devcontainer/ # (if not present) ├── devcontainer.json └── Dockerfilerapid start
Section titled “rapid start”Start the development environment.
rapid start [options]Options
Section titled “Options”| Option | Default | Description |
|---|---|---|
--rebuild | false | Force rebuild container |
--no-cache | false | Build without Docker cache |
--reinstall-tools | false | Reinstall AI CLI tools |
--skip-secrets | false | Skip secret loading |
--detach, -d | false | Run in background |
Examples
Section titled “Examples”# Normal startrapid start
# Force full rebuildrapid start --rebuild --no-cache
# Start without loading secretsrapid start --skip-secrets
# Start in backgroundrapid start -dExit Codes
Section titled “Exit Codes”| Code | Meaning |
|---|---|
| 0 | Success |
| 1 | Configuration error |
| 2 | Docker not available |
| 3 | Build failed |
| 4 | Secret loading failed |
rapid dev
Section titled “rapid dev”Launch AI coding session.
rapid dev [options]Options
Section titled “Options”| Option | Default | Description |
|---|---|---|
--agent <name> | From config | Agent to use |
--multi | false | Launch all agents in tmux |
--attach | false | Attach to existing session |
--layout <type> | tiled | Tmux layout (multi mode) |
Layout Types (—multi)
Section titled “Layout Types (—multi)”| Layout | Description |
|---|---|
tiled | Equal size panes |
horizontal | Stacked horizontally |
vertical | Stacked vertically |
main-vertical | One large, others small |
Examples
Section titled “Examples”# Launch default agentrapid dev
# Launch specific agentrapid dev --agent aider
# Launch all agentsrapid dev --multi
# Launch with specific layoutrapid dev --multi --layout main-vertical
# Attach to running sessionrapid dev --attachrapid stop
Section titled “rapid stop”Stop the development environment.
rapid stop [options]Options
Section titled “Options”| Option | Default | Description |
|---|---|---|
--remove | false | Remove container after stop |
--volumes | false | Also remove volumes |
--force | false | Force stop (SIGKILL) |
Examples
Section titled “Examples”# Normal stoprapid stop
# Stop and remove containerrapid stop --remove
# Stop, remove container and volumesrapid stop --remove --volumes
# Force stoprapid stop --forcerapid agent
Section titled “rapid agent”Manage AI agents.
rapid agent <subcommand> [options]Subcommands
Section titled “Subcommands”rapid agent list
Section titled “rapid agent list”List available agents.
rapid agent listOutput:
Available agents: * claude (default) opencode aiderrapid agent add
Section titled “rapid agent add”Add a new agent.
rapid agent add <name> [options]| Option | Description |
|---|---|
--cli <command> | CLI command |
--instruction-file <path> | Instruction file path |
--install-cmd <command> | Installation command |
# Add with promptsrapid agent add my-agent
# Add with optionsrapid agent add my-agent \ --cli my-tool \ --instruction-file MY_AGENT.md \ --install-cmd "npm install -g my-tool"rapid agent remove
Section titled “rapid agent remove”Remove an agent.
rapid agent remove <name>rapid agent default
Section titled “rapid agent default”Set default agent.
rapid agent default <name>Examples
Section titled “Examples”# List agentsrapid agent list
# Set default to opencoderapid agent default opencode
# Add custom agentrapid agent add cursor --cli cursor --instruction-file CURSOR.md
# Remove agentrapid agent remove aiderrapid config
Section titled “rapid config”View and edit configuration.
rapid config [subcommand] [options]Subcommands
Section titled “Subcommands”rapid config show
Section titled “rapid config show”Display current configuration.
rapid config show [--json]rapid config edit
Section titled “rapid config edit”Open config in editor.
rapid config editrapid config set
Section titled “rapid config set”Set a configuration value.
rapid config set <key> <value>rapid config get
Section titled “rapid config get”Get a configuration value.
rapid config get <key>Examples
Section titled “Examples”# Show configrapid config show
# Show as JSONrapid config show --json
# Edit in $EDITORrapid config edit
# Set default agentrapid config set agents.default opencode
# Get secret providerrapid config get secrets.providerrapid secrets
Section titled “rapid secrets”Manage secrets.
rapid secrets <subcommand>Subcommands
Section titled “Subcommands”rapid secrets list
Section titled “rapid secrets list”List configured secrets (names only).
rapid secrets listrapid secrets verify
Section titled “rapid secrets verify”Verify all secrets are accessible.
rapid secrets verifyrapid secrets refresh
Section titled “rapid secrets refresh”Reload secrets into environment.
rapid secrets refreshExamples
Section titled “Examples”# List secret namesrapid secrets list
# Verify accessrapid secrets verify
# Refresh after rotationrapid secrets refreshrapid status
Section titled “rapid status”Show environment status.
rapid status [options]Options
Section titled “Options”| Option | Description |
|---|---|
--json | Output as JSON |
Output
Section titled “Output”RAPID Status────────────Container: running (rapid-my-project)Uptime: 2h 34mAgent: claude (active)Secrets: loaded (3 items)MCP: 2 servers connectedrapid logs
Section titled “rapid logs”View logs.
rapid logs [options]Options
Section titled “Options”| Option | Default | Description |
|---|---|---|
--follow, -f | false | Follow log output |
--tail <n> | 100 | Number of lines |
--container | false | Show container logs |
Examples
Section titled “Examples”# View RAPID logsrapid logs
# Follow logsrapid logs -f
# View container logsrapid logs --container
# Last 50 linesrapid logs --tail 50rapid mcp
Section titled “rapid mcp”Manage MCP (Model Context Protocol) servers.
rapid mcp <subcommand> [options]Subcommands
Section titled “Subcommands”rapid mcp list
Section titled “rapid mcp list”List configured MCP servers.
rapid mcp list [options]| Option | Description |
|---|---|
--json | Output as JSON |
--templates | Show available server templates |
# List configured serversrapid mcp list
# Show available templatesrapid mcp list --templatesrapid mcp add
Section titled “rapid mcp add”Add an MCP server.
rapid mcp add <name> [options]| Option | Description |
|---|---|
--type <type> | Server type: remote or stdio |
--url <url> | URL for remote servers |
--command <cmd> | Command for stdio servers |
--args <args> | Arguments (comma-separated) |
--header <header> | HTTP header (name=value), repeatable |
# Add from templaterapid mcp add playwright
# Add custom remote serverrapid mcp add myapi --type remote --url https://api.example.com/mcp
# Add custom stdio serverrapid mcp add mytool --type stdio --command npx --args "@example/mcp-server"rapid mcp remove
Section titled “rapid mcp remove”Remove an MCP server.
rapid mcp remove <name>rapid mcp enable
Section titled “rapid mcp enable”Enable a disabled MCP server.
rapid mcp enable <name>rapid mcp disable
Section titled “rapid mcp disable”Disable an MCP server (without removing).
rapid mcp disable <name>rapid mcp status
Section titled “rapid mcp status”Show MCP server status.
rapid mcp status [options]| Option | Description |
|---|---|
--json | Output as JSON |
rapid mcp sync
Section titled “rapid mcp sync”Regenerate .mcp.json and opencode.json from rapid.json.
rapid mcp syncExamples
Section titled “Examples”# List available templatesrapid mcp list --templates
# Add Context7 and Tavilyrapid mcp add context7rapid mcp add tavily
# Check statusrapid mcp status
# Temporarily disable a serverrapid mcp disable tavily
# Re-enable itrapid mcp enable tavily
# Remove a serverrapid mcp remove playwrightEnvironment Variables
Section titled “Environment Variables”RAPID respects these environment variables:
| Variable | Description |
|---|---|
RAPID_CONFIG | Path to rapid.json |
RAPID_LOG_LEVEL | Log verbosity (debug, info, warn, error) |
RAPID_NO_COLOR | Disable colored output |
DOCKER_HOST | Docker daemon socket |
MCP_CONFIG_FILE | Path to MCP configuration file |
Configuration File
Section titled “Configuration File”See rapid.json Specification for complete configuration reference.
See MCP Server Configuration for MCP server setup.