Skip to content

INSTALL.md

Latest commit

 

History

History
121 lines (90 loc) · 7.02 KB

INSTALL.md

File metadata and controls

121 lines (90 loc) · 7.02 KB
Raw

Composio CLI installation

Install the CLI bundle in ~/.composio and its entry point in ~/.local/bin:

curl -fsSL https://composio.dev/install | sh

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.

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 does not install agent plugins or log you in unless you ask it to.

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.

Choose or skip shell setup

Set COMPOSIO_INSTALL_SHELL to force a specific shell, or to skip shell configuration entirely:

curl -fsSL https://composio.dev/install | COMPOSIO_INSTALL_SHELL=zsh sh
curl -fsSL https://composio.dev/install | COMPOSIO_INSTALL_SHELL=bash sh
curl -fsSL https://composio.dev/install | COMPOSIO_INSTALL_SHELL=fish sh
curl -fsSL https://composio.dev/install | COMPOSIO_INSTALL_SHELL=none sh

Use none for an install-only run that changes no shell files. Reach for it in CI, Docker images, or when a dotfile manager owns your startup files.

Shell-specific installer variants (install/zsh.sh, install/bash.sh, install/fish.sh) pin COMPOSIO_INSTALL_SHELL to their shell before delegating to the base installer.

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.

Pin a stable or beta release with COMPOSIO_INSTALL_VERSION, or pass the tag as a positional argument:

curl -fsSL https://composio.dev/install | COMPOSIO_INSTALL_VERSION=0.3.1 sh
curl -fsSL https://composio.dev/install | sh -s -- @composio/cli@0.3.1-beta.329

The positional argument takes precedence over COMPOSIO_INSTALL_VERSION.

Variable or argument Description Default
COMPOSIO_INSTALL_DIR Complete CLI bundle directory. $HOME/.composio
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
COMPOSIO_INSTALL_VERSION Stable or beta version, with or without the package prefix. Latest stable release
COMPOSIO_QUIET Set to 1 or true to hide progress output. Warnings and errors still print. Unset
COMPOSIO_DEBUG Set to 1 or true to print installer traces. Unset
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
COMPOSIO_INSTALL_PLUGINS Set to 1 to install plugins for detected agent hosts. 0
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
--agent Log in as a Composio agent after installation. Off
--no-plugins Skip plugin setup. Kept for compatibility. Off

Manual Installation

Download the archive for your platform from GitHub Releases:

  • composio-linux-x64.zip
  • composio-linux-aarch64.zip
  • composio-darwin-x64.zip
  • composio-darwin-aarch64.zip

Extract and install the complete bundle. The CLI loads support files beside the executable, so do not copy only the nested composio file.

bundle=composio-linux-x64
COMPOSIO_INSTALL_DIR=${COMPOSIO_INSTALL_DIR:-"$HOME/.composio"}
COMPOSIO_BIN_DIR=${COMPOSIO_BIN_DIR:-"$HOME/.local/bin"}

unzip "$bundle.zip"
mkdir -p "$COMPOSIO_INSTALL_DIR"
cp -Rp "$bundle"/. "$COMPOSIO_INSTALL_DIR/"
chmod +x "$COMPOSIO_INSTALL_DIR/composio"
mkdir -p "$COMPOSIO_BIN_DIR"
if [ "$COMPOSIO_BIN_DIR" != "$COMPOSIO_INSTALL_DIR" ]; then
  ln -sf "$COMPOSIO_INSTALL_DIR/composio" "$COMPOSIO_BIN_DIR/composio"
fi
export PATH="$COMPOSIO_BIN_DIR:$PATH"

Verification

composio --version
which composio

Uninstall

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.

install_dir=${COMPOSIO_INSTALL_DIR:-"$HOME/.composio"}
bin_dir=${COMPOSIO_BIN_DIR:-"$HOME/.local/bin"}

rm -f \
  "$bin_dir/composio" \
  "$install_dir/composio" \
  "$install_dir/release-tag.txt" \
  "$install_dir/run-helpers-runtime.mjs" \
  "$install_dir/run-subagent-shared.mjs" \
  "$install_dir/run-subagent-acp.mjs" \
  "$install_dir/run-subagent-legacy.mjs" \
  "$install_dir/run-subagent-output-mcp.mjs"
rm -rf \
  "$install_dir/services" \
  "$install_dir/acp-adapters" \
  "$install_dir/local-tools-binaries"

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.

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.

Supported platforms

  • Linux x64
  • Linux ARM64
  • macOS Intel
  • macOS Apple Silicon
  • Windows: use WSL and run the installer inside your WSL distribution