Getting Started

With just a few lines of code, your application can send and receive messages with WeChat using the Wechaty Puppets for WeChat.

This Quickstart will teach you how to do this using the Wechaty SDK for WeChat, wechaty-puppet-mock, TypeScript. In this Quickstart, you will learn how to:

  1. Install Node.js
  2. Install Wechaty
  3. Start running your first chatbot


  1. Node.js v10 or above
  2. Build Tools for your Platform


0. Install Node.js (>=10)#

If you have not installed Node.js(or version is below 10),You need to install the latest version of Node.js first by following the links below:

Instal Node.js for other platforms can be found at

1. Clone wechaty-getting-started Repository#

git clone
cd wechaty-getting-started

2. Install Dependencies#

npm install

3. Run the Bot#

Notice: Wechaty requires Node.js version >= 10

npm start
# Or use node to run bot directly
node examples/starter-bot.js

You are all set!

You can see the following result after running:


This demo will show all message on the bot.


Wechaty Developers' Home

Scan the following QR Code in WeChat with secret code wechaty, join our Wechaty Developers' Home. This group is only for developers.

Last updated on by Huan