飞书/企微 BOM 聊天机器人 — Node + OpenClaw 式分层架构
- 多渠道接入:飞书机器人 + 企业微信应用,统一消息标准化
- BOM 物料清单:文本/图片解析 → 结构化提取 → 确定性计算 → 落库
- RAG 知识库:企业文档向量化检索,增强回复(M1.5)
- RBAC 权限:部门/角色级别的工具与数据访问控制
- Skill 插件:可插拔技能目录,新增功能无需改网关代码
- 大模型可配置:多 Provider、多场景(chat/vision/embedding)、降级链路
chunliangclaw/
├── apps/
│ └── gateway/ # Fastify HTTP 网关(Webhook 入口、Agent 编排)
├── packages/
│ ├── core/ # 核心类型定义(UnifiedMessage、Principal 等)
│ ├── config/ # 配置加载与验证
│ ├── auth/ # Principal 解析 + RBAC 校验
│ ├── llm/ # 可配置 LLM Provider 与场景路由
│ ├── channels-feishu/ # 飞书渠道适配器
│ ├── skills-runtime/ # Skill 扫描、加载、注册
│ ├── bom-domain/ # BOM 领域模型(解析、计算、存储)
│ ├── rag/ # RAG 知识库接口与实现
│ ├── prompts/ # 提示词模板版本化管理
│ └── cli/ # CLI 命令行工具
├── skills/
│ ├── bom/ # 内置 BOM Skill
│ └── rag/ # 内置 RAG Skill
├── migrations/ # PostgreSQL 数据库迁移脚本
├── docker-compose.yml # PostgreSQL + Redis 本地开发环境
└── chunliangclaw.config.json # 配置文件(chunliangclaw init 生成)
# 安装 Node.js 20+ 和 pnpm
npm install -g pnpm
# 克隆项目
git clone <repo-url> && cd chunliangclaw
# 安装依赖
pnpm install
# 构建所有包
pnpm run build# 启动 PostgreSQL + Redis(需要 Docker)
docker-compose up -d# 生成配置文件模板(本仓库未发布到 npm,请用 pnpm 调用 workspace 里的 CLI)
pnpm exec chunliangclaw init
# 等价:pnpm run chunliangclaw -- init
# 或让 npx 使用本地包目录(不查 npm 注册表,需先 build)
# npx ./packages/cli init
# 复制环境变量模板并填写
cp .env.example .env
# 编辑 .env 填入实际的 API Key、飞书/企微凭证等
# 验证配置
pnpm exec chunliangclaw config validatepnpm exec chunliangclaw gateway start
# 或直接启动网关包(不经过 CLI 的 dotenv 加载顺序时略有不同)
pnpm run gateway配置文件 chunliangclaw.config.json 支持以下核心配置项:
| 配置项 | 说明 |
|---|---|
providers |
LLM 提供商列表(支持 OpenAI 兼容端点) |
models |
按用途绑定模型:chat / vision / embedding |
channels |
飞书 / 企微渠道配置 |
database |
PostgreSQL 连接配置 |
redis |
Redis 连接配置 |
rbac |
角色与权限映射 |
skills |
Skill 目录路径 |
knowledgeBase |
知识库配置 |
gateway |
网关端口、限流等 |
敏感信息(API Key 等)使用 ${ENV_VAR} 语法引用环境变量。
在仓库根目录执行(需已 pnpm install 且 pnpm run build):
pnpm exec chunliangclaw init # 生成配置文件模板
pnpm exec chunliangclaw gateway start # 启动网关服务
pnpm exec chunliangclaw config validate [path] # 验证配置文件
pnpm exec chunliangclaw kb ingest <path> # 入库知识文档(M1.5)
pnpm exec chunliangclaw kb sync # 同步知识库(M1.5)全局安装本仓库 CLI 后可直接使用 chunliangclaw 命令:npm install -g ./packages/cli(需先 build)。
在 skills/ 目录下创建新目录,包含:
SKILL.md— YAML frontmatter 描述 Skill 元信息skill.json— 可选的清单文件src/index.ts— 导出register(context)函数,注册工具
import type { SkillRegistrationContext, ToolDefinition } from '@chunliangclaw/core';
import { z } from 'zod';
export function register(context: SkillRegistrationContext) {
const myTool: ToolDefinition<{ query: string }, string> = {
id: 'my_tool',
name: '我的工具',
description: '自定义工具描述',
inputSchema: z.object({ query: z.string() }),
requiredPermissions: ['my_resource:read'],
execute: async (input, ctx) => {
return `处理结果: ${input.query}`;
},
};
context.registerTool(myTool);
}| 阶段 | 内容 | 状态 |
|---|---|---|
| M1 | CLI + 配置 + 单渠道(飞书) + 文本 BOM + RBAC + Skill 骨架 | ✅ 当前 |
| M1.5 | RAG: 向量化入库 + knowledge_search + 热加载 | 🔜 |
| M2 | 企微渠道 + 图片 BOM + BullMQ 异步 | 📋 |
| M3 | 采购需求查询 + Skill 生态 + 审计完善 | 📋 |
- 运行时: Node.js 22+, TypeScript 5.x
- HTTP 框架: Fastify 5
- 数据库: PostgreSQL 16 + pgvector
- 缓存/队列: Redis 7 + BullMQ
- LLM 接入: OpenAI 兼容端点(可配置多厂商)
- 包管理: pnpm workspace (monorepo)
MIT