> ## 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.

# Installation

> Install the Composio CLI on Linux, macOS, or via package managers

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

## Quick Install (Recommended)

### One-line Install

The fastest way to install the Composio CLI:

```bash theme={null}
curl -fsSL https://raw.githubusercontent.com/ComposioHQ/composio/main/install.sh | bash
```

This installer:

* 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

### Install Specific Version

To install a specific version of the CLI:

```bash theme={null}
curl -fsSL https://raw.githubusercontent.com/ComposioHQ/composio/main/install.sh | bash -s -- v0.1.24
```

<Note>
  CLI binaries use the tag format `@composio/cli@<semver>` (e.g., `@composio/cli@0.1.24`). Legacy `v<semver>` tags are also supported during the migration period.
</Note>

## Manual Installation

### From GitHub Releases

1. Go to the [releases page](https://github.com/ComposioHQ/composio/releases)

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:

```bash theme={null}
# 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

```bash theme={null}
npm install -g @composio/cli
```

### pnpm

```bash theme={null}
pnpm add -g @composio/cli
```

### yarn

```bash theme={null}
yarn global add @composio/cli
```

## Verification

After installation, verify it works:

```bash theme={null}
composio --version
composio --help
```

**Expected output:**

```
0.1.33
```

## Getting Started

Once installed, follow these steps:

### 1. Login to Composio

```bash theme={null}
composio login
```

This opens your browser for OAuth authentication.

### 2. Generate Types

Generate type-safe code for your project:

```bash theme={null}
# Auto-detect project type
composio generate

# TypeScript projects
composio ts generate

# Python projects
composio py generate
```

### 3. Check Your Account

```bash theme={null}
composio whoami
```

## Supported Platforms

<Check>**Fully Supported**</Check>

* Linux x86\_64
* Linux ARM64 (aarch64)
* macOS x86\_64 (Intel)
* macOS ARM64 (Apple Silicon)

<Warning>**Not Supported**</Warning>

* Windows (use WSL or npm installation)

## Troubleshooting

### Permission Denied

If you get permission errors:

```bash theme={null}
chmod +x ~/.composio/bin/composio
```

### Command Not Found

If `composio` is not found after installation:

**1. Restart your shell:**

```bash theme={null}
exec $SHELL
```

**2. Or manually source your profile:**

```bash theme={null}
# For bash
source ~/.bashrc

# For zsh
source ~/.zshrc

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

**3. Check if the binary exists:**

```bash theme={null}
ls -la ~/.composio/bin/composio
```

**4. Manually add to PATH:**

```bash theme={null}
export PATH="$HOME/.composio/bin:$PATH"
```

### Download Failures

If the download fails:

**1. Check your internet connection**

**2. Try again with verbose output:**

```bash theme={null}
curl -v -fsSL https://raw.githubusercontent.com/ComposioHQ/composio/main/install.sh | bash
```

**3. Manual download:**

```bash theme={null}
# 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:

```bash theme={null}
# Remove the binary
rm -rf ~/.composio

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

## Installation Environment Variables

The installer respects these environment variables:

| Variable           | Description            | Default              |
| ------------------ | ---------------------- | -------------------- |
| `COMPOSIO_INSTALL` | Installation directory | `~/.composio`        |
| `GITHUB`           | GitHub base URL        | `https://github.com` |

**Example:**

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

## Development

To build the CLI binary locally:

```bash theme={null}
cd ts/packages/cli
pnpm install
pnpm build:binary
```

The binary will be created at `dist/composio`.

## Next Steps

<CardGroup cols={2}>
  <Card title="Login" icon="right-to-bracket" href="/cli/commands/login">
    Authenticate with Composio
  </Card>

  <Card title="Generate" icon="code" href="/cli/commands/generate">
    Generate type-safe code
  </Card>
</CardGroup>