Skip to content

Quickstart

Get RAPID running in your project in under 5 minutes.

  1. Navigate to your project (or create a new one):

    Terminal window
    mkdir my-project && cd my-project
  2. Initialize RAPID:

    Terminal window
    rapid init --template typescript

    This creates:

    • rapid.json — RAPID configuration
    • .envrc — Secure secrets loading (safe to commit)
    • .devcontainer/ — Dev container configuration
    • CLAUDE.md — AI instruction file
  3. Configure your secrets:

    Edit rapid.json to point to your 1Password vault:

    {
    "secrets": {
    "provider": "1password",
    "vault": "Development",
    "items": {
    "ANTHROPIC_API_KEY": "op://Development/Anthropic/api-key"
    }
    }
    }
  4. Allow direnv:

    Terminal window
    direnv allow
  5. Start the environment:

    Terminal window
    rapid start
  6. Launch AI coding session:

    Terminal window
    rapid dev

When you ran rapid start, RAPID:

  1. Built and started a dev container based on your template
  2. Loaded secrets from 1Password into the container environment
  3. Installed AI CLI tools (Claude Code, OpenCode) inside the container
  4. Generated/updated the CLAUDE.md instruction file

When you ran rapid dev, RAPID:

  1. Attached to the running container
  2. Launched your configured AI coding assistant (Claude by default)
  3. The AI tool reads CLAUDE.md for project context
Terminal window
# Use a different agent for this session
rapid dev --agent aider
# Or change the default
rapid agent default opencode
Terminal window
# Launch all configured agents in split panes
rapid dev --multi
Terminal window
# After changing devcontainer.json or Dockerfile
rapid start --rebuild
Terminal window
rapid stop

After initialization, your project looks like:

my-project/
├── rapid.json # RAPID configuration
├── .envrc # Secret references (safe to commit)
├── CLAUDE.md # AI instruction file
├── AGENTS.md # Generic AI instructions
└── .devcontainer/
└── devcontainer.json # Container configuration