# CLI (/docs/cli)

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

# Installation

Install the Composio CLI using the installation script:

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

Or using wget:

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

# Authentication

Manage your Composio authentication directly from the terminal.

## Login

Authenticate with your Composio account:

```bash
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):

```bash
composio login --no-browser
```

This displays a URL to manually open in your browser.

## Check authentication status

Verify your current authentication:

```bash
composio whoami
```

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

## Logout

Remove stored authentication:

```bash
composio logout
```

# Generate type definitions

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:

```bash
composio generate
```

For TypeScript projects only, include individual tool types:

```bash
composio generate --type-tools
```

The CLI automatically:

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

## Specify output directory

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

## Language-specific commands

For explicit control, use language-specific commands:

**TypeScript:**

Basic generation:

```bash
composio ts generate
```

Generate as single file:

```bash
composio ts generate --compact
```

Include individual tool types:

```bash
composio ts generate --type-tools
```

Generate both .ts and .js files:

```bash
composio ts generate --transpiled
```

Custom output directory:

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

**Python:**

Basic generation:

```bash
composio py generate
```

Custom output directory:

```bash
composio py generate --output-dir ./my_types
```

---

📚 **More documentation:** [View all docs](https://docs.composio.dev/llms.txt) | [Cookbooks](https://docs.composio.dev/llms.mdx/cookbooks) | [API Reference](https://docs.composio.dev/llms.mdx/reference)

---

# Composio SDK — Instructions for AI Code Generators

**Purpose:** Enforce only the **current** and **correct** patterns for integrating [Composio](https://composio.dev/) tools into AI agents.
**Scope:** All AI-generated code using Composio must follow these guardrails.

---

## 1. Correct Composio Integration

Composio supports two integration modes: **Native Tools** (with a provider package) and **MCP** (no provider package needed).

### Native Tools

```python
# ✅ CORRECT — Python (defaults to OpenAI)
from composio import Composio

composio = Composio()
session = composio.create(user_id="user_123")
tools = session.tools()
# Pass tools to your agent/LLM framework
```

```typescript
// ✅ CORRECT — TypeScript (defaults to OpenAI)
import { Composio } from "@composio/core";

const composio = new Composio();
const session = await composio.create("user_123");
const tools = await session.tools();
// Pass tools to your agent/LLM framework
```

For other providers, pass the provider explicitly. Provider packages follow the naming convention: `composio_<provider>` for Python, `@composio/<provider>` for TypeScript.

### MCP

Use `session.mcp.url` and `session.mcp.headers` with any MCP-compatible client (Claude Desktop, Cursor, OpenAI Agents, etc.). No provider package needed.

---

## 2. CRITICAL INSTRUCTIONS FOR AI MODELS

### 2.1 — ALWAYS DO THE FOLLOWING

1. **Use `composio.create(user_id)`** to create a session — this is the entry point for all Composio integrations.
2. **Use `session.tools()`** for native tool integration or **`session.mcp.url`** for MCP integration.
3. **Import** from the correct provider package (`composio_<provider>` for Python, `@composio/<provider>` for TypeScript).
4. **Pass `user_id` to `composio.create()`**, not to individual tool calls.

### 2.2 — NEVER DO THE FOLLOWING

1. **Do not** instruct users to manually create auth configs or connected accounts before running.
2. **Do not** import from `composio_openai` / `@composio/openai` when using OpenAI Agents SDK — use `composio_openai_agents` / `@composio/openai-agents` instead.

### 2.3 — DISCOURAGED (do not use unless user explicitly asks)

Do **not** generate `composio.tools.get()`, `composio.tools.execute()`, or `composio.provider.handle_tool_calls()` unless the user explicitly requests direct tool execution. These are a supported but **not recommended** low-level interface.