@xopcai/xopcbot
v0.2.1
Published
Ultra-Lightweight Personal AI Assistant - Node.js + TypeScript
Maintainers
Readme
🐈 xopcbot: 超轻量级个人 AI 助手
✨ xopcbot 能做什么?
xopcbot 是运行在本地 的个人 AI 助手,可以帮助你:
| 使用场景 | 示例 | |----------|------| | 编程助手 | 调试代码、解释代码片段、编写函数 | | 任务自动化 | 使用 cron 设置定时任务 | | 文件操作 | 在工作区中搜索、读取、编辑文件 | | 网络搜索 | 搜索网页并总结结果 | | 多渠道聊天 | 通过 Telegram、WhatsApp、飞书或网页 UI 交流 |
# 在终端中交互式聊天
xopcbot agent -i
# 或发送单条消息
xopcbot agent -m "解释这段代码:function foo() { return 42; }"
# 让 xopcbot 帮你处理 git 任务
xopcbot agent -m "查看最近的提交并创建 PR 摘要"🚀 快速开始
1️⃣ 安装
# 从 npm 安装(推荐)
npm install -g @xopcai/xopcbot
# 或从源码构建
git clone https://github.com/xopcai/xopcbot.git
cd xopcbot && npm install && npm build2️⃣ 配置(交互式向导)
xopcbot onboard
# 或: npm run dev -- onboard向导会引导你完成:
- 选择喜欢的 AI 模型(支持 20+ 提供商)
- 配置 API 密钥
- 设置聊天渠道(Telegram、WhatsApp 等)
提示: 使用
xopcbot onboard --quick可快速设置模型。
3️⃣ 开始聊天!
# 交互式聊天模式
xopcbot agent -i
# 或使用特定渠道
xopcbot agent -m "你好!" --channel telegram --chat-id 123456📖 文档
| 指南 | 描述 | |------|------| | 快速开始 | 安装和基本用法 | | 配置 | 完整配置参考 | | CLI 参考 | 所有可用命令 | | 渠道 | Telegram、WhatsApp、飞书设置 | | 工具 | 内置工具参考 |
🔌 支持的渠道
| 渠道 | 状态 | 安装 |
|------|------|------|
| Telegram | ✅ | 设置指南 |
| WhatsApp | ✅ | 设置指南 |
| 飞书/Lark | ✅ | 设置指南 |
| 网页 UI | ✅ | 内置,运行 xopcbot gateway 即可 |
🛠️ 开发
# 开发模式(热重载)
npm run dev
# 构建生产版本
npm run build
# 运行测试
npm test
# 代码检查
npm run lint🙏 致谢
- 灵感来自 OpenClaw
- LLM 提供商基于 @mariozechner/pi-ai
