@devries-cameron20 / composio-1 / commits / 13ddfba8d
Fork 0

Composio powers 1000+ toolkits, tool search, context management, authentication, and a sandboxed workbench to help you build AI agents that turn intent into action.

docs: update documentation for new changelog entries (#5031)

## Summary Automated documentation updates triggered by new changelog entries merged to next. Generated by Codex via GitHub Actions. Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

sdkrelease[bot] committed Oct 21, 2026 at 20:07 UTC 13ddfba8d777938cf9256f964d407d8699666e18
1 file changed +29 -1
docs/content/docs/cli.mdx
+29 -1
@@ -47,6 +47,14 @@ composio setup skill claude
47 composio setup skill codex
48 ```
49
50 +### Backend and Dashboard configuration
51 +
52 +The CLI uses the backend recorded by `composio login`. `COMPOSIO_BASE_URL` and `COMPOSIO_ENVIRONMENT` override that backend. If an override sends your stored key to a different backend, the CLI warns on stderr. If your key is rejected, follow the printed command to log in again.
53 +
54 +`composio execute` sends single executions, `--parallel` executions, and meta tool calls through the Dashboard recorded with your login. For the default deployment, allow outbound requests to both `dashboard.composio.dev` and `backend.composio.dev`. Other commands, including `composio dev playground-execute`, use the backend API.
55 +
56 +For a custom deployment, setting `COMPOSIO_BASE_URL` without `COMPOSIO_WEB_URL` keeps executions on that backend. Set both variables to route executions through your deployment's Dashboard. `COMPOSIO_WEB_URL` must use HTTPS and contain no credentials, query string, or fragment. HTTP is accepted only for `localhost`. An invalid URL causes `composio execute` to fail before sending a request.
57 +
58 ### Install with options
59
60 Pin a version and skip agent plugin setup:
@@ -261,10 +269,30 @@ Use `composio proxy` when the agent already knows the provider's API endpoint an
269 composio proxy https://gmail.googleapis.com/gmail/v1/users/me/profile --toolkit gmail
270 ```
271
272 +### Execution failures and exit codes
273 +
274 +`composio execute` exits `1` when a tool reports failure or the Dashboard or backend cannot run it. With `--parallel`, any failed call makes the command exit `1`. Meta tools follow the same rules. Failed tool results include `{"successful": false, ...}` on stdout, with diagnostic messages on stderr. Check the exit code in scripts and agents, even when stdout contains JSON.
275 +
276 +Execution requests are sent once, without retries or redirects. After 15 minutes, the CLI stops waiting.
277 +
278 +<Callout type="warn">
279 +A timed-out tool may still have run. Check the result in the connected app before sending the request again.
280 +</Callout>
281 +
282 +Missing required IDs or names for `composio dev auth-configs info`, `composio tools info`, and `composio dev triggers create` or `enable` cause exit `1`. The `--custom-credentials` option for auth config creation and `--trigger-config` option for trigger creation must contain JSON objects. Invalid input prints a message on stderr, leaves stdout empty, and sends no request.
283 +
284 +If `--account` matches no connected account, `composio execute` and `composio proxy` print a usage error on stderr and exit `1`. If `composio orgs switch` has no usable stored API key, it exits `1` and asks you to run `composio login`.
285 +
286 +### Execution telemetry
287 +
288 +When telemetry is enabled, `composio execute` sends the anonymous install ID from `~/.composio/analytics.json` to the Dashboard in the `x-cli-install-id` header. This random UUID is never sent to the backend API. Set `COMPOSIO_CLI_TELEMETRY_DISABLED`, `TELEMETRY_DISABLED`, `COMPOSIO_DISABLE_TELEMETRY`, or `CI` to prevent the header from being sent.
289 +
290 ### Run scripts
291
292 Reach for `composio run` when the agent needs a multi-step workflow: loops, parallel fan-out, or data transformation. It runs inline TS/JS or a file, with `execute()`, `search()`, `proxy()`, `result.prompt()`, and `z` injected.
293
294 +If a tool execution fails, `execute()` rejects with the tool's error message and the failed result.
295 +
296 Run a single scripted workflow:
297
298 ```bash
@@ -392,7 +420,7 @@ composio dev logs triggers --limit 20
420 composio dev triggers list gmail
421 composio dev triggers info GMAIL_NEW_GMAIL_MESSAGE
422 composio dev triggers status
395 -composio dev triggers create
423 +composio dev triggers create GMAIL_NEW_GMAIL_MESSAGE
424 composio dev triggers enable ti_xxx
425 composio dev listen --trigger-slug GMAIL_NEW_GMAIL_MESSAGE --json --max-events 5
426 ```