CLI Installation

Install and set up the Composio command-line interface

Quick Install (Recommended)

The fastest way to install the Composio CLI is using the one-line installer:

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

Install Specific Version

You can install a specific version by passing it as an argument:

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

What the Installer Does

The install script automatically:

• Detects your platform and architecture
• 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

Package Manager Installation

Alternatively, install the CLI using npm, pnpm, or yarn:

npm

npm install -g @composio/cli

Manual Installation

For manual installation from GitHub releases:

1. Download the binary

   Go to the releases page and 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
2. 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
   

Verification

After installation, verify the CLI is working correctly:

1. Check version

   composio --version
   
2. View help

   composio --help
   
3. Login to Composio

   composio login
   

   This will open your browser to authenticate with your Composio account.

4. Verify authentication

   composio whoami
   

   This should display your account information.

Getting Started

Once installed and authenticated, you can start using the CLI:

Generate Types for Your Project

Auto-detect

# Automatically detect project type and generate types
composio generate

Common Commands

# View account information
composio whoami

# List available tools
composio tools list

# Connect an account
composio connect github

# View connected accounts
composio accounts list

Supported Platforms

Fully Supported

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

Not Supported

Windows is not directly supported. Use WSL (Windows Subsystem for Linux) or install via npm.

Environment Variables

The installer respects these environment variables:

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

Custom Installation Directory

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

Troubleshooting

Permission Denied

If you get permission errors when running the CLI:

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

   bash

   source ~/.bashrc
   
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 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 the Composio CLI:

# Remove the binary and installation directory
rm -rf ~/.composio

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

If installed via npm:

npm uninstall -g @composio/cli

Next Steps

• Learn about CLI commands
• Set up authentication
• Generate type definitions
• Check out the GitHub repository