CLI command reference

Run openstead --help or openstead COMMAND --help for the exact options supported by your installed release.

Command groupsCopy Anchor Link

All operations use the caller's permissions and service entitlements. Some non-core lists return only their latest records; GitHub listings support --page, with nextPage in JSON output.

Common contextCopy Anchor Link

OPENSTEAD_API_KEY supplies a key directly. A token file takes precedence over that environment key, which takes precedence over the keychain. For workspace/service context, explicit flags and environment values precede local openstead.toml, then the active profile. OPENSTEAD_CONFIG_DIR can select another CLI configuration directory. The corresponding RUNIVO_* environment names remain supported as fallbacks. Existing runivo.toml files are read when openstead.toml is absent.

The default API origin is https://openstead-dashboard.vercel.app; the CLI uses its API proxy. SDK base URLs include /api/v1, while this CLI option is an origin.

CLI profiles remain pinned to the origin where they were authorized. You can select another origin with --api-url, but saved credentials are never forwarded to a different origin automatically.

Create and update resourcesCopy Anchor Link

openstead services create --file service.json
openstead services update example-api --file service-update.json
openstead projects create --name production
openstead domains create --service example-api --name app.example.com
openstead domains verify app.example.com --service example-api --yes

--file accepts the operation's JSON request body; --file - reads stdin. Service creation saves configuration. Add --deploy to request an initial release, subject to payment, quota, and runtime requirements.

Supply secretsCopy Anchor Link

Use a private file or stdin so values do not become command-line arguments:

openstead env set API_TOKEN --file ./api-token.txt --service example-api
openstead env import --file variables.json --service example-api --yes
openstead secret-files set credentials.json --file ./credentials.json --service example-api

These file-based commands work across supported shells. You can also pipe the exact intended bytes to env set. Secret input preserves trailing newlines. Imports apply one key at a time and can partially succeed; inspect the command result before retrying.

To target environment-group secrets, use env --group NAME_OR_ID.

Observe and run commandsCopy Anchor Link

openstead logs --service example-api --follow
openstead shell --service example-api
openstead jobs run --service example-worker --command 'python manage.py check' --wait --yes

Shell access and jobs follow service entitlements. Disconnect an interactive shell with Ctrl+]. A one-off command runs inside your workload and can affect its data.

Output and exit codesCopy Anchor Link

JSON goes to stdout; errors and progress go to stderr. Follow and watch commands emit newline-delimited JSON. The CLI does not automatically retry a mutation after an uncertain network result; inspect the target resource first.

Raw workspace API callsCopy Anchor Link

openstead api PATH sends a request relative to the current authorized workspace. It does not bypass access checks. Use the published core reference for REST integrations that need the stable public contract; prefer dedicated CLI commands for other console workflows.