
OCTO —— 为人和 AI Agent 协作而生的开源工作平台。
让 龙虾(Lobster / OpenClaw-powered digital double agents)去「思」和「行」,让人专注于「品」。
🏠 OCTO 主页 · 🚀 快速开始 · 📦 生态 · 🤝 贡献
🌐 语言: English · 简体中文
Go 后端 —— OCTO 平台的中心节点:REST + WebSocket API、龙虾 Agent 编排、WuKongIM 控制面。
octo-server 是 OCTO 平台的心脏。它向
octo-web 与
octo-admin
提供 REST 与 WebSocket 接口,负责业务编排与龙虾(Lobster / AI Agent)调度,
并通过 WuKongIM 驱动实时消息底座。
octo-server。你只需部署与扩展一个后端,其它组件都走它。git clone https://github.com/Mininglamp-OSS/octo-server.git
cd octo-server
go build -o octo-server .
./octo-server --config ./configs/tsdd.yaml
默认 dev 配置期望本地存在一个 WuKongIM 实例与一个 MySQL 兼容的数据库。
参考仓库自带的 configs/tsdd.yaml 模板获取单二进制运行路径,配合
QUICKSTART.md 与 BUILDING.md 获取完整步骤。
若需要一键拉起完整 OCTO 栈(server + admin + web + matter + smart-summary
+ WuKongIM + MySQL + Redis + MinIO + nginx),请使用官方 OOTB 部署仓库
Mininglamp-OSS/octo-deployment。
本仓库原有的 docker/octo/ 与 docker/tsdd/ compose 栈已下线,统一收口
到 octo-deployment,避免两份独立维护带来的偏移。
顶层结构:
| 路径 | 作用 |
|---|---|
cmd/ |
服务入口(octo-server 与子命令) |
internal/api/ |
REST + WebSocket handler —— 会话 / 用户 / 群组 / 文件 / 组织 / Webhook |
internal/service/ |
业务逻辑 —— 访问控制、龙虾编排、IM 扩散 |
internal/repository/ |
SQL + 缓存仓储(MySQL / Redis) |
internal/im/ |
WuKongIM 控制面客户端(频道 / 消息 / 在线状态) |
internal/agent/ |
龙虾路由、会话存储、工具调用执行 |
internal/adapter/ |
Adapter 注册与下发入口 |
configs/ |
YAML 配置 schema 与 dev / prod 示例 |
migrations/ |
SQL 迁移脚本 |
docs/ |
架构文档、API 参考、图表 |
每次请求 server 做的事:
graph TD
subgraph Clients[客户端]
Web[octo-web
Web / PC]
Android[octo-android
Android]
iOS[octo-ios
iOS]
end
subgraph Core[核心服务]
Server[octo-server
后端 API]
Matter[octo-matter
任务 / Todo]
Summary[octo-smart-summary
AI 摘要]
Admin[octo-admin
管理后台]
end
subgraph Shared[共享库与集成]
Lib[octo-lib
核心 Go 库]
Adapters[octo-adapters
第三方适配器]
end
Web --> Server
Android --> Server
iOS --> Server
Admin --> Server
Server --> Matter
Server --> Summary
Server --> Adapters
Server -.uses.-> Lib
Matter -.uses.-> Lib
Adapters -.uses.-> Lib
| 仓库 | 语言 | 职责 |
|---|---|---|
octo-server |
Go | 后端 API · 业务编排 · 龙虾 Agent 调度 |
octo-matter |
Go | 任务 / Todo / Matter 微服务 |
octo-smart-summary |
Go | 基于 LLM 的会话摘要服务 |
octo-web |
TypeScript / React | Web 与 PC(Electron)客户端 |
octo-android |
Kotlin / Java | 原生 Android 客户端 |
octo-ios |
Swift / Objective-C | 原生 iOS 客户端 |
octo-admin |
TypeScript / React | 管理后台(租户 / 组织 / 用户 / 频道管理) |
octo-lib |
Go | 共享核心库(协议 / 加密 / 存储 / HTTP) |
octo-adapters |
TypeScript / Python | 第三方集成(IM 桥接、AI 渠道) |
OCTO 遵循三条共用原则 —— 这套矩阵里的每个仓都一致:
欢迎提 Pull Request!开 PR 前请先读:
安全问题请按 SECURITY.zh.md 上报,不要走公开 issue。
Apache License 2.0 —— 完整文本见 LICENSE,第三方致谢见 NOTICE。
octo-server 是以下项目的衍生作品:
完整的 Go 模块许可证清单与第三方致谢见 NOTICE。
由 OCTO Contributors 🐙 共同开发 · Mininglamp-OSS
$ claude mcp add octo-server \
-- python -m otcore.mcp_server <graph>