WeChat Bot SDK for Personal Account, Powered by TypeScript, Docker, and 💖
TypeScript Shell JavaScript Dockerfile
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.
.circleci better circlerci steps Jul 3, 2018
.github add search first Aug 19, 2018
.vscode delete eslint because it not be used anymore Jul 1, 2018
bin fix pre-install puppet fail problem Aug 18, 2018
docs update doc Aug 17, 2018
examples upgrade memory card for a better logic Aug 12, 2018
scripts aad room invitation jsdoc (#1510) Jul 27, 2018
src fix #293 Aug 19, 2018
tests lint Jul 26, 2018
.codeclimate.yml make sure the port is not same as orignal Nov 3, 2016
.dockerignore ignore memory-card Aug 10, 2018
.editorconfig merge Apr 19, 2017
.gitignore ignore /*.jpg Jun 13, 2018
.markdownlintrc lint markdown Apr 15, 2018
.travis.yml clean ci config Jun 27, 2018
AUTHORS add @lijiarui to AUTHOR file Dec 5, 2017
CHANGELOG.md update CHANGELOG for v0.20 Aug 18, 2018
CODEOWNERS Split PuppetPuppeteer Out (#1371) Jun 30, 2018
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md (#608) Jun 26, 2017
CONTRIBUTING.md wechaty -> Chatie May 1, 2018
Dockerfile fix docker image Aug 9, 2018
Dockerfile.alpine wechaty -> Chatie May 1, 2018
Dockerfile.onbuild fix chown: invalid user: ‘bot’ (#1089) Feb 4, 2018
LICENSE code clean Apr 20, 2018
README.md Update README.md Aug 18, 2018
TODO.md fix todo Jun 29, 2018
app.json fix heroku deploy config Jun 21, 2018
appveyor.yml fix appveyor win32 ci Jul 11, 2018
package.json 0.21.9 Aug 19, 2018
shippable.yml enable shippable for all version branches Aug 18, 2018
tsconfig.json add some useful typescript v2.9 settings Jun 24, 2018
tslint.json prepare to use tslint:recommend (#1303) Jul 21, 2018
wercker.yml add wercker ci for docker image deploy Mar 19, 2018





Wechaty is a Bot SDK for Wechat Personal Account which can help you create a bot in 6 lines of javascript, with cross-platform support include Linux, Windows, Darwin(OSX/Mac) and Docker.

NPM Version Downloads GitHub stars Docker Pulls TypeScript Greenkeeper badge

:octocat: https://github.com/chatie/wechaty
🐞 https://github.com/chatie/wechaty/issues
📖 https://github.com/chatie/wechaty/wiki
🐳 https://hub.docker.com/r/zixia/wechaty


"Wechaty is a great solution, I believe there would be much more users recognize it." link
-- @Gcaufy, Tencent Engineer, Author of WePY

-- @xinbenlv, Google Engineer, Founder of HaoShiYou.org

"最好的微信开发库" link
-- @Jarvis, Baidu Engineer

"Wechaty让运营人员更多的时间思考如何进行活动策划、留存用户,商业变现" link
-- @lijiarui, CEO of BotOrange.

"If you know js ... try Chatie/wechaty, it's easy to use."
-- @Urinx Uri Lee, Author of WeixinBot(Python)

See more at Wiki:Voice Of Developer

The World's Shortest ChatBot Code: 6 lines of JavaScript

const { Wechaty } = require('wechaty') // import { Wechaty } from 'wechaty'

Wechaty.instance() // Global Instance
.on('scan', (qrcode, status) => console.log(`Scan QR Code to login: ${status}\nhttps://api.qrserver.com/v1/create-qr-code/?data=${encodeURIComponent(qrcode)}`))
.on('login',            user => console.log(`User ${user} logined`))
.on('message',       message => console.log(`Message: ${message}`))

Notice: Wechaty requires Node.js version >= 10

This bot can log all messages to the console after login by scan.

You can find more examples from Wiki and Example Directory.


  1. Node.js 10 or above
  2. Global Network Connection



We have a Wechaty starter repository for beginners with the simplest setting. It will be just work out-of-the-box after you clone & npm install & npm start.

If you are new to Wechaty and want to try it the first time, we'd like to strong recommend you starting from this repository, and using it as your starter template for your project.

Otherwise, please saved the above The World's Shortest ChatBot Code: 6 lines of JavaScript example to a file named mybot.js before you can use either NPM or Docker to run it.

1. NPM

NPM Version npm (tag) Downloads

npm init
npm install wechaty

# create your first mybot.js file, you can copy/paste from the above "The World's Shortest ChatBot Code: 6 lines of JavaScript"
# then:
node mybot.js

2. Docker

Docker Pulls Docker Layers

Wechaty Docker supports both JavaScript and TypeScript. To use TypeScript just write in TypeScript and save with extension name .ts, no need to compile because we use ts-node to run it.

2.1. Run JavaScript

# for JavaScript
docker run -ti --rm --volume="$(pwd)":/bot zixia/wechaty mybot.js

2.2. Run TypeScript

# for TypeScript
docker run -ti --rm --volume="$(pwd)":/bot zixia/wechaty mybot.ts

Learn more about Wechaty Docker at Wiki:Docker.


Ubuntu Linux/Mac Build Status Travis CentOS Linux Build Status CircleCI Windows Build Status Docker Build Status

Coverage Status Known Vulnerabilities

Wechaty is fully automatically tested by unit and integration tests, with Continious Integration & Continious Deliver(CI/CD) support powered by CI like Travis, Shippable and Appveyor.

To test Wechaty, run:

npm test

Get to know more about the tests from Wiki:Tests


In order to sync the doc with the lastest code, we are using jsdoc to describe the API, and use jsdoc-to-markdown to generate markdown format documents to the docs directory.

See: Official API Reference



Powered by Wechaty Donate Wechaty

Wechaty Badge

[![Powered by Wechaty](https://img.shields.io/badge/Powered%20By-Wechaty-blue.svg)](https://github.com/chatie/wechaty)

Get more embed html/markdown code from Wiki:PoweredByWechaty

Projects Using Wechaty

  1. 一个用CNN深度神剧网络给图片评分的wechaty项目
  2. Relay between Telegram and WeChat
  3. A chat bot managing the HaoShiYou wechat groups run by volunteers of haoshiyou.org
  4. An interactive chat bot to manage a TODO list
  5. Forward WeChat messages to telegram

Pull Request is welcome to add yours!

Learn more about Projects Using Wechaty at Wiki:PoweredByWechaty


The best practice for running Wechaty Docker/NPM is using a VPS(Virtual Private Server) outside of China, which can save you hours of time because npm install and docker pull will run smoothly without any problem.

The following VPS providers are used by the Wechaty team, and they worked perfectly in production. You can use the following link to get one in minutes. Also, doing this can support Wechaty because you are referred by us.

Location Price Ram Payment Provider
Singapore $5 512MB Paypal DigitalOcean
Japan $5 1GB Paypal Linode
Korea $10 1GB Alipay, Paypal Netdedi



Issue Stats Issue Stats Join the chat at https://gitter.im/zixia/wechaty

Howto contribute

Contributions in any form are highly encouraged and welcome! Be it new or improved presets, optimized streaming code or just some cleanup. So start forking!

Contributors List


Code Contributions

If you want to add new features or change the API, please submit an issue first to make sure no one else is already working on the same thing and discuss the implementation and API details with maintainers and users by creating an issue. When everything is settled down, you can submit a pull request.

When fixing bugs, you can directly submit a pull request.

Make sure to add tests for your features and bugfixes and update the documentation (see below) before submitting your code!

Documentation Contributions

You can directly submit pull requests for documentation changes.

Join Us

Wechaty is used in many ChatBot projects by hundreds of developers. If you want to talk with other developers, just scan the following QR Code in WeChat with secret code wechaty, join our Wechaty Developers' Home.

Wechaty Developers' Home

Scan now, because other Wechaty developers want to talk with you too! (secret code: wechaty)


Huan LI <zixia@zixia.net>

profile for zixia on Stack Exchange, a network of free, community-driven Q&A sites

My Story

My daily life/work depends on too much chat on wechat.

  • I almost have 14,000 wechat friends in May 2014, before wechat restricts a total number of friends to 5,000.
  • I almost have 400 wechat rooms, and most of them have more than 400 members.

Can you imagine that? I'm dying...

So a tireless bot working for me 24x7 on wechat, monitoring/filtering the most important message is badly needed. For example, it highlights discussion which contains the KEYWORDS which I want to follow up(especially in a noisy room). ;-)

At last, It's built for my personal study purpose of Automatically Testing.


  • Code & Docs © 2016-2018 Huan LI <zixia@zixia.net>
  • Code released under the Apache-2.0 License
  • Docs released under Creative Commons