Skip to content

CLI Reference

Complete reference for RAPID CLI commands.

Terminal window
npm install -g @a3t/rapid

These options work with all commands:

OptionDescription
--help, -hShow help
--version, -vShow version
--config <path>Path to rapid.json
--verboseVerbose output
--quiet, -qMinimal output

Initialize RAPID in a project.

Terminal window
rapid init [options]
OptionDefaultDescription
--template <name>defaultTemplate to use
--forcefalseOverwrite existing files
--no-devcontainerfalseSkip devcontainer creation
--agent <name>claudeDefault agent to configure
Terminal window
# Basic initialization
rapid init
# Use TypeScript template
rapid init --template typescript
# Initialize with OpenCode as default
rapid init --agent opencode
# Force overwrite existing config
rapid init --force
project/
├── rapid.json # RAPID configuration
├── AGENTS.md # Generic agent instructions
├── CLAUDE.md # Claude-specific instructions
└── .devcontainer/ # (if not present)
├── devcontainer.json
└── Dockerfile

Start the development environment.

Terminal window
rapid start [options]
OptionDefaultDescription
--rebuildfalseForce rebuild container
--no-cachefalseBuild without Docker cache
--reinstall-toolsfalseReinstall AI CLI tools
--skip-secretsfalseSkip secret loading
--detach, -dfalseRun in background
Terminal window
# Normal start
rapid start
# Force full rebuild
rapid start --rebuild --no-cache
# Start without loading secrets
rapid start --skip-secrets
# Start in background
rapid start -d
CodeMeaning
0Success
1Configuration error
2Docker not available
3Build failed
4Secret loading failed

Launch AI coding session.

Terminal window
rapid dev [options]
OptionDefaultDescription
--agent <name>From configAgent to use
--multifalseLaunch all agents in tmux
--attachfalseAttach to existing session
--layout <type>tiledTmux layout (multi mode)
LayoutDescription
tiledEqual size panes
horizontalStacked horizontally
verticalStacked vertically
main-verticalOne large, others small
Terminal window
# Launch default agent
rapid dev
# Launch specific agent
rapid dev --agent aider
# Launch all agents
rapid dev --multi
# Launch with specific layout
rapid dev --multi --layout main-vertical
# Attach to running session
rapid dev --attach

Stop the development environment.

Terminal window
rapid stop [options]
OptionDefaultDescription
--removefalseRemove container after stop
--volumesfalseAlso remove volumes
--forcefalseForce stop (SIGKILL)
Terminal window
# Normal stop
rapid stop
# Stop and remove container
rapid stop --remove
# Stop, remove container and volumes
rapid stop --remove --volumes
# Force stop
rapid stop --force

Manage AI agents.

Terminal window
rapid agent <subcommand> [options]

List available agents.

Terminal window
rapid agent list

Output:

Available agents:
* claude (default)
opencode
aider

Add a new agent.

Terminal window
rapid agent add <name> [options]
OptionDescription
--cli <command>CLI command
--instruction-file <path>Instruction file path
--install-cmd <command>Installation command
Terminal window
# Add with prompts
rapid agent add my-agent
# Add with options
rapid agent add my-agent \
--cli my-tool \
--instruction-file MY_AGENT.md \
--install-cmd "npm install -g my-tool"

Remove an agent.

Terminal window
rapid agent remove <name>

Set default agent.

Terminal window
rapid agent default <name>
Terminal window
# List agents
rapid agent list
# Set default to opencode
rapid agent default opencode
# Add custom agent
rapid agent add cursor --cli cursor --instruction-file CURSOR.md
# Remove agent
rapid agent remove aider

View and edit configuration.

Terminal window
rapid config [subcommand] [options]

Display current configuration.

Terminal window
rapid config show [--json]

Open config in editor.

Terminal window
rapid config edit

Set a configuration value.

Terminal window
rapid config set <key> <value>

Get a configuration value.

Terminal window
rapid config get <key>
Terminal window
# Show config
rapid config show
# Show as JSON
rapid config show --json
# Edit in $EDITOR
rapid config edit
# Set default agent
rapid config set agents.default opencode
# Get secret provider
rapid config get secrets.provider

Manage secrets.

Terminal window
rapid secrets <subcommand>

List configured secrets (names only).

Terminal window
rapid secrets list

Verify all secrets are accessible.

Terminal window
rapid secrets verify

Reload secrets into environment.

Terminal window
rapid secrets refresh
Terminal window
# List secret names
rapid secrets list
# Verify access
rapid secrets verify
# Refresh after rotation
rapid secrets refresh

Show environment status.

Terminal window
rapid status [options]
OptionDescription
--jsonOutput as JSON
RAPID Status
────────────
Container: running (rapid-my-project)
Uptime: 2h 34m
Agent: claude (active)
Secrets: loaded (3 items)
MCP: 2 servers connected

View logs.

Terminal window
rapid logs [options]
OptionDefaultDescription
--follow, -ffalseFollow log output
--tail <n>100Number of lines
--containerfalseShow container logs
Terminal window
# View RAPID logs
rapid logs
# Follow logs
rapid logs -f
# View container logs
rapid logs --container
# Last 50 lines
rapid logs --tail 50

Manage MCP (Model Context Protocol) servers.

Terminal window
rapid mcp <subcommand> [options]

List configured MCP servers.

Terminal window
rapid mcp list [options]
OptionDescription
--jsonOutput as JSON
--templatesShow available server templates
Terminal window
# List configured servers
rapid mcp list
# Show available templates
rapid mcp list --templates

Add an MCP server.

Terminal window
rapid mcp add <name> [options]
OptionDescription
--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
Terminal window
# Add from template
rapid mcp add playwright
# Add custom remote server
rapid mcp add myapi --type remote --url https://api.example.com/mcp
# Add custom stdio server
rapid mcp add mytool --type stdio --command npx --args "@example/mcp-server"

Remove an MCP server.

Terminal window
rapid mcp remove <name>

Enable a disabled MCP server.

Terminal window
rapid mcp enable <name>

Disable an MCP server (without removing).

Terminal window
rapid mcp disable <name>

Show MCP server status.

Terminal window
rapid mcp status [options]
OptionDescription
--jsonOutput as JSON

Regenerate .mcp.json and opencode.json from rapid.json.

Terminal window
rapid mcp sync
Terminal window
# List available templates
rapid mcp list --templates
# Add Context7 and Tavily
rapid mcp add context7
rapid mcp add tavily
# Check status
rapid mcp status
# Temporarily disable a server
rapid mcp disable tavily
# Re-enable it
rapid mcp enable tavily
# Remove a server
rapid mcp remove playwright

RAPID respects these environment variables:

VariableDescription
RAPID_CONFIGPath to rapid.json
RAPID_LOG_LEVELLog verbosity (debug, info, warn, error)
RAPID_NO_COLORDisable colored output
DOCKER_HOSTDocker daemon socket
MCP_CONFIG_FILEPath to MCP configuration file

See rapid.json Specification for complete configuration reference.

See MCP Server Configuration for MCP server setup.