Command reference
deployments app
Internal apps that agents build and members sign in to
| Command | Summary |
|---|---|
deployments app list | List apps, or find one by its slug |
deployments app show | Show an app, its URL, and its lifecycle |
deployments app update | Rename an app, set member access, or hand it to another agent definition |
deployments app set-publication | Change an app's audience and serving settings (needs apps:publish) |
deployments app archive | Archive an app so it stops serving members and agents |
deployments app erase | Erase an app and its data |
deployments app list
List apps, or find one by its slug.
deployments app list- Calls
GET /v1/apps(SDKlistApps). - Needs an environment:
--envor the saved context. - Paginated.
--page-sizesets the page size; pass the returned cursor as--cursorfor the next page.
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
--cursor | string (cursor) | Pagination cursor | ||
--page-size | string (number) | Page size | ||
--slug | string | Only the app with this exact slug |
Also accepts the global flags.
deployments app show
Show an app, its URL, and its lifecycle.
deployments app show <id>- Calls
GET /v1/apps/{appId}(SDKgetApp). - Needs an environment:
--envor the saved context.
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
<id> | positional | yes | Resource ID |
Also accepts the global flags.
deployments app update
Rename an app, set member access, or hand it to another agent definition.
deployments app update <id>- Calls
PATCH /v1/apps/{appId}(SDKupdateApp). - Needs an environment:
--envor the saved context. - Sends an idempotency key. The CLI generates one per run; pass
--idempotency-keyto retry safely.
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
<id> | positional | yes | Resource ID | |
--name | string | App name | ||
--access | string (json) | Access for every organization member, such as {"organizationMembers":"viewer"} | ||
--agent-definition-id | string | Agent definition whose runs can reach the app |
Also accepts the global flags.
deployments app set-publication
Change an app's audience and serving settings (needs apps:publish).
deployments app set-publication <id>- Calls
PATCH /v1/apps/{appId}/publication(SDKsetAppPublication). - Needs an environment:
--envor the saved context. - Sends an idempotency key. The CLI generates one per run; pass
--idempotency-keyto retry safely.
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
<id> | positional | yes | Resource ID | |
--audience | string | members or public | ||
--serving | string | single-page or static-site |
Also accepts the global flags.
deployments app archive
Archive an app so it stops serving members and agents.
deployments app archive <id>- Calls
POST /v1/apps/{appId}/archive(SDKarchiveApp). - Needs an environment:
--envor the saved context. - Destructive. Live runs ask for confirmation; pass
--yesin scripts or with--json. - Sends an idempotency key. The CLI generates one per run; pass
--idempotency-keyto retry safely.
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
<id> | positional | yes | Resource ID |
Also accepts the global flags.
deployments app erase
Erase an app and its data.
deployments app erase <id>- Calls
DELETE /v1/apps/{appId}(SDKeraseApp). - Needs an environment:
--envor the saved context. - Destructive. Live runs ask for confirmation; pass
--yesin scripts or with--json. - Sends an idempotency key. The CLI generates one per run; pass
--idempotency-keyto retry safely.
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
<id> | positional | yes | Resource ID |
Also accepts the global flags.