octo-lib

README

OCTO — 为人和 AI Agent 协作而生的开源工作平台
_{让 龙虾（Lobster / OpenClaw-powered digital double agents） 去「思」和「行」，让人聚焦在「品」}

📖 产品 Overview · What is OCTO · 🚀 Quickstart · 📦 Ecosystem · 🤝 Contributing

---

🌐 Read in: English · 简体中文

OCTO Lib

Core shared library for the OCTO platform — used by octo-server and other backend components.

This Go library contains protocol definitions, shared data types, crypto utilities (RSA/AES), storage adapters, HTTP helpers, logging, and other foundational building blocks used across the OCTO ecosystem.

📦 Install

go get github.com/Mininglamp-AI/octo-lib

🧱 Modules

Top-level packages under this module:

Path	Purpose
common/	Cache, pagination, message types, constants
config/	App context, config loader, message/group/channel/stream/RTC configs, ES & tracer init
model/	Shared data models (channel, response)
module/	Module registration primitives
server/	HTTP server bootstrap
testutil/	Test helpers
pkg/cache/	In-memory cache
pkg/db/	MySQL / Redis / SQLite adapters
pkg/keylock/	Per-key lock
pkg/log/	Structured logger (zap-based)
pkg/markdown/	Markdown rendering
pkg/network/	HTTP client helpers
pkg/pool/	Worker pool / job dispatcher
pkg/redis/	Redis client helpers
pkg/register/	API & task router registration
pkg/util/	Crypto (AES / RSA / DH / SHA / MD5), base62, decimal, IP, SSRF-safe URL validation, reflection, time, UUID, string/json utils
pkg/wait/	Wait-group helpers
pkg/wkevent/	Event bus
pkg/wkhook/	Webhook gRPC service (proto + generated code)
pkg/wkhttp/	HTTP handler framework
pkg/wkrsa/	RSA utilities

🛠️ Ecosystem

Part of the OCTO open-source platform.

🤝 Contributing

See CONTRIBUTING.md. Please also read our Code of Conduct.

Acknowledgments

OCTO is built on the excellent work of the open-source community. We'd like to especially thank:

• TangSengDaoDaoServerLib — our upstream project, by the TangSengDaoDao team
• WuKongIM — the underlying real-time messaging core

See NOTICE for full attribution and third-party components.

📄 License

Apache License 2.0 — see LICENSE.

---

Made with 🐙 by the OCTO community.

---

📦 OCTO Ecosystem（仓库矩阵）

graph TD
  subgraph Clients[客户端]
    Web[octo-web<br/>Web / PC]
    Android[octo-android]
    iOS[octo-ios]
  end

  subgraph Core[核心服务]
    Server[octo-server<br/>后端 API / 业务]
    IM[WuKongIM<br/>IM 底座]
  end

  subgraph Libs[共享库 & 工具]
    Lib[octo-lib<br/>核心库]
    CLI[octo-daemon-cli<br/>CLI 工具]
    Adapters[octo-adapters<br/>第三方集成]
  end

  Web --> Server
  Android --> Server
  iOS --> Server
  Server --> IM
  Server --> Adapters
  Server -.uses.-> Lib
  CLI -.uses.-> Lib
  Adapters -.uses.-> Lib

仓库	语言	职责	状态
octo-server	Go	后端 API、业务编排、龙虾调度	Public
octo-web	TypeScript / React	Web & PC 客户端	Public
octo-android	Kotlin / Java	Android 客户端	Public
octo-ios	Swift / Objective-C	iOS 客户端	Public
octo-lib	Go	核心领域模型 / 协议 / 工具库	Public
octo-daemon-cli	Go	运维/接入 CLI、本地守护进程	Public
octo-adapters	TypeScript / Python	第三方系统集成（IM / SSO / 存储等）	Public
WuKongIM	Go	IM 底座（fork，针对 OCTO 增强）	Public