simdeploy

Built for coding agents

Everything the dashboard does exists as a non-interactive CLI, API and MCP. This is the minimal guide for Claude Code, Codex, Cursor and other agents. Machine-readable version: /llms.txt

Deploy an existing application

# 1. Install the CLI
npm i -g simdeploy

# 2. Authenticate (token created at /dashboard/settings) — never pasted in chat
export SIMDEPLOY_TOKEN=sd_live_...   # or: simdeploy login (reads it securely)

# 3. Analyze (offline, no side effects)
simdeploy analyze --json

# 4. Non-interactive deploy — essential for agents
simdeploy deploy --yes

# 5. Verify (exit code != 0 on failure)
simdeploy status --json
simdeploy logs

Golden rules

  • Always --yes in automation; without it the CLI prompts for confirmation.
  • Always --json when parsing the output.
  • Builds run on the local machine; only the output goes to SimDeploy.
  • Deployment states: CREATED, ANALYZING, QUEUED, BUILDING, UPLOADING, DEPLOYING, HEALTH_CHECK, READY and the typed failures ANALYSIS_FAILED, BUILD_FAILED, DEPLOY_FAILED.
  • Displayed costs are projections from price tables, never a real bill.

API v1

Auth: Authorization: Bearer sd_live_... — errors return {"error":{"code","message"}}.

GET /api/v1/mevalidates token; returns organization and scopes
GET | POST /api/v1/projectslist / create project {name}
GET | DELETE /api/v1/projects/:iddetail / delete project
POST /api/v1/projects/:id/analyzeregisters analysis; returns cost + planned route
GET | POST /api/v1/projects/:id/deploymentslist / deploy (multipart meta + artifact)
GET /api/v1/deployments/:idstatus + pipeline events
GET /api/v1/deployments/:id/logsstructured logs (?format=text for plain text)
GET | POST /api/v1/projects/:id/envlist keys / set variable
POST /api/v1/cost/estimatestandalone cost estimate

Full REST API reference: /docs/api.

MCP

The stdio server simdeploy-mcp with the tools analyze_project, estimate_cost, create_project, deploy_project, list_projects, get_project, get_deployment and get_logs. Authentication reuses the CLI's.

{
  "mcpServers": {
    "simdeploy": { "command": "simdeploy-mcp" }
  }
}

Full MCP setup and tools: /docs/mcp.