[![Wechaty](https://raw.githubusercontent.com/wechaty/wechaty/master/image/wechaty-logo-en.png)](https://github.com/wechaty/wechaty) # Wechaty [![Linux/Mac Build Status](https://img.shields.io/travis/wechaty/wechaty.svg?label=Linux/Mac)](https://travis-ci.org/wechaty/wechaty) [![Win32 Build status](https://img.shields.io/appveyor/ci/zixia/wechaty/master.svg?label=Windows)](https://ci.appveyor.com/project/zixia/wechaty) [![Docker CircleCI](https://img.shields.io/circleci/project/github/wechaty/wechaty.svg?label=Docker)](https://circleci.com/gh/wechaty/wechaty) ## Connecting ChatBots. Wechaty is a Bot Framework for Wechat **Personal** Account that helps you easy creating bot in 6 lines of javascript, with cross-platform support include [Linux](https://travis-ci.org/wechaty/wechaty), [Win32](https://ci.appveyor.com/project/zixia/wechaty), [Darwin(OSX/Mac)](https://travis-ci.org/wechaty/wechaty) and [Docker](https://circleci.com/gh/wechaty/wechaty). :octocat: :beetle: :book: :whale: [![Join the chat at https://gitter.im/zixia/wechaty](https://badges.gitter.im/zixia/wechaty.svg)](https://gitter.im/zixia/wechaty?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [![node](https://img.shields.io/node/v/wechaty.svg?maxAge=2592000)](https://nodejs.org/) [![Repo Size](https://reposs.herokuapp.com/?path=wechaty/wechaty)](https://github.com/wechaty/wechaty) ## Voice of the Developer > @JasLin: it may be the best wechat SDK I have seen in Github! [link](https://github.com/wechaty/wechaty/issues/8#issuecomment-228971491) > @ccaapton: wechaty library fantastic! [link](https://github.com/wechaty/wechaty/issues/9) > @ak5: Thanks for this it's quite cool! [link](https://github.com/wechaty/wechaty/issues/4) > @Samurais: wechaty is great. [link](https://github.com/wechaty/wechaty/issues/36#issuecomment-251708382) > @Jarvis: 目前用过的最好的微信开发库 [link](http://weibo.com/3296245513/Ec4iNp9Ld?type=comment) > @naishstar: thanks for great SDK [link](https://github.com/wechaty/wechaty/issues/57) # Example Your first Wechaty Bot with only 6 lines javascript: ```typescript import Wechaty from 'wechaty' Wechaty.instance() // Singleton .on('scan', (url, code) => console.log(`Scan QrCode to login: ${code}\n${url}`)) .on('login', user => console.log(`User ${user} logined`)) .on('message', message => console.log(`Message: ${message}`)) .init() ``` This bot just log all the message to the console. Source code at [here](https://github.com/wechaty/wechaty/blob/master/example/roger-bot.ts). You can find more example from [Wiki](https://github.com/wechaty/wechaty/wiki/Example) and [Example Directory](https://github.com/wechaty/wechaty/blob/master/example/). # Run [![Docker Pulls](https://img.shields.io/docker/pulls/zixia/wechaty.svg?maxAge=2592000)](https://hub.docker.com/r/zixia/wechaty/) [![Docker Stars](https://img.shields.io/docker/stars/zixia/wechaty.svg?maxAge=2592000)](https://hub.docker.com/r/zixia/wechaty/) [![Docker Layers](https://images.microbadger.com/badges/image/zixia/wechaty.svg)](https://microbadger.com/#/images/zixia/wechaty) Run the above example bot code(`mybot.ts` in this example): ```shell $ alias wechaty='docker run \ -t -i --rm \ -e WECHATY_LOG="$WECHATY_LOG" \ --volume="$(pwd)":/bot \ --name=wechaty \ zixia/wechaty \ ' $ wechaty mybot.ts ``` Know more about Wechaty [Docker](https://github.com/wechaty/wechaty/wiki/Docker). # NPM [![NPM Version](https://badge.fury.io/js/wechaty.svg)](https://badge.fury.io/js/wechaty) [![Downloads][downloads-image]][downloads-url] Install Wechaty by NPM: ```shell npm install --save wechaty ``` # Requirement 1. Javascript ES6(ECMAScript2015) 1. Node.js v6+ 1. Docker(optional) 1. TypeScript(optional) # API Reference ## [Wechaty](https://github.com/wechaty/wechaty/wiki/API#class-wechaty) 1. [init(): Promise<void>](https://github.com/wechaty/wechaty/wiki/API#wechaty-init-promise-void) 1. [instance(setting: PuppetSetting): Promise<Wechaty>](https://github.com/wechaty/wechaty/wiki/API#wechaty-instance-setting-puppetsetting-promise-wechaty) 1. [send(message: Message): Promise<void>](https://github.com/wechaty/wechaty/wiki/API#wechaty-send-message-message-promise-void) 1. [say(content: string): Promise<void>](https://github.com/wechaty/wechaty/wiki/API#wechaty-say-content-string-promise-void) ### [Wechaty Event](https://github.com/wechaty/wechaty/wiki/API#wechaty-event) 1. [error](https://github.com/wechaty/wechaty/wiki/API#wechaty-event-error) 1. [friend](https://github.com/wechaty/wechaty/wiki/API#wechaty-event-friend) 1. [login](https://github.com/wechaty/wechaty/wiki/API#wechaty-event-login) 1. [logout](https://github.com/wechaty/wechaty/wiki/API#wechaty-event-logout) 1. [message](https://github.com/wechaty/wechaty/wiki/API#wechaty-event-message) 1. [room-join](https://github.com/wechaty/wechaty/wiki/API#wechaty-event-room-join) 1. [room-leave](https://github.com/wechaty/wechaty/wiki/API#wechaty-event-room-leave) 1. [room-topic](https://github.com/wechaty/wechaty/wiki/API#wechaty-event-room-topic) 1. [scan](https://github.com/wechaty/wechaty/wiki/API#wechaty-event-scan) ## [Contact](https://github.com/wechaty/wechaty/wiki/API#class-contact) TBW ## [FriendRequest](https://github.com/wechaty/wechaty/wiki/API#class-friendrequest) TBW ## [Message](https://github.com/wechaty/wechaty/wiki/API#class-message) TBW ## [Room](https://github.com/wechaty/wechaty/wiki/API#class-room) TBW ### [Room Event](https://github.com/wechaty/wechaty/wiki/API#room-event) # Test [![Coverage Status](https://coveralls.io/repos/github/wechaty/wechaty/badge.svg?branch=master)](https://coveralls.io/github/wechaty/wechaty?branch=master) [![Code Climate](https://codeclimate.com/github/wechaty/wechaty/badges/gpa.svg)](https://codeclimate.com/github/wechaty/wechaty) [![Issue Count](https://codeclimate.com/github/wechaty/wechaty/badges/issue_count.svg)](https://codeclimate.com/github/wechaty/wechaty) [![Test Coverage](https://codeclimate.com/github/wechaty/wechaty/badges/coverage.svg)](https://codeclimate.com/github/wechaty/wechaty/coverage) Wechaty use ~~[TAP protocol](http://testanything.org/)~~ [AVA](https://github.com/avajs/ava) to test itself ~~by [tap](http://www.node-tap.org/)~~. To test Wechaty, run: ```shell npm test ``` To test with full log messages ```shell $ WECHATY_LOG=silly npm test ``` See more about: * [Details about unit testing](https://github.com/wechaty/wechaty/tree/master/test) * Know more about TAP: [Why I use Tape Instead of Mocha & So Should You](https://medium.com/javascript-scene/why-i-use-tape-instead-of-mocha-so-should-you-6aa105d8eaf4) * [Log](https://github.com/wechaty/wechaty/wiki/Log) * [Debug](https://github.com/wechaty/wechaty/wiki/Debug) # Release Notes [Latest Release](https://github.com/wechaty/wechaty/releases/latest)(All releases [here](https://github.com/wechaty/wechaty/releases)) [CHANGELOG](https://github.com/wechaty/wechaty/blob/master/CHANGELOG) # Todo List - [ ] Events - [ ] Use EventEmitter2 to emit message events so that we can use wildcard 1. `message` 2. `message.recv` 3. `message.sent` 4. `message.recv.image` 5. `message.sent.image` 6. `message.recv.sys` 1. `message.**.image` 1. `message.recv.*` - [ ] Message - [ ] Send/Reply image/video/attachment message - [ ] Save video message to file - [x] Save image message to file # Badge [![Powered by Wechaty](https://img.shields.io/badge/Powered%20By-Wechaty-green.svg)](https://github.com/wechaty/wechaty) Here's how to show the Wechaty Badge on your page: in case you are interested, or you'd like to support Wechaty by show the badge. Appreciate! ## Markdown ```markdown [![Powered by Wechaty](https://img.shields.io/badge/Powered%20By-Wechaty-green.svg)](https://github.com/wechaty/wechaty) ``` ## Html ```html Powered by Wechaty ``` # Contributing Welcome to be a Wechaty Contributer:　[CONTRIBUTING](https://github.com/wechaty/wechaty/blob/master/CONTRIBUTING) # See Also * [RelatedProject](https://github.com/wechaty/wechaty/wiki/RelatedProject) 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 that most of them have more than 400 members. Can you image 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 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. Author ----------------- Zhuohuan LI (http://linkedin.com/in/zixia) profile for zixia at Stack Overflow, Q&A for professional and enthusiast programmers Copyright & License ------------------- * Code & Docs 2016© zixia * Code released under the ISC license * Docs released under Creative Commons [downloads-image]: http://img.shields.io/npm/dm/wechaty.svg?style=flat-square [downloads-url]: https://npmjs.org/package/wechaty