Command reference
deployments tool-policy
Tool permissions and approval policy
| Command | Summary |
|---|---|
deployments tool-policy create | Create a tool policy |
deployments tool-policy list | List tool policies |
deployments tool-policy show | Show a tool policy |
deployments tool-policy update | Update a tool policy |
deployments tool-policy archive | Archive a tool policy |
deployments tool-policy evaluate | Show what a tool policy or an agent deployment's pinned policies decide for tools (no side effects) |
deployments tool-policy create
Create a tool policy.
deployments tool-policy create --name <name> --policy <json>- Calls
POST /v1/tool-policies(SDKcreateToolPolicy). - 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 |
|---|---|---|---|---|
--name | string | yes | Resource name | |
--description | string | Resource description | ||
--policy | string (json) | yes | Tool policy document |
Also accepts the global flags.
deployments tool-policy list
List tool policies.
deployments tool-policy list- Calls
GET /v1/tool-policies(SDKlistToolPolicies). - 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 |
Also accepts the global flags.
deployments tool-policy show
Show a tool policy.
deployments tool-policy show <id>- Calls
GET /v1/tool-policies/{id}(SDKgetToolPolicy). - Needs an environment:
--envor the saved context.
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
<id> | positional | yes | Resource ID |
Also accepts the global flags.
deployments tool-policy update
Update a tool policy.
deployments tool-policy update <id> --expected-version <number>- Calls
PATCH /v1/tool-policies/{id}(SDKupdateToolPolicy). - 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 | |
--policy | string (json) | Tool policy document | ||
--expected-version | string (number) | yes | Expected resource version |
Also accepts the global flags.
deployments tool-policy archive
Archive a tool policy.
deployments tool-policy archive <id>- Calls
DELETE /v1/tool-policies/{id}(SDKarchiveToolPolicy). - 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 | |
--reason | string | Reason for this operation |
Also accepts the global flags.
deployments tool-policy evaluate
Show what a tool policy or an agent deployment's pinned policies decide for tools (no side effects).
deployments tool-policy evaluate- Calls
POST /v1/tool-policies/evaluate(SDKevaluateToolPolicy). - Needs an environment:
--envor the saved context.
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
--tool-policy-id | string | Tool policy to evaluate (requires --tool) | ||
--agent-deployment-id | string | Agent deployment whose pinned tool policies to evaluate | ||
--tool | string | Tool name to evaluate (repeatable) |
Also accepts the global flags.