# KOPI AI 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/Kopi Ai Agent Pte Ltd/kopi-ai-agent/main/scripts/install.sh | bash`  (Linux, macOS, WSL2, Termux)

Repo: https://github.com/LINYIQ66/kopi-ai-agent

## Getting Started

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

## Using Hermes

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

## Core Features

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

## Automation

- [Cron Jobs](https://kopiaiagent.com/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://kopiaiagent.com/docs/user-guide/features/delegation): Spawn isolated child agents for parallel workstreams with delegate_task
- [Kanban Multi-Agent](https://kopiaiagent.com/docs/user-guide/features/kanban): Durable SQLite-backed task board for coordinating multiple Hermes profiles
- [Kanban Tutorial](https://kopiaiagent.com/docs/user-guide/features/kanban-tutorial)
- [Persistent Goals](https://kopiaiagent.com/docs/user-guide/features/goals): Set a standing goal and let Hermes keep working across turns until it's done. Our take on the Ralph loop.
- [Code Execution](https://kopiaiagent.com/docs/user-guide/features/code-execution): Programmatic Python execution with RPC tool access — collapse multi-step workflows into a single turn
- [Hooks](https://kopiaiagent.com/docs/user-guide/features/hooks): Run custom code at key lifecycle points — log activity, send alerts, post to webhooks
- [Batch Processing](https://kopiaiagent.com/docs/user-guide/features/batch-processing): Generate agent trajectories at scale — parallel processing, checkpointing, and toolset distributions

## Media & Web

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

## Messaging Platforms

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

## Integrations

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

## Guides & Tutorials

- [Tips & Best Practices](https://kopiaiagent.com/docs/guides/tips): Practical advice to get the most out of KOPI AI AGENT — prompt tips, CLI shortcuts, context files, memory, cost optimization, and security
- [Local LLMs on Mac](https://kopiaiagent.com/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://kopiaiagent.com/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://kopiaiagent.com/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 Hermes as a Python Library](https://kopiaiagent.com/docs/guides/python-library): Embed AIAgent in your own Python scripts, web apps, or automation pipelines — no CLI required
- [Use MCP with Hermes](https://kopiaiagent.com/docs/guides/use-mcp-with-hermes)
- [Use Voice Mode with Hermes](https://kopiaiagent.com/docs/guides/use-voice-mode-with-hermes)
- [Use SOUL.md with Hermes](https://kopiaiagent.com/docs/guides/use-soul-with-hermes)
- [Build a Hermes Plugin](https://kopiaiagent.com/docs/guides/build-a-kopi-plugin)
- [Automate with Cron](https://kopiaiagent.com/docs/guides/automate-with-cron): Real-world automation patterns using Hermes cron — monitoring, reports, pipelines, and multi-skill workflows
- [Work with Skills](https://kopiaiagent.com/docs/guides/work-with-skills): Find, install, use, and create skills — on-demand knowledge that teaches Hermes new workflows
- [Delegation Patterns](https://kopiaiagent.com/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://kopiaiagent.com/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://kopiaiagent.com/docs/developer-guide/contributing): How to contribute to KOPI AI AGENT — dev setup, code style, PR process
- [Architecture](https://kopiaiagent.com/docs/developer-guide/architecture): KOPI AI AGENT internals — major subsystems, execution paths, data flow, and where to read next
- [Agent Loop](https://kopiaiagent.com/docs/developer-guide/agent-loop): Detailed walkthrough of AIAgent execution, API modes, tools, callbacks, and fallback behavior
- [Prompt Assembly](https://kopiaiagent.com/docs/developer-guide/prompt-assembly): How Hermes builds the system prompt, preserves cache stability, and injects ephemeral layers
- [Context Compression & Caching](https://kopiaiagent.com/docs/developer-guide/context-compression-and-caching)
- [Gateway Internals](https://kopiaiagent.com/docs/developer-guide/gateway-internals): How the messaging gateway boots, authorizes users, routes sessions, and delivers messages
- [Session Storage](https://kopiaiagent.com/docs/developer-guide/session-storage)
- [Provider Runtime](https://kopiaiagent.com/docs/developer-guide/provider-runtime): How Hermes resolves providers, credentials, API modes, and auxiliary models at runtime
- [Adding Tools](https://kopiaiagent.com/docs/developer-guide/adding-tools): How to add a new tool to KOPI AI AGENT — schemas, handlers, registration, and toolsets
- [Adding Providers](https://kopiaiagent.com/docs/developer-guide/adding-providers): How to add a new inference provider to KOPI AI AGENT — auth, runtime resolution, CLI flows, adapters, tests, and docs
- [Adding Platform Adapters](https://kopiaiagent.com/docs/developer-guide/adding-platform-adapters)
- [Creating Skills](https://kopiaiagent.com/docs/developer-guide/creating-skills): How to create skills for KOPI AI AGENT — SKILL.md format, guidelines, and publishing
- [Extending the CLI](https://kopiaiagent.com/docs/developer-guide/extending-the-cli): Build wrapper CLIs that extend the Hermes TUI with custom widgets, keybindings, and layout changes

## Reference

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