@openacp/cli 0.4.4 → 0.4.6

package/README.md

@@ -16,11 +16,11 @@ One message, any channel, any agent.
 
 ---
 
-Send a message in Telegram. An AI coding agent picks it up, writes code, runs commands, and streams everything back — in real time.
+## What is OpenACP?
 
-OpenACP connects messaging platforms (Telegram, Discord, ...) to AI coding agents (Claude Code, Codex, ...) via the [Agent Client Protocol (ACP)](https://agentclientprotocol.org/). You host it, you own the data.
+OpenACP lets you control AI coding agents (Claude Code, Codex, ...) from messaging apps like Telegram. You send a message, the agent writes code, runs commands, and streams everything back — in real time.
 
-## Architecture
+It uses the [Agent Client Protocol (ACP)](https://agentclientprotocol.org/) to talk to agents. You host it on your own machine, so you own the data.
 
 ```
 You (Telegram / Discord / ...)
@@ -29,30 +29,75 @@ OpenACP ─── ChannelAdapter ─── Session Manager ─── Session Sto
   ↓                                                     ↓
 ACP Protocol (JSON-RPC / stdio)                  Tunnel Service
   ↓                                                     ↓
-AI Agent (Claude Code, Codex, ...)            File/Diff Viewer (Monaco)
+AI Agent (Claude Code, Codex, ...)            File/Diff Viewer
 ```
 
-## Highlights
+## Features
 
-- [**Multi-agent**](docs/guide/configuration.md#agents) — Claude Code, Codex, or any ACP-compatible agent
-- [**Telegram**](docs/guide/telegram-setup.md) — Forum topics, real-time streaming, permission buttons, skill commands
-- [**Tunnel & Viewer**](docs/guide/tunnel.md) — Public file/diff viewer via Cloudflare, ngrok, bore, Tailscale
-- [**Session persistence**](docs/guide/usage.md#session-persistence--resume) — Lazy resume across restarts
-- [**Setup wizard**](docs/guide/getting-started.md) — Interactive first-run setup with bot validation and auto-detect
-- [**Plugin system**](docs/guide/plugins.md) — Install channel adapters as npm packages
-- [**Structured logging**](docs/guide/configuration.md#logging) — Pino with rotation, per-session log files
+- **Multi-agent** — Claude Code, Codex, or any ACP-compatible agent
+- **Telegram** — Forum topics, real-time streaming, permission buttons, skill commands
+- **Tunnel & file viewer** — Public file/diff viewer via Cloudflare, ngrok, bore, or Tailscale
+- **Session persistence** — Resume sessions across restarts
+- **Plugin system** — Install channel adapters as npm packages
+- **Structured logging** — Pino with rotation, per-session log files
 - **Self-hosted** — Your keys, your data, your machine
 
-## Quick Start
+## Setup
+
+### Prerequisites
+
+- **Node.js 20+**
+- **A Telegram bot** — Create one via [@BotFather](https://t.me/BotFather) and save the token
+- **A Telegram supergroup** with Topics enabled — Add your bot as admin
+
+### Install & first run
 
 ```bash
 npm install -g @openacp/cli
 openacp
 ```
 
-First run launches an [interactive setup wizard](docs/guide/getting-started.md) that validates your bot token, auto-detects your Telegram group, and finds installed agents.
+> **Important: `openacp` is an interactive CLI.**
+> The first run launches a setup wizard that asks you questions in the terminal (bot token, group selection, workspace path, etc.).
+> You **must run it yourself in a terminal** — it cannot be run by a script or an AI agent because it requires interactive input.
+
+The wizard will:
+
+1. **Ask for your Telegram bot token** — validates it against the Telegram API
+2. **Auto-detect your group** — send "hi" in the group and it picks it up, or enter the chat ID manually
+3. **Set a workspace directory** — where agents will create project folders (default: `~/openacp-workspace`)
+4. **Detect installed agents** — finds Claude Code, Codex, etc.
+5. **Choose run mode** — foreground (in terminal) or background (daemon with auto-start)
+
+Config is saved to `~/.openacp/config.json`. After setup, OpenACP starts automatically.
+
+### Running after setup
+
+```bash
+# Foreground (shows logs in terminal)
+openacp
+
+# Or as a background daemon
+openacp start
+openacp stop
+openacp status
+openacp logs
+```
+
+### Other CLI commands
 
-## Commands
+```bash
+openacp config            # Show current config
+openacp reset             # Re-run the setup wizard
+openacp update            # Update to latest version
+openacp install <plugin>  # Install a plugin (e.g. @openacp/adapter-discord)
+openacp uninstall <plugin>
+openacp plugins           # List installed plugins
+```
+
+## Usage
+
+Once OpenACP is running, control it from Telegram:
 
 | Command | Description |
 |---------|-------------|
@@ -62,6 +107,27 @@ First run launches an [interactive setup wizard](docs/guide/getting-started.md)
 | `/status` | Show session or system status |
 | `/agents` | List available agents |
 
+Each session gets its own forum topic. The agent streams responses in real time, shows tool calls, and asks for permission when needed.
+
+### Session Handoff
+
+Transfer sessions between Claude CLI and Telegram:
+
+**CLI → Telegram:**
+```bash
+# Install Claude CLI integration (one-time)
+openacp integrate claude
+
+# In Claude CLI, type /openacp:handoff to transfer current session
+# Or manually:
+openacp adopt claude <session_id> --cwd /path/to/project
+```
+
+**Telegram → CLI:**
+Type `/handoff` in any session topic. The bot will reply with the `claude --resume` command to paste in your terminal.
+
+Sessions are not locked after handoff — you can continue from either side.
+
 ## Roadmap
 
 - **Phase 1** — Core + Telegram + ACP agents

package/dist/agent-registry-7HC6D4CH.js

@@ -0,0 +1,7 @@
+import {
+  getAgentCapabilities
+} from "./chunk-VA2M52CM.js";
+export {
+  getAgentCapabilities
+};
+//# sourceMappingURL=agent-registry-7HC6D4CH.js.map