mirror of
https://github.com/ComposioHQ/composio.git
synced 2026-09-22 11:46:35 +08:00
Kshitij Jhunjhunwala
f5aaa0b3d6
**Stacked on #3927** (A1 — direct-to-PostHog + install→Apollo identity). Targets that branch; will auto-retarget to `next` when #3927 merges. Review only this diff. ## What Makes every CLI event self-describe its funnel stage, so the adoption funnel can be queried without string-matching event names — which is how it silently broke in the first place. - **`journey_stage`** on every event: `install | setup | login | connect | execute | other`. Declared as an exported typed const plus a single exhaustive map, `as const satisfies Record<CliAnalyticsEventName, CliJourneyStage>` — so **the compiler refuses to build if a future event has no stage**. No per-event literals; stamped in one shared builder. - **`cli_channel`** alongside `cli_version`, reusing the existing `inferSkillReleaseChannel()` / `CLI_RELEASE_CHANNELS`. Makes "did this fix reach stable users?" answerable — the question that went unanswered in the 0.2.30 assetless-release incident. - **Installer origin fix:** `install.sh` ran `"$exe" install` *without* `COMPOSIO_CLI_INVOCATION_ORIGIN=installer` (the `setup` call on line 410 had it), so a genuine install was indistinguishable from a user running `composio install` by hand. Now tagged, with a regression test that reads `install.sh` and asserts it. ## Stage mapping (reviewed against 30d volume) `install` = `CLI_INSTALL_*` · `setup` = `CLI_SETUP_*` + `CLI_PLUGIN_*` · `login` = `CLI_LOGIN_*` · `connect` = `CLI_LINK_*` · `execute` = `CLI_EXECUTE_*` + `CLI_TOOL_INVOCATION_*` · `other` = `CLI_COMMAND_*`, `CLI_SEARCH_*`, `CLI_PROXY_*`, `CLI_RUN_*`, `CLI_LOGOUT_*` Judgment calls, made with data rather than by default: - **`proxy` → `other`.** 2,060 of 2,140 proxy users (96%) already execute; only 80 are proxy-only. Reclassifying would move the activated cohort ~1%, so `execute` stays precisely "tool execution". - **`run` → `other`.** `run` children emit their own execute events carrying `parent_run_id`; staging the parent as `execute` would double-count. - **`search` → `other`.** Not a required funnel stage. Candidate for a "discovery" step later if the flow page wants one. ## Note for whoever builds the flow page `CLI_TOOL_INVOCATION_*` and `CLI_EXECUTE_FAILED` can both fire for a single failure, so the `execute` stage **double-counts at the event level**. Count **distinct users per stage**, not events. ## Known coverage limit npm and Homebrew installs don't run `install.sh`, so they emit no `CLI_INSTALL_*`. The `install` stage means "installed via install.sh", not all installs. ## Verification `pnpm typecheck` clean · `validate:boundaries` OK (46 disables, **zero added**) · CLI suite **107 files / 971 passed** (+15 tests) · `dispatch.ts` identity/transport untouched. 🤖 Generated with [Claude Code](https://claude.com/claude-code)
Composio TypeScript workspace
This directory contains the TypeScript half of the Composio SDK monorepo: the core SDK, provider adapters, the CLI, examples, and end-to-end tests. For an overview of Composio itself, start at the root README and docs.composio.dev.
If you just want to use the SDK:
npm install @composio/core
import { Composio } from '@composio/core';
const composio = new Composio({ apiKey: process.env.COMPOSIO_API_KEY });
const session = await composio.create('user_123');
const tools = await session.tools();
See the @composio/core README and the quickstart for the full flow, including provider setup for your agent framework.
Packages
Published packages:
| Package | Description |
|---|---|
@composio/core |
The Composio SDK. Ships its TypeScript source and SDK docs so installed copies are inspectable by coding agents. |
@composio/slim |
Same API as @composio/core without the packaged source and docs; smaller install. |
composio CLI |
Standalone CLI binary: search, execute, and script tools from your shell. |
@composio/* providers |
Adapters that format Composio tools for agent frameworks (OpenAI, Anthropic, Vercel AI SDK, LangChain, and more). See the provider table. |
@composio/experimental |
Experimental integrations, currently the Pi provider. |
@composio/json-schema-to-zod |
JSON Schema to Zod conversion. |
Internal (unpublished) packages: cli-keyring and cli-local-tools support the CLI; ts-builders generates TypeScript source.
Layout
ts/
packages/ Published and internal packages (see above)
examples/ Runnable examples per feature and framework
e2e-tests/ Runtime E2E tests (Node, Deno, Cloudflare Workers, CLI)
docs/ Workspace SDK docs: API notes and internal guides
scripts/ Build, validation, and scaffolding scripts
vendor/ Read-only reference submodules; do not edit
Development
Commands run from the repository root. Install the pinned toolchain first:
mise install
pnpm install
Build and verify:
pnpm build:packages # build all TS packages
pnpm typecheck # typecheck all TS packages
pnpm lint:packages # oxlint over ts/packages
pnpm test # package unit tests plus example validation
Runtime E2E suites (require credentials):
pnpm test:e2e:node
pnpm test:e2e:deno
pnpm test:e2e:cloudflare
pnpm test:e2e:cli
Scaffolding:
pnpm create:provider <name> [--agentic] # new provider package
pnpm create:example <name> # new example under ts/examples
Changesets are required for changes to published packages; see the contribution guidelines.