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

next
md 147 lines 8.62 KB
Rendered Raw
1 # Composio CLI installation
2
3 On Linux or macOS, install the CLI bundle in `~/.composio` and its entry point in `~/.local/bin`:
4
5 ```bash
6 curl -fsSL https://composio.dev/install | sh
7 ```
8
9 The installer also configures your shell. It infers your login shell from `$SHELL` (`zsh`, `bash`, or `fish`) and writes a managed `# Composio CLI` PATH block so future terminals find `composio`. For `zsh` and `fish`, it updates the matching startup file. For `bash`, it updates `~/.bashrc` plus a login-mode startup file, because a login bash (what macOS Terminal.app starts) never reads `~/.bashrc`: the first existing of `~/.bash_profile` or `~/.bash_login`, or a newly created `~/.bash_profile` when neither exists. A `~/.bash_profile` created this way sources `~/.profile` first, so nothing you already had stops loading; `~/.profile` itself is never modified. Open a new terminal, then run `composio login`.
10
11 If your shell is not recognized, or shell setup fails, the binary install still succeeds and the installer prints a runnable command instead. The installer also installs plugins for detected, supported Codex and Claude Code hosts. Set `COMPOSIO_INSTALL_PLUGINS=0` or pass `--no-plugins` to skip plugin setup. Login remains a separate step.
12
13 Official releases must pass SHA-256 verification against the release's `checksums.txt`: a missing manifest, a manifest with no entry for your platform's archive, a malformed entry, or a mismatch aborts the install with `Refusing to install`. On systems with no `sha256sum` or `shasum`, the installer warns that verification was skipped and continues.
14
15 ## Windows x64 (experimental)
16
17 Run in PowerShell:
18
19 ```powershell
20 irm https://raw.githubusercontent.com/ComposioHQ/composio/next/install.ps1 | iex
21 ```
22
23 The installer verifies the release's SHA-256 checksum, installs `composio.exe` and its support files in `$HOME\.composio`, and adds that directory to your User PATH. Then run `composio login`. You don't need administrator access.
24
25 To install a specific stable or beta release, set `COMPOSIO_INSTALL_VERSION` first:
26
27 ```powershell
28 $env:COMPOSIO_INSTALL_VERSION = "X.Y.Z"; irm https://raw.githubusercontent.com/ComposioHQ/composio/next/install.ps1 | iex
29 ```
30
31 Set `COMPOSIO_INSTALL_DIR` to choose the bundle directory, or `COMPOSIO_INSTALL_SHELL` to `none` to leave PATH unchanged. Keep the complete bundle together when moving it.
32
33 Windows support is experimental. Installation, `composio run`, `composio upgrade`, and `composio setup` are tested on Windows; other commands may not work yet. `composio install` and shell completions support only zsh, bash, and fish: the PowerShell installer sets PATH for you.
34
35 Windows requires Windows 10 version 1809 or newer and an x64 CPU with SSE4.2. Windows ARM64 is not supported. For a fully supported setup, run the Linux installer inside [WSL](https://learn.microsoft.com/windows/wsl/install).
36
37 ## Choose or skip shell setup
38
39 Set `COMPOSIO_INSTALL_SHELL` to force a specific shell, or to skip shell configuration entirely:
40
41 ```bash
42 curl -fsSL https://composio.dev/install | COMPOSIO_INSTALL_SHELL=zsh sh
43 curl -fsSL https://composio.dev/install | COMPOSIO_INSTALL_SHELL=bash sh
44 curl -fsSL https://composio.dev/install | COMPOSIO_INSTALL_SHELL=fish sh
45 curl -fsSL https://composio.dev/install | COMPOSIO_INSTALL_SHELL=none sh
46 ```
47
48 Use `none` to leave shell files unchanged. Use it when a dotfile manager owns your startup files. For an install-only run in CI or Docker, also set `COMPOSIO_INSTALL_PLUGINS=0`.
49
50 Shell-specific installer variants ([`install/zsh.sh`](install/zsh.sh), [`install/bash.sh`](install/bash.sh), [`install/fish.sh`](install/fish.sh)) pin `COMPOSIO_INSTALL_SHELL` to their shell before delegating to the base installer.
51
52 Shell setup is idempotent: repeated installs keep exactly one managed PATH block per startup file and reconcile it when the bin directory changes. Setup delegates to `composio install --shell <shell>` and falls back to writing the same `# Composio CLI` PATH block inline when the installed CLI predates that flag, delegated setup fails, or delegated setup leaves a stale block.
53
54 Pin a stable or beta release with `COMPOSIO_INSTALL_VERSION`, or pass the tag as a positional argument:
55
56 ```bash
57 curl -fsSL https://composio.dev/install | COMPOSIO_INSTALL_VERSION=0.3.1 sh
58 curl -fsSL https://composio.dev/install | sh -s -- @composio/cli@0.3.1-beta.329
59 ```
60
61 The positional argument takes precedence over `COMPOSIO_INSTALL_VERSION`.
62
63 | Variable or argument | Description | Default |
64 |---|---|---|
65 | `COMPOSIO_INSTALL_DIR` | Complete CLI bundle directory. | `$HOME/.composio` |
66 | `COMPOSIO_BIN_DIR` | `composio` entry-point directory. Treat this as trusted input: anyone who can write to this directory can replace commands that future terminals run. | `$HOME/.local/bin` |
67 | `COMPOSIO_INSTALL_VERSION` | Stable or beta version, with or without the package prefix. | Latest stable release |
68 | `COMPOSIO_QUIET` | Set to `1` or `true` to hide progress output. Warnings and errors still print. | Unset |
69 | `COMPOSIO_DEBUG` | Set to `1` or `true` to print installer traces. | Unset |
70 | `COMPOSIO_INSTALL_HELP` | Set to `0` to hide normal post-install guidance. Shell-setup failures still warn and print a recovery command to stderr. | `1` |
71 | `COMPOSIO_INSTALL_PLUGINS` | Set to `0` to skip plugin setup for detected agent hosts. | `1` |
72 | `COMPOSIO_INSTALL_SHELL` | Shell setup mode: `auto` infers your login shell from `$SHELL`, `zsh`, `bash`, or `fish` force a specific shell, and `none` skips shell configuration. | `auto` |
73 | `--agent` | Log in as a Composio agent after installation. | Off |
74 | `--no-plugins` | Skip plugin setup, even when `COMPOSIO_INSTALL_PLUGINS=1`. | Off |
75
76 ## Manual Installation
77
78 Download the archive for your platform from [GitHub Releases](https://github.com/ComposioHQ/composio/releases):
79
80 - `composio-linux-x64.zip`
81 - `composio-linux-aarch64.zip`
82 - `composio-darwin-x64.zip`
83 - `composio-darwin-aarch64.zip`
84 - `composio-windows-x64.zip`
85
86 Extract and install the complete bundle. The CLI loads support files beside the executable, so do not copy only the nested `composio` or `composio.exe` file.
87
88 ```bash
89 bundle=composio-linux-x64
90 COMPOSIO_INSTALL_DIR=${COMPOSIO_INSTALL_DIR:-"$HOME/.composio"}
91 COMPOSIO_BIN_DIR=${COMPOSIO_BIN_DIR:-"$HOME/.local/bin"}
92
93 unzip "$bundle.zip"
94 mkdir -p "$COMPOSIO_INSTALL_DIR"
95 cp -Rp "$bundle"/. "$COMPOSIO_INSTALL_DIR/"
96 chmod +x "$COMPOSIO_INSTALL_DIR/composio"
97 mkdir -p "$COMPOSIO_BIN_DIR"
98 if [ "$COMPOSIO_BIN_DIR" != "$COMPOSIO_INSTALL_DIR" ]; then
99 ln -sf "$COMPOSIO_INSTALL_DIR/composio" "$COMPOSIO_BIN_DIR/composio"
100 fi
101 export PATH="$COMPOSIO_BIN_DIR:$PATH"
102 ```
103
104 ## Verification
105
106 ```bash
107 composio --version
108 which composio
109 ```
110
111 ## Uninstall
112
113 Remove the entry point and release artifacts without deleting credentials, configuration, or caches. The file list below matches the current release layout; if you installed a different version, compare it against the contents of that release's archive.
114
115 ```bash
116 install_dir=${COMPOSIO_INSTALL_DIR:-"$HOME/.composio"}
117 bin_dir=${COMPOSIO_BIN_DIR:-"$HOME/.local/bin"}
118
119 rm -f \
120 "$bin_dir/composio" \
121 "$install_dir/composio" \
122 "$install_dir/release-tag.txt" \
123 "$install_dir/release-manifest.json" \
124 "$install_dir/run-helpers-runtime.mjs" \
125 "$install_dir/run-subagent-shared.mjs" \
126 "$install_dir/run-subagent-acp.mjs" \
127 "$install_dir/run-subagent-legacy.mjs" \
128 "$install_dir/run-subagent-output-mcp.mjs" \
129 "$install_dir/generation-runtime.mjs" \
130 "$install_dir/execute-output-encoder-runtime.mjs"
131 rm -rf \
132 "$install_dir/services" \
133 "$install_dir/acp-adapters" \
134 "$install_dir/local-tools-binaries"
135 ```
136
137 Remove the managed `# Composio CLI` PATH block from `~/.zshrc`, `~/.bashrc`, `~/.bash_profile`, `~/.bash_login`, or `~/.config/fish/config.fish`. Blocks written by older installers contain an extra `export COMPOSIO_INSTALL_DIR=...` (or `set --export COMPOSIO_INSTALL_DIR ...`) line after the marker; remove that line too. If removing the block leaves `~/.bash_profile` with nothing but blank lines, delete the file: the installer creates it on bash systems that had no login startup file, and even an empty `~/.bash_profile` keeps bash from reading `~/.profile`. If you had a `~/.profile` at install time, that created file instead holds a passthrough sourcing it, starts with `# Created by the Composio CLI installer.`, and is left in place; delete it as well to restore bash's default startup-file selection.
138
139 To purge credentials, configuration, caches, and every other CLI file, run `rm -rf "${COMPOSIO_INSTALL_DIR:-$HOME/.composio}"`. This is a complete reset and cannot be undone.
140
141 ## Supported platforms
142
143 - Linux x64
144 - Linux ARM64
145 - macOS Intel
146 - macOS Apple Silicon
147 - Windows: x64, experimental (Windows 10 1809+), installed with PowerShell. Requires an SSE4.2-capable CPU.