mirror of
https://github.com/ComposioHQ/composio.git
synced 2026-09-22 11:46:35 +08:00
Alberto Schiabel
230f81a737
This PR: - rebases onto `next` now that https://github.com/ComposioHQ/composio/pull/4358 and https://github.com/ComposioHQ/composio/pull/4359 are merged - rewrites every `@effect/platform` and `@effect/platform-bun` barrel import under `ts/packages/cli` (155 statements in 112 files) as a per-module namespace import, e.g. `import * as FileSystem from '@effect/platform/FileSystem'` - adds both barrels to the `no-restricted-imports` lists for `ts/packages/cli/src`, with messages pointing at the subpath form - updates the boundary guidance in `ts/packages/cli/AGENTS.md` and the `cli-command` skill to the subpath form ## Context Both barrels are pure namespace re-exports (60 and 19 modules), so this is import-only with no runtime change. Effect v4 spreads these modules across `effect` (`FileSystem`, `Path`, `PlatformError`), `effect/unstable/http`, and `effect/unstable/process`; with per-module imports the port becomes a scripted path rewrite instead of hand-splitting each barrel line. Third of three preparation PRs. ## Validation - `pnpm --filter @composio/cli typecheck` and oxlint clean; a probe barrel import in `src/` is rejected by the new rule - `pnpm --filter @composio/cli test`: 127 files, 1318 tests pass, 1 skipped
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.