https://github.com/wechaty/cli
Terminal Client for Wechaty
https://github.com/wechaty/cli
blessed cli wechaty
Last synced: 10 months ago
JSON representation
Terminal Client for Wechaty
- Host: GitHub
- URL: https://github.com/wechaty/cli
- Owner: wechaty
- License: apache-2.0
- Created: 2021-06-19T12:13:22.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2021-12-18T15:52:40.000Z (over 4 years ago)
- Last Synced: 2025-08-09T19:05:06.594Z (10 months ago)
- Topics: blessed, cli, wechaty
- Language: TypeScript
- Homepage: https://npmjs.com/package/wechaty-cli
- Size: 269 KB
- Stars: 3
- Watchers: 3
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# wechaty-cli
[](https://github.com/wechaty/cli/actions/workflows/npm.yml)
[](https://badge.fury.io/js/wechaty-cli)
[](https://www.npmjs.com/package/wechaty-cli?activeTab=versions)
[](https://www.typescriptlang.org/)
[](https://github.com/Chatie/tsconfig/issues/16)
Terminal Command Line Client (CLI) for Wechaty
## Usage
### Install from NPM
```sh
npm install wechaty-cli
```
Show version:
```sh
$ wechaty-cli --version
0.2.1
```
Start CLI
```sh
wechaty-cli
```
### Install from source
```sh
git clone https://github.com/wechaty/cli.git wechaty-cli
cd wechaty-cli
npm start
```
### Build from Dockerfile
```sh
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](https://wechaty.js.org/docs/puppet-providers/) for different instant messaging (IM) systems (such as WeChat and Whatsapp). [wechaty-puppet-wechat](https://github.com/wechaty/wechaty-puppet-wechat) is used by default and you can specify wechaty puppet by using the following command to chat on different IM system.
```sh
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
- [Summer of Wechaty](https://github.com/wechaty/summer-of-wechaty/issues/80)
- [Wechaty API](https://wechaty.js.org/docs/api)
### Similar Projects
- [WeChat in Terminal (微信终端版)](https://github.com/LingDong-/wechit)
### Related Projects
- [blessed](https://github.com/chjj/blessed#documentation)
- [blessed-contrib](https://github.com/yaronn/blessed-contrib#widgets)
- [node-facenet](https://github.com/huan/node-facenet)
- [console-tg-client](https://github.com/lekzd/console-tg-client)
## History
### master v0.2 (Sep 12, 2021)
1. ESM support
### v0.0.1 (Jul 3, 2021)
Init.
## Creators
- [@chinggg](https://github.com/chinggg) - (刘靖) liuchinggg@gmail.com
- [@huan](https://github.com/huan) - ([李卓桓](https://wechaty.js.org/contributors/huan)) zixia@zixia.net
## Copyright & License
- Code & Docs © 2021 Wechaty Contributors
- Code released under the Apache-2.0 License
- Docs released under Creative