Clanka is an Effect-native TypeScript library that lets you build AI coding agents that execute JavaScript in a sandboxed environment. Agents can read and write files, run shell commands, search your codebase semantically, and spawn sub-agents — all expressed as composable Effect layers.Documentation Index
Fetch the complete documentation index at: https://mintlify.com/Effectful-Tech/clanka/llms.txt
Use this file to discover all available pages before exploring further.
Quickstart
Get a working agent running in under five minutes with OpenAI Codex or GitHub Copilot.
Installation
Install Clanka and configure peer dependencies for your project.
Core concepts
Understand how Agent, AgentExecutor, and Tools compose to form a complete agent.
API reference
Full type signatures for every public export in the Clanka SDK.
What Clanka does
Clanka gives an LLM a singleexecute tool it uses to run JavaScript snippets. Those snippets call built-in functions — readFile, writeFile, applyPatch, bash, glob, rg, webSearch, and more — that the agent uses to accomplish engineering tasks autonomously.
Agent tools
Built-in tools for file I/O, shell commands, web search, and task management.
Semantic search
Index your codebase with embeddings for fast, context-aware code search.
Provider setup
Connect to OpenAI Codex or GitHub Copilot with a few lines of configuration.
Custom tools
Extend the agent with your own Effect-based tools and handlers.
How it works
Install Clanka and peer dependencies
Add
clanka and the required Effect peer packages to your project.Choose a provider
Configure OpenAI Codex (
Codex.layerClient) or GitHub Copilot (Copilot.layerClient) as your language model provider.Clanka is built entirely on Effect and requires familiarity with Effect’s layer and service model. If you are new to Effect, check out the Effect documentation first.