Coddy Agent
Open-source ReAct AI coding agent in Go with TUI. Works with Cursor, Zed via ACP. Supports any OpenAI-compatible providers. Can use SKILLS and MCP servers.
Ask AI about Coddy Agent
Powered by Claude · Grounded in docs
I know everything about Coddy Agent. Ask me about installation, configuration, usage, or troubleshooting.
0/500
Reviews
Documentation
Coddy Agent
Coddy is a distroless-friendly harness for running an Agent Client Protocol (ACP)
agent over stdio. It ships as a single static-friendly Go binary, so you can drop it into
minimal container images (scratch, distroless, read-only workspaces) without a full OS shell
inside the image. The bundled default is a ReAct loop with filesystem, shell (when exposed), todo,
and MCP tools, which makes Coddy behave as a coding agent inside Cursor, Zed, or any other ACP client.
The harness layer (ACP RPC, sessions, prompts, providers) stays the same if you tighten the toolset or
drive it from automation instead of an IDE.
Features
- Harness-first - ACP server, session lifecycle, prompts, LLM backends, MCP merge, distroless-ready binary
- ReAct loop - LLM alternates between reasoning, acting (tool calls), and observing results (coding-agent persona out of the box)
- Two operating modes -
agent(full tool access) andplan(planning + text files only) - Cursor rules support - reads
.cursor/rules/and skills just like Cursor IDE - MCP server integration - connect any MCP server for additional tools
- Multi-provider LLM - OpenAI, Anthropic, Ollama, any OpenAI-compatible API
- ACP protocol - works with Cursor, Zed, and other ACP-compatible editors
Quick Start
Installation
go install github.com/EvilFreelancer/coddy-agent/cmd/coddy@latest
Or build and install manually from source:
git clone https://github.com/EvilFreelancer/coddy-agent
cd coddy-agent
make install
make install builds the binary and copies it to the appropriate location:
- root -
/usr/local/bin/coddy - regular user -
~/.local/bin/coddy
To only build without installing:
make build
# or manually:
go build -ldflags "-X github.com/EvilFreelancer/coddy-agent/internal/version.Version=$(make -s print-version)" -o coddy ./cmd/coddy/
Long-term memory copilot lives in external/memory/ and is always linked into build/coddy. Turn it on or off at runtime with memory.enabled in config.yaml (see external/memory/README.md).
Optional OpenAI HTTP API lives in external/httpserver/ and is linked only when you build with -tags http (for example make build TAGS=http). It adds the coddy http subcommand (-H / --host, -P / --port, same session and log flags as coddy acp). GET /v1/models exposes session modes agent and plan; pass a models[].model id in model when you call chat if you pin an LLM. OpenAPI is generated at runtime under /openapi.yaml and Swagger UI under /docs. See docs/http-api.md.
Optional cron scheduler lives under external/scheduler/ (package scheduler, daemon and Start at the external/scheduler import path). Job parsing and cron live in lib/ (also package scheduler, path scheduler/lib). coddy_scheduler_* agent tools live in tools/ (package schedtools). Split layouts avoid an import cycle with internal/agent and internal/tools. Linked only with -tags scheduler (combine with http when you need both). Enable scheduler.enabled in config or coddy acp -scheduler-enabled / coddy http -scheduler-enabled (sets the same YAML field for this process). Jobs are markdown files under ~/.coddy/scheduler with UTC crontab metadata in YAML frontmatter.
After make build the binary is build/coddy. If another coddy is already on your PATH, a plain coddy acp runs that older install. Use ./build/coddy acp, run make install, or compare with which coddy and coddy -v.
The agent speaks ACP over stdio. Editors launch coddy for you once it is configured. coddy -v or coddy --version prints the embedded build version (dev if not set at link time - see -ldflags in the build command above). Flags for ACP itself live on the subcommand, for example coddy acp --help for --log-level, --log-output, --log-file, --log-format, --home, --cwd, and --config.
Paths (CODDY_HOME, CODDY_CWD)
CODDY_HOME(orcoddy acp --home) is the agent state directory. Default~/.coddy. The process createssessions/andskills/under it. Config defaults to$CODDY_HOME/config.yaml.CODDY_CWD(orcoddy acp --cwd) is the default session working directory whensession/newsends an emptycwd. Default is the process current directory at startup. Editors that pass a path insession/newuse that path instead.
Configuration
Copy the example config and edit it (either layout works):
mkdir -p ~/.coddy && cp config.example.yaml ~/.coddy/config.yaml
# legacy location still searched if ~/.coddy/config.yaml is missing
mkdir -p ~/.config/coddy-agent
cp config.example.yaml ~/.config/coddy-agent/config.yaml
Set your API keys:
export OPENAI_API_KEY="sk-..."
# or
export ANTHROPIC_API_KEY="sk-ant-..."
Operating Modes
Agent Mode (default)
Full task execution mode. The agent has access to all tools:
- Read and write files
- Execute shell commands (with permission prompt)
- Search codebase
- Call MCP server tools
Best for: code generation, refactoring, debugging, feature implementation.
Plan Mode
Planning and documentation mode. Restricted tools:
- Read files (no write to code files)
- Write/edit text and markdown files
- Search codebase
When the plan is ready, switch to agent mode yourself for full tools and implementation.
Best for: architecture planning, writing specs, design documents, code review.
Use your editor session mode selector (or session/set_config_option).
Cursor Rules and Skills
By default the agent reads skill files and rules from (see skills in docs/config.md):
$CODDY_HOME/skills/(installed skills)${CWD}/.skills/(session working directory)~/.cursor/skills/~/.claude/skills/
Rules support the standard Cursor frontmatter format:
---
description: "Go coding standards"
globs: ["**/*.go"]
alwaysApply: false
---
Write all comments in English.
Use fmt.Errorf("context: %w", err) for error wrapping.
See Skills Guide for details.
MCP Server Integration
Connect external tools via MCP servers. Configured globally in config.yaml or
passed per-session by the ACP client.
Example adding a GitHub MCP server in config:
mcp_servers:
- name: "github"
command: "npx"
args: ["-y", "@modelcontextprotocol/server-github"]
env:
- name: "GITHUB_PERSONAL_ACCESS_TOKEN"
value: "${GITHUB_TOKEN}"
See MCP Integration Guide for details.
Configuration
Full configuration reference in docs/config.md.
Key settings:
providers:
- name: local
type: openai
api_key: "${OPENAI_API_KEY}"
api_base: "${OPENAI_API_BASE}"
models:
- model: "local/gpt-4o"
max_tokens: 8192
temperature: 0.2
agent:
model: "local/gpt-4o"
max_turns: 30
tools:
require_permission_for_commands: true
Architecture
ACP Client (Cursor/Zed)
|
JSON-RPC 2.0 over stdio
|
ACP Server Layer
|
Session Manager
|
ReAct Agent Loop
/ | | \
LLM Tools Skills MCP
See Architecture docs for full details.
Documentation
- Architecture - system design and component overview
- ACP Protocol - protocol reference and message formats
- ReAct Agent - ReAct loop design and tool specifications
- Configuration - full config file reference
- Skills & Rules - cursor rules and skills guide
- MCP Integration - MCP server integration guide
Examples (ACP over stdio)
examples/acp-jsonrpc-session/acp_agent_todo_e2e_demo.py is a newline-delimited JSON-RPC harness against coddy acp ( stdbuf -oL, permission auto-reply, nil-result responses). Use it as reference when building your own minimal client rather than chaining naive echo lines into a pipe.
examples/acp_memory_copilot_e2e_demo.py drives build/coddy from make build, an isolated CODDY_HOME, and RPA_API_KEY to verify recall, persist, and optional prune of markdown under $CODDY_HOME/memory. See the script docstring for flags.
Persistent sessions
By default, coddy acp stores each session bundle under $CODDY_HOME/sessions/<sessionId>/ (default ~/.coddy/sessions/) with session.json, messages.json, an assets/ directory, and todos/active.md (plus todos/archive/ when completed lists are replaced). Override the root with coddy acp --sessions-dir or sessions.dir in config.yaml. If the sessions directory cannot be created, startup fails with an error.
Use coddy acp --disable-session to avoid writing any bundle (in-memory only, e.g. cron or one-shot). The agent does not advertise session/load or session/list in that mode.
coddy sessions listprints stored sessions (--sessions-dirand--cwdfilters supported).coddy acp --session-id <id>makes the nextsession/neweither reopen snapshots for that folder (if present) or create a fresh bundle whose directory name matches that id.session/loadrestores history and notifies the client;session/listlists bundles for ACP-aware clients.
The coddy todo tools keep the active checklist mirrored to todos/active.md. A wholesale coddy_todo_plan_replace while items are incomplete is rejected until you finish rows or run coddy_todo_plan_archive; replacing when every row is completed moves the prior active.md into todos/archive/ (todo-<nanos>.md). coddy_todo_plan_archive finishes open rows to completed, writes todos/archive/plan_<unix_seconds>.md, then clears the session plan when persistence is on.
When the persisted plan is non-empty, the agent injects ### Current todo checklist plus rendered markdown checklist lines into the system prompt template (embedded defaults, or files under prompts.dir using prompts.agent_prompt and prompts.plan_prompt, which default to agent.md and plan.md) via {{if .TodoList}} … {{end}}. That block is omitted when there is nothing to track. Before each LLM call inside one session/prompt turn, Coddy refreshes that system message so a todo list created or updated earlier in the same ReAct episode stays visible immediately.
Development
# Run tests
go test ./...
make test
# Build binary (with git version embedded)
make build
coddy -v # same as --version
# Run with debug logging (ACP mode); optional --log-output, --log-file, --log-format
coddy acp --log-level debug
# Single-line sanity check only (responses may omit JSON-RPC "result" for nil payloads; prefer examples/acp-jsonrpc-session/acp_agent_todo_e2e_demo.py)
echo '{"jsonrpc":"2.0","id":0,"method":"initialize","params":{"protocolVersion":1,"clientCapabilities":{}}}' | coddy acp
License
MIT
