304 lines
16 KiB
Markdown
304 lines
16 KiB
Markdown
OpenACP — self-hosted bridge that connects 28+ AI coding agents (Claude Code, Codex, Gemini, Cursor) to Telegram, Discord & Slack. Your machine, your keys, your data.
|
|
|
|
<div align="center">
|
|
|
|
# OpenACP
|
|
|
|
**Control AI coding agents from Telegram, Discord & Slack**
|
|
|
|
Send a message. The agent writes code. You see everything — in real time.
|
|
|
|
[](LICENSE)
|
|
[](https://nodejs.org/)
|
|
[](https://agentclientprotocol.org/)
|
|
[](https://www.npmjs.com/package/@openacp/cli)
|
|
[](https://x.com/openacp_ai)
|
|
|
|
[Documentation](https://openacp.gitbook.io/docs) · [Quick Start](#quick-start) · [Features](#features) · [Agents](#supported-agents) · [Contributing](CONTRIBUTING.md) · [Discussions](https://github.com/Open-ACP/OpenACP/discussions)
|
|
|
|
<img src="docs/images/banner.jpg" alt="OpenACP — Control AI coding agents from Telegram, Discord and Slack" width="100%" />
|
|
|
|
</div>
|
|
|
|
---
|
|
|
|
## What is OpenACP?
|
|
|
|
OpenACP is a self-hosted bridge that connects AI coding agents to your messaging platforms. You chat with an AI agent through Telegram, Discord, or Slack — it reads your codebase, writes code, runs commands, and streams results back to you in real time.
|
|
|
|
Built on the open [Agent Client Protocol (ACP)](https://agentclientprotocol.org/). Your machine, your keys, your data.
|
|
|
|
```
|
|
You (Telegram / Discord / Slack)
|
|
↓
|
|
OpenACP (bridge + session manager)
|
|
↓
|
|
AI Agent (Claude Code, Codex, Gemini, Cursor, ...)
|
|
↓
|
|
Your Codebase
|
|
```
|
|
|
|
## Why OpenACP?
|
|
|
|
| Without OpenACP | With OpenACP |
|
|
|----------------|-------------|
|
|
| *"Its usage is currently focused on its dedicated terminal REPL and specific IDE integrations"* | Control from Telegram, Discord, or Slack — any device, anywhere |
|
|
| *"Codex Desktop App only works with local projects. It does not support development on remote hosts"* | Full remote development support — run agents on your server, manage from your phone |
|
|
| *"There's no way to trigger Claude Code sessions from external issue trackers"* | REST API for CI/CD integration and external triggers |
|
|
| *"Being able to use a proper mobile app UI would be much better than having to access sessions through ssh + tmux"* | Native Telegram/Discord UI — no SSH, no terminal on mobile |
|
|
| *"Cline is really burning up OpenRouter tokens and my wallet"* | Built-in usage tracking and monthly budget limits per session |
|
|
|
|
## Use Cases
|
|
|
|
- **Remote coding** — Tired of being chained to your desk to run Claude Code? Review PRs, fix bugs, and deploy from your phone via Telegram while away from your desk.
|
|
- **Team visibility** — Share a Discord channel where everyone sees what the AI agent is doing in real time — no more black-box coding sessions.
|
|
- **Multi-agent workflows** — Start with Claude Code for planning, switch to Codex for implementation, use Gemini for review — all in one chat thread, no reconfiguration.
|
|
- **CI/CD integration** — Trigger agent sessions from GitHub Actions or any issue tracker via the REST API.
|
|
- **Self-hosted AI gateway** — Keep API keys and code on your own infrastructure. No third-party cloud, no vendor lock-in.
|
|
- **Local LLM support** — Run agents against self-hosted models (Ollama, LM Studio) via ACP-compatible adapters. Your models, your data.
|
|
|
|
<div align="center">
|
|
<table>
|
|
<tr>
|
|
<td align="center"><img src="docs/images/menu.png" width="250" alt="OpenACP control panel showing session management, agent selection, and settings menu in Telegram" /><br /><b>Control Panel</b><br />Manage sessions, agents, and settings</td>
|
|
<td align="center"><img src="docs/images/agent-working.png" width="250" alt="AI coding agent reading files, planning changes, and writing code through OpenACP Telegram interface" /><br /><b>Agent at Work</b><br />Plans, reads files, writes code</td>
|
|
</tr>
|
|
<tr>
|
|
<td align="center"><img src="docs/images/tool-calls.png" width="250" alt="Real-time tool call streaming showing agent actions like file reads, edits, and command execution" /><br /><b>Real-time Tool Calls</b><br />See every action the agent takes</td>
|
|
<td align="center"><img src="docs/images/skills.png" width="250" alt="OpenACP agent skills menu with options for brainstorming, TDD, debugging, and code review" /><br /><b>Agent Skills</b><br />Brainstorming, TDD, debugging & more</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
|
|
## Installation
|
|
|
|
**Requirements:** Node.js 20+ (the installer handles this for you)
|
|
|
|
### macOS
|
|
|
|
```bash
|
|
curl -fsSL https://raw.githubusercontent.com/Open-ACP/OpenACP/main/scripts/install.sh | bash
|
|
```
|
|
|
|
### Linux
|
|
|
|
```bash
|
|
curl -fsSL https://raw.githubusercontent.com/Open-ACP/OpenACP/main/scripts/install.sh | bash
|
|
```
|
|
|
|
> Works on Debian/Ubuntu, Fedora/RHEL, Arch, and other distros. Also supports WSL (Windows Subsystem for Linux).
|
|
|
|
### Windows
|
|
|
|
Open PowerShell and run:
|
|
|
|
```powershell
|
|
powershell -c "irm https://raw.githubusercontent.com/Open-ACP/OpenACP/main/scripts/install.ps1 | iex"
|
|
```
|
|
|
|
> Requires PowerShell 5.1+ (built into Windows 10/11).
|
|
|
|
### Manual install via npm
|
|
|
|
If you already have Node.js 20+ installed:
|
|
|
|
```bash
|
|
npm install -g @openacp/cli
|
|
openacp
|
|
# → Interactive setup wizard starts:
|
|
# → ? Choose your platform: Telegram / Discord / Slack
|
|
# → ? Enter your bot token: ********
|
|
# → ? Select workspace directory: ~/projects
|
|
# → ? Choose default AI agent: Claude Code
|
|
# → ✓ Configuration saved. Starting OpenACP...
|
|
# → 🚀 OpenACP is running. Send a message to your bot!
|
|
```
|
|
|
|
---
|
|
|
|
After installation, the **interactive setup wizard** walks you through everything:
|
|
|
|
1. Choose your platform (Telegram, Discord, Slack, or multiple)
|
|
2. Connect your bot (token validation + auto-detection)
|
|
3. Pick a workspace directory
|
|
4. Select your default AI agent
|
|
5. Choose run mode (foreground or daemon)
|
|
|
|
That's it. Send a message to your bot and start coding.
|
|
|
|
> **Need detailed setup for a specific platform?** See the [Platform Setup guides](https://openacp.gitbook.io/docs/platform-setup).
|
|
|
|
## Features
|
|
|
|
### Messaging Platforms
|
|
|
|
| Platform | Status | Highlights |
|
|
|----------|--------|------------|
|
|
| **Telegram** | Stable | Forum topics per session, streaming, permission buttons, voice |
|
|
| **Discord** | Stable | Thread-based sessions, slash commands, button interactions |
|
|
| **Slack** | Stable | Socket Mode, channel-based sessions, thread organization |
|
|
|
|
### Core
|
|
|
|
- **28+ AI agents** — Claude Code, Codex, Gemini, Cursor, Copilot, and [more](#supported-agents)
|
|
- **Session management** — Each conversation gets its own thread/topic with auto-naming
|
|
- **Session persistence** — Sessions survive restarts, with configurable TTL
|
|
- **Permission control** — Approve or deny agent actions via buttons, with optional auto-approve
|
|
- **Real-time streaming** — See agent thinking, tool calls, and output as they happen
|
|
- **Agent switching** — Switch agents mid-conversation with `/switch`; history carries over automatically
|
|
|
|
### Developer Tools
|
|
|
|
- **Tunnel & port forwarding** — Expose local ports to the internet (Cloudflare, ngrok, bore, Tailscale)
|
|
- **Built-in file viewer** — Monaco Editor with syntax highlighting, diffs, and markdown preview
|
|
- **Session transfer** — Move sessions between terminal and chat (`/handoff`)
|
|
- **Agent switch** — Change which AI agent handles your session mid-conversation (`/switch`)
|
|
- **Voice & speech** — Send voice messages, get spoken responses (Groq STT + Edge TTS)
|
|
- **Usage tracking** — Token counts, cost reports, optional monthly budget limits
|
|
- **Context resume** — Resume sessions with full conversation history
|
|
|
|
### Operations
|
|
|
|
- **Daemon mode** — Run as a background service with auto-start on boot
|
|
- **CLI API** — Full REST API for automation (`openacp api ...`)
|
|
- **Plugin system** — Install adapters as npm packages
|
|
- **Doctor diagnostics** — `openacp doctor` checks everything and suggests fixes
|
|
- **Structured logging** — Pino with rotation, per-session log files
|
|
|
|
> **Full feature documentation** — [Documentation](https://openacp.gitbook.io/docs)
|
|
|
|
## Supported Agents
|
|
|
|
OpenACP uses the [ACP Registry](https://agentclientprotocol.com/get-started/registry) — new agents are available as soon as they're registered.
|
|
|
|
| Agent | Type | Description |
|
|
|-------|------|-------------|
|
|
| [Claude Code](https://github.com/anthropics/claude-code) | npx | Anthropic's Claude coding agent |
|
|
| [Gemini CLI](https://github.com/google-gemini/gemini-cli) | npx | Google's Gemini CLI |
|
|
| [Codex CLI](https://github.com/openai/codex) | npx | OpenAI's coding assistant |
|
|
| [GitHub Copilot](https://github.com/github/copilot-cli) | npx | GitHub's AI pair programmer |
|
|
| [Cursor](https://www.cursor.com/) | binary | Cursor's coding agent |
|
|
| [Cline](https://github.com/cline/cline) | npx | Autonomous coding agent |
|
|
| [goose](https://github.com/block/goose) | binary | Open source AI agent by Block |
|
|
| Amp | binary | The frontier coding agent |
|
|
| [Auggie CLI](https://www.augmentcode.com/) | npx | Augment Code's context engine |
|
|
| [Junie](https://www.jetbrains.com/) | binary | AI coding agent by JetBrains |
|
|
| [Kilo](https://github.com/kilocode/kilo) | npx | Open source coding agent |
|
|
| [Qwen Code](https://github.com/QwenLM/qwen-code) | npx | Alibaba's Qwen assistant |
|
|
| ...and more | | [Full registry →](https://agentclientprotocol.com/get-started/registry) |
|
|
|
|
```bash
|
|
openacp agents # Browse all agents
|
|
openacp agents install <name> # Install from registry
|
|
```
|
|
|
|
## CLI Overview
|
|
|
|
```bash
|
|
# Server
|
|
openacp # Start (first run = setup wizard)
|
|
openacp start / stop / restart # Daemon management
|
|
openacp status # Check daemon status
|
|
openacp logs # Tail daemon logs
|
|
|
|
# Configuration
|
|
openacp config # Interactive config editor
|
|
openacp reset # Re-run setup wizard
|
|
openacp doctor # System diagnostics
|
|
|
|
# Sessions & API (requires running daemon)
|
|
openacp api new [agent] [workspace]
|
|
openacp api status
|
|
openacp api cancel <id>
|
|
|
|
# Tunnels
|
|
openacp tunnel add <port> [--label name]
|
|
openacp tunnel list
|
|
```
|
|
|
|
> **Full CLI reference** — [CLI Commands](https://openacp.gitbook.io/docs/api-reference/cli-commands)
|
|
|
|
## Documentation
|
|
|
|
| Section | Description |
|
|
|---------|-------------|
|
|
| [Getting Started](https://openacp.gitbook.io/docs/getting-started) | What is OpenACP, quickstart for users & developers |
|
|
| [Platform Setup](https://openacp.gitbook.io/docs/platform-setup) | Step-by-step guides for Telegram, Discord, Slack |
|
|
| [Using OpenACP](https://openacp.gitbook.io/docs/using-openacp) | Commands, sessions, agents, permissions, voice |
|
|
| [Self-Hosting](https://openacp.gitbook.io/docs/self-hosting) | Installation, configuration, daemon, security |
|
|
| [Features](https://openacp.gitbook.io/docs/features) | Tunnel, context resume, usage tracking, and more |
|
|
| [Extending](https://openacp.gitbook.io/docs/extending) | Plugin system, building adapters, contributing |
|
|
| [API Reference](https://openacp.gitbook.io/docs/api-reference) | CLI commands, REST API, config schema, env vars |
|
|
| [Troubleshooting](https://openacp.gitbook.io/docs/troubleshooting) | Common issues and FAQ |
|
|
|
|
## Known Limitations
|
|
|
|
- **Early stage** — OpenACP is under active development; expect breaking changes between minor versions
|
|
- **Single user** — Currently designed for individual use; multi-user/team support is planned
|
|
- **Remote host** — Agents run on the same machine as OpenACP; to use on a remote server, install OpenACP on that server
|
|
- **Agent availability** — Some agents require their own API keys and local installation
|
|
- **Platform features** — Not all messaging platform features are supported equally (e.g., Slack threads vs Telegram forum topics)
|
|
- **No Windows daemon** — Daemon mode (auto-start on boot) currently supports macOS and Linux only
|
|
|
|
## FAQ
|
|
|
|
### Why use Telegram or Discord instead of just the terminal?
|
|
Most AI coding agents are locked to a terminal REPL or IDE. OpenACP lets you send messages, review code diffs, approve or deny actions, and monitor progress from any device — phone, tablet, or browser — without opening a laptop.
|
|
|
|
### How is OpenACP different from MCP?
|
|
MCP (Model Context Protocol) is a standard for giving AI models access to tools and data sources. OpenACP uses the **Agent Client Protocol (ACP)** to manage full coding agent *sessions* — starting agents, streaming output, handling permissions, and routing results to your messaging platform. The two protocols are complementary: your agents can use MCP tools while OpenACP manages the session layer.
|
|
|
|
### Can I auto-approve agent actions?
|
|
Yes. By default, OpenACP shows a permission button for destructive actions. You can configure [auto-approve rules](https://openacp.gitbook.io/docs/using-openacp) to skip confirmation for specific action types (e.g., read-only operations) while still requiring approval for file writes or shell commands.
|
|
|
|
### How do I control API spending?
|
|
Set a monthly budget limit in your config. OpenACP tracks token usage and cost in real time and will pause the agent when the limit is reached. Run `openacp config` to set limits per session.
|
|
|
|
### Can I use a local or self-hosted LLM?
|
|
Yes, if the model has a compatible agent CLI. Any agent that implements the ACP protocol can be registered. Community adapters exist for Ollama and LM Studio — run `openacp agents` to browse available options.
|
|
|
|
### What happens if the agent gets stuck or the chat hangs?
|
|
Use `/cancel` in your chat to stop the current session. Run `openacp doctor` to check for connectivity or configuration issues. OpenACP's session persistence means you can resume with full context intact after a restart.
|
|
|
|
### Does OpenACP send my code to the cloud?
|
|
No. OpenACP runs entirely on your machine. AI agents connect directly to your chosen provider using your own API keys. Nothing is routed through OpenACP servers.
|
|
|
|
### Can I use multiple AI agents at the same time?
|
|
Each session uses one agent, but you can run multiple sessions simultaneously — one per thread/topic in your chat. Switch agents between sessions or start a new session with a different agent at any time.
|
|
|
|
### Is OpenACP free?
|
|
Yes. OpenACP is MIT-licensed and free to self-host. You only pay for the AI provider API keys you choose to use.
|
|
|
|
### How do I update OpenACP?
|
|
```bash
|
|
npm update -g @openacp/cli
|
|
```
|
|
|
|
## Security
|
|
|
|
OpenACP grants AI agents access to your filesystem and shell. Before using in production:
|
|
|
|
- Run in a sandboxed environment or container when possible
|
|
- Review agent permissions — use the built-in permission gate to approve/deny actions
|
|
- Never expose your OpenACP instance to the public internet without authentication
|
|
- Keep your bot tokens secret — rotate them if compromised
|
|
- See the [Security guide](https://openacp.gitbook.io/docs/self-hosting/security) for hardening recommendations
|
|
|
|
## Star History
|
|
|
|
<a href="https://star-history.com/#Open-ACP/OpenACP&Date">
|
|
<picture>
|
|
<source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=Open-ACP/OpenACP&type=Date&theme=dark" />
|
|
<source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=Open-ACP/OpenACP&type=Date" />
|
|
<img alt="Star History Chart" src="https://api.star-history.com/svg?repos=Open-ACP/OpenACP&type=Date" />
|
|
</picture>
|
|
</a>
|
|
|
|
## Contributing
|
|
|
|
We welcome contributions! See the [contributing guide](CONTRIBUTING.md) for development setup, testing conventions, and PR process. Have questions? Start a thread on [GitHub Discussions](https://github.com/Open-ACP/OpenACP/discussions).
|
|
|
|
## License
|
|
|
|
[MIT](LICENSE)
|