Skip to content

Eduiskss/learn-clawbot

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

🦞 Moltbot学习资料库

深度学习Moltbot项目的完整中文资料

GitHub 文档

📚 仓库介绍

这是一个专门用于学习Moltbot项目的中文资料库。

Moltbot 是一个个人AI助手网关系统,它将多种消息平台(WhatsApp、Telegram、Discord等)统一接入,通过Gateway作为中央控制平面,使用Pi Agent作为AI智能体核心。

本仓库包含:

  • ✅ 完整的项目初始化文档
  • ✅ 深度技术架构剖析
  • ✅ 快速开始指南
  • ✅ Python开发者专用指南
  • ✅ TypeScript ↔ Python对照表
  • ✅ 完整的代码示例

总计43,000+字,50+代码示例,适合Python/LangGraph开发者学习!


🎯 适合人群

  • ✅ Python开发者想学习TypeScript项目
  • ✅ 使用过LangGraph/LangChain的开发者
  • ✅ 想深度理解Agent系统实现
  • ✅ 计划用Python复现类似功能
  • ✅ 对AI助手架构感兴趣的开发者

📖 文档列表

🚀 QUICK_START_ZH.md - 快速开始指南

阅读时间: 30分钟 | 字数: 5,000字

从零开始,30分钟内运行Moltbot!

内容:

  • 环境搭建和安装
  • 配置Telegram Bot
  • 发送第一条AI消息
  • 常见问题排查
  • 学习路径建议

适合: 所有人,新手必读


📖 PROJECT_INIT_ZH.md - 项目初始化文档 ⭐

阅读时间: 2-3小时 | 字数: 15,000字

核心学习文档,全面理解Moltbot!

内容:

  1. 项目概览(定位、规模、非核心标记)
  2. 核心架构(完整架构图、数据流)
  3. 技术栈分析(依赖对照表)
  4. 核心模块深度解析
    • Gateway模块(WebSocket服务器)
    • Agents模块(Pi Agent运行时)
    • Channels模块(消息平台适配)
    • CLI模块(命令行接口)
  5. Agent系统实现
    • Pi Agent集成
    • 工具系统
    • 会话管理
    • 沙箱执行
  6. 与Python/LangGraph对比
  7. 学习路线图(初级/中级/高级)
  8. Python复现指南

适合: 深度学习者、准备开发、计划Python复现


🏗️ ARCHITECTURE_DEEP_DIVE_ZH.md - 架构深度剖析

阅读时间: 3-4小时 | 字数: 12,000字

深入实现细节,掌握核心技术!

内容:

  1. 数据流分析(完整流向图)
  2. 消息处理流程(队列机制)
  3. Gateway协议详解(RPC方法、事件推送)
  4. Agent执行机制(系统提示词生成)
  5. 会话持久化(存储策略)
  6. 工具调用链路(Bash/Browser工具实现)
  7. 安全机制(DM配对、沙箱隔离)
  8. 性能优化策略(连接池、批处理、缓存)

适合: 高级开发者、性能优化、二次开发


🐍 PYTHON_DEVELOPER_GUIDE_ZH.md - Python开发者指南 ⭐

阅读时间: 2小时 | 字数: 8,000字

专为Python开发者设计,TypeScript无缝转Python!

内容:

  1. 概念映射表
    • 语言特性对照(interface ↔ Protocol)
    • 标准库对照(fs ↔ pathlib)
    • 第三方库对照(commander ↔ typer)
  2. 代码对照示例
    • 类型定义
    • 异步函数
    • WebSocket服务器
    • HTTP API服务器
  3. 核心模块Python实现
    • Gateway服务器(完整代码)
    • Channel适配器(Telegram示例)
    • Agent执行器(LangGraph集成)
    • 会话管理器
  4. 最小可行实现(200行完整Python代码)
  5. 学习资源推荐

适合: Python开发者、LangGraph用户、TypeScript→Python


📚 README_DOCS_ZH.md - 文档导航索引

阅读时间: 20分钟 | 字数: 3,000字

学习路线规划,选择最适合你的路径!

内容:

  • 快速导航表
  • 每个文档的详细介绍
  • 3条推荐学习路径
    • 快速体验路径
    • 深度学习路径
    • Python复现路径
  • 学习目标检查清单
  • 补充学习资源

适合: 所有人,开始前必读


🎓 推荐学习路径

路径1: 快速体验 (适合所有人)

Day 1: QUICK_START_ZH.md (30分钟)
  → 运行Moltbot,发送第一条消息

Day 2-3: PROJECT_INIT_ZH.md (第1-3章)
  → 理解整体架构

