项目预览
项目数据
项目介绍
Star 增长趋势
本站每日记录该项目 GitHub 星标变化,观测越久曲线越完整
数据来源:GitHub API 逐日快照 · 收录于 2026-08-09 · 当前星标 ★ 6601
使用教程
环境要求
- Node.js 18 或更高版本(v6 强制要求)
- npm 包管理器(随 Node.js 一起安装)
- 可访问 WhatsApp Web 的网络环境
- 一个可用于扫码登录的 WhatsApp 账号(手机端保持联网)
安装与启动步骤
-
1确认 Node 版本
Venom v6 要求 Node.js 18+,先检查本机版本,低于 18 需先升级再继续。
node -v -
2初始化项目
在空目录中生成 package.json,避免把依赖装到全局或上级目录。
npm init -y -
3安装 venom-bot
从 npm 安装主包,安装过程中会自动下载 Chromium,网络慢时请耐心等待。
npm install venom-bot -
4编写快速上手脚本
新建入口文件写入 README 示例:create 建会话,onMessage 里用 sendText 回复 hello。
import { create } from 'venom-bot'; create({ session: 'venom-bot' }).then((client) => { client.onMessage(async (message) => { if (message.body === 'hello') { await client.sendText(message.from, "Hey there! I'm running on Venom."); } }); }); -
5运行并扫码登录
用 node 执行入口文件,终端会打印二维码,用手机 WhatsApp 扫码即可上线。
node index.js -
6验证会话持久化
登录后 token 自动保存,重启脚本无需重新扫码;可在 options.folderNameToken 查看存储目录。
关键配置
| 配置项 | 必填 | 说明 | 示例 |
|---|---|---|---|
session | 是 | 会话名称,决定 token 存储标识,多会话场景用不同名字 | venom-bot |
catchQR | 否 | 二维码回调,可拿到 base64、ASCII 二维码与扫码尝试次数 | (base64Qr, asciiQR, attempts, urlCode) => { console.log(atte |
statusFind | 否 | 监听连接状态变化,如 isLogged、notLogged、successChat | (status, session) => { console.log(status) } |
options.headless | 否 | 是否无头运行浏览器;调试时可设为 false 看到界面 | 'new' |
options.folderNameToken | 否 | 存放登录 token 的目录名,删除该目录等于退出登录 | tokens |
options.autoClose | 否 | 无操作自动关闭浏览器的毫秒数,0 表示不自动关闭 | 60000 |
如何确认成功
终端出现二维码,扫码后 statusFind 打印 successChat/isLogged,向机器人发送 hello 能收到回复即成功。
常见问题
Q:每次重启脚本都要重新扫码吗?
A:不需要。README 明确说明会话会自动保存,下次启动直接复用 token,除非手动删除 token 目录或退出登录。
Q:安装时提示 Node 版本不满足怎么办?
A:Venom v6 要求 Node.js 18+,请升级 Node 后重新执行 npm install venom-bot,低版本无法运行。
Q:需要自己下载 Chromium 吗?
A:不需要,README 写明 npm install 时会自动下载 Chromium,无需再安装 puppeteer-extra 或隐身插件。
Q:可以安装 nightly 或源码版本吗?
A:可以。nightly:npm install https://github.com/orkestral/venom/releases/download/nightly/venom-bot-nightly.tgz ;源码:npm install github:orkestral/venom。
注意事项
- Venom 基于非官方 WhatsApp Web 协议,存在账号被风控或封禁的风险,建议使用小号测试。
- 扫码登录后 token 会持久化保存,请勿把 token 目录提交到公开仓库。
- 生产环境建议通过 options.browserPathExecutable、addProxy 等按需定制浏览器与代理配置。
- 使用 AI 能力(如 NLP 识别)需在业务层自行接入,README 未提供内置 AI 服务端点。
核心亮点
- API 简洁易用,文档齐全,上手快
- 基于 Puppeteer,无需官方 API 即可实现丰富功能
- 支持多会话和消息队列,适合生产级部署
不足之处
- 依赖非官方 Web 接口,账号存在被封锁风险
- Puppeteer 资源占用较高,大规模部署成本大
- 文档/社区待观察
适用场景
- 客服自动回复与工单分流
- 营销消息群发与用户互动
- 个人助理或群管理机器人
替代项目
whatsapp-web.js、Baileys、WPPConnect
上一篇:aidea
下一篇:Red-DiscordBot
同类项目推荐
RWKV_APP
开源
一个应用,全平台离线跑 RWKV 聊天
Cross-platform, local-first RWKV chat built with Flutter for Android, iOS, Windows, ···
dialogflow-web-v2
开源
给网站快速加一个带富文本的 Dialogflow 聊天框
Dialogflow Web Integration. Supports rich components
WeChatMsg
开源
一键导出微信聊天记录,喂给大模型做分析
whatsapp-chatgpt-bot
开源
给WhatsApp装上AI大脑,支持图文语音,自动回复客户。
Ready-to-use AI Multimodal ChatGPT-based WhatsApp chatbot assistant for your busines···
twurple
开源
一站式搞定 Twitch 开发:API、聊天、事件订阅全打通
Interact with Twitch's API, chat and subscribe to events via PubSub and EventSub.
halbot
开源
在 Telegram 里一键接入多种 AI 对话能力
Just another AI powered Telegram bot, which is simple design, easy to use, extendabl···
Magento-Chatbot
开源
给 Magento 店铺装上多平台聊天机器人,自动回复省人力
Magento Chatbot Integration with Telegram, Messenger, Whatsapp, WeChat, Skype and wi···
open-webui
开源
给本地模型配个漂亮聊天室,全家都能用
User-friendly AI Interface (Supports Ollama, OpenAI API, ...)
WatBot
开源
用 IBM Watson 给安卓 App 加上能听会说的聊天机器人
An Android ChatBot powered by IBM Watson Services (Assistant V1, Text-to-Speech, and···
