Composio powers 1000+ toolkits, tool search, context management, authentication, and a sandboxed workbench to help you build AI agents that turn intent into action.
TypeScript agentic-aiagentsaiai-agentsaiagentsdeveloper-toolsfunction-callinggpt-4javascriptjsllmllmopsmcppythonremote-mcp-serverssetypescript
docs: add comprehensive CLI reference page and update welcome page
Sushmitha Mallesh54ce26869bde
diff --git a/docs/components/ai-tools-banner.tsx b/docs/components/ai-tools-banner.tsxindex eb1bd2516..7957b79c0 100644--- a/docs/components/ai-tools-banner.tsx+++ b/docs/components/ai-tools-banner.tsx@@ -2,7 +2,7 @@import { useState } from 'react';import Link from 'next/link';-import { Bot, FileText, Copy, Check, ExternalLink } from 'lucide-react';+import { Bot, FileText, Terminal, Copy, Check, ExternalLink } from 'lucide-react';function CopyableCommand({ text }: { text: string }) {const [copied, setCopied] = useState(false);@@ -30,9 +30,10 @@ function CopyableCommand({ text }: { text: string }) {export function AIToolsBanner() {const skillsCommand = 'npx skills add composiohq/skills';+ const cliCommand = 'curl -fsSL https://composio.dev/install | bash';return (- <div className="not-prose relative mt-4 mb-4 sm:mt-6 sm:mb-6 overflow-hidden rounded-xl border border-fd-border bg-gradient-to-br from-fd-card via-fd-card to-fd-muted/50 dark:from-fd-muted/20 dark:via-fd-card dark:to-fd-muted/40">+ <div className="not-prose relative mt-4 mb-4 sm:mt-6 sm:mb-6 overflow-hidden rounded-xl border border-[var(--composio-orange)]/30 shadow-[0_0_15px_rgba(255,100,0,0.08)] dark:shadow-[0_0_15px_rgba(255,100,0,0.12)] bg-gradient-to-br from-fd-card via-fd-card to-fd-muted/50 dark:from-fd-muted/20 dark:via-fd-card dark:to-fd-muted/40">{/* Subtle grid pattern */}<divclassName="pointer-events-none absolute inset-0 opacity-[0.03] dark:opacity-[0.02]"@@ -53,11 +54,10 @@ export function AIToolsBanner() {</span></div>- {/* Skills command */}+ {/* Skills */}+ <div className="mb-1 text-xs font-medium text-[var(--composio-orange)] uppercase tracking-wider">Skills</div><CopyableCommand text={skillsCommand} />-- {/* Skills links */}- <div className="mb-3 sm:mb-4 flex items-center gap-3 text-xs">+ <div className="mb-3 flex items-center gap-3 text-xs"><Linkhref="https://skills.sh/composiohq/skills/composio"target="_blank"@@ -78,7 +78,21 @@ export function AIToolsBanner() {</Link></div>- {/* Context files */}+ {/* CLI */}+ <div className="mb-1 text-xs font-medium text-[var(--composio-orange)] uppercase tracking-wider">CLI</div>+ <CopyableCommand text={cliCommand} />+ <div className="mb-3 flex items-center gap-3 text-xs">+ <Link+ href="/docs/cli"+ className="inline-flex items-center gap-1 text-fd-muted-foreground hover:text-[var(--composio-orange)] transition-colors"+ >+ <Terminal className="h-3 w-3" />+ CLI Reference+ </Link>+ </div>++ {/* Context */}+ <div className="mb-1 text-xs font-medium text-[var(--composio-orange)] uppercase tracking-wider">Context</div><div className="flex flex-col gap-2 sm:flex-row"><Linkhref="/llms.txt"diff --git a/docs/content/docs/cli.mdx b/docs/content/docs/cli.mdxindex eb516a563..6f3a49b0c 100644--- a/docs/content/docs/cli.mdx+++ b/docs/content/docs/cli.mdx@@ -1,31 +1,68 @@---title: CLI-description: Generate type definitions and manage authentication-keywords: [command line, generate types]+description: Install the Composio CLI to manage toolkits, execute tools, handle authentication, and generate type-safe code from the terminal.+keywords: [cli, command line, terminal, toolkits, tools, authentication, generate types]----The Composio CLI helps you generate type-safe code and manage your Composio workspace.+The Composio CLI gives you full control over your Composio workspace from the terminal — discover toolkits, execute tools, manage authentication, subscribe to triggers, inspect logs, and generate type-safe code.## Installation-Install the Composio CLI using the installation script:-```bashcurl -fsSL https://composio.dev/install | bash```Or using wget:+```bashwget -qO- https://composio.dev/install | bash```-## Authentication+## Getting started++Log in, initialize a project, and verify your setup:++```bash+# Authenticate with Composio+composio login++# Initialize a project in the current directory+composio init++# Verify your identity+composio whoami++# Check CLI version+composio version+```++## Command reference++| Command | Description |+| --- | --- |+| [`login`](#login) | Authenticate with your Composio account |+| [`logout`](#logout) | Remove stored authentication |+| [`whoami`](#whoami) | Display your account information |+| [`init`](#init) | Initialize a Composio project |+| [`toolkits`](#toolkits) | Discover and inspect toolkits |+| [`tools`](#tools) | Discover, inspect, and execute tools |+| [`connected-accounts`](#connected-accounts) | Manage connected accounts |+| [`auth-configs`](#auth-configs) | Manage auth configurations |+| [`triggers`](#triggers) | Inspect and subscribe to trigger events |+| [`logs`](#logs) | Inspect tool and trigger execution logs |+| [`generate`](#generate) | Generate type stubs (auto-detects language) |+| [`ts generate`](#ts-generate) | Generate TypeScript type stubs |+| [`py generate`](#py-generate) | Generate Python type stubs |+| [`upgrade`](#upgrade) | Upgrade CLI to the latest version |+| [`version`](#version) | Display the current CLI version |-Manage your Composio authentication directly from the terminal.+----### Login+## Authentication & setup-Authenticate with your Composio account:+### login++Authenticate with your Composio account.```bashcomposio login@@ -33,100 +70,668 @@ composio loginThis opens your browser to complete authentication and stores your API key locally.-To authenticate without opening a browser (useful for SSH/remote sessions):+| Flag | Description |+| --- | --- |+| `--no-browser` | Login without opening a browser (displays a URL to open manually) |+| `--api-key <key>` | API key for non-interactive login (CI/agents) |+| `--org-id <id>` | Organization ID (required with `--api-key`) |+| `--project-id <id>` | Project ID (required with `--api-key`) |```bash+# Remote/SSH sessionscomposio login --no-browser++# Non-interactive (CI/agents)+composio login --api-key "sk_..." --org-id "org_..." --project-id "proj_..."```-This displays a URL to manually open in your browser.+### logout++Remove stored authentication.++```bash+composio logout+```-### Check authentication status+### whoami-Verify your current authentication:+Display your account information and API key.```bashcomposio whoami```-This displays your current API key or indicates if you're not authenticated.+### init-### Logout+Initialize a Composio project in the current directory. Creates `.composio/project.json` with your org and project IDs.-Remove stored authentication:+```bash+composio init+```++| Flag | Description |+| --- | --- |+| `--org-id <id>` | Organization ID (skip interactive picker) |+| `--project-id <id>` | Project ID (skip interactive picker) |+| `-y`, `--yes` | Auto-select default org and project |+| `--no-browser` | Skip auto-opening the browser |```bash-composio logout+# Auto-select defaults+composio init --yes++# Specify org and project directly+composio init --org-id "org_..." --project-id "proj_..."+```++---++## Toolkits++Discover and inspect Composio toolkits.++### toolkits list++List available toolkits with connection status.++```bash+composio toolkits list+```++| Flag | Description |+| --- | --- |+| `--query <text>` | Search by name, slug, or description |+| `--connected` | Show only connected toolkits |+| `--user-id <id>` | User ID for connection status |+| `--limit <n>` | Results per page (default: 30) |++```bash+composio toolkits list --query "email" --connected+```++### toolkits info++View details of a specific toolkit.++```bash+composio toolkits info <slug>+```++| Flag | Description |+| --- | --- |+| `--user-id <id>` | User ID for connection status |+| `-a`, `--all` | Show all details including auth config fields |++```bash+composio toolkits info github --all+```++### toolkits search++Search toolkits by use case.++```bash+composio toolkits search <query>+```++| Flag | Description |+| --- | --- |+| `--limit <n>` | Results per page (default: 10) |++```bash+composio toolkits search "send emails"+```++### toolkits version++Show latest and recent versions for a toolkit.++```bash+composio toolkits version <slug>+```++```bash+composio toolkits version gmail+```++---++## Tools++Discover, inspect, and execute Composio tools.++### tools list++List available tools.++```bash+composio tools list --toolkits "gmail"+```++| Flag | Description |+| --- | --- |+| `--query <text>` | Search by name, slug, or description |+| `--toolkits <slugs>` | Filter by toolkit slugs (comma-separated) |+| `--tags <tags>` | Filter by tags |+| `--limit <n>` | Results per page (default: 30) |++```bash+composio tools list --toolkits "gmail,slack" --query "send"+```++### tools info++View details of a specific tool, including its input schema.++```bash+composio tools info <slug>+```++```bash+composio tools info GMAIL_SEND_EMAIL+```++### tools search++Semantically search tools by use case. Returns the most relevant tools plus recommended usage guidance.++```bash+composio tools search <query>+```++| Flag | Description |+| --- | --- |+| `--toolkits <slugs>` | Filter by toolkit slugs (comma-separated) |+| `--limit <n>` | Results per page (default: 10) |++```bash+composio tools search "onboard a new GitHub repo and notify Slack"+```++### tools execute++Execute a tool with JSON arguments.++```bash+composio tools execute <slug> --data '<json>'+```++| Flag | Description |+| --- | --- |+| `-d`, `--data <json>` | JSON arguments, `@file`, or `-` for stdin |+| `--user-id <id>` | User ID to execute as |++```bash+# Inline JSON+composio tools execute GITHUB_GET_REPOS -d '{"owner":"composio"}'++# From file+composio tools execute GMAIL_SEND_EMAIL -d @payload.json++# From stdin+echo '{"owner":"composio"}' | composio tools execute GITHUB_GET_REPOS+```++---++## Connected accounts++Manage authenticated connections to external services.++### connected-accounts list++List connected accounts.++```bash+composio connected-accounts list+```++| Flag | Description |+| --- | --- |+| `--toolkits <slugs>` | Filter by toolkit slugs (comma-separated) |+| `--user-id <id>` | Filter by user ID |+| `--status <status>` | Filter by status: `ACTIVE`, `FAILED`, `EXPIRED`, `INITIALIZING`, `INITIATED`, `INACTIVE` |+| `--limit <n>` | Results per page (default: 30) |++```bash+composio connected-accounts list --toolkits "gmail" --status ACTIVE+```++### connected-accounts info++View details of a specific connected account.++```bash+composio connected-accounts info <id>+```++```bash+composio connected-accounts info con_1a2b3c4d5e6f+```++### connected-accounts whoami++Show the external account profile for a connected account.++```bash+composio connected-accounts whoami <id>+```++```bash+composio connected-accounts whoami con_1a2b3c4d5e6f+```++### connected-accounts link++Link an external account via OAuth redirect.++```bash+composio connected-accounts link <toolkit>+```++| Flag | Description |+| --- | --- |+| `--auth-config <id>` | Auth config ID (uses legacy flow, mutually exclusive with `<toolkit>`) |+| `--user-id <id>` | User ID for the connection |+| `--no-browser` | Skip auto-opening the browser |++```bash+# Link using Tool Router (default)+composio connected-accounts link github++# Link with specific auth config+composio connected-accounts link --auth-config "ac_..." --user-id "alice"+```++### connected-accounts delete++Delete a connected account.++```bash+composio connected-accounts delete <id>+```++| Flag | Description |+| --- | --- |+| `-y`, `--yes` | Skip confirmation prompt |++---++## Auth configs++Manage auth configurations for toolkits.++### auth-configs list++List auth configs.++```bash+composio auth-configs list+```++| Flag | Description |+| --- | --- |+| `--toolkits <slugs>` | Filter by toolkit slugs (comma-separated) |+| `--query <text>` | Search by auth config name |+| `--limit <n>` | Results per page (default: 30) |++```bash+composio auth-configs list --toolkits "gmail"+```++### auth-configs info++View details of a specific auth config.++```bash+composio auth-configs info <id>+```++```bash+composio auth-configs info ac_1232323+```++### auth-configs create++Create a new auth config.++```bash+composio auth-configs create <name> --toolkit <toolkit>+```++| Flag | Description |+| --- | --- |+| `--toolkit <slug>` | Toolkit slug (required) |+| `--auth-scheme <scheme>` | Auth scheme: `OAUTH2`, `API_KEY`, `BEARER_TOKEN`, etc. |+| `--scopes <scopes>` | Comma-separated OAuth scopes |+| `--custom-credentials <json>` | Custom credentials JSON (for white-labeling) |++```bash+# Composio-managed defaults+composio auth-configs create "my-gmail-config" --toolkit "gmail"++# Custom OAuth with scopes+composio auth-configs create "custom-gmail" --toolkit "gmail" --auth-scheme "OAUTH2" --scopes "send_email,read_email"++# White-labeled with custom credentials+composio auth-configs create "custom-gmail" --toolkit "gmail" --auth-scheme "OAUTH2" \+ --custom-credentials '{"client_id":"...","client_secret":"..."}'+```++### auth-configs delete++Delete an auth config.++```bash+composio auth-configs delete <id>+```++| Flag | Description |+| --- | --- |+| `-y`, `--yes` | Skip confirmation prompt |++---++## Triggers++Subscribe to external events and manage trigger instances.++### triggers list++List available trigger types.++```bash+composio triggers list+```++| Flag | Description |+| --- | --- |+| `--toolkits <slugs>` | Filter by toolkit slugs (comma-separated) |+| `--limit <n>` | Max results (default: 30) |++```bash+composio triggers list --toolkits "gmail,slack"+```++### triggers info++View details of a specific trigger type.++```bash+composio triggers info <slug>+```++```bash+composio triggers info GMAIL_NEW_GMAIL_MESSAGE+```++### triggers create++Create a new trigger instance.++```bash+composio triggers create <trigger-name>+```++| Flag | Description |+| --- | --- |+| `--connected-account-id <id>` | Connected account ID |+| `--trigger-config <json>` | Trigger config as JSON |++```bash+composio triggers create GMAIL_NEW_GMAIL_MESSAGE --connected-account-id "con_123"++composio triggers create SLACK_NEW_MESSAGE --connected-account-id "con_456" \+ --trigger-config '{"channel":"#general"}'+```++### triggers status++Show active trigger instances with optional filters.++```bash+composio triggers status+```++| Flag | Description |+| --- | --- |+| `--user-ids <ids>` | Filter by user IDs (comma-separated) |+| `--connected-account-ids <ids>` | Filter by connected account IDs (comma-separated) |+| `--toolkits <slugs>` | Filter by toolkit slugs (comma-separated) |+| `--trigger-ids <ids>` | Filter by trigger instance IDs (comma-separated) |+| `--trigger-names <names>` | Filter by trigger names (comma-separated) |+| `--show-disabled` | Include disabled triggers |+| `--limit <n>` | Results per page (default: 30) |++```bash+composio triggers status --user-ids "alice,bob" --show-disabled+```++### triggers listen++Listen to realtime trigger events.++```bash+composio triggers listen+```++| Flag | Description |+| --- | --- |+| `--toolkits <slugs>` | Filter by toolkit slugs (comma-separated) |+| `--trigger-id <id>` | Filter by trigger ID |+| `--trigger-slug <slugs>` | Filter by trigger slug (comma-separated) |+| `--connected-account-id <id>` | Filter by connected account ID |+| `--user-id <id>` | Filter by user ID |+| `--json` | Show raw event payload as JSON |+| `--table` | Show compact table rows |+| `--max-events <n>` | Stop after N matching events |+| `--forward <url>` | Forward each event to a URL |+| `--out <file>` | Append each event to a file |++```bash+# Stream Gmail events as a table+composio triggers listen --toolkits gmail --table++# Forward events to a local server+composio triggers listen --forward "http://localhost:8080/webhook"++# Capture events to a file+composio triggers listen --trigger-slug GMAIL_NEW_GMAIL_MESSAGE --out events.jsonl --max-events 10+```++### triggers enable++Enable a trigger instance.++```bash+composio triggers enable <id>+```++### triggers disable++Disable a trigger instance.++```bash+composio triggers disable <id>+```++### triggers delete++Delete a trigger instance.++```bash+composio triggers delete <id>+```++| Flag | Description |+| --- | --- |+| `-y`, `--yes` | Skip confirmation prompt |++---++## Logs++Inspect tool and trigger execution logs.++### logs tools++List tool execution logs.++```bash+composio logs tools+```++Pass a log ID to fetch a specific log:++```bash+composio logs tools <log_id>+```++| Flag | Description |+| --- | --- |+| `--toolkit <slugs>` | Filter by toolkit (comma-separated) |+| `--tool <slugs>` | Filter by tool (comma-separated) |+| `--user-id <ids>` | Filter by user ID (comma-separated) |+| `--connected-account-id <ids>` | Filter by connected account ID (comma-separated) |+| `--auth-config-id <ids>` | Filter by auth config ID (comma-separated) |+| `--status <values>` | Filter by execution status (comma-separated) |+| `--from <ms>` | Start timestamp (epoch milliseconds) |+| `--to <ms>` | End timestamp (epoch milliseconds) |+| `--limit <n>` | Number of logs (default: 30) |+| `--cursor <cursor>` | Cursor for pagination |++```bash+composio logs tools --toolkit gmail --status success --limit 50+```++### logs triggers++List trigger logs.++```bash+composio logs triggers+```++Pass a log ID to fetch a specific log:++```bash+composio logs triggers <log_id>+```++| Flag | Description |+| --- | --- |+| `--trigger <name>` | Filter by trigger name |+| `--trigger-id <id>` | Filter by trigger ID |+| `--user-id <id>` | Filter by user ID |+| `--connected-account-id <id>` | Filter by connected account ID |+| `--from <ms>` | Start timestamp (epoch milliseconds) |+| `--to <ms>` | End timestamp (epoch milliseconds) |+| `--time <window>` | Relative time window: `5m`, `30m`, `6h`, `1d`, `1w`, `1month`, `1y` |+| `--search <query>` | Full-text search |+| `--include-payload` | Include payload fields |+| `--limit <n>` | Number of logs (default: 30) |+| `--cursor <cursor>` | Cursor for pagination |++```bash+composio logs triggers --trigger GMAIL_NEW_GMAIL_MESSAGE --time 1d```-## 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.+## Type generation-### Auto-detect and generate+Generate type-safe definitions for toolkits, tools, and triggers. These types provide autocomplete and type safety when using direct tool execution (`composio.tools.execute()`).-The CLI auto-detects your project language.-In your project directory:+### generate++Auto-detect project language and generate types.```bashcomposio generate```-For TypeScript projects only, include individual tool types:+| Flag | Description |+| --- | --- |+| `-o`, `--output-dir <dir>` | Output directory |+| `--type-tools` | Generate typed schemas for each tool (TypeScript only, slower) |+| `--toolkits <names>` | Only generate for specific toolkits (repeatable) |+```bash-composio generate --type-tools+composio generate --toolkits gmail --toolkits slack```-The CLI automatically:-- Detects your project type (Python or TypeScript)-- Generates appropriate type definitions+### ts generate-### Specify output directory+Generate TypeScript type stubs.```bash-composio generate --output-dir ./my-types+composio ts generate```-### Language-specific commands+| Flag | Description |+| --- | --- |+| `-o`, `--output-dir <dir>` | Output directory |+| `--compact` | Emit a single TypeScript file |+| `--transpiled` | Emit transpiled JavaScript alongside TypeScript |+| `--type-tools` | Generate typed schemas for each tool (slower) |+| `--toolkits <names>` | Only generate for specific toolkits (repeatable) |-For explicit control, use language-specific commands:+```bash+composio ts generate --compact --type-tools+```++### py generate-<Tabs items={['TypeScript', 'Python']}>- <Tab value="TypeScript">- Basic generation:- ```bash- composio ts generate- ```+Generate Python type stubs.- Generate as single file:- ```bash- composio ts generate --compact- ```+```bash+composio py generate+```++| Flag | Description |+| --- | --- |+| `-o`, `--output-dir <dir>` | Output directory |+| `--toolkits <names>` | Only generate for specific toolkits (repeatable) |++```bash+composio py generate --output-dir ./my_types+```++---++## Maintenance++### upgrade++Upgrade the CLI to the latest version.++```bash+composio upgrade+```++### version++Display the current CLI version.++```bash+composio version+```++---- Include individual tool types:- ```bash- composio ts generate --type-tools- ```+## Global options- Generate both .ts and .js files:- ```bash- composio ts generate --transpiled- ```+| Flag | Description |+| --- | --- |+| `--log-level <level>` | Set log level: `silent`, `error`, `warn`, `info`, `debug` |- Custom output directory:- ```bash- composio ts generate --output-dir ./my-types- ```- </Tab>- <Tab value="Python">- Basic generation:- ```bash- composio py generate- ```+## Environment variables- Custom output directory:- ```bash- composio py generate --output-dir ./my_types- ```- </Tab>-</Tabs>+| Variable | Description |+| --- | --- |+| `COMPOSIO_API_KEY` | Your Composio API key (required for most commands) |+| `COMPOSIO_BASE_URL` | Custom API base URL |+| `COMPOSIO_LOG_LEVEL` | Logging level: `silent`, `error`, `warn`, `info`, `debug` |+| `COMPOSIO_DISABLE_TELEMETRY` | Set to `"true"` to disable telemetry |+| `COMPOSIO_TOOLKIT_VERSION_<TOOLKIT>` | Override toolkit version (e.g., `COMPOSIO_TOOLKIT_VERSION_GMAIL=20250901_00`) |+| `COMPOSIO_WEBHOOK_SECRET` | Signing secret for trigger webhook forwarding |diff --git a/docs/content/docs/index.mdx b/docs/content/docs/index.mdxindex 9a39be853..51edeb62e 100644--- a/docs/content/docs/index.mdx+++ b/docs/content/docs/index.mdx@@ -87,7 +87,7 @@ Composio works with any AI framework. Pick your preferred SDK:icon={<Terminal />}title="CLI"href="/docs/cli"- description="Generate types and manage your workspace"+ description="Manage toolkits, execute tools, and generate type-safe code from the terminal"/><Cardicon={<Palette />}diff --git a/docs/content/docs/meta.json b/docs/content/docs/meta.jsonindex 4f5c14a71..d38554654 100644--- a/docs/content/docs/meta.json+++ b/docs/content/docs/meta.json@@ -4,6 +4,7 @@"index","quickstart","providers",+ "cli","---Core Concepts---","how-composio-works","users-and-sessions",@@ -23,7 +24,6 @@"webhook-verification","subscribing-to-connection-expiry-events","---Features---",- "cli","projects","single-toolkit-mcp","---Direct Tool Execution Guides---",diff --git a/docs/lib/source.ts b/docs/lib/source.tsindex 4fd2b8816..9d02015c1 100644--- a/docs/lib/source.ts+++ b/docs/lib/source.ts@@ -247,7 +247,10 @@ export function mdxToCleanMarkdown(content: string): string {'**Skills:**\n' +'```bash\nnpx skills add composiohq/skills\n```\n' +'[Skills.sh](https://skills.sh/composiohq/skills/composio) · [GitHub](https://github.com/composiohq/skills)\n\n' +- '**Context files:**\n' ++ '**CLI:**\n' ++ '```bash\ncurl -fsSL https://composio.dev/install | bash\n```\n' ++ '[CLI Reference](/docs/cli)\n\n' ++ '**Context:**\n' +'- [llms.txt](/llms.txt) — Documentation index with links\n' +'- [llms-full.txt](/llms-full.txt) — Complete documentation in one file');