Overview
The CLI binary is synapsor and ships from the existing @synapsor/client Node package. Hosted access still depends on your Synapsor API key, plan, quota, billing state, and permissions.
Use it for local terminal workflows, scripts, CI checks, and agent workflow experiments: list/create resources when permitted, run SQL, invoke capabilities, inspect evidence, preview/approve/reject proposals, and replay runs.
The CLI runs Synapsor SQL/API commands only. It never executes server shell commands and does not expose operator-only restore, billing override, launch, infrastructure, secret, or filesystem access.
CLI request path
CLI commands go through the same hosted API path as SDK and browser Console calls.
You install @synapsor/client and run the synapsor binary on your machine.
The CLI reads SYNAPSOR_API_KEY or an owner-only local config file.
Commands are authenticated, rate-limited, metered, audited, and quota checked like normal API calls.
Project/database scope decides which hosted single-node runtime receives SQL or capability calls.
Developer notes
- Prefer database-scoped API keys for application traffic and local experiments.
- Use --json for machine-readable command output; invoke uses --json '{...}' for capability arguments.
- Approval/rejection commands require confirmation unless you pass --yes.
- The CLI never bypasses auth, billing, quotas, RBAC, rate limits, or audit.