TencentCloud/Octop

A smarter, self-hosted AI assistant — multi-user, multi-agent. Highlights · Overview · Core Technology · Features · Roadmap · Quick Start · Contents English · 中文 Octop is an open-source, self-hosted AI assistant. It's not just a tool — it's a digital life form that can operate in parallel. Through its multi-agent architecture, it builds an intelligent environment that is both independent and collaborative for teams, families, and individuals. Best of all, it runs entirely on your machine — the fully self-hosted design means privacy is never a compromise, while single-process startup makes the powerful web console, CLI, and IM integrations readily accessible. Chat through the Web Dashboard, Feishu, DingTalk, QQ, Discord, WeCom, or programmatic HTTP/SSE/WebSocket. Extend capabilities with the expert library , Connectors (OAuth + MCP), and ACP integration for IDE workflows. ✨ Highlights Feature Description 👥 Multi-user expert team One admin, shared household; built-in expert library — switch specialists per scenario 🎭 MBTI personas 16 personality templates plus an interactive quiz — give each agent a distinct character 🔒 Security built-in JWT multi-user isolation, tool approval, shell command guardrails, and PII redaction — data stays local 🔌 Connector ecosystem Tencent suite (Docs, Weibo trends, News, …); OAuth and MCP gateway extend resource boundaries 💾 Pluggable backends Local disk, Docker containers, PostgreSQL, or COS/S3 — AI operates inside isolated boundaries 🧠 Portable memory Powered by harness-memory; memory migrates with the workspace 📚 Knowledge base RAG over your documents; semantic retrieval grounds agent answers in your private corpus 🧩 Plugins Extend Octop with third-party plugins; bundled plugins are seeded and toggled on demand ↔️ ACP bidirectional octop acp for IDE/terminal AI; delegate to OpenCode / Claude Code with permission gates 💻 Terminal AI+ Interactive shell in the browser — AI-assisted command execution and troubleshooting 🌐 Browser AI+ Headless Chromium sessions for web automation, screenshots, and remote browsing 🖥️ Remote desktop Live screen and input from the dashboard on Linux, Windows, and macOS — remote office work and GUI apps; one-click isolated desktop on headless Linux 🏠 Self-hosted Dashboard, CLI, IM channels, and cron in one octop run — all data under ~/.octop/ 📌 Overview Octop is a self-hosted AI assistant platform for households and small teams. It runs a single process that serves a web dashboard, a CLI, IM channels (Feishu, DingTalk, QQ, Discord, WeCom, and more), and cron automation — all sharing one control-plane database under ~/.octop/ (SQLite by default; PostgreSQL optional). Octop's design goal: keep every conversation, workspace, and credential on your own machine, while giving each user a personal team of specialized agents they can switch between per task. 🐾 What can you do with Octop Personal assistant — let a dedicated agent write weekly reports, organize notes, and manage your schedule; memory persists with the workspace. Family sharing — one admin account, the whole household; assign different agents and experts per member. Team helper — multiple agents collaborate in parallel, bridging Feishu / DingTalk / WeCom to route tasks into group chats. Developer boost — delegate coding tasks to OpenCode / Claude Code via ACP, or troubleshoot from the terminal with AI assistance. Web automation — use Browser AI+ to fill forms, capture screenshots, and gather public info. Scheduled tasks — configure cron in natural language so the agent pushes or runs jobs on time every day. 🧠 Core Technology Layer Technology Language Python 3.12+ Web framework FastAPI + uvicorn Agent runtime harness-agent Gateway harness-gateway Control plane DB SQLite (WAL, default) or PostgreSQL (optional) Frontend React 18 + TypeScript + Vite + Ant Design Scheduling APScheduler ACP agent-client-protocol Build / quality hatchling · ruff · mypy · pytest Octop is built on the Harness stack — a set of focused runtimes that Octop composes into one process: harness-agent — Agent runtime: model routing, tools, skills, and conversation checkpointing. harness-gateway — multi-platform IM channel bridge that normalizes incoming messages into a single processing pipeline. harness-memory — hierarchical recall with full-text search, so an agent's memory travels with its workspace. harness-browser — CDP-based browser automation with persistent profiles for web tasks. Instead of an external queue or message broker, Octop routes every surface — Web UI, IM, and cron — through one in-process HarnessProcessor . The result is a single, restart-safe process whose entire state is rebuilt from the control-plane database on boot (local SQLite by default; PostgreSQL optional). 🤔 Features Server & auth Multi-user JWT authentication with admin role First-run setup wizard ( octop init ) Interactive API docs at /api/docs (off by default — set "enable_api_docs": true in config.json to enable) Agents Multiple agents per user; each has its own workspace, providers, channels, and cron 16 MBTI persona templates + custom system prompt Expert library scanned at boot ( infra/agents/experts/library/ ) Workspace backends: local disk, COS, S3, and other remote stores Channels & automation IM channels: Feishu, DingTalk, QQ, Discord, WeCom, and more Proactive cron jobs with natural-language and slash-command triggers Unified message processing across Web UI, IM, and cron surfaces Surfaces Web dashboard — chat, agents, connectors, channels, cron, settings CLI — octop run , octop chat , octop acp , admin commands HTTP/SSE/WebSocket API — full programmatic access Knowledge & plugins Knowledge base — RAG over your documents; upload files and let semantic retrieval ground agent answers in your private corpus Plugins — install and manage third-party plugins ( octop plugin ); bundled plugins are seeded and toggled on demand from the dashboard ACP (Agent Client Protocol) Octop supports ACP in two directions: Inbound — external tools use your Octop agent octop acp --agent main # stdio ACP server for Zed, OpenCode, … Outbound — Octop delegates to external coding agents Dashboard → ACP ( /acp ): configure runners (global per user) Enable acp_runner per agent, then delegate in chat Built-in outbound runners include OpenCode, CodeBuddy, Claude Code, and Codex. Full setup: docs/acp.md . 🧭 Roadmap Here are our mid-to-long term plans: Shared resource pool — a central pool of skills and sub-agents that any user can drop into a new expert without rebuilding from scratch. Expert sharing — publish your experts to other users in the same deployment, so good configurations are reused instead of recreated. Browser & terminal polishing — browser skill recording (capture a workflow and replay it as a skill) and a more capable terminal AI assistant. AgentTeams — let one coordinator autonomously schedule and orchestrate multiple experts to tackle multi-step tasks. Self-evolution — automatically distill everyday conversations into reusable skills, so the assistant grows with you. PC / mobile clients — native desktop and mobile apps alongside the web dashboard and IM channels. This roadmap may shift as the community grows; treat it as indicative only. 🚀 Quick Start Prerequisites macOS / Linux / Windows No pre-installed Python required — the installer uses uv to provision Python 3.12 in an isolated venv under ~/.octop/ A modern multi-core CPU with a few GB of RAM for the process plus model/embedding caches; enough disk for the database, agent workspaces, and document corpora 1. Install macOS / Linux — one-line installer (recommended): curl -fsSL https://finnie-1258344699.cos.ap-guangzhou.myqcloud.com/octop/install.sh | bash Windows (PowerShell) : irm https: // finnie-1258344699.cos.ap-guangzhou.myqcloud.com / octop / install.ps1 | iex Windows (cmd) — download and run, or from a cloned repo: curl -fsSL https://finnie-1258344699.cos.ap-guangzhou.myqcloud.com/octop/install.bat -o install.bat install.