From effect-lookup
Quick lookup for Effect TypeScript library APIs, patterns, and source code. Use when you need to find Effect functions, understand Effect patterns, or look up implementation details.
npx claudepluginhub guillempuche/ai-skill-effect-lookup --plugin effect-lookupThis skill uses the workspace's default tool permissions.
Quick reference for finding and understanding Effect TypeScript library APIs from local source code.
Guides Next.js Cache Components and Partial Prerendering (PPR) with cacheComponents enabled. Implements 'use cache', cacheLife(), cacheTag(), revalidateTag(), static/dynamic optimization, and cache debugging.
Guides building MCP servers enabling LLMs to interact with external services via tools. Covers best practices, TypeScript/Node (MCP SDK), Python (FastMCP).
Generates original PNG/PDF visual art via design philosophy manifestos for posters, graphics, and static designs on user request.
Quick reference for finding and understanding Effect TypeScript library APIs from local source code.
Source code is available locally and on GitHub. Check local first, fall back to GitHub if not available.
| Repo | Local path | GitHub |
|---|---|---|
| Effect | opensrc/repos/github.com/effect-ts/effect/ | https://github.com/effect-ts/effect |
| EffectPatterns | opensrc/repos/github.com/PaulJPhilp/EffectPatterns/ | https://github.com/PaulJPhilp/EffectPatterns |
Use this skill when:
The effect-docs MCP server provides indexed documentation:
mcp__effect-docs__effect_docs_search: Search for Effect concepts
mcp__effect-docs__get_effect_doc: Get specific documentation by ID
For implementation details, search the local source at opensrc/repos/github.com/effect-ts/effect/:
# Find a specific function
grep -r "export const myFunction" opensrc/repos/github.com/effect-ts/effect/packages/effect/src/
# Find usage patterns
grep -rn "Effect.gen" opensrc/repos/github.com/effect-ts/effect/packages/effect/src/
# Find type definitions
grep -rn "interface MyType" opensrc/repos/github.com/effect-ts/effect/packages/effect/src/
Core modules are at: opensrc/repos/github.com/effect-ts/effect/packages/effect/src/<Module>.ts
Example: To understand Effect.map, read opensrc/repos/github.com/effect-ts/effect/packages/effect/src/Effect.ts
| Task | Reference |
|---|---|
| Module categories | references/modules.md |
| Common patterns | references/patterns.md |
opensrc/repos/github.com/effect-ts/effect/
├── packages/
│ ├── effect/ # Core Effect library
│ │ └── src/ # Source files (Effect.ts, Layer.ts, etc.)
│ ├── platform/ # Cross-platform utilities (HTTP, FileSystem)
│ ├── platform-node/ # Node.js platform implementation
│ ├── platform-browser/ # Browser platform implementation
│ ├── cli/ # CLI building utilities
│ ├── sql/ # SQL database utilities
│ ├── sql-pg/ # PostgreSQL implementation
│ ├── sql-kysely/ # Kysely integration
│ ├── rpc/ # Remote procedure calls
│ ├── cluster/ # Distributed computing
│ ├── opentelemetry/ # OpenTelemetry integration
│ ├── experimental/ # Experimental features
│ └── ai/ # AI integrations (OpenAI, Anthropic, etc.)
| Module | File | Purpose |
|---|---|---|
| Effect | Effect.ts | Core effect type and combinators |
| Layer | Layer.ts | Dependency injection layers |
| Context | Context.ts | Type-safe service context |
| Scope | Scope.ts | Resource management |
| Runtime | Runtime.ts | Effect execution |
| Module | File | Purpose |
|---|---|---|
| Option | Option.ts | Optional values |
| Either | Either.ts | Success/failure values |
| Chunk | Chunk.ts | Immutable arrays |
| HashMap | HashMap.ts | Immutable hash maps |
| HashSet | HashSet.ts | Immutable hash sets |
| List | List.ts | Immutable linked lists |
| Module | File | Purpose |
|---|---|---|
| Fiber | Fiber.ts | Lightweight threads |
| Queue | Queue.ts | Concurrent queues |
| Ref | Ref.ts | Mutable references |
| Semaphore | Semaphore.ts | Concurrency limiting |
| PubSub | PubSub.ts | Publish/subscribe |
| Module | File | Purpose |
|---|---|---|
| Schema | Schema.ts | Data validation & encoding |
| ParseResult | ParseResult.ts | Parsing results |
| Arbitrary | Arbitrary.ts | Property-based testing |
| Module | File | Purpose |
|---|---|---|
| Stream | Stream.ts | Effectful streams |
| Sink | Sink.ts | Stream consumers |
| Channel | Channel.ts | Bidirectional streaming |
| Module | File | Purpose |
|---|---|---|
| Schedule | Schedule.ts | Retry/repeat schedules |
| Duration | Duration.ts | Time durations |
| DateTime | DateTime.ts | Date/time handling |
| Clock | Clock.ts | Time service |
| Cron | Cron.ts | Cron expressions |
| Module | File | Purpose |
|---|---|---|
| Config | Config.ts | Type-safe configuration |
| ConfigProvider | ConfigProvider.ts | Configuration sources |
# In Effect.ts, functions are well-documented with JSDoc
grep -A 20 "export const map" opensrc/repos/github.com/effect-ts/effect/packages/effect/src/Effect.ts
# Look for interface or type alias
grep -n "interface Effect<" opensrc/repos/github.com/effect-ts/effect/packages/effect/src/Effect.ts
# Tests often have practical examples
grep -rn "Effect.gen" opensrc/repos/github.com/effect-ts/effect/packages/effect/test/
# HTTP client/server
ls opensrc/repos/github.com/effect-ts/effect/packages/platform/src/Http*.ts
# FileSystem
cat opensrc/repos/github.com/effect-ts/effect/packages/platform/src/FileSystem.ts
Community-driven patterns and architectural guides at opensrc/repos/github.com/PaulJPhilp/EffectPatterns/.
# Browse pattern categories
ls opensrc/repos/github.com/PaulJPhilp/EffectPatterns/content/
# Search for a specific pattern
grep -rn "Layer" opensrc/repos/github.com/PaulJPhilp/EffectPatterns/content/
# Read docs
ls opensrc/repos/github.com/PaulJPhilp/EffectPatterns/docs/
Covers: getting started, core concepts, error management, resource management, concurrency, streams, scheduling, domain modeling, schema, platform, HTTP APIs, data pipelines, testing, and observability.
effect_docs_search for conceptual questions@effect/platform