openclaw-cn-im
v1.2.5
Published
OpenClaw 中国 IM 插件整合版 - 一键安装配置工具
Downloads
456
Maintainers
Readme
openclaw-cn-im
OpenClaw 中国 IM 插件整合版 - 一键安装配置工具
一个用于快速安装和配置 OpenClaw 中国 IM 平台插件的 npm 包,支持飞书、钉钉、企业微信、QQ 机器人、Telegram 等主流平台。
特性
- 🚀 一键安装 - 通过 npm 全局安装,无需 Docker
- 🎯 交互式配置 - 向导式引导,轻松完成配置
- 🔧 插件管理 - 支持多个 IM 平台插件的安装和管理
- 📦 开箱即用 - 预配置最佳实践,快速启动
- 🛠️ 配置管理 - 提供便捷的配置查看和修改工具
- 🔄 服务管理 - 支持前台/后台运行,集成 pm2
安装
全局安装(推荐)
npm install -g openclaw-cn-im本地安装
npm install openclaw-cn-im
npx openclaw-cn-im --help快速开始
1. 初始化配置
openclaw-cn-im init向导会引导你完成:
- ✅ 安装 OpenClaw 核心包
- ✅ 配置 AI 模型(API Key、Base URL 等)
- ✅ 配置 Gateway(端口、Token 等)
- ✅ 选择要安装的 IM 平台插件
2. 安装插件
# 交互式选择插件
openclaw-cn-im install
# 安装指定插件
openclaw-cn-im install feishu dingtalk
# 安装所有插件
openclaw-cn-im install --all支持的插件:
feishu- 飞书 (Feishu/Lark)dingtalk- 钉钉 (DingTalk)wecom- 企业微信 (WeCom)qqbot- QQ 机器人napcat- NapCat (OneBot v11)telegram- Telegram
3. 启动服务
# 前台运行(查看日志)
openclaw-cn-im start
# 后台运行(使用 pm2)
openclaw-cn-im start --daemon4. 管理服务
# 查看状态
openclaw-cn-im status
# 停止服务
openclaw-cn-im stop
# 配置管理
openclaw-cn-im config命令详解
openclaw-cn-im init
初始化 OpenClaw 配置,创建配置文件。
选项:
-f, --force- 强制重新初始化(覆盖现有配置)
示例:
openclaw-cn-im init
openclaw-cn-im init --forceopenclaw-cn-im install [plugins...]
安装 IM 平台插件。
选项:
-a, --all- 安装所有插件
示例:
openclaw-cn-im install # 交互式选择
openclaw-cn-im install feishu dingtalk # 安装指定插件
openclaw-cn-im install --all # 安装所有插件openclaw-cn-im config
配置管理工具。
选项:
-v, --view- 查看当前配置-e, --edit- 编辑配置文件
示例:
openclaw-cn-im config # 交互式配置
openclaw-cn-im config --view # 查看配置
openclaw-cn-im config --edit # 编辑配置openclaw-cn-im start
启动 OpenClaw Gateway。
选项:
-d, --daemon- 后台运行-p, --port <port>- 指定端口
示例:
openclaw-cn-im start # 前台运行
openclaw-cn-im start --daemon # 后台运行
openclaw-cn-im start --port 8080 # 指定端口openclaw-cn-im stop
停止 OpenClaw Gateway(后台服务)。
openclaw-cn-im status
查看服务运行状态。
openclaw-cn-im uninstall
卸载 OpenClaw 及所有插件。
选项:
-k, --keep-config- 保留配置文件
示例:
openclaw-cn-im uninstall # 卸载并删除配置
openclaw-cn-im uninstall --keep-config # 卸载但保留配置配置文件
配置文件位置:~/.openclaw/openclaw.json
最小配置示例
{
"models": {
"providers": {
"default": {
"baseUrl": "https://api.openai.com/v1",
"apiKey": "your-api-key",
"api": "openai-completions",
"models": [{
"id": "gpt-4",
"contextWindow": 200000,
"maxTokens": 8192
}]
}
}
},
"agents": {
"defaults": {
"model": { "primary": "default/gpt-4" }
}
},
"gateway": {
"port": 18789,
"bind": "lan",
"auth": { "token": "your-token" }
},
"channels": {},
"plugins": { "entries": {} }
}IM 平台配置
飞书 (Feishu)
openclaw-cn-im install feishu需要提供:
- App ID
- App Secret
配置权限和事件订阅请参考:飞书配置文档
钉钉 (DingTalk)
openclaw-cn-im install dingtalk需要提供:
- Client ID
- Client Secret
企业微信 (WeCom)
openclaw-cn-im install wecom需要提供:
- Token
- EncodingAESKey
QQ 机器人
openclaw-cn-im install qqbot需要提供:
- App ID
- Client Secret
Telegram
openclaw-cn-im install telegram需要提供:
- Bot Token
推荐配置
推荐模型
推荐使用 Gemini 3 Flash Preview:
- 超大上下文窗口(1M tokens)
- 快速响应速度
- 优秀的性价比
# 初始化时选择
Model ID: gemini-3-flash-preview
Base URL: https://api.example.com/v1
Context Window: 1000000配合 AIClient-2-API
推荐配合 AIClient-2-API 使用,实现无限 Token 调用:
Base URL: http://localhost:3000/v1
API Key: your-api-key常见问题
Q: 安装失败?
检查 Node.js 版本:
node --version # 需要 >= 18.0.0Q: 如何后台运行?
使用 --daemon 选项(需要 pm2):
npm install -g pm2
openclaw-cn-im start --daemonQ: 如何查看日志?
前台运行时直接查看输出。后台运行时:
pm2 logs openclaw-gatewayQ: 如何更新?
npm update -g openclaw-cn-imQ: 配置文件在哪里?
- Linux/macOS:
~/.openclaw/openclaw.json - Windows:
%USERPROFILE%\.openclaw\openclaw.json
Q: 如何卸载?
openclaw-cn-im uninstall
npm uninstall -g openclaw-cn-im开发
本地开发
git clone https://github.com/justlovemaki/OpenClaw-Docker-CN-IM.git
cd OpenClaw-Docker-CN-IM/npm-package
npm install
npm link发布到 npm
npm version patch # 或 minor, major
npm publish相关项目
- OpenClaw - OpenClaw 主项目
- AIClient-2-API - AI 客户端转 API 服务
- OpenClaw-Docker-CN-IM - Docker 版本
许可证
本项目基于 OpenClaw 构建,遵循 GPL-3.0 许可证。
贡献
欢迎提交 Issue 和 Pull Request!
支持
- GitHub Issues: https://github.com/justlovemaki/OpenClaw-Docker-CN-IM/issues
- 文档: https://github.com/justlovemaki/OpenClaw-Docker-CN-IM
如果这个项目对你有帮助,请给我们一个 Star ⭐️
