Skip to content

wechaty/cli

Repository files navigation

wechaty-cli

NPM NPM Version npm (tag) TypeScript ES Modules

wechaty-cli

Terminal Command Line Client (CLI) for Wechaty

Usage

Install from NPM

npm install wechaty-cli

Show version:

$ wechaty-cli --version
0.2.1

Start CLI

wechaty-cli

Install from source

git clone https://github.com/wechaty/cli.git wechaty-cli
cd wechaty-cli
npm start

Build from Dockerfile

git clone https://github.com/wechaty/cli.git wechaty-cli
cd wechaty-cli
docker build -t wechaty-cli .  # this command needs only to be executed once
docker run --rm -it wechaty-cli  # use this command to run wechaty-cli at any time!

Different IM support

The Wechaty community builds separate RPA modules called Wechaty Puppet for different instant messaging (IM) systems (such as WeChat and Whatsapp). wechaty-puppet-wechat is used by default and you can specify wechaty puppet by using the following command to chat on different IM system.

npm install wechaty-puppet-NAME
export WECHATY_PUPPET=wechaty-puppet-NAME
# some puppet requires a token to be set

Debug in VS Code

Debugging with configuration "Launch via NPM", the app will run immediately in the integrated terminal.

To test the app in external terminal, run npm run debug then start debugging with configuration "Attach".

Resources

Wechaty

Similar Projects

Related Projects

History

master v0.2 (Sep 12, 2021)

  1. ESM support

v0.0.1 (Jul 3, 2021)

Init.

Creators

Copyright & License

  • Code & Docs © 2021 Wechaty Contributors https://github.com/wechaty
  • Code released under the Apache-2.0 License
  • Docs released under Creative