TurboSteed CLI

Deploy and manage TurboSteed sites from your terminal or CI/CD pipeline.

Features

• Deploy sites with a single command
• Manage assets (upload, list, delete)
• Retrieve contact form submissions
• Manage CMS schemas and entries
• Progress indicators and formatted output
• Works with GitHub Actions, GitLab CI, and Bitbucket Pipelines
• MCP server for Claude Code / Claude Desktop integration

Requirements

• Node.js 18.0.0 or higher
• A TurboSteed account (sign up)

Installation

Global Installation (Recommended)

npm install -g @turbosteed/cli

Verify installation:

turbosteed --version

Local Installation (Per Project)

npm install --save-dev @turbosteed/cli

Run via npx:

npx turbosteed deploy

Or add to package.json scripts:

{
  "scripts": {
    "deploy": "turbosteed deploy --source ./dist"
  }
}

Configuration

Step 1: Get Your Credentials

1. Log in to the TurboSteed Dashboard
2. Navigate to Settings > API Keys
3. Copy your Account SID and API Key
4. Navigate to your site and copy the Site ID

Step 2: Set Environment Variables

export TURBOSTEED_ACCOUNT_SID="your-account-sid"
export TURBOSTEED_API_KEY="your-api-key"
export TURBOSTEED_SITE_ID="your-site-id"

For permanent setup, add these to your shell profile (~/.bashrc, ~/.zshrc, etc.).

Step 3 (Optional): Create a Config File

Create turbosteed.json in your project root:

{
  "version": "1",
  "site": {
    "id": "your-site-id",
    "accountSid": "your-account-sid"
  },
  "deploy": {
    "source": "./dist",
    "exclude": ["**/*.map", ".DS_Store"]
  }
}

Note: Never put your API key in config files. Always use environment variables for secrets.

Environment Variables Reference

Usage

Deploy a Site

# Deploy from ./dist (default)
turbosteed deploy

# Deploy from a specific directory
turbosteed deploy --source ./build

# Preview what would be deployed
turbosteed deploy --dry-run

# Output result as JSON
turbosteed deploy --json

Requirements:

• Source directory must contain an index.html file
• Maximum zip size: 25 MB

Manage Assets

# Upload a file
turbosteed assets upload ./images/logo.png

# List first page of assets
turbosteed assets list

# List ALL assets (automatic pagination)
turbosteed assets list --all

# Manual pagination (next page)
turbosteed assets list --page <token>

# Delete an asset
turbosteed assets delete logo.png

Contact Forms

# List first page of submissions
turbosteed forms list

# List ALL submissions (automatic pagination)
turbosteed forms list --all

# Manual pagination (next page)
turbosteed forms list --page <formId>

# Get a specific submission
turbosteed forms get <formId>

CMS Content

# List first page of schemas
turbosteed cms schema list

# List ALL schemas (automatic pagination)
turbosteed cms schema list --all

# Create a schema from JSON file
turbosteed cms schema create ./blog-schema.json

# List first page of entries in a schema
turbosteed cms entry list <schemaId>

# List ALL entries (automatic pagination)
turbosteed cms entry list <schemaId> --all

# Create an entry
turbosteed cms entry create <schemaId> ./post.json

# Publish an entry
turbosteed cms entry publish <schemaId> <entryId>

Example schema file (blog-schema.json):

{
  "display_name": "Blog Posts",
  "schema_mode": "custom",
  "fields": [
    { "name": "title", "type": "text", "require

... [View full README on GitHub](https://github.com/turbosteed/turbosteed-cli#readme)