Deployments.ai Docs
Command reference

deployments tool

Platform tool catalog and hosted code tools

CommandSummary
deployments tool listList code-owned platform tools with their default policy
deployments tool getShow a platform tool with its input schema
deployments tool uploadUpload 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 (SDK listTools).
  • Needs an environment: --env or the saved context.
  • Paginated. --page-size sets the page size; pass the returned cursor as --cursor for the next page.
FlagTypeRequiredDefaultDescription
--cursorstring (cursor)Pagination cursor
--page-sizestring (number)Page size
--provider-keystringOnly tools bound to this provider
--prefixstringOnly tools whose name starts with this prefix
--statusactive | archived | allCatalog status (default active)
--searchstringCase-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>
FlagTypeRequiredDefaultDescription
--namestringyesTool name

Also accepts the global flags.

deployments tool upload

Upload hosted code and create or update its extension tool.

deployments tool upload --name <name>
FlagTypeRequiredDefaultDescription
<file>positionalTool source file (.js, .mjs, .ts, .py)
--namestringyesExtension tool name
--descriptionstringTool description (required when creating)
--effectstringread, write, or execute (default read on create)
--default-actionstringallow, require_approval, or deny (default allow on create)
--scopesstringRequired scopes JSON array (default [] on create)
--languagestringjavascript, typescript, or python (from extension)
--entrypointstringExported handler name (default handler)
--input-schemastringJSON input schema, inline or file path
--output-schemastringJSON output schema, inline or file path
--timeout-msstringExecution timeout in milliseconds
--memory-mibstringExecution memory in MiB
--networkstringnone or sandbox
--secretstringSecret NAME (from env NAME), NAME=env:VAR, or NAME=file:PATH; repeatable

Also accepts the global flags.

On this page