Dispatch CLI

The Dispatch CLI is a powerful command-line tool that enables developers to deploy OpenAPI-defined REST APIs to production infrastructure instantly. With built-in safety checks, custom domains, and enterprise-grade monitoring.

Installation

Global Installation

npm install -g dispatch-deploy

Verify Installation

dispatch --version
# Output: dispatch-deploy@1.0.0

System Requirements

Node.js 16.0.0 or higher
NPM 7.0.0 or higher
Windows, macOS, Linux

Authentication

Authenticate securely with your Dispatch account to start deploying.

Initial Setup

# Authenticate interactively
dispatch login

# Or login with a specific token (CI/CD)
dispatch login --code YOUR_ACCESS_CODE

Core Commands

dispatch deploy

Deploy your API project to production infrastructure.

# Deploy current directory
dispatch deploy

# Deploy with options
dispatch deploy --dry-run
dispatch deploy --project my-api --env production

--dry-run

Validate configuration and safety without deploying

--project <name>

Override project name from dispatch.yaml

--source <path>

Deploy from specific source directory

--architecture <arch>

Specify architecture (x86_64 or arm64)

dispatch check

Run safety and security checks on your API specification.

dispatch check --verbose

Output

🔍 Running safety checks...
✅ PASS: Authentication required
⚠️  WARN: Rate limiting missing on /users
❌ BLOCK: Admin endpoint exposed

Configuration

Every project requires a dispatch.yaml configuration file.

dispatch.yaml

projectName: my-api
runtime: python3.11
handler: app.handler

# Optional architecture (x86_64 or arm64)
architecture: x86_64
memory: 512
timeout: 30

environment:
  API_VERSION: "v1.0"
  DATABASE_URL: "${DATABASE_URL}"