# KOPI O Agent

> The self-improving AI agent built by Kopi Ai Agent Pte Ltd. A terminal-native autonomous coding and task agent with persistent memory, agent-created skills, and a messaging gateway that lives on 21+ messaging platforms — 19 native to the gateway plus IRC and Microsoft Teams via plugins (Telegram, Discord, Slack, SMS, Matrix, ...). Runs on local, Docker, SSH, Daytona, Modal, or Singularity backends. Works with Nous Portal, OpenRouter, OpenAI, Anthropic, Google, or any OpenAI-compatible endpoint.

Install: `curl -fsSL https://raw.githubusercontent.com/XingBaoKu/kopi-agent/main/scripts/install.sh | bash`  (Linux, macOS, WSL2, Termux)

Repo: https://github.com/XingBaoKu/kopi-agent

## Getting Started

- [Installation](https://kopi-agent.happysocial.xyz/docs/getting-started/installation): Install KOPI O Agent on Linux, macOS, WSL2, native Windows (early beta), or Android via Termux
- [Quickstart](https://kopi-agent.happysocial.xyz/docs/getting-started/quickstart): Your first conversation with KOPI O Agent — from install to chatting in under 5 minutes
- [Learning Path](https://kopi-agent.happysocial.xyz/docs/getting-started/learning-path): Choose your learning path through the KOPI O Agent documentation based on your experience level and goals.
- [Updating](https://kopi-agent.happysocial.xyz/docs/getting-started/updating): How to update KOPI O Agent to the latest version or uninstall it
- [Termux (Android)](https://kopi-agent.happysocial.xyz/docs/getting-started/termux): Run KOPI O Agent directly on an Android phone with Termux
- [Nix Setup](https://kopi-agent.happysocial.xyz/docs/getting-started/nix-setup): Install and deploy KOPI O Agent with Nix — from quick `nix run` to fully declarative NixOS module with container mode

## Using Kopi

- [CLI](https://kopi-agent.happysocial.xyz/docs/user-guide/cli): Master the KOPI O Agent terminal interface — commands, keybindings, personalities, and more
- [TUI (Ink terminal UI)](https://kopi-agent.happysocial.xyz/docs/user-guide/tui): Launch the modern terminal UI for Kopi — mouse-friendly, rich overlays, and non-blocking input.
- [Configuration](https://kopi-agent.happysocial.xyz/docs/user-guide/configuration): Configure KOPI O Agent — config.yaml, providers, models, API keys, and more
- [Configuring Models](https://kopi-agent.happysocial.xyz/docs/user-guide/configuring-models)
- [Sessions](https://kopi-agent.happysocial.xyz/docs/user-guide/sessions): Session persistence, resume, search, management, and per-platform session tracking
- [Profiles](https://kopi-agent.happysocial.xyz/docs/user-guide/profiles)
- [Git Worktrees](https://kopi-agent.happysocial.xyz/docs/user-guide/git-worktrees): Run multiple Kopi agents safely on the same repository using git worktrees and isolated checkouts
- [Docker Backend](https://kopi-agent.happysocial.xyz/docs/user-guide/docker): Running KOPI O Agent in Docker and using Docker as a terminal backend
- [Security](https://kopi-agent.happysocial.xyz/docs/user-guide/security): Security model, dangerous command approval, user authorization, container isolation, and production deployment best practices
- [Checkpoints & Rollback](https://kopi-agent.happysocial.xyz/docs/user-guide/checkpoints-and-rollback): Filesystem safety nets for destructive operations using shadow git repos and automatic snapshots

## Core Features

- [Features Overview](https://kopi-agent.happysocial.xyz/docs/user-guide/features/overview)
- [Tools](https://kopi-agent.happysocial.xyz/docs/user-guide/features/tools): Overview of KOPI O Agent's tools — what's available, how toolsets work, and terminal backends
- [Skills System](https://kopi-agent.happysocial.xyz/docs/user-guide/features/skills): On-demand knowledge documents — progressive disclosure, agent-managed skills, and the Skills Hub
- [Curator](https://kopi-agent.happysocial.xyz/docs/user-guide/features/curator): Background maintenance for agent-created skills — usage tracking, staleness, archival, and LLM-driven review
- [Memory](https://kopi-agent.happysocial.xyz/docs/user-guide/features/memory): How KOPI O Agent remembers across sessions — MEMORY.md, USER.md, and session search
- [Memory Providers](https://kopi-agent.happysocial.xyz/docs/user-guide/features/memory-providers): External memory provider plugins — Honcho, OpenViking, Mem0, Hindsight, Holographic, RetainDB, ByteRover, Supermemory
- [Context Files](https://kopi-agent.happysocial.xyz/docs/user-guide/features/context-files): Project context files — .kopi.md, AGENTS.md, CLAUDE.md, global SOUL.md, and .cursorrules — automatically injected into every conversation
- [Context References](https://kopi-agent.happysocial.xyz/docs/user-guide/features/context-references): Inline @-syntax for attaching files, folders, git diffs, and URLs directly into your messages
- [Personality & SOUL.md](https://kopi-agent.happysocial.xyz/docs/user-guide/features/personality): Customize KOPI O Agent's personality with a global SOUL.md, built-in personalities, and custom persona definitions
- [Plugins](https://kopi-agent.happysocial.xyz/docs/user-guide/features/plugins): Extend Kopi with custom tools, hooks, and integrations via the plugin system
- [Built-in Plugins](https://kopi-agent.happysocial.xyz/docs/user-guide/features/built-in-plugins): Plugins shipped with KOPI O Agent that run automatically via lifecycle hooks — disk-cleanup and friends

## Automation

- [Cron Jobs](https://kopi-agent.happysocial.xyz/docs/user-guide/features/cron): Schedule automated tasks with natural language, manage them with one cron tool, and attach one or more skills
- [Delegation](https://kopi-agent.happysocial.xyz/docs/user-guide/features/delegation): Spawn isolated child agents for parallel workstreams with delegate_task
- [Kanban Multi-Agent](https://kopi-agent.happysocial.xyz/docs/user-guide/features/kanban): Durable SQLite-backed task board for coordinating multiple Kopi profiles
- [Kanban Tutorial](https://kopi-agent.happysocial.xyz/docs/user-guide/features/kanban-tutorial)
- [Persistent Goals](https://kopi-agent.happysocial.xyz/docs/user-guide/features/goals): Set a standing goal and let Kopi keep working across turns until it's done. Our take on the Ralph loop.
- [Code Execution](https://kopi-agent.happysocial.xyz/docs/user-guide/features/code-execution): Programmatic Python execution with RPC tool access — collapse multi-step workflows into a single turn
- [Hooks](https://kopi-agent.happysocial.xyz/docs/user-guide/features/hooks): Run custom code at key lifecycle points — log activity, send alerts, post to webhooks
- [Batch Processing](https://kopi-agent.happysocial.xyz/docs/user-guide/features/batch-processing): Generate agent trajectories at scale — parallel processing, checkpointing, and toolset distributions

## Media & Web

- [Voice Mode](https://kopi-agent.happysocial.xyz/docs/user-guide/features/voice-mode): Real-time voice conversations with KOPI O Agent — CLI, Telegram, Discord (DMs, text channels, and voice channels)
- [Browser](https://kopi-agent.happysocial.xyz/docs/user-guide/features/browser)
- [Vision](https://kopi-agent.happysocial.xyz/docs/user-guide/features/vision)
- [Image Generation](https://kopi-agent.happysocial.xyz/docs/user-guide/features/image-generation)
- [Text-to-Speech](https://kopi-agent.happysocial.xyz/docs/user-guide/features/tts): Text-to-speech and voice message transcription across all platforms

## Messaging Platforms

- [Overview](https://kopi-agent.happysocial.xyz/docs/user-guide/messaging/index): Chat with Kopi from Telegram, Discord, Slack, WhatsApp, Signal, SMS, Email, Home Assistant, Mattermost, Matrix, DingTalk, Yuanbao, Microsoft Teams, LINE, Webhooks, or any OpenAI-compatible frontend via the API server — architecture and setup overview
- [Telegram](https://kopi-agent.happysocial.xyz/docs/user-guide/messaging/telegram): Set up KOPI O Agent as a Telegram bot
- [Discord](https://kopi-agent.happysocial.xyz/docs/user-guide/messaging/discord): Set up KOPI O Agent as a Discord bot
- [Slack](https://kopi-agent.happysocial.xyz/docs/user-guide/messaging/slack): Set up KOPI O Agent as a Slack bot using Socket Mode
- [WhatsApp](https://kopi-agent.happysocial.xyz/docs/user-guide/messaging/whatsapp): Set up KOPI O Agent as a WhatsApp bot via the built-in Baileys bridge
- [Signal](https://kopi-agent.happysocial.xyz/docs/user-guide/messaging/signal): Set up KOPI O Agent as a Signal messenger bot via signal-cli daemon
- [Email](https://kopi-agent.happysocial.xyz/docs/user-guide/messaging/email): Set up KOPI O Agent as an email assistant via IMAP/SMTP
- [SMS](https://kopi-agent.happysocial.xyz/docs/user-guide/messaging/sms): Set up KOPI O Agent as an SMS chatbot via Twilio
- [Matrix](https://kopi-agent.happysocial.xyz/docs/user-guide/messaging/matrix): Set up KOPI O Agent as a Matrix bot
- [Mattermost](https://kopi-agent.happysocial.xyz/docs/user-guide/messaging/mattermost): Set up KOPI O Agent as a Mattermost bot
- [Home Assistant](https://kopi-agent.happysocial.xyz/docs/user-guide/messaging/homeassistant)
- [Webhooks](https://kopi-agent.happysocial.xyz/docs/user-guide/messaging/webhooks): Receive events from GitHub, GitLab, and other services to trigger Kopi agent runs

## Integrations

- [Integrations Overview](https://kopi-agent.happysocial.xyz/docs/integrations/index)
- [Providers](https://kopi-agent.happysocial.xyz/docs/integrations/providers)
- [MCP (Model Context Protocol)](https://kopi-agent.happysocial.xyz/docs/user-guide/features/mcp): Connect KOPI O Agent to external tool servers via MCP — and control exactly which MCP tools Kopi loads
- [ACP (Agent Context Protocol)](https://kopi-agent.happysocial.xyz/docs/user-guide/features/acp): Use KOPI O Agent inside ACP-compatible editors such as VS Code, Zed, and JetBrains
- [API Server](https://kopi-agent.happysocial.xyz/docs/user-guide/features/api-server): Expose kopi-agent as an OpenAI-compatible API for any frontend
- [Honcho Memory](https://kopi-agent.happysocial.xyz/docs/user-guide/features/honcho): AI-native persistent memory via Honcho — dialectic reasoning, multi-agent user modeling, and deep personalization
- [Provider Routing](https://kopi-agent.happysocial.xyz/docs/user-guide/features/provider-routing)
- [Fallback Providers](https://kopi-agent.happysocial.xyz/docs/user-guide/features/fallback-providers)
- [Credential Pools](https://kopi-agent.happysocial.xyz/docs/user-guide/features/credential-pools)

## Guides & Tutorials

- [Tips & Best Practices](https://kopi-agent.happysocial.xyz/docs/guides/tips): Practical advice to get the most out of KOPI O Agent — prompt tips, CLI shortcuts, context files, memory, cost optimization, and security
- [Local LLMs on Mac](https://kopi-agent.happysocial.xyz/docs/guides/local-llm-on-mac): Set up a local OpenAI-compatible LLM server on macOS with llama.cpp or MLX, including model selection, memory optimization, and real benchmarks on Apple Silicon
- [Daily Briefing Bot](https://kopi-agent.happysocial.xyz/docs/guides/daily-briefing-bot): Build an automated daily briefing bot that researches topics, summarizes findings, and delivers them to Telegram or Discord every morning
- [Team Telegram Assistant](https://kopi-agent.happysocial.xyz/docs/guides/team-telegram-assistant): Step-by-step guide to setting up a Telegram bot that your whole team can use for code help, research, system admin, and more
- [Use Kopi as a Python Library](https://kopi-agent.happysocial.xyz/docs/guides/python-library): Embed AIAgent in your own Python scripts, web apps, or automation pipelines — no CLI required
- [Use MCP with Kopi](https://kopi-agent.happysocial.xyz/docs/guides/use-mcp-with-kopi): A practical guide to connecting MCP servers to KOPI O Agent, filtering their tools, and using them safely in real workflows
- [Use Voice Mode with Kopi](https://kopi-agent.happysocial.xyz/docs/guides/use-voice-mode-with-kopi): A practical guide to setting up and using Kopi voice mode across CLI, Telegram, Discord, and Discord voice channels
- [Use SOUL.md with Kopi](https://kopi-agent.happysocial.xyz/docs/guides/use-soul-with-kopi): How to use SOUL.md to shape KOPI O Agent's default voice, what belongs there, and how it differs from AGENTS.md and /personality
- [Build a Kopi Plugin](https://kopi-agent.happysocial.xyz/docs/guides/build-a-kopi-plugin): Step-by-step guide to building a complete Kopi plugin with tools, hooks, data files, and skills
- [Automate with Cron](https://kopi-agent.happysocial.xyz/docs/guides/automate-with-cron): Real-world automation patterns using Kopi cron — monitoring, reports, pipelines, and multi-skill workflows
- [Work with Skills](https://kopi-agent.happysocial.xyz/docs/guides/work-with-skills): Find, install, use, and create skills — on-demand knowledge that teaches Kopi new workflows
- [Delegation Patterns](https://kopi-agent.happysocial.xyz/docs/guides/delegation-patterns): When and how to use subagent delegation — patterns for parallel research, code review, and multi-file work
- [GitHub PR Review Agent](https://kopi-agent.happysocial.xyz/docs/guides/github-pr-review-agent): Build an automated AI code reviewer that monitors your repos, reviews pull requests, and delivers feedback — hands-free

## Developer Guide

- [Contributing](https://kopi-agent.happysocial.xyz/docs/developer-guide/contributing): How to contribute to KOPI O Agent — dev setup, code style, PR process
- [Architecture](https://kopi-agent.happysocial.xyz/docs/developer-guide/architecture): KOPI O Agent internals — major subsystems, execution paths, data flow, and where to read next
- [Agent Loop](https://kopi-agent.happysocial.xyz/docs/developer-guide/agent-loop): Detailed walkthrough of AIAgent execution, API modes, tools, callbacks, and fallback behavior
- [Prompt Assembly](https://kopi-agent.happysocial.xyz/docs/developer-guide/prompt-assembly): How Kopi builds the system prompt, preserves cache stability, and injects ephemeral layers
- [Context Compression & Caching](https://kopi-agent.happysocial.xyz/docs/developer-guide/context-compression-and-caching)
- [Gateway Internals](https://kopi-agent.happysocial.xyz/docs/developer-guide/gateway-internals): How the messaging gateway boots, authorizes users, routes sessions, and delivers messages
- [Session Storage](https://kopi-agent.happysocial.xyz/docs/developer-guide/session-storage)
- [Provider Runtime](https://kopi-agent.happysocial.xyz/docs/developer-guide/provider-runtime): How Kopi resolves providers, credentials, API modes, and auxiliary models at runtime
- [Adding Tools](https://kopi-agent.happysocial.xyz/docs/developer-guide/adding-tools): How to add a new tool to KOPI O Agent — schemas, handlers, registration, and toolsets
- [Adding Providers](https://kopi-agent.happysocial.xyz/docs/developer-guide/adding-providers): How to add a new inference provider to KOPI O Agent — auth, runtime resolution, CLI flows, adapters, tests, and docs
- [Adding Platform Adapters](https://kopi-agent.happysocial.xyz/docs/developer-guide/adding-platform-adapters)
- [Creating Skills](https://kopi-agent.happysocial.xyz/docs/developer-guide/creating-skills): How to create skills for KOPI O Agent — SKILL.md format, guidelines, and publishing
- [Extending the CLI](https://kopi-agent.happysocial.xyz/docs/developer-guide/extending-the-cli): Build wrapper CLIs that extend the Kopi TUI with custom widgets, keybindings, and layout changes

## Reference

- [CLI Commands](https://kopi-agent.happysocial.xyz/docs/reference/cli-commands): Authoritative reference for Kopi terminal commands and command families
- [Slash Commands](https://kopi-agent.happysocial.xyz/docs/reference/slash-commands): Complete reference for interactive CLI and messaging slash commands
- [Profile Commands](https://kopi-agent.happysocial.xyz/docs/reference/profile-commands)
- [Environment Variables](https://kopi-agent.happysocial.xyz/docs/reference/environment-variables): Complete reference of all environment variables used by KOPI O Agent
- [Tools Reference](https://kopi-agent.happysocial.xyz/docs/reference/tools-reference): Authoritative reference for Kopi built-in tools, grouped by toolset
- [Toolsets Reference](https://kopi-agent.happysocial.xyz/docs/reference/toolsets-reference): Reference for Kopi core, composite, platform, and dynamic toolsets
- [MCP Config Reference](https://kopi-agent.happysocial.xyz/docs/reference/mcp-config-reference): Reference for KOPI O Agent MCP configuration keys, filtering semantics, and utility-tool policy
- [Model Catalog](https://kopi-agent.happysocial.xyz/docs/reference/model-catalog)
- [Bundled Skills Catalog](https://kopi-agent.happysocial.xyz/docs/reference/skills-catalog): Table of all ~90 skills bundled with Kopi
- [Optional Skills Catalog](https://kopi-agent.happysocial.xyz/docs/reference/optional-skills-catalog): Table of ~60 additional installable skills
- [FAQ & Troubleshooting](https://kopi-agent.happysocial.xyz/docs/reference/faq): Frequently asked questions and solutions to common issues with KOPI O Agent