Command reference
deployments preview
Unpublished agent manifest previews
| Command | Summary |
|---|---|
deployments preview create | Create a preview from an unpublished agent manifest |
deployments preview show | Show a preview |
deployments preview delete | Expire a preview |
deployments preview turn | Submit a turn to a preview |
deployments preview create
Create a preview from an unpublished agent manifest.
deployments preview create- Calls
POST /v1/previews(SDKcreatePreview). - 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 |
|---|---|---|---|---|
--manifest | string (json) | Agent manifest JSON | ||
--manifest-file | string | Local agent manifest JSON file | ||
--runtime-config | string (json) | Preview runtime configuration JSON | ||
--runtime-config-file | string | Local runtime configuration JSON file | ||
--from-agent-deployment-id | string | Agent deployment whose runtime configuration to reuse | ||
--ttl-seconds | string (number) | Preview lifetime in seconds (60-604800) |
Also accepts the global flags.
deployments preview show
Show a preview.
deployments preview show <id>- Calls
GET /v1/previews/{previewId}(SDKgetPreview). - Needs an environment:
--envor the saved context.
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
<id> | positional | yes | Resource ID |
Also accepts the global flags.
deployments preview delete
Expire a preview.
deployments preview delete <id>- Calls
DELETE /v1/previews/{previewId}(SDKdeletePreview). - Needs an environment:
--envor the saved context. - Destructive. Live runs ask for confirmation; pass
--yesin scripts or with--json.
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
<id> | positional | yes | Resource ID |
Also accepts the global flags.
deployments preview turn
Submit a turn to a preview.
deployments preview turn <id> --message <message>- Calls
POST /v1/previews/{previewId}/turns(SDKsubmitPreviewTurn). - 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 | |
--thread | string | Thread ID | ||
--message | string | yes | Message input |
Also accepts the global flags.