Day 4-7: 探索和实践
  → 使用各种功能,阅读配置文档

路径2: 深度学习 (适合深度学习者)

Week 1:
  - QUICK_START_ZH.md (运行起来)
  - PROJECT_INIT_ZH.md (完整阅读)
  - 浏览源码结构

Week 2:
  - ARCHITECTURE_DEEP_DIVE_ZH.md
  - 阅读关键源码文件
  - 理解数据流和协议

Week 3-4:
  - 开发简单扩展
  - 实现自定义Tool
  - 创建Skill包

路径3: Python复现 (适合Python开发者)

Week 1:
  - QUICK_START_ZH.md (运行TS版本)
  - PYTHON_DEVELOPER_GUIDE_ZH.md (理解映射)
  - PROJECT_INIT_ZH.md (理解架构)

Week 2:
  - ARCHITECTURE_DEEP_DIVE_ZH.md (实现细节)
  - 搭建Python开发环境
  - 设计Python架构

Week 3-4:
  - 实现基础Gateway
  - 实现Telegram适配器
  - 集成LangGraph
  - 实现核心Tool

📊 文档统计

指标 数值
文档总数 5份
总字数 43,000+
代码示例 50+
架构图 10+
对照表 15+
学习路线 3条

🔑 核心概念速查

概念 说明 Python对应
Gateway WebSocket控制中心 FastAPI + websockets
Channel 消息平台适配器 协议适配器模式
Agent AI智能体(Pi) LangGraph + LangChain
Session 会话隔离机制 conversation_id
Tool 可调用的功能函数 LangChain Tool
Skill 可安装的功能包 Tool集合
Hook 事件驱动钩子 中间件/回调
Sandbox 沙箱执行环境 Docker容器

🚀 快速开始

1. 克隆仓库

git clone https://github.com/Eduiskss/learn-clawbot.git
cd learn-clawbot

2. 选择文档开始阅读

# 快速开始(新手)
QUICK_START_ZH.md

# 全面学习(推荐)
PROJECT_INIT_ZH.md

# Python开发者
PYTHON_DEVELOPER_GUIDE_ZH.md

# 深入细节
ARCHITECTURE_DEEP_DIVE_ZH.md

3. 运行原项目

按照 QUICK_START_ZH.md 指引安装和运行Moltbot。


✅ 学习目标检查

完成学习后,你应该能够:

理解层面

  • 理解Moltbot的整体架构
  • 理解Gateway/Agent/Channel的作用
  • 理解消息处理的完整流程
  • 理解会话管理和工具系统
  • 理解安全和沙箱机制

技能层面

  • 能配置和运行Moltbot
  • 能开发自定义Tool
  • 能创建Skill包
  • 能添加新的Channel适配器
  • 能看懂TypeScript代码

Python复现

  • 能将TypeScript代码转换为Python
  • 能用FastAPI实现Gateway
  • 能用LangGraph实现Agent
  • 能实现核心功能的Python版本

🔗 相关资源

官方资源

技术栈学习

Python异步编程


💡 学习建议

  1. 先实践,后理论

    • 先运行起来(QUICK_START)
    • 再深入理解(PROJECT_INIT)
    • 最后掌握细节(ARCHITECTURE_DEEP_DIVE)
  2. 循序渐进

    • 不要一次性读完所有文档
    • 边读边实践
    • 遇到不懂的概念先跳过
  3. 做好笔记

    • 记录关键概念
    • 画出架构图
    • 总结核心代码
  4. 动手实践

    • 修改配置文件
    • 开发简单扩展
    • 实现Python版本

🤝 贡献

欢迎贡献改进建议!

如果你:

  • 发现文档错误
  • 有改进建议
  • 想分享学习心得
  • 添加更多示例

请:

  • 提交Issue
  • 发起Pull Request
  • 分享你的学习笔记

📝 更新日志

v1.0 (2026-01-28)

  • ✅ 初始发布
  • ✅ 5份完整文档(43,000+字)
  • ✅ 50+代码示例
  • ✅ 3条学习路径
  • ✅ TypeScript ↔ Python完整对照

📄 许可证

本学习资料采用 MIT License

Moltbot项目本身也采用 MIT License


⭐ 如果这些资料对你有帮助

  • ⭐ Star这个仓库
  • 🔄 Fork并添加你的学习笔记
  • 💬 分享给其他学习者
  • 🤝 贡献改进

📮 联系方式

如有问题或建议,欢迎:


开始你的Moltbot学习之旅吧! 🚀

Happy Learning! 祝学习愉快!

About

learn

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors