CLI

The Composio CLI helps you generate type-safe code and manage your Composio workspace.

Installation

Install the Composio CLI using the installation script:

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

Or using wget:

wget -qO- https://composio.dev/install | bash

Authentication

Manage your Composio authentication directly from the terminal.

Authenticate with your Composio account:

composio login

This opens your browser to complete authentication and stores your API key locally.

To authenticate without opening a browser (useful for SSH/remote sessions):

composio login --no-browser

This displays a URL to manually open in your browser.

Check authentication status

Verify your current authentication:

composio whoami

This displays your current API key or indicates if you're not authenticated.

Logout

Remove stored authentication:

composio logout

Generate TypeScript or Python type definitions for all Composio tools. These types provide type safety when using direct tool execution (composio.tools.execute()), helping you pass the correct parameters and catch errors early.

Auto-detect and generate

The CLI auto-detects your project language. In your project directory:

composio generate

For TypeScript projects only, include individual tool types:

composio generate --type-tools

The CLI automatically:

Detects your project type (Python or TypeScript)
Generates appropriate type definitions

Specify output directory

composio generate --output-dir ./my-types

Language-specific commands

For explicit control, use language-specific commands:

Basic generation:

composio ts generate

Generate as single file:

composio ts generate --compact

Include individual tool types:

composio ts generate --type-tools

Generate both .ts and .js files:

composio ts generate --transpiled

Custom output directory:

composio ts generate --output-dir ./my-types