CLI Recipes

Trigger.dev CLI Recipes

The CLI is bundled with the SDK — no separate install:

npx trigger.dev@latest <command>
# or: pnpm dlx trigger.dev@latest <command>
# or: yarn dlx trigger.dev@latest <command>

Authentication

# Login to cloud
npx trigger.dev@latest login

# Login to self-hosted
npx trigger.dev@latest login -a https://trigger.example.com

# Login with named profile
npx trigger.dev@latest login -a https://trigger.example.com --profile self-hosted

# Verify
npx trigger.dev@latest whoami

Profile Management

# List all profiles
npx trigger.dev@latest list-profiles

# Switch profile interactively
npx trigger.dev@latest switch

# Switch to specific profile
npx trigger.dev@latest switch self-hosted

# Remove a profile
npx trigger.dev@latest logout --profile self-hosted

Project Initialization

# Interactive init
npx trigger.dev@latest init

# Self-hosted with project ref
npx trigger.dev@latest init -p proj_xxx -a https://trigger.example.com

# With specific runtime
npx trigger.dev@latest init --runtime bun

# JavaScript (default: TypeScript)
npx trigger.dev@latest init --javascript

Development Server

# Start dev server
npx trigger.dev@latest dev

# Custom config (monorepo)
npx trigger.dev@latest dev --config ./packages/jobs/trigger.config.ts

# Debug log level
npx trigger.dev@latest dev --log-level debug

# With specific profile
npx trigger.dev@latest dev --profile self-hosted

The dev server watches for file changes, registers tasks, and executes them locally.

Deployment

# Deploy to production
npx trigger.dev@latest deploy

# Deploy to staging
npx trigger.dev@latest deploy --env staging

# Deploy preview branch
npx trigger.dev@latest deploy --env preview --branch feature/new-task

# Skip promotion (canary)
npx trigger.dev@latest deploy --skip-promotion

MCP Server

# Interactive installer (detects installed clients and writes their configs)
npx trigger.dev@latest install-mcp

# Install for a specific client
npx trigger.dev@latest install-mcp --client claude-code
npx trigger.dev@latest install-mcp --client cursor --scope user

# Install across every supported client at once
npx trigger.dev@latest install-mcp --yolo

# Production-safe — hide deploy, trigger_task, cancel_run
npx trigger.dev@latest install-mcp --readonly

# Restrict to dev env and a single project
npx trigger.dev@latest install-mcp --dev-only --project-ref proj_abc123

install-mcp Flags

Manual Config

{
  "mcpServers": {
    "trigger": {
      "command": "npx",
      "args": ["trigger.dev@latest", "mcp"]
    }
  }
}

Dev-only + project-scoped example:

{
  "mcpServers": {
    "trigger": {
      "command": "npx",
      "args": ["trigger.dev@latest", "mcp", "--dev-only", "--project-ref", "proj_abc123", "--readonly"]
    }
  }
}

Platform Notifications

Since v4.4.4, trigger dev and trigger login fetch server-side notifications (info/warn/error/success) with color markup. Disable with --skip-platform-notifications:

npx trigger.dev@latest dev --skip-platform-notifications

Agent Rules

# Interactive — choose AI tool and rule sets
npx trigger.dev@latest install-rules

Rules auto-update when you run npx trigger.dev@latest dev.

Self-Hosted Docker

# Clone and start
git clone --depth=1 https://github.com/triggerdotdev/trigger.dev
cd trigger.dev/hosting/docker

# Start webapp
cd webapp && docker compose up -d

# Start worker (supervisor)
cd ../worker && docker compose up -d

# View logs
docker compose logs -f webapp
docker compose logs -f supervisor

# Check status
docker compose ps

# Version lock (in .env)
TRIGGER_IMAGE_TAG=v4.0.0

Package.json Scripts

{
  "scripts": {
    "trigger:dev": "trigger.dev dev",
    "trigger:deploy:staging": "trigger.dev deploy --env staging",
    "trigger:deploy:prod": "trigger.dev deploy --env production"
  }
}

Common Issues