composio-cli

Composio CLI

通过统一的终端界面使用 1000 多种 SaaS 工具，并由托管式身份验证提供支持。可靠的操作流程始终是：发现 → 检查架构 → 确认连接 → 执行。切勿臆造工具 slug；执行前务必确认已连接的账户。

设置

curl -fsSL https://composio.dev/install | bash   # install
composio --version
composio login                                   # browser auth
composio whoami                                   # confirm identity

如果缺少 composio，请先安装。如果 whoami 失败，用户必须运行 composio login（这是交互式操作——请让用户自行运行）。

执行流程

1. 查找 slug（切勿猜测）

composio search "send a slack message" --human
composio search "create issue" --toolkits github
composio tools list github            # all tools in a toolkit
composio tools info GITHUB_CREATE_AN_ISSUE

2. 调用前检查架构

composio execute GITHUB_CREATE_AN_ISSUE --get-schema

将用户的意图对应到必填字段。如果某个必填字段未知，请询问，不要编造。

3. 确认账户已连接

composio link github --list      # already connected?
composio link github             # connect if not (interactive)
composio connections list

对未连接的工具包发起工具调用会失败——请先检查。

4. 先试运行，再执行

composio execute GITHUB_CREATE_AN_ISSUE --dry-run -d '{"owner":"acme","repo":"api","title":"Bug"}'
composio execute GITHUB_CREATE_AN_ISSUE -d '{"owner":"acme","repo":"api","title":"Bug"}'
composio execute SLUG -d @payload.json     # large payloads from file
composio execute SLUG --file ./image.png   # file upload
composio execute -p SLUG_A -d '...' SLUG_B -d '...'   # parallel

对于写入或破坏性操作，请先试运行，并在实际调用前征得用户确认。

其他模式

需求	命令
原始身份验证 API 调用	composio proxy <URL> --toolkit <tk> -X POST -d '{...}'
订阅事件	composio triggers list <tk> → composio listen <TRIGGER_SLUG> --timeout 5m --max-events 5
脚本化多步骤工作流	composio run --file ./workflow.ts（使用 --dry-run 预览）
类型化 SDK 存根	composio generate ts --toolkits github gmail

质量标准

• slug 来自 search/tools list，而非记忆。
• 已检查架构；负载与必填字段完全匹配。
• 执行前已验证连接。
• 写入操作已试运行，并经用户确认。
• 缺少必填输入 → 询问，不要编造。

反面做法

• 猜测工具 slug 或负载格式，而不是使用 --get-schema。
• 未检查 connections list 就运行 execute → 导致身份验证失败且错误信息不明确。
• 对破坏性调用跳过 --dry-run。
• 将密钥硬编码到负载中（Composio 会管理身份验证——不要传入令牌）。
• 将 composio login 当作可脚本化操作；它是交互式的——请让用户运行。