{"id":13495924,"url":"https://github.com/wzpan/wukong-robot","last_synced_at":"2025-05-14T02:04:26.731Z","repository":{"id":38427622,"uuid":"166071450","full_name":"wzpan/wukong-robot","owner":"wzpan","description":"🤖 wukong-robot 是一个简单、灵活、优雅的中文语音对话机器人/智能音箱项目，支持ChatGPT多轮对话能力，还可能是首个支持脑机交互的开源智能音箱项目。","archived":false,"fork":false,"pushed_at":"2024-10-25T08:30:25.000Z","size":10614,"stargazers_count":6822,"open_issues_count":67,"forks_count":1387,"subscribers_count":176,"default_branch":"master","last_synced_at":"2025-05-10T16:01:40.732Z","etag":null,"topics":["ai","alexa","amazon-echo","anyq","asr","bci","chatgpt","google-home","gpt3","homeassistant","muse","openai","raspeberry-pi","snowboy","speaker","tts","unit"],"latest_commit_sha":null,"homepage":"https://wukong.hahack.com/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/wzpan.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":null,"patreon":null,"open_collective":"wukong-robot","ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"custom":["https://wukong.hahack.com/#/donate"]}},"created_at":"2019-01-16T16:19:51.000Z","updated_at":"2025-05-10T09:31:22.000Z","dependencies_parsed_at":"2024-03-15T04:01:14.110Z","dependency_job_id":"543a1c7d-651f-4f82-8054-738978db5845","html_url":"https://github.com/wzpan/wukong-robot","commit_stats":{"total_commits":536,"total_committers":24,"mean_commits":"22.333333333333332","dds":0.1324626865671642,"last_synced_commit":"3fd73e075bc3fb22a36191f5e656c52aebcc6834"},"previous_names":[],"tags_count":93,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wzpan%2Fwukong-robot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wzpan%2Fwukong-robot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wzpan%2Fwukong-robot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wzpan%2Fwukong-robot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/wzpan","download_url":"https://codeload.github.com/wzpan/wukong-robot/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253459928,"owners_count":21912129,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ai","alexa","amazon-echo","anyq","asr","bci","chatgpt","google-home","gpt3","homeassistant","muse","openai","raspeberry-pi","snowboy","speaker","tts","unit"],"created_at":"2024-07-31T19:01:39.775Z","updated_at":"2025-05-14T02:04:26.706Z","avatar_url":"https://github.com/wzpan.png","language":"Python","funding_links":["https://opencollective.com/wukong-robot","https://wukong.hahack.com/#/donate","https://opencollective.com/wukong-robot/contribute/tier/8131-sponsor"],"categories":["Python","A01_文本生成_文本对话","AI **工具**","Chatbots","开源项目"],"sub_categories":["大语言对话模型及数据","其他"],"readme":"# wukong-robot\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://wukong.hahack.com\" target=\"_blank\"\u003e\n    \u003cimg width=\"128\" src=\"http://hahack-1253537070.file.myqcloud.com/images/wukong-icons/256_256.png\" alt=\"wukong-robot\"\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  wukong-robot 是一个简单、灵活、优雅的中文语音对话机器人/智能音箱项目，目的是让中国的 Maker 和 Haker 们也能快速打造个性化的智能音箱。wukong-robot 还可能是第一个开源的脑机唤醒智能音箱。  \n\u003c/p\u003e\n\u003cp align=\"center\"\u003e\n  截至 2023 年 3 月 31 日，wukong-robot 的安装设备数已超过 13,000 台，唤醒次数累积超过了 700,000 次。\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://github.com/users/wzpan/projects/2/views/1\"\u003e\u003cimg alt=\"wukong-project\" src=\"https://img.shields.io/badge/project-wukong-informational.svg?style=flat-square\"\u003e\u003c/a\u003e\n  \u003ca href=\"https://wukong.hahack.com/#/donate\"\u003e\u003cimg alt=\"捐赠\" src=\"https://img.shields.io/badge/%EF%BF%A5-donate-green.svg?style=flat-square\"\u003e\u003c/a\u003e\n  \u003ca href=\"#\"\u003e\u003cimg alt=\"Python3.7+\" src=\"https://img.shields.io/badge/Python-\u003e=3.7-blue.svg?style=flat-square\"\u003e\u003c/a\u003e\n  \u003ca href=\"https://hub.docker.com/r/wzpan/wukong-robot\"\u003e\u003cimg alt=\"docker-pulls\" src=\"https://img.shields.io/docker/pulls/wzpan/wukong-robot.svg?style=flat-square\u0026colorB=success\"\u003e\u003c/a\u003e\n  \u003ca href=\"https://github1s.com/wzpan/wukong-robot\"\u003e\u003cimg alt=\"browse-code\" src=\"https://img.shields.io/badge/browse-code-purple.svg?style=flat-square\"\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://opencollective.com/wukong-robot/contribute/tier/8131-sponsor\" target=\"_blank\"\u003e\u003cimg src=\"https://opencollective.com/wukong-robot/sponsors.svg?avatarHeight=36\"\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n## Table of Contents\n\n* [特性](#特性)\n* [Demo](#demo)\n* [环境要求](#环境要求)\n* [安装](#安装)\n* [升级](#升级)\n* [运行](#运行)\n* [配置](#配置)\n* [技能插件](#插件)\n* [API接口](#api-接口)\n* [捐赠](#捐赠)\n* [贡献](#贡献)\n* [引用](#引用)\n* [联系](#联系)\n* [感谢](#感谢)\n* [FAQ](#faq)\n* [免责声明](#免责声明)\n\n## 特性\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://wzpan-1253537070.cos.ap-guangzhou.myqcloud.com/wukong/wukong-robot-3.3.0.png\" alt=\"wukong-robot\"\u003e\n\u003c/p\u003e\n\n* 模块化。功能插件、语音识别、语音合成、对话机器人都做到了高度模块化，第三方插件单独维护，方便继承和开发自己的插件。\n* 中文支持。集成百度、科大讯飞、阿里、腾讯、OpenAI Whisper、Apple、微软Edge、VITS声音克隆TTS 等多家中文语音识别和语音合成技术，且可以继续扩展。\n* 对话机器人支持。支持基于 [AnyQ](https://wukong.hahack.com/#/anyq) 的本地对话机器人，并支持接入图灵机器人、ChatGPT 等在线对话机器人。\n* 全局监听，离线唤醒。支持 [Porcupine](https://github.com/Picovoice/porcupine) 和 [snowboy](https://github.com/Kitt-AI/snowboy) 两套离线语音指令唤醒引擎，并支持 Muse [脑机唤醒](https://wukong.hahack.com/#/bci) 以及行空板摇一摇唤醒等其他唤醒方式。\n* 灵活可配置。支持定制机器人名字，支持选择语音识别和合成的插件。\n* 智能家居。支持和 [小爱音箱](https://wukong.hahack.com/#/linkage)、[Siri](https://wukong.hahack.com/#/linkage)、mqtt、[HomeAssistant](https://wukong.hahack.com/#/smarthome) 等智能家居协议联动，支持语音控制智能家电。\n* 后台配套支持。提供配套后台，可实现远程操控、修改配置和日志查看等功能。\n* 开放API。可利用后端开放的API，实现更丰富的功能。\n* 安装简单，支持更多平台。相比 dingdang-robot ，舍弃了 PocketSphinx 的离线唤醒方案，安装变得更加简单，代码量更少，更易于维护并且能在 Mac 以及更多 Linux 系统中运行。\n\nwukong-robot 的功能还在不断更新迭代中，详见 [更新说明](https://github.com/wzpan/wukong-robot/wiki/update-notes) 。\n\nwukong-robot 的工作模式：\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://wzpan-1253537070.cos.ap-guangzhou.myqcloud.com/wukong/wukong-robot-workflow.png\" alt=\"wukong-robot 的工作模式\"\u003e\n\u003c/p\u003e\n\nwukong-robot 被唤醒后，用户的语音指令先经过 ASR 引擎进行 ASR 识别成文本，然后对识别到的文本进行 NLU 解析，再将解析结果进行技能匹配，交给适合处理该指令的技能插件去处理。插件处理完成后，得到的结果再交给 TTS 引擎合成成语音，播放给用户。\n\n虽然一次交互可能包含多次网络请求，不过带来的好处是：每一个环节都可以被修改和定制。而且我认为，到了 5G 时代，音箱的响应速度将不再成为体验问题。可定制和个性化才是未来的主流，而届时 wukong-robot 将会是更好的选择！\n\n## Demo\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://wzpan-1253537070.cos.ap-guangzhou.myqcloud.com/wukong/user-demo.jpg\" alt=\"demo\"\u003e\n\u003c/p\u003e\n\n* Demo视频：\n  - [wukong-robot + ChatGPT 实现支持流式对话的智能音箱（一分半钟）](https://www.bilibili.com/video/BV1Bh411g7t2)\n  - [粉丝向定制版，演示对话+音乐+开放API+智能家居（五分钟）](https://www.bilibili.com/video/av50685517/)\n  - [使用脑机唤醒 wukong-robot](https://www.bilibili.com/video/av76739580/)\n  - [Google AIY Voice Kit + wukong-robot](https://www.bilibili.com/video/av81173082/)\n  - [Siri 联动 wukong-robot + ChatGPT](https://www.bilibili.com/video/BV1yY4y1y7oW)\n  - [小爱同学联动 wukong-robot](https://www.bilibili.com/video/BV1eg4y1b75Y)\n  - [教程：基于树莓派\u0026wukong-robot\u0026VITS的AI泠鸢开源智能音箱的初步实现（by @二维环状无限深势阱）](https://www.bilibili.com/video/BV1Sc411K7dv)\n  - [教程：实现一个虚拟管家：贾维斯(by @Echo）](https://zhuanlan.zhihu.com/p/655865035)\n* 后台管理端 Demo\n  - 体验地址：https://bot.hahack.com  （体验用户名：wukong；体验密码：wukong@2019）\n\n## 环境要求 ##\n\n### Python 版本 ###\n\nwukong-robot 只支持 Python \u003e= 3.7 且 \u003c 3.10 ，不支持 Python 2.x 。\n\n### 设备要求 ###\n\nwukong-robot 支持运行在以下的设备和系统中：\n\n* Intel Chip Mac (不支持 M1 芯片)\n* 64bit Ubuntu（12.04 and 14.04）\n* 全系列的树莓派（Raspbian 系统）\n* Pine 64 with Debian Jessie 8.5（3.10.102）\n* Intel Edison with Ubilinux （Debian Wheezy 7.8）\n* 装有 WSL（Windows Subsystem for Linux） 的 Windows\n\n## 安装 ##\n\n见 [wukong-robot 安装教程](https://wukong.hahack.com/#/install) 。\n\n## 升级\n\n``` bash\npython3 wukong.py update\n```\n\n如果提示升级失败，可以尝试在 wukong-robot 的根目录手动执行以下命令，看看问题出在哪。\n\n``` sh\ngit pull\npip3 install -r requirements.txt\n```\n\n## 运行 ##\n\n``` bash\npython3 wukong.py\n```\n\n建议在 [tmux](http://blog.jobbole.com/87278/) 或 supervisor 中执行。\n\n第一次启动时将提示你是否要到用户目录下创建一个配置文件，输入 `y` 即可。\n\n然后通过唤醒词 “snowboy” 唤醒 wukong-robot 进行交互（该唤醒词可自定义）。\n\n此外，wukong-robot 默认在运行期间还会启动一个后台管理端，提供了远程对话、查看修改配置、查看 log 等能力。\n\n- 默认地址：http://localhost:5001\n- 默认账户名：wukong\n- 默认密码：wukong@2019\n\n建议正式使用时修改用户名和密码，以免泄漏隐私。\n\n## 配置 ##\n\n参考[配置文件的注释](https://github.com/wzpan/wukong-robot/blob/master/static/default.yml)进行配置即可。注意不建议直接修改 default.yml 里的内容，否则会给后续通过 `git pull` 更新带来麻烦。你应该拷贝一份放到 `$HOME/.wukong/config.yml` 中，或者在运行的时候按照提示让 wukong-robot 为你完成这件事。\n\n\u003e tips：不论使用哪个厂商的API，都建议注册并填上自己注册的应用信息，而不要用默认的配置。这是因为这些API都有使用频率和并发数限制，过多人同时使用会影响服务质量。\n\n## 技能插件 ##\n\n* [官方插件列表](https://wukong.hahack.com/#/official)\n* [用户贡献插件](https://wukong.hahack.com/#/contrib)\n\n## API 接口 ##\n\nwukong-robot 的后台接口是开放 Web API 的，可以使用 Restful 方式调用，见 [后台API](https://wukong.hahack.com/#/api)。\n\n## 捐赠\n\n您的捐赠将鼓励我继续完善 wukong-robot。\n\n* 对于个人用户，可以使用支付宝或者微信进行捐赠，单笔超过 100 元的捐赠者，您的 ID 将可以出现在 wukong-robot 后台管理端的捐赠页面中。\n\n \n| 支付宝 | 微信支付 |\n| ------ | --------- |\n| \u003cimg src=\"http://hahack.com/images/misc/alipay.png\" height=\"248px\" width=\"164px\" title=\"支付宝\" style=\"display:inherit;\"/\u003e | \u003cimg src=\"http://hahack.com/images/misc/wechatpay.jpeg\" height=\"248px\" width=\"164px\" title=\"微信支付\" style=\"display:inherit;\"/\u003e |\n\n如果以上的图裂了，可以下载图片（[支付宝](http://hahack.com/images/misc/alipay.png) | [微信](http://hahack.com/images/misc/wechatpay.jpeg)）到本地进行扫描。\n\n* 对于企业用户，建议[成为这个项目的 backer](https://opencollective.com/wukong-robot/contribute/tier/8131-sponsor)，您将可以把一个带链接的 logo 放在 wukong-robot 后台管理端的首页、捐赠页面以及 Github 项目首页中。\n\n\u003cp\u003e\n  \u003ca href=\"https://opencollective.com/wukong-robot/sponsor/0/website\" target=\"_blank\"\u003e\u003cimg src=\"https://opencollective.com/wukong-robot/sponsor/0/avatar.svg\"\u003e\u003c/a\u003e\n\u003ca href=\"https://opencollective.com/wukong-robot/sponsor/1/website\" target=\"_blank\"\u003e\u003cimg src=\"https://opencollective.com/wukong-robot/sponsor/1/avatar.svg\"\u003e\u003c/a\u003e\n\u003ca href=\"https://opencollective.com/wukong-robot/sponsor/2/website\" target=\"_blank\"\u003e\u003cimg src=\"https://opencollective.com/wukong-robot/sponsor/2/avatar.svg\"\u003e\u003c/a\u003e\n\u003ca href=\"https://opencollective.com/wukong-robot/sponsor/3/website\" target=\"_blank\"\u003e\u003cimg src=\"https://opencollective.com/wukong-robot/sponsor/3/avatar.svg\"\u003e\u003c/a\u003e\n\u003ca href=\"https://opencollective.com/wukong-robot/sponsor/4/website\" target=\"_blank\"\u003e\u003cimg src=\"https://opencollective.com/wukong-robot/sponsor/4/avatar.svg\"\u003e\u003c/a\u003e\n\u003ca href=\"https://opencollective.com/wukong-robot/sponsor/5/website\" target=\"_blank\"\u003e\u003cimg src=\"https://opencollective.com/wukong-robot/sponsor/5/avatar.svg\"\u003e\u003c/a\u003e\n\u003ca href=\"https://opencollective.com/wukong-robot/sponsor/6/website\" target=\"_blank\"\u003e\u003cimg src=\"https://opencollective.com/wukong-robot/sponsor/6/avatar.svg\"\u003e\u003c/a\u003e\n\u003ca href=\"https://opencollective.com/wukong-robot/sponsor/7/website\" target=\"_blank\"\u003e\u003cimg src=\"https://opencollective.com/wukong-robot/sponsor/7/avatar.svg\"\u003e\u003c/a\u003e\n\u003ca href=\"https://opencollective.com/wukong-robot/sponsor/8/website\" target=\"_blank\"\u003e\u003cimg src=\"https://opencollective.com/wukong-robot/sponsor/8/avatar.svg\"\u003e\u003c/a\u003e\n\u003ca href=\"https://opencollective.com/wukong-robot/sponsor/9/website\" target=\"_blank\"\u003e\u003cimg src=\"https://opencollective.com/wukong-robot/sponsor/9/avatar.svg\"\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n## 贡献\n\n* 喜欢本项目请先打一颗星；\n* 提 bug 请到 [issue 页面](https://github.com/wzpan/wukong-robot/issues)；\n* 要贡献代码，欢迎 fork 之后再提 pull request；\n* 插件请提交到 [wukong-contrib](https://github.com/wzpan/wukong-contrib) ；\n\n\n## 引用\n\n如果使用本项目的代码或插件，请引用本项目。\n\n```\n@misc{wukong-robot,\n  author = {潘伟洲},\n  title = {wukong-robot，一个简单、灵活、优雅的中文语音对话机器人/智能音箱项目},\n  year = {2019},\n  publisher = {GitHub},\n  journal = {GitHub repository},\n  howpublished = {\\url{https://github.com/wzpan/wukong-robot}},\n}\n```\n\n\n## 联系\n\n* wukong-robot 的主要开发者是 [潘伟洲](http://hahack.com) 。\n* QQ 频道（推荐）：\n\n使用 QQ 扫码加入：\n\n![](https://wzpan-1253537070.cos.ap-guangzhou.myqcloud.com/misc/wukong-guild-qrcode-256.png)\n\n* QQ 群：580447290（人数将满，为控制人数，需付费20元入群。微信或支付宝支付后，申请入群时贴上转账单号即可。**群收入的前一万元已无偿捐赠给[壹基金等公益项目](https://hahack-1253537070.cos.ap-chengdu.myqcloud.com/images/donate.png)**）。\n\n| 支付宝 | 微信支付 |\n| ------ | --------- |\n| \u003cimg src=\"http://hahack.com/images/misc/alipay.png\" height=\"248px\" width=\"164px\" title=\"支付宝\" style=\"display:inherit;\"/\u003e | \u003cimg src=\"http://hahack.com/images/misc/wechatpay.jpeg\" height=\"248px\" width=\"164px\" title=\"微信支付\" style=\"display:inherit;\"/\u003e |\n\n如果以上的图裂了，可以下载图片（[支付宝](http://hahack.com/images/misc/alipay.png) | [微信](http://hahack.com/images/misc/wechatpay.jpeg)）到本地进行扫描。\n\n## 感谢\n\n* 悟空的前身是 [dingdang-robot](https://github.com/dingdang-robot/dingdang-robot) 项目和 [jasper-client](https://github.com/jasperproject/jasper-client) 项目。感谢 [Shubhro Saha](http://www.shubhro.com/), [Charles Marsh](http://www.crmarsh.com/) and [Jan Holthuis](http://homepage.ruhr-uni-bochum.de/Jan.Holthuis/) 在 Jasper 项目上做出的优秀贡献；\n* 感谢三咲智子提供了备选的后台管理端 Demo 体验地址。\n* 感谢 aliciacai 贡献的 wukong-robot 图标。\n* 感谢所有为[本项目](https://github.com/wzpan/wukong-robot/graphs/contributors)、 [wukong-contrib](https://github.com/wzpan/wukong-contrib/graphs/contributors) 项目以及[dingdang-robot](https://github.com/dingdang-robot/dingdang-robot/graphs/contributors) 项目做出过贡献的人！\n\n## Star 历史\n\n[![Star History Chart](https://api.star-history.com/svg?repos=wzpan/wukong-robot\u0026type=Date)](https://star-history.com/#wzpan/wukong-robot\u0026Date)\n\n## 免责声明\n\n* wukong-robot 只用作个人学习研究，如因使用 wukong-robot 导致任何损失，本人概不负责。\n* 本开源项目与腾讯叮当助手及优必选悟空项目没有任何关系。\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwzpan%2Fwukong-robot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwzpan%2Fwukong-robot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwzpan%2Fwukong-robot/lists"}