hangar
hangar list
List the Hangars in a team.
read onlyrepeatable
The Hangars in a team, with whether each one is running and which agents it has.
Hangars are not applications, so app list never shows them and this never shows an
application. The names are shared all the same, which is why a name can be taken
without appearing here.
Usage
outplane hangar listOutput
| Field | Type | Description |
|---|---|---|
id | string | |
name | string | Immutable and lower case. Unique in the team among Hangars and applications together. |
displayName | string | null | The name as it was typed at creation. |
status | string | Effective state, read as app list reads an application's: paused outranks the rest. deploying while it starts, ready once it runs, failed when it could not start, crashed when it stopped unexpectedly and is restarting, or unknown:N. The field to branch on. |
paused | bool | |
agents | array | The coding agents installed, by id. Empty for a terminal-only Hangar. |
size | string | Instance type code, e.g. op-46. Set by the platform. |
diskGb | int | The disk's size in GB. Set by the platform. |
idleTimeoutMinutes | int | null | How long it may sit idle before it pauses, in minutes: 15, 30, 60, 120, 360, 720 or 1440. null for never. Changed with hangar update. |
ports | array | The ports open for its dev servers, lowest first: {port, scheme, public, url, internal}. url is null on a private port; internal is name:port, where the team's applications reach it. |
repository | string | null | Owner/name on GitHub, cloned into ~/<name> on its first start. null for none. Set at creation and never changed. |
branch | string | null | The branch cloned. null without a repository. |
publicSource | bool | The repository is read without a GitHub installation. |
createdAt | string | null | RFC 3339, UTC. |
Examples
List the Hangars in the current team
outplane hangar listList as JSON and pick out the names
outplane hangar list --json --fields name,status{
"items": [
{
"name": "myhangar",
"status": "ready"
},
{
"name": "reviewbox",
"status": "deploying"
}
],
"total": 2,
"truncated": false
}List the Hangars in a specific team
outplane hangar list --team acmeWhat to Know
- The API returns every Hangar in one response. There is no pagination, so
totalis the complete count andtruncatedis always false. - Hangars are not applications, and
app listdoes not include them. The two share one set of names all the same: a name either one holds is taken for both. - status is read as an application's: paused outranks the rest. A new Hangar reports deploying while it starts and ready once it runs.
- An unrecognised state decodes to "unknown:N", carrying the number the server sent. Treat it as unknown rather than as a failure.
- Environment variables are never included, in any format.
Errors
Beyond 0 for success, this command exits with:
| Exit | Kind | Meaning |
|---|---|---|
2 | usage | Invalid arguments, unknown flag, or client-side validation failure. |
3 | auth | Not authenticated, token revoked or expired, or forbidden for this team. |
8 | upstream | The Out Plane API returned a server error. |
The code on the error object is one of context.no_team, auth.token_invalid. Branch on that, or on the exit status. The message is prose and changes.