CLI reference

The Camplax CLI is camplax. Install it with npm install -g camplax (Node 24+), then camplax help prints this same list. The dashboard and the CLI use the same projects and the same deploys — nothing you can do in one is hidden from the other.

Most commands take the project slug from the folder's link (camplax link <slug> writes .camplax/link.json) or from camplax.json; pass the slug positionally — or --project/-p on deploy — to override.

Setup

Working locally

env push only accepts UPPER_SNAKE_CASE keys, skips empty values, and never touches keys Camplax manages — DATABASE_URL, DIRECT_URL, BETTER_AUTH_SECRET, anything starting CAMPLAX_. When camplax.json lists env names, push sends only those keys.

Shipping

Checking a live app

camplax probe                      # write → read → delete checks against real features
camplax probe --only database,auth # a subset of checks
camplax probe --json               # machine-readable report; exit 1 if any check fails
camplax probe --strict             # exit 1 when a check skipped, not only when it failed
camplax probe --strict --allow-skip domains,webhooks

Each check prints pass, skip or fail. A skip means the feature is not set up on this project — under --strict, "not checked" counts the same as "not working" unless you allow it.

In CI

export CAMPLAX_TOKEN="$CAMPLAX_TOKEN"   # a cx_cli_… token from camplax login
camplax deploy --json                    # parse the queued deploy, no browser involved

--json output and JSON errors with a code make deploy, import and probe safe to drive from a pipeline or a coding agent. The same verbs exist over MCP — see AI agents and MCP.

Environment variables

camplax.json

When camplax.json is present it is the source of truth for the repo — name, region, build (install, command, start), env names, database, cron and domains:

{
  "name": "my-app",
  "region": "iad",
  "build": {
    "install": "pnpm install",
    "command": "pnpm build",
    "start": "pnpm start"
  },
  "env": ["DATABASE_URL", "STRIPE_PRICE_ID"],
  "database": { "branchOnPreview": true },
  "cron": [],
  "domains": []
}