stackdome CLI deploys, inspects, and operates stacks. Run stackdome --help for the command inventory in your installed release and stackdome <command> --help before adding flags to automation.
Command inventory
Global flags
These flags are available on every command:
Command-specific flags belong to that command. Check them with
stackdome <command> --help; do not assume that a flag on one command exists on another.
Automation and non-interactive use
For agent and CI workflows:- Authenticate with an API token and provide required values through flags or environment variables.
- Use
-o jsonor-o yamlfor machine-readable results. - Pass
--yeswhen a destructive command’s help offers it. A confirmation cannot be answered through non-interactive standard input; without--yes, the command exits with invalid-input status. - Do not depend on interactive login or signup prompts.
- Run
stackdome whoami -o jsonbefore making changes to confirm the server and scope in use.
stackdome login specifically requires --token, or both --email and --password, when standard input is not a terminal. Agents and CI should use token authentication. See authentication.
Standard output and standard error
With-o json or -o yaml, stdout contains only the structured result. Prompts, progress, warnings, and other prose go to stderr. Parse stdout; retain stderr for diagnostics.
Some commands stream results. For example, stackdome status --watch -o json emits one structured object per refresh rather than one JSON array.
Environment variables
Environment values overlay the saved CLI configuration for the current process.
Set both
STACKDOME_ORG and STACKDOME_PROJECT=default for a narrowly scoped token that cannot discover its scope. Setting only one still requires the CLI to discover the missing value. Organization and project selection are not exposed during alpha.
Exit codes
Exit code
130 applies to canceled command paths that return the CLI’s cancellation error, including a declined confirmation. It is not a universal interrupt result in the current release: interrupting stackdome status --watch exits 0, while other paths that return a raw cancellation may fall back to the general-error behavior and exit 1. A bad flag or wrong argument count exits with code 4.