Skip to content

Composio powers 1000+ toolkits, tool search, context management, authentication, and a sandboxed workbench to help you build AI agents that turn intent into action.

chore: add Effect-TS/effect submodule and update agent docs

jkomyno78309e8d256e
diff --git a/.github/workflows/claude.yml b/.github/workflows/claude.yml
index cc248396a..5982be748 100644
--- a/.github/workflows/claude.yml
+++ b/.github/workflows/claude.yml
@@ -28,6 +28,7 @@ jobs:
uses: actions/checkout@v6
with:
fetch-depth: 1
+ submodules: true
- name: Run Claude Code
id: claude
diff --git a/.gitmodules b/.gitmodules
new file mode 100644
index 000000000..c3be0f027
--- /dev/null
+++ b/.gitmodules
@@ -0,0 +1,4 @@
+[submodule "ts/vendor/effect"]
+ path = ts/vendor/effect
+ url = [email protected]:Effect-TS/effect.git
+ branch = main
diff --git a/CLAUDE.md b/CLAUDE.md
index 9d7537dd4..099779d51 100644
--- a/CLAUDE.md
+++ b/CLAUDE.md
@@ -10,6 +10,21 @@ This is the Composio SDK v3 repository containing both TypeScript and Python SDK
- For documentation tasks, refer to `fern/CLAUDE.md`
+## Effect.ts Reference Source
+
+The CLI package (`@composio/cli`) is built on the Effect.ts ecosystem. A local copy of the Effect source code is available as a git submodule:
+
+- **Location:** `ts/vendor/effect/`
+- **Repo:** [Effect-TS/effect](https://github.com/Effect-TS/effect)
+- **Branch:** `main`
+
+When working on CLI code, reference the Effect source for accurate patterns:
+- `ts/vendor/effect/packages/effect/src/` — core Effect runtime
+- `ts/vendor/effect/packages/cli/src/` — @effect/cli (Command, Options, Args)
+- `ts/vendor/effect/packages/platform/src/` — @effect/platform (FileSystem, Terminal)
+
+**Important:** The submodule is for **read-only reference only**. Do not modify files in `ts/vendor/`. The CLI's actual dependencies come from npm via `pnpm install`.
+
## Common Development Commands
### Build and Development
diff --git a/ts/packages/cli/.cursor/rules/effect-source-reference.mdc b/ts/packages/cli/.cursor/rules/effect-source-reference.mdc
new file mode 100644
index 000000000..69b180709
--- /dev/null
+++ b/ts/packages/cli/.cursor/rules/effect-source-reference.mdc
@@ -0,0 +1,21 @@
+---
+description: Reference Effect source code for accurate patterns
+globs:
+ - "src/**/*.ts"
+alwaysApply: true
+---
+
+# Effect Source Code Reference
+
+A local copy of the Effect source is available at `ts/vendor/effect/`.
+
+When writing or modifying CLI code that uses Effect APIs, consult:
+- `ts/vendor/effect/packages/cli/src/` for @effect/cli patterns (Command, Options, Args)
+- `ts/vendor/effect/packages/effect/src/` for core Effect patterns (Effect.gen, Layer, Service)
+- `ts/vendor/effect/packages/platform/src/` for @effect/platform patterns (FileSystem, Terminal)
+
+Key patterns used in this CLI:
+- Commands defined with `Command.make().pipe(Command.withHandler(...))`
+- Options defined with `Options.text()`, `Options.boolean()`, etc.
+- Services as `Effect.Service<T>()` classes with Layer composition
+- Error handling with tagged errors and `Effect.gen(function* () { ... })`
diff --git a/ts/vendor/effect b/ts/vendor/effect
new file mode 160000
index 000000000..4f2107548
--- /dev/null
+++ b/ts/vendor/effect
@@ -0,0 +1 @@
+Subproject commit 4f2107548fa64c21a8643b7b0efcd556cd16d4b9