Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/ComposioHQ/composio/llms.txt

Use this file to discover all available pages before exploring further.

The Composio CLI is the terminal interface for Composio, designed primarily for use inside Claude Code. It lets Claude search for tools, execute them with managed auth, connect apps, run multi-step scripts, and debug Composio projects — all from the command line. Instead of copying API keys and schemas into chat, you give Claude a reliable local tool surface it can operate autonomously.

​
Installation

1

Download and install the CLI

Run the one-line install script. It detects your platform and architecture automatically, downloads the appropriate binary, installs it to ~/.composio/bin/composio, and adds it to your shell’s PATH.
curl -fsSL https://composio.dev/install | bash
Alternatively, install from npm, pnpm, or yarn:
npm install -g @composio/cli
# or
pnpm add -g @composio/cli
# or
yarn global add @composio/cli
The npm/pnpm/yarn packages install the same CLI but rely on Node.js being present. The curl script installs a standalone binary that runs without any additional runtime.
2

Restart your shell

Reload your shell so the newly added PATH entry takes effect:
exec $SHELL
3

Log in to Composio

Authenticate with your Composio account. composio login opens a browser for OAuth and stores your credentials locally.
composio login
You need a Composio API key (tied to your account) to use the CLI. Sign up at composio.dev if you don’t have one. composio login handles credential storage automatically — you do not need to manage the key directly.
Prefer to log in directly with an existing key? Use the --user-api-key flag:
composio login --user-api-key <your-api-key>

​
Verify installation

After logging in, confirm that the CLI is working correctly: 
composio whoami
composio --version
composio whoami prints your email, current organization, and account type. composio --version prints the installed binary version.

​
Using inside Claude Code

composio login installs the composio-cli skill for Claude Code by default. This skill tells Claude how to use the CLI to find tools, connect accounts, and run scripts on your behalf. To install the skill manually at any time, run: 
composio --install-skill composio-cli claude
Once the skill is installed, open Claude Code in any project directory. Claude will automatically use the CLI to search for tools, execute them with managed authentication, connect apps, and run multi-step scripted workflows — without requiring any additional setup on your part.
The CLI is the recommended tool surface for Composio inside Claude Code. It handles auth, schema validation, and connection management automatically, so you can ask Claude to work in your connected apps directly.

​
Core workflows

Search tools

Find the right tool by describing what you want to do in natural language. Returns tool slugs, schemas, and suggested next steps.

Execute tools

Run any of Composio’s 1000+ tool integrations directly from the terminal, with automatic input validation and connection checks.

Connect apps

Connect an external account (Gmail, GitHub, Slack, and more) using a browser-based OAuth flow. Composio manages all auth state.

Run scripts

Execute inline TypeScript or a script file with injected globals — execute(), search(), proxy(), z (Zod), and more — for multi-step workflows and fan-out pipelines.

​
Upgrading

Keep the CLI up to date with the upgrade command: 
composio upgrade
To install a specific release: 
composio upgrade 0.13.1
To upgrade to the latest beta: 
composio upgrade --beta
After upgrading, the CLI automatically re-installs the Claude Code skill for the new version.

​
Getting help

Every command and subcommand supports --help: 
composio --help
composio --help full
composio execute --help full
composio run --help full
composio dev --help full

Build docs developers (and LLMs) love

Get started for freeTalk to us