README
¶
Kodelet
Kodelet is a lightweight agentic SWE Agent. It runs as an interactive CLI tool in your terminal. It is capable of peforming software engineering and production operating tasks.
Key Features
- Intelligent Engineering Assistant: Automates software engineering tasks and production operations with agentic capabilities.
- Interactive Architecture Design: Collaboratively design and refine system architectures through natural dialogue.
- Continuous Code Intelligence: Analyzes, understands, and improves your codebase while answering technical questions in context.
- Reusable Fragments/Receipts: Create template-based prompts with variable substitution and bash command execution for routine tasks.
- Vision Capabilities: Support for image inputs including screenshots, diagrams, and mockups (Anthropic Claude models).
Installation
Via Homebrew (macOS/Linux)
brew tap jingkaihe/kodelet
brew install kodelet
Via Install Script
curl -sSL https://raw.githubusercontent.com/jingkaihe/kodelet/main/install.sh | bash
Choice of LLM
Kodelet supports Anthropic Claude, OpenAI compatible models and Google Gemini. Currently we recommend using Claude Sonnet 4.6 for standard tasks and Claude 4.5 Haiku for lightweight tasks.
Development
For detailed development instructions, including prerequisites, running locally, configuration options, and available mise tasks, please see the Development Guide.
License
This project is licensed under the MIT License - see the LICENSE file for details..
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
kodelet
command
Package main provides the entry point for the Kodelet CLI application.
|
Package main provides the entry point for the Kodelet CLI application. |
|
pkg
|
|
|
acp
Package acp implements the Agent Client Protocol (ACP) server for kodelet.
|
Package acp implements the Agent Client Protocol (ACP) server for kodelet. |
|
acp/acptypes
Package acptypes defines types for the Agent Client Protocol (ACP).
|
Package acptypes defines types for the Agent Client Protocol (ACP). |
|
acp/bridge
Package bridge provides the bridge between kodelet's message handler system and the ACP session update protocol.
|
Package bridge provides the bridge between kodelet's message handler system and the ACP session update protocol. |
|
acp/session
Package session manages ACP session lifecycle, wrapping kodelet threads with ACP session semantics.
|
Package session manages ACP session lifecycle, wrapping kodelet threads with ACP session semantics. |
|
auth
Package auth provides authentication mechanisms for various AI providers.
|
Package auth provides authentication mechanisms for various AI providers. |
|
binaries
Package binaries provides functionality for managing external binary dependencies that kodelet requires, such as ripgrep.
|
Package binaries provides functionality for managing external binary dependencies that kodelet requires, such as ripgrep. |
|
conversations
Package conversations provides conversation management functionality for kodelet.
|
Package conversations provides conversation management functionality for kodelet. |
|
conversations/sqlite
Package sqlite provides SQLite-specific implementation for conversation storage.
|
Package sqlite provides SQLite-specific implementation for conversation storage. |
|
db
Package db provides shared SQLite database utilities.
|
Package db provides shared SQLite database utilities. |
|
db/migrations
Package migrations contains all database migrations for kodelet.
|
Package migrations contains all database migrations for kodelet. |
|
fragments
Package fragments provides a template system for reusable prompt fragments and recipes.
|
Package fragments provides a template system for reusable prompt fragments and recipes. |
|
github
Package github provides GitHub Actions workflow templates and utilities for generating and rendering GitHub workflow files.
|
Package github provides GitHub Actions workflow templates and utilities for generating and rendering GitHub workflow files. |
|
hooks
Package hooks provides an extensibility mechanism for agent lifecycle events.
|
Package hooks provides an extensibility mechanism for agent lifecycle events. |
|
llm
Package llm provides a unified interface for Large Language Model providers.
|
Package llm provides a unified interface for Large Language Model providers. |
|
llm/anthropic
Package anthropic provides a client implementation for interacting with Anthropic's Claude AI models.
|
Package anthropic provides a client implementation for interacting with Anthropic's Claude AI models. |
|
llm/base
Package base provides shared functionality for LLM thread implementations.
|
Package base provides shared functionality for LLM thread implementations. |
|
llm/google
Package google provides a client implementation for interacting with Google's GenAI models.
|
Package google provides a client implementation for interacting with Google's GenAI models. |
|
llm/openai
Package openai provides OpenAI API client implementations.
|
Package openai provides OpenAI API client implementations. |
|
llm/openai/preset/codex
Package codex provides preset configurations for Codex CLI models.
|
Package codex provides preset configurations for Codex CLI models. |
|
llm/openai/preset/openai
Package openai provides preset configurations for OpenAI models
|
Package openai provides preset configurations for OpenAI models |
|
llm/openai/preset/xai
Package xai provides preset configurations for xAI Grok models
|
Package xai provides preset configurations for xAI Grok models |
|
llm/openai/responses
Package responses implements storage types for the OpenAI Responses API.
|
Package responses implements storage types for the OpenAI Responses API. |
|
llm/prompts
Package prompts provides common prompt templates for LLM interactions including context compacting prompts and other reusable prompt text used throughout kodelet's LLM communication.
|
Package prompts provides common prompt templates for LLM interactions including context compacting prompts and other reusable prompt text used throughout kodelet's LLM communication. |
|
logger
Package logger provides context-aware structured logging functionality using logrus.
|
Package logger provides context-aware structured logging functionality using logrus. |
|
mcp
Package mcp provides Model Context Protocol integration for kodelet.
|
Package mcp provides Model Context Protocol integration for kodelet. |
|
mcp/codegen
Package codegen provides code generation for MCP tools.
|
Package codegen provides code generation for MCP tools. |
|
mcp/rpc
Package rpc provides an RPC server for code execution to call MCP tools.
|
Package rpc provides an RPC server for code execution to call MCP tools. |
|
mcp/runtime
Package runtime provides code execution runtime implementations.
|
Package runtime provides code execution runtime implementations. |
|
osutil
Package osutil provides common utility functions for kodelet including content formatting with line numbers, process management, language detection, domain filtering, and various helper functions used across the application.
|
Package osutil provides common utility functions for kodelet including content formatting with line numbers, process management, language detection, domain filtering, and various helper functions used across the application. |
|
plugins
Package plugins provides a unified plugin system for managing both skills (model-invoked capabilities) and recipes (user-invoked templates).
|
Package plugins provides a unified plugin system for managing both skills (model-invoked capabilities) and recipes (user-invoked templates). |
|
presenter
Package presenter provides consistent CLI output functionality for user-facing messages, including success, error, warning, and informational output with color support and quiet mode.
|
Package presenter provides consistent CLI output functionality for user-facing messages, including success, error, warning, and informational output with color support and quiet mode. |
|
skills
Package skills provides an agentic skills system where the model can autonomously invoke specialized capabilities based on task context.
|
Package skills provides an agentic skills system where the model can autonomously invoke specialized capabilities based on task context. |
|
steer
Package steer provides functionality for managing user steering messages for autonomous conversations in kodelet.
|
Package steer provides functionality for managing user steering messages for autonomous conversations in kodelet. |
|
sysprompt
Package sysprompt renders system prompts from embedded templates.
|
Package sysprompt renders system prompts from embedded templates. |
|
telemetry
Package telemetry provides OpenTelemetry tracing for Kodelet
|
Package telemetry provides OpenTelemetry tracing for Kodelet |
|
tools
Package tools provides the core tool execution framework for Kodelet.
|
Package tools provides the core tool execution framework for Kodelet. |
|
tools/renderers
Package renderers provides CLI output rendering functionality for tool results.
|
Package renderers provides CLI output rendering functionality for tool results. |
|
types/conversations
Package conversations defines types and interfaces for conversation data structures, query options, and conversation records used throughout kodelet's conversation management system.
|
Package conversations defines types and interfaces for conversation data structures, query options, and conversation records used throughout kodelet's conversation management system. |
|
types/llm
Package llm defines types and interfaces for Large Language Model interactions including message handlers, threads, configuration, and usage tracking for different LLM providers.
|
Package llm defines types and interfaces for Large Language Model interactions including message handlers, threads, configuration, and usage tracking for different LLM providers. |
|
types/tools
Package tools defines interfaces and types for kodelet's tool system including tool execution, result structures, state management, and JSON schema generation for LLM tool integration.
|
Package tools defines interfaces and types for kodelet's tool system including tool execution, result structures, state management, and JSON schema generation for LLM tool integration. |
|
usage
Package usage provides functionality for tracking and calculating usage statistics for LLM conversations including token counts, conversation metrics, and time-based analytics for monitoring system performance.
|
Package usage provides functionality for tracking and calculating usage statistics for LLM conversations including token counts, conversation metrics, and time-based analytics for monitoring system performance. |
|
version
Package version provides version information for kodelet including semantic version, git commit SHA, build time, and build information that are set during the build process.
|
Package version provides version information for kodelet including semantic version, git commit SHA, build time, and build information that are set during the build process. |
|
webui
Package webui provides a web server and HTTP API for kodelet's web interface.
|
Package webui provides a web server and HTTP API for kodelet's web interface. |
Click to show internal directories.
Click to hide internal directories.