Skip to content

INSTALL.md

Latest commit

 

History

History
212 lines (157 loc) · 4.25 KB

INSTALL.md

File metadata and controls

212 lines (157 loc) · 4.25 KB

Composio CLI Installation Guide

This guide provides multiple ways to install the Composio CLI on your system.

Quick Install (Recommended)

One-line Install

curl -fsSL https://raw.githubusercontent.com/ComposioHQ/composio/main/install.sh | bash

Install specific version

curl -fsSL https://raw.githubusercontent.com/ComposioHQ/composio/main/install.sh | bash -s -- v0.1.24

What the install script does:

  • Detects your platform and architecture automatically
  • Downloads the appropriate binary from GitHub releases
  • Installs to ~/.composio/bin/composio
  • Updates your shell configuration (.bashrc, .zshrc, or .config/fish/config.fish)
  • Adds the binary to your PATH

Manual Installation

From GitHub Releases

  1. Go to the releases page

  2. Download the appropriate binary for your platform:

    • composio-linux-x64.zip - Linux 64-bit
    • composio-linux-aarch64.zip - Linux ARM64
    • composio-darwin-x64.zip - macOS Intel
    • composio-darwin-aarch64.zip - macOS Apple Silicon

  3. Extract and install:

# Extract the binary
unzip composio-*.zip

# Move to a directory in your PATH
sudo mv composio /usr/local/bin/

# Make it executable
chmod +x /usr/local/bin/composio

Package Manager Installation

npm

npm install -g @composio/cli

pnpm

pnpm add -g @composio/cli

yarn

yarn global add @composio/cli

Verification

After installation, verify it works:

composio --version
composio --help

Getting Started

  1. Login to Composio:

    composio login

  2. Generate types for your project:

    # Auto-detect project type and generate
composio generate

# Generate for TypeScript
composio ts generate

# Generate for Python  
composio py generate

  3. Check your account:

    composio whoami

Supported Platforms

✅ Fully Supported:

  • Linux x86_64
  • Linux ARM64 (aarch64)
  • macOS x86_64 (Intel)
  • macOS ARM64 (Apple Silicon)

❌ Not Supported:

  • Windows (use WSL or npm installation)

Troubleshooting

Permission Denied

If you get permission errors:

chmod +x ~/.composio/bin/composio

Command Not Found

If composio is not found after installation:

  1. Restart your shell:

    exec $SHELL

  2. Or manually source your profile:

    # For bash
source ~/.bashrc

# For zsh  
source ~/.zshrc

# For fish
source ~/.config/fish/config.fish

  3. Check if the binary exists:

    ls -la ~/.composio/bin/composio

  4. Manually add to PATH:

    export PATH="$HOME/.composio/bin:$PATH"

Download Failures

If the download fails:

  1. Check your internet connection

  2. Try again with verbose output:

    curl -v -fsSL https://raw.githubusercontent.com/ComposioHQ/composio/main/install.sh | bash

  3. Manual download:

    # Download the install script first
curl -O https://raw.githubusercontent.com/ComposioHQ/composio/main/install.sh

# Review the script
cat install.sh

# Run it
bash install.sh

Uninstallation

To remove Composio CLI:

# Remove the binary
rm -rf ~/.composio

# Remove from shell configuration
# Edit ~/.bashrc, ~/.zshrc, or ~/.config/fish/config.fish
# and remove the lines that were added by the installer:
# export COMPOSIO_INSTALL="$HOME/.composio"
# export PATH="$COMPOSIO_INSTALL/bin:$PATH"

Environment Variables

The installer respects these environment variables:

  • COMPOSIO_INSTALL - Installation directory (default: ~/.composio)
  • GITHUB - GitHub base URL (default: https://github.com)

Example:

export COMPOSIO_INSTALL="/usr/local"
curl -fsSL https://raw.githubusercontent.com/ComposioHQ/composio/main/install.sh | bash

Development

To build the CLI binary locally:

cd ts/packages/cli
pnpm install
pnpm build:bin

The binary will be created at dist/composio.

Support