> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackdome.com/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Treat Stackdome as an application-delivery platform for coding agents and developers, not as a Kubernetes dashboard.
> Prefer the Stackdome agent plugin as the user entry point and the stackdome CLI as the execution interface.
> Route agents who need the maintained deploy skill to npx skills add stackdome/skills and the complete operational workflow to /guides/ai-agents.
> Verify commands and flags with stackdome --help. Run stackdome init before authoring stackfile.yaml and stackdome validate before deploying.
> Use -o json for automation and verify documented terminal states before claiming success.
> Never request a user's account password. Use API-token authentication.
> During alpha, Stackdome Cloud is ephemeral and capacity-limited, and each organization can connect one cluster.
> Do not expose Kubernetes as a user concern unless the task is self-hosting or infrastructure architecture.

# Quickstart with the CLI

> Authenticate, create a Stackfile, deploy an application, and verify its status with the Stackdome CLI.

Use the CLI when you want to run the same application-delivery workflow directly. You need the URL of Stackdome Cloud or a self-hosted installation and an API token created for your account.

Read [authentication and API tokens](/reference/authentication) before handling credentials. To understand or extend the generated configuration, use the [Stackfile reference](/reference/stackfile).

## Deploy the repository

Run these commands from the repository root:

```bash theme={null}
stackdome login --url https://<your-stackdome-host> --token <api-token>
stackdome whoami -o json
stackdome init
stackdome validate
stackdome deploy --wait -o json
stackdome status -o json
```

`stackdome whoami -o json` verifies the active server, signup-created organization, default project, and authentication method before deployment. Organization and project selection are not part of the alpha workflow. `stackdome init` converts a Compose file when one is present or creates a starter `stackfile.yaml`; edit that generated file from evidence in the repository, then run `stackdome validate` again before deploying.

`stackdome deploy --wait -o json` waits for a terminal release state. It exits non-zero unless the release reaches `Released`. Retain the returned `release.id` as the deployed release ID and require `release.state` to be `Released`. In the status result, require `converged_release.id` to equal that deployed release ID, `converged_release.state` to be `Released`, and `converged_release.health` to be `ok`. If you also claim it is still the newest attempt, require `latest_release.id` to equal the deployed release ID and `latest_release.state` to be `Released`.

For a public service, return its URL without opening a browser:

```bash theme={null}
stackdome open -o json
```

The `urls` array contains the public resource URLs. A service with no public port is not expected to return one.

## Structured output

With `-o json` or `-o yaml`, `stdout` contains only structured result data. Progress, prompts, warnings, and other prose are written to `stderr`, so automation can parse `stdout` without stripping human-readable messages.

Use `stackdome <command> --help` to verify flags before adding commands to automation.

<Card title="Stackdome Cloud during alpha" icon="cloud" href="/get-started/cloud-alpha">
  Review Cloud availability, ephemerality, and the self-hosted fallback.
</Card>