Quick Start

Deploy any project to any cloud in one click. No YAML. No pipelines. Just point, detect, deploy.

1. Authenticate

GET /auth/github          # OAuth via GitHub
GET /auth/me              # Returns user + tier

2. Create a deploy config

POST /v1/configs
{
  "name": "my-app",
  "source": { "type": "github", "uri": "your-org/your-repo", "ref": "main" },
  "build": { "command": "npm run build", "outputDir": "dist" },
  "targets": [
    { "platform": "cloudflare-pages", "credentialId": "cf-cred-id" }
  ]
}

3. Deploy

POST /v1/configs/:id/deploy    # The 1-click action

4. Check status

GET /v1/runs/:id

Concepts

DeployConfig

The core unit. Specifies source, build, targets, checks, rollback, and environment stage. One config = one 1-click action.

Pipeline Phases

Every deploy runs through 20 sequential phases behind the scenes:

1Source Selection
2Env Analysis
3Smart Recommendations
4Security Advisory
5Testing Completeness
6Secret Detection
7Target Connection
8Credential Vault
9Policy Engine
10Authorization
11LOGAL Tracking
12Tunnel Test
13Rollback Generation
14Health Hygiene
15Recoverable Deploy
16Dependency Manifest
17Reachability Test
18Observability Setup
19Continuous Monitoring
20Documentation

LOGAL

Built-in observability: Logger (structured events), Observer (metrics), Governor (rate/cost limits), Auditor (immutable trail), Linter (config validation).

Mainline Steps

Users see 5 steps: connect → configure → review → deploy → live. Each runs multiple pipeline phases in the background.

API Reference

Base URL: https://1-click-deploy-api.srini-rentala.workers.dev

Auth: Authorization: Bearer <token> or X-API-Key: <key>

MethodPathDescription
GET/Health + version info
GET/auth/githubStart GitHub OAuth flow
GET/auth/meCurrent user + tier
POST/v1/detectAuto-detect framework from repo
GET/v1/configsList your deploy configs
POST/v1/configsCreate deploy config
PUT/v1/configs/:idUpdate config
DELETE/v1/configs/:idDelete config
POST/v1/configs/:id/deploy🚀 Trigger deployment
GET/v1/configs/:id/environmentCurrent env stage + promotion trail
POST/v1/configs/:id/promotePromote to next env stage
GET/v1/runs/:idGet deployment run status
POST/v1/scanScan any source for health/quality/security
GET/v1/credentialsList platform credentials
POST/v1/credentialsStore platform credential
POST/v1/credentials/:id/testTest credential connectivity
GET/v1/billing/statusCurrent tier + feature limits
POST/v1/billing/checkoutStart Stripe checkout (Prosumer)
GET/v1/billing/portalOpen Stripe billing portal

Environment Pipeline

Every config targets one environment stage. You must promote sequentially — you cannot skip stages or push direct to PROD.

DEV
TEST
OAT_TEST
SEC_TEST
INT_TEST
PRE_PROD
PROD

Promotion API

# Check current stage
GET /v1/configs/:id/environment

# Promote to next stage (runs gate checks)
POST /v1/configs/:id/promote

Promotion Gates

  • Successful deploy in current env — must have at least one live run
  • Pre-deploy checks required — PRE_PROD and PROD require configured checks
  • Rollback config required — PROD requires a rollback strategy
  • Sequential promotion — no stage skipping
Tier note: Free tier is DEV only. Upgrade to Prosumer for the full 7-stage pipeline.

Scanner

Point the scanner at any source — folder, file, URL, npm package, or GitHub repo. Get a scored report across 4 dimensions.

Via API

POST /v1/scan
{
  "target": "vercel/next.js",          // GitHub slug
  "checkVulns": true,                   // Query OSV.dev for CVEs
  "register": true,                     // Register to depot after scan
  "depotUrl": "http://localhost:4873"
}

Score dimensions

DimensionWhat it checks
HealthLicense, CI config, last commit date, outdated deps, vulnerability count
CompatibilityNode engine floor, peer dep satisfaction, dep tree size, language detection
QualityREADME, test files, package description, version declared, framework detected
SecuritySecret pattern scan (API keys, private keys, GitHub PATs), CVE lookup via OSV.dev

Via CLI

npx tsx packages/scanner/src/cli.ts scan react@18 --check-vulns
npx tsx packages/scanner/src/cli.ts scan github:vercel/next.js --register

Billing

Free

$0/month

  • 5 deploy configs
  • 50 deploys / month
  • 3 targets per config
  • DEV environment only
  • Community support

Enterprise

Custom

  • Everything in Prosumer
  • Unlimited deploys
  • SSO / SAML
  • SLA guarantee
  • Audit compliance
  • On-prem option
Contact Sales

Upgrade via API

POST /v1/billing/checkout   → returns checkoutUrl (Stripe)
GET  /v1/billing/portal     → returns portalUrl (manage subscription)
GET  /v1/billing/status     → { tier, features, upgradedAt }

CLI

The browser automation CLI (@1cd/browser) and scanner CLI (@1cd/scanner) are available via npx tsx.

Scanner CLI

npx tsx packages/scanner/src/cli.ts scan <target> [options]

Options:
  --check-vulns        Query OSV.dev for CVEs
  --register           Register result to depot
  --depot-url <url>   Depot URL (default: http://localhost:4873)
  --json               Raw JSON output

Browser automation CLI

npx tsx packages/browser/src/cli.ts navigate <url>
npx tsx packages/browser/src/cli.ts screenshot <url> [output.png]
npx tsx packages/browser/src/cli.ts content <url>
npx tsx packages/browser/src/cli.ts cf-domain <project> <domain>
npx tsx packages/browser/src/cli.ts interactive [url]