Composio powers 1000+ toolkits, tool search, context management, authentication, and a sandboxed workbench to help you build AI agents that turn intent into action.
Mirrored from https://github.com/Camo67/composio.git
Synced Nov 21, 04:45 UTC
| 1 | # Composio CLI |
| 2 | |
| 3 | The vocabulary of `@composio/cli`: who a command acts for, where it runs, and how one invocation ends. |
| 4 | |
| 5 | ## Command trees |
| 6 | |
| 7 | **Root tree**: |
| 8 | The commands a Composio user runs directly (`composio execute`, `composio link`); they act on the user's consumer project. |
| 9 | _Avoid_: consumer mode, root mode |
| 10 | |
| 11 | **Dev tree**: |
| 12 | The commands under `composio dev`, for developers building on Composio; they act on a developer project. |
| 13 | _Avoid_: developer mode, playground |
| 14 | |
| 15 | **Command path**: |
| 16 | The command names of an invocation, without `composio`, flags, or arguments, e.g. `dev triggers list`. |
| 17 | _Avoid_: command name, command string |
| 18 | |
| 19 | **Command registration**: |
| 20 | One place a command appears in the command tree; the same command can have several, each with its own command path (`link` and `dev connected-accounts link`). |
| 21 | _Avoid_: command instance |
| 22 | |
| 23 | **Root shortcut**: |
| 24 | A root-tree command that reaches a command defined in a group, e.g. `search` for `tools search`. |
| 25 | _Avoid_: alias (reserved for a flag's or command's short name) |
| 26 | |
| 27 | ## Projects and users |
| 28 | |
| 29 | **Consumer project**: |
| 30 | The project that holds a Composio user's own connections and executions, resolved from their login. |
| 31 | |
| 32 | **Developer project**: |
| 33 | A project a developer builds against, chosen by the working directory or `--project-name`. A dev command that reads or writes a project's resources falls back, with a notice on stderr, to the backend's default developer project (the newest one in the logged-in org) when neither names a usable one. |
| 34 | |
| 35 | **Consumer user**: |
| 36 | The user id of the logged-in person within their consumer project; no flag overrides it. |
| 37 | |
| 38 | **Test user**: |
| 39 | A user id a developer acts as on a developer project: the directory test user (from the directory's project setup) or the global test user (stored at login). |
| 40 | _Avoid_: playground user, default user |
| 41 | |
| 42 | **Acting user**: |
| 43 | The user a command acts as: the consumer user on the root tree; on the dev tree, against the developer project, `--user-id` when given, otherwise the directory test user (only for the directory's own project), otherwise the global test user. A test user standing in is named on stderr; no user at all is a missing acting user, with one message per tree. |
| 44 | _Avoid_: current user, target user |
| 45 | |
| 46 | **User filter**: |
| 47 | A `--user-id` that only narrows listed results and never falls back to a test user. |
| 48 | |
| 49 | ## Outcomes |
| 50 | |
| 51 | **Invocation**: |
| 52 | One execution of the `composio` binary, from argv to exit code. |
| 53 | _Avoid_: run (that is the `composio run` command) |
| 54 | |
| 55 | **Expected failure**: |
| 56 | A failure the user fixes by changing the invocation or their setup, or that a remote service reported clearly; the CLI prints its message and no defect report. |
| 57 | _Avoid_: usage error (a usage error is one kind) |
| 58 | |
| 59 | **Defect**: |
| 60 | A failure that signals a bug in the CLI; the CLI prints a defect report. |