{"id":28445053,"url":"https://github.com/wechaty/vorpal","last_synced_at":"2025-06-29T20:32:27.792Z","repository":{"id":46514032,"uuid":"273291831","full_name":"wechaty/vorpal","owner":"wechaty","description":"CLI for Chatbot - Extensible Commands for ChatOps, Powered by Vorpal.","archived":false,"fork":false,"pushed_at":"2022-02-22T14:31:18.000Z","size":508,"stargazers_count":3,"open_issues_count":4,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-06-06T10:11:34.093Z","etag":null,"topics":["chatops","cli","vorpal","wechaty"],"latest_commit_sha":null,"homepage":"https://paka.dev/npm/wechaty-vorpal","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":"2020-06-18T16:47:30.000Z","updated_at":"2023-08-07T02:26:01.000Z","dependencies_parsed_at":"2022-07-25T04:01:59.662Z","dependency_job_id":null,"html_url":"https://github.com/wechaty/vorpal","commit_stats":null,"previous_names":["wechaty/wechaty-vorpal"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/wechaty/vorpal","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wechaty%2Fvorpal","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wechaty%2Fvorpal/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wechaty%2Fvorpal/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wechaty%2Fvorpal/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/wechaty","download_url":"https://codeload.github.com/wechaty/vorpal/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wechaty%2Fvorpal/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":262663226,"owners_count":23345025,"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","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":["chatops","cli","vorpal","wechaty"],"created_at":"2025-06-06T10:11:11.308Z","updated_at":"2025-06-29T20:32:27.762Z","avatar_url":"https://github.com/wechaty.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# wechaty-vorpal\n\n[![Wechaty Vorpal](https://img.shields.io/badge/Wechaty-Vorpal-brightgreen.svg)](https://github.com/wechaty/wechaty-vorpal)\n[![NPM](https://github.com/wechaty/wechaty-vorpal/workflows/NPM/badge.svg)](https://github.com/wechaty/wechaty-vorpal/actions?query=workflow%3ANPM)\n [![NPM Version](https://img.shields.io/npm/v/wechaty-vorpal?color=brightgreen)](https://www.npmjs.com/package/wechaty-vorpal)\n\nExtensible Interactive CLI Plugin for Wechaty ChatOps, Powered by Vorpal.\n\n[![Wechaty Vorpal](docs/images/wechaty-vorpal.png)](https://github.com/wechaty/wechaty-vorpal)\n\n\u003e Image: [rainbow sword](http://pixelartmaker.com/art/3008b950f5ab168)\n\n[![Powered by Wechaty](https://img.shields.io/badge/Powered%20By-Wechaty-brightgreen.svg)](https://github.com/Wechaty/wechaty)\n[![TypeScript](https://img.shields.io/badge/%3C%2F%3E-TypeScript-blue.svg)](https://www.typescriptlang.org/)\n\n## Usage\n\n```ts\nimport { Wechaty }        from 'wechaty'\nimport { WechatyVorpal }  from 'wechaty-vorpal'\nimport hackerNews         from 'vorpal-hacker-news'\n\nconst wechaty = new Wechaty()\n\nwechaty.use(\n  WechatyVorpal({\n    use: hackerNews,\n  }),\n)\n\nwechaty.start()\n```\n\nSee: [wechaty-vorpal-contrib](https://github.com/wechaty/wechaty-vorpal-contrib) for more Wechaty Vorpal Extension CLI for Chatbots.\n\n## Demo\n\n![Wechaty Vorpal Hacker News](docs/images/wechaty-vorpal-hacker-news.png)\n\n\u003e help\n\n```sh\nCommands:\n\n    help [command...]       Provides help for a given command.\n    exit                    Exits application.\n    hacker-news [options]   Lists the top stories on hacker news.\n```\n\n\u003e help hacker-news\n\n```sh\nUsage: hacker-news [options]\n\n  Lists the top stories on hacker news.\n\n  Options:\n\n    --help              output usage information\n    -l, --length [amt]  Limits the list to a given length.\n```\n\n\u003e hacker-news --length 3\n\n```sh\nPulling top 3 stories on Hacker News:\n\n  1. Discovering Dennis Ritchies Lost Dissertation (org)\n     93 points by beefhash 3 hours ago | 23 comments\n\n  2. Updating the Git protocol for SHA-256 (net)\n     81 points by chmaynard 14 hours ago | 48 comments\n\n  3. Mac OS X Leopard and Xcode on iPad Pro (com)\n     134 points by tosh 10 hours ago | 28 comments\n```\n\n## Resources\n\n1. [Creating Node.js Command Line Utilities to Improve Your Workflow](https://www.telerik.com/blogs/creating-node-js-command-line-utilities-improve-workflow)\n1. [vantge - Distributed, realtime CLI for live Node apps.](https://github.com/dthree/vantage)\n1. [vorpal - Node's framework for interactive CLIs](https://github.com/dthree/vorpal)\n1. [vorpal-regorged - Conquer the command-line. ⚔️](https://github.com/vorpaljs-reforged/vorpal): This is a Fork aiming at reforging vorpal into typescript, and bringing a 2.0\n1. [bandersnatch - Super lightweight and friendly CLI scaffolding for Node.js programs.](https://github.com/hongaar/bandersnatch)\n\n## Contributors\n\n[![contributor](https://sourcerer.io/fame/huan/wechaty/wechaty-vorpal/images/0)](https://sourcerer.io/fame/huan/wechaty/wechaty-vorpal/links/0)\n[![contributor](https://sourcerer.io/fame/huan/wechaty/wechaty-vorpal/images/1)](https://sourcerer.io/fame/huan/wechaty/wechaty-vorpal/links/1)\n[![contributor](https://sourcerer.io/fame/huan/wechaty/wechaty-vorpal/images/2)](https://sourcerer.io/fame/huan/wechaty/wechaty-vorpal/links/2)\n[![contributor](https://sourcerer.io/fame/huan/wechaty/wechaty-vorpal/images/3)](https://sourcerer.io/fame/huan/wechaty/wechaty-vorpal/links/3)\n[![contributor](https://sourcerer.io/fame/huan/wechaty/wechaty-vorpal/images/4)](https://sourcerer.io/fame/huan/wechaty/wechaty-vorpal/links/4)\n[![contributor](https://sourcerer.io/fame/huan/wechaty/wechaty-vorpal/images/5)](https://sourcerer.io/fame/huan/wechaty/wechaty-vorpal/links/5)\n[![contributor](https://sourcerer.io/fame/huan/wechaty/wechaty-vorpal/images/6)](https://sourcerer.io/fame/huan/wechaty/wechaty-vorpal/links/6)\n[![contributor](https://sourcerer.io/fame/huan/wechaty/wechaty-vorpal/images/7)](https://sourcerer.io/fame/huan/wechaty/wechaty-vorpal/links/7)\n\n## History\n\n### main v1.0 (Oct 23, 2021)\n\nRelease 1.0\n\n1. v0.7 (Sep 19, 2021): ES MOdule support\n\n### v0.6 (July 13, 2020)\n\n1. Support Input, Output, and Error (powered by Observable)\n    1. `this.stdout.next(...)`\n    1. `this.stderr.next(...)`\n    1. `this.stdin.subscribe(msg =\u003e {...})`.\n1. Support send any supported `SayableMessage` type of message to the user\n    1. `string`\n    1. `FileBox`\n    1. `Contact`\n    1. `UrlLink`\n    1. etc...\n1. Support get the `message` instance which invoked this command\n    1. `this.message`\n1. Support `ask()` to ask user question and get the answer back!\n1. Support WechatyVorpalConfig `silent` to do not show help message for unknown commands\n1. Rename  WechatyVorpalConfig `at` to `mention` for only react for message in a room that mention the bot itself.\n\n### v0.3 (July 7, 2020)\n\nInherit the TypeScript source code from the [Vorpal Reforged](https://github.com/vorpaljs-reforged/vorpal) ([MIT License](src/vorpal/LICENSE)) so that we can refactor it to fit the Chatbot environment better.\n\n### v0.2 (Jun 19, 2020)\n\nInit the first version of Vorpal Wechaty Plugin for managing ChatOps Commands\n\n## Author\n\n[Huan LI](https://github.com/huan) ([李卓桓](http://linkedin.com/in/zixia)), Tencent TVP of Chatbot, \\\u003czixia@zixia.net\\\u003e\n\n[![Profile of Huan LI (李卓桓) on StackOverflow](https://stackexchange.com/users/flair/265499.png)](https://stackexchange.com/users/265499)\n\n## Copyright \u0026 License\n\n- Code \u0026 Docs © 2020 Huan LI (李卓桓) \\\u003czixia@zixia.net\\\u003e\n- Code released under the Apache-2.0 License\n- Docs released under Creative Commons\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwechaty%2Fvorpal","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwechaty%2Fvorpal","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwechaty%2Fvorpal/lists"}