Commands
Every stechbd command, grouped the way stechbd --help lists them.
Commands take the form stechbd <group> <command> [options]. Each group below has its own page, with a section for every command: what it does, its usage line, its options and worked examples.
# list every group and command
stechbd --help
# describe one command without running it
stechbd edge deploy --helpCommand groups
| Group | What it covers |
|---|---|
| auth | Sign in to a panel, see who you are signed in as, and manage your sessions and tokens. |
| account | The customer accounts you belong to, their members, groups and invitations. |
| project | Link a directory to an application, and create, list and inspect projects. |
| edge | Deploy and run front ends: static sites and server-rendered applications. |
| compute | Deploy and run everything else: services with a container of their own. |
| env | Environment variables for an application, their scopes and secrets. |
| domain | Hostnames for an application, and which deployment each one serves. |
| app | An application’s own settings: create, update, size, migrate, usage and metrics. |
| datastore | Managed databases, and the applications they are linked to. |
| job | Commands run on a schedule inside an application’s image. |
| backup | Backup destinations, schedules, runs, restore drills and downloads. |
| alert | Open alerts, the rules that raise them and the channels they reach. |
| size | Resource presets: how much memory and CPU something may use. |
| panel | The panel itself: what this installation can do, and search across it. |
| billing | Your statements, the billed services and the rate profiles. |
| api | Call any panel endpoint directly, for what no command covers yet. |
| preview | Previews made with deploy:preview, which nothing else removes. |
Shortcuts
| Shortcut | Same as |
|---|---|
stechbd login | stechbd auth login |
stechbd logout | stechbd auth logout |
stechbd me | stechbd auth me |
stechbd link | stechbd project link |
stechbd unlink | stechbd project unlink |
Options every command takes
| Option | Description |
|---|---|
--json | Print the result as JSON, for scripts and CI. |
--quiet | Print only what a script needs, without progress lines. |
--help | Describe the command and exit without running it. |
--app <app> | On commands that act on an application: use this one instead of the directory’s link. An id, or the application’s slug in the linked project. |
- authSign this machine in to a panel, see who it acts as, and review or revoke the sessions and tokens that have access.
- accountList the customer accounts you belong to, set the one commands act in, and see their members, groups and pending invitations.
- projectLink a directory to a project and application, create and manage projects and their environments, and read their usage, traffic and deployment reports.
- EdgeDeploy, follow and manage front ends: static sites and SSR applications, billed on the edge service.
- ComputeDeploy and run every application that is not a front end, on the compute service.
- envList, set, remove and read the environment variables an application is built and run with.
- DomainAdd, move and remove the hostnames an application serves, and manage its edge cache.
- appCreate, inspect, change, move and delete an application, and read its limits, webhook, usage, metrics and logs.
- datastoreCreate, inspect, start, stop, link and query the managed databases that applications use.
- jobSchedule commands that run inside an application's image, and read their runs and logs.
- backupRead backup destinations, schedules and runs, prove archives by restoring them, and download them.
- alertRead the open alerts, the rules that raise them and the channels they are sent to.
- sizeList the resource presets, the memory and CPU each one allows, and how many things use each.
- panelRead the panel itself: what its engine can and cannot do, and search for projects, applications, servers and people by name.
- billingRead your statements, the services that are billed, and the rate profiles estimates are priced against.
- apiSend a GET, POST, PUT, PATCH or DELETE to any customer endpoint, with this machine's credential.
- PreviewRemove previews built with deploy:preview, which nothing else removes.