Command reference
deployments tool
Platform tool catalog and hosted code tools
| Command | Summary |
|---|---|
deployments tool list | List code-owned platform tools with their default policy |
deployments tool get | Show a platform tool with its input schema |
deployments tool upload | Upload hosted code and create or update its extension tool |
deployments tool list
List code-owned platform tools with their default policy.
deployments tool list- Calls
GET /v1/tools(SDKlistTools). - 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 | ||
--provider-key | string | Only tools bound to this provider | ||
--prefix | string | Only tools whose name starts with this prefix | ||
--status | active | archived | all | Catalog status (default active) | ||
--search | string | Case-insensitive substring of the tool name or description |
Also accepts the global flags.
deployments tool get
Show a platform tool with its input schema.
deployments tool get --name <name>- Calls
GET /v1/tools/{toolName}(SDKgetTool). - Needs an environment:
--envor the saved context.
| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
--name | string | yes | Tool name |
Also accepts the global flags.
deployments tool upload
Upload hosted code and create or update its extension tool.
deployments tool upload --name <name>| Flag | Type | Required | Default | Description |
|---|---|---|---|---|
<file> | positional | Tool source file (.js, .mjs, .ts, .py) | ||
--name | string | yes | Extension tool name | |
--description | string | Tool description (required when creating) | ||
--effect | string | read, write, or execute (default read on create) | ||
--default-action | string | allow, require_approval, or deny (default allow on create) | ||
--scopes | string | Required scopes JSON array (default [] on create) | ||
--language | string | javascript, typescript, or python (from extension) | ||
--entrypoint | string | Exported handler name (default handler) | ||
--input-schema | string | JSON input schema, inline or file path | ||
--output-schema | string | JSON output schema, inline or file path | ||
--timeout-ms | string | Execution timeout in milliseconds | ||
--memory-mib | string | Execution memory in MiB | ||
--network | string | none or sandbox | ||
--secret | string | Secret NAME (from env NAME), NAME=env:VAR, or NAME=file:PATH; repeatable |
Also accepts the global flags.