Every command below also accepts the global options.
Run one built-in tool and print what it produced
sim tools execute <toolId> [options]Run one built-in tool and print what it produced (OAuth login or personal API key required)
Arguments
| Argument | Required | Description |
|---|---|---|
toolId | Yes | Tool identifier. An unversioned name resolves to the newest version, and the response echoes the resolved id. |
Options
| Option | Required | Description |
|---|---|---|
--input <json|@file> | No | Tool arguments as JSON, keyed by the parameter ids sim tools get <toolId> lists (JSON, or @path / @- to read a file or stdin). |
--credential-id <value> | No | Credential to authenticate with, required for OAuth tools. |
--timeout <value> | No | Seconds to wait before abandoning the call. |
Get tool
sim tools get <toolId>Arguments
| Argument | Required | Description |
|---|---|---|
toolId | Yes | Tool identifier. An unversioned name resolves to the newest version, and the response echoes the resolved id. |
List tools
sim tools list [options]Options
| Option | Required | Description |
|---|---|---|
--search <value> | No | Case-insensitive substring match against the tool id, name, and description. |
--hosted-api-key <value> | No | Restrict to tools by how their API key is supplied. Accepted values: always, conditional, none. |
--oauth-provider <value> | No | Restrict to tools that authenticate against this OAuth service. |
--sort-by <value> | No | Field used to sort the result. Sorting by name is case-sensitive and follows the storage collation, so do not rely on a case-insensitive order. Accepted values: id, name. |
--sort-order <value> | No | Sort direction. Accepted values: asc, desc. |
--limit <n> | No | Maximum items to return (0 for everything). Defaults to 0. |