{"id":28445059,"url":"https://github.com/wechaty/cli","last_synced_at":"2025-08-15T21:34:39.738Z","repository":{"id":47146449,"uuid":"378404115","full_name":"wechaty/cli","owner":"wechaty","description":"Terminal Client for Wechaty","archived":false,"fork":false,"pushed_at":"2021-12-18T15:52:40.000Z","size":275,"stargazers_count":3,"open_issues_count":5,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-08-09T19:05:06.594Z","etag":null,"topics":["blessed","cli","wechaty"],"latest_commit_sha":null,"homepage":"https://npmjs.com/package/wechaty-cli","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/wechaty.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-06-19T12:13:22.000Z","updated_at":"2024-02-02T16:04:55.000Z","dependencies_parsed_at":"2022-09-26T16:21:17.890Z","dependency_job_id":null,"html_url":"https://github.com/wechaty/cli","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/wechaty/cli","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wechaty%2Fcli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wechaty%2Fcli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wechaty%2Fcli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wechaty%2Fcli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/wechaty","download_url":"https://codeload.github.com/wechaty/cli/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wechaty%2Fcli/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":269818813,"owners_count":24480075,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-10T02:00:08.965Z","response_time":71,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["blessed","cli","wechaty"],"created_at":"2025-06-06T10:11:11.872Z","updated_at":"2025-08-15T21:34:39.730Z","avatar_url":"https://github.com/wechaty.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# wechaty-cli\n\n[![NPM](https://github.com/wechaty/cli/actions/workflows/npm.yml/badge.svg)](https://github.com/wechaty/cli/actions/workflows/npm.yml)\n[![NPM Version](https://badge.fury.io/js/wechaty-cli.svg)](https://badge.fury.io/js/wechaty-cli)\n[![npm (tag)](https://img.shields.io/npm/v/wechaty-cli/next.svg)](https://www.npmjs.com/package/wechaty-cli?activeTab=versions)\n[![TypeScript](https://img.shields.io/badge/%3C%2F%3E-TypeScript-blue.svg)](https://www.typescriptlang.org/)\n[![ES Modules](https://img.shields.io/badge/ES-Modules-brightgreen)](https://github.com/Chatie/tsconfig/issues/16)\n\n![wechaty-cli](docs/images/terminal-wechaty.webp)\n\nTerminal Command Line Client (CLI) for Wechaty\n\n## Usage\n\n### Install from NPM\n\n```sh\nnpm install wechaty-cli\n```\n\nShow version:\n\n```sh\n$ wechaty-cli --version\n0.2.1\n```\n\nStart CLI\n\n```sh\nwechaty-cli\n```\n\n### Install from source\n\n```sh\ngit clone https://github.com/wechaty/cli.git wechaty-cli\ncd wechaty-cli\nnpm start\n```\n\n### Build from Dockerfile\n\n```sh\ngit clone https://github.com/wechaty/cli.git wechaty-cli\ncd wechaty-cli\ndocker build -t wechaty-cli .  # this command needs only to be executed once\ndocker run --rm -it wechaty-cli  # use this command to run wechaty-cli at any time!\n```\n\n### Different IM support\n\nThe 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.\n\n```sh\nnpm install wechaty-puppet-NAME\nexport WECHATY_PUPPET=wechaty-puppet-NAME\n# some puppet requires a token to be set\n```\n\n### Debug in VS Code\n\nDebugging with configuration \"Launch via NPM\", the app will run immediately in the integrated terminal.\n\nTo test the app in external terminal, run `npm run debug` then start debugging with configuration \"Attach\".\n\n## Resources\n\n### Wechaty\n\n- [Summer of Wechaty](https://github.com/wechaty/summer-of-wechaty/issues/80)\n- [Wechaty API](https://wechaty.js.org/docs/api)\n\n### Similar Projects\n\n- [WeChat in Terminal (微信终端版)](https://github.com/LingDong-/wechit)\n\n### Related Projects\n\n- [blessed](https://github.com/chjj/blessed#documentation)\n- [blessed-contrib](https://github.com/yaronn/blessed-contrib#widgets)\n- [node-facenet](https://github.com/huan/node-facenet)\n- [console-tg-client](https://github.com/lekzd/console-tg-client)\n\n## History\n\n### master v0.2 (Sep 12, 2021)\n\n1. ESM support\n\n### v0.0.1 (Jul 3, 2021)\n\nInit.\n\n## Creators\n\n- [@chinggg](https://github.com/chinggg) - (刘靖) liuchinggg@gmail.com\n- [@huan](https://github.com/huan) - ([李卓桓](https://wechaty.js.org/contributors/huan)) zixia@zixia.net\n\n## Copyright \u0026 License\n\n- Code \u0026 Docs © 2021 Wechaty Contributors \u003chttps://github.com/wechaty\u003e\n- Code released under the Apache-2.0 License\n- Docs released under Creative\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwechaty%2Fcli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwechaty%2Fcli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwechaty%2Fcli/lists"}