Wechaty

:hearts: Connecting Chatbots

Wechaty is a RPA (Robotic Process Automation) SDK for Chatbot Makers which can help you create a bot in 6 lines of JavaScript, Python, Go, and Java, with cross-platform support including Linux, Windows, MacOS, and Docker.

:octocat: https://github.com/Wechaty/wechaty
:beetle: https://github.com/Wechaty/wechaty/issues
:book: https://github.com/Wechaty/wechaty/wiki
:whale: https://hub.docker.com/r/wechaty/wechaty

:yum: Voice of Developers

"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, Founder & CEO of Juzi.BOT.

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

"Wechaty is a good project, I hope it can continue! Therefore, I became a contributors in open collective."
— @Simple

See more at Wiki:Voice Of Developer

:raising_hand: Join Us

Wechaty is used in many ChatBot projects by thousands 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.

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

You are also welcome to join our Gitter channel at https://gitter.im/wechaty/wechaty with your GitHub account!

:book: Resource

Wechaty already held lots of talk and got a lot of blogs in the past 4 years, here is all of the wechaty resources:

• :video_camera: Youtube Playlist: Watch all of talk video related with Wechaty
• :page_with_curl: Full Docs
• :bulb: Blog: See how developers use wechaty building fantastic project!
• :beginner: Wechaty-Getting-Started:Wechaty Starter Project Template that Works Out-of-the-Box
• :tada: Wechaty Contributor List: Thanks for their contribution!
• :gift: Juzibot Support Wechaty: Know everything about Wechaty

:rocket: 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://wechaty.js.org/qrcode/${encodeURIComponent(qrcode)}`))
.on('login',            user => console.log(`User ${user} logged in`))
.on('message',       message => console.log(`Message: ${message}`))
.start()

Notice: Wechaty requires Node.js version >= 12

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

You can find Wechaty Official Example at examples/ding-dong-bot.ts, and more from our Example Directory.

:checkered_flag: Requirements

1. Node.js v12
2. sudo apt-get install build-essential && sudo snap install shellcheck

:triangular_flag_on_post: Getting Started

• Wechaty Starter Repository - https://github.com/wechaty/wechaty-getting-started

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 bot.js before you can use either NPM or Docker to run it.

1. Npm

npm init
npm install wechaty

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

2. Docker

• Wechaty Starter Repository for Docker - https://github.com/wechaty/docker-wechaty-getting-started

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 wechaty/wechaty bot.js

2.2. Run TypeScript

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

Learn more about Wechaty Docker at Wiki:Docker.

3. Switch Protocol(Puppet)

Wechaty is very powerful that it can run over different protocols. You can specify the protocol by set the environment variable WECHATY_PUPPET to different puppet provider.

If you cannot use Web protocol, you can apply other protocal following the instruction here: https://github.com/wechaty/wechaty/wiki/Support-Developers We provide free token to support developers build a valuable WeChat chatbot.

Currently we support the following puppet providers :

Learn more about Wechaty Puppet from the Puppet Wiki:

1. Puppet Directory: https://github.com/Wechaty/wechaty-puppet/wiki/Directory
2. Puppet Compatibility: https://github.com/Wechaty/wechaty-puppet/wiki/Compatibility

:guitar: API

Read the Full Documentation at Wechaty Official API Reference

1 Class Wechaty

Main bot class.

A Bot is a Wechaty instance that control a specific wechaty-puppet.

• new Wechaty(options?: WechatyOptions)
  1. options.name?: string the name of this bot(optional)
  2. options.puppet?: string select which puppet provider we want to use. must be one of the:
     1. wechaty-puppet-puppeteer - Angular Hook for Web Wechat <- This is the DEFAULT
     2. wechaty-puppet-wechat4u - HTTP API for Web Wechat
     3. wechaty-puppet-padpro - iPad App Protocol
     4. wechaty-puppet-ioscat - iPhone App Hook
     5. wechaty-puppet-mock - Mock for Testing
  3. options.puppetOptions?: PuppetOptions options for the puppet provider.

2 Class Contact

All wechat contacts(friends/non-friends) will be encapsulated as a Contact.