{"_id":"@moleculer/vorpal","_rev":"3-be2ade5d36ac0f9a982c8f7f1f7815b6","name":"@moleculer/vorpal","dist-tags":{"latest":"1.11.5"},"versions":{"1.11.5":{"name":"@moleculer/vorpal","version":"1.11.5","description":"Node's first framework for building immersive CLI apps.","main":"./dist/vorpal.js","scripts":{"test":"gulp build && mocha --exit","prepublish":"in-publish && gulp build || not-in-publish","release":"npm publish --access public"},"repository":{"type":"git","url":"git+https://github.com/moleculerjs/vorpal.git"},"keywords":["api","cli","repl","shell","immersive","framework","app","application","command","commander","automated","prompt","inquirer"],"author":{"name":"MoleculerJS"},"license":"MIT","bugs":{"url":"https://github.com/moleculerjs/vorpal/issues"},"homepage":"https://github.com/moleculerjs/vorpal#readme","devDependencies":{"@babel/core":"7.6.0","@babel/preset-env":"7.6.0","babel":"^6.3.26","babel-core":"^6.4.5","babel-preset-es2015":"^6.3.13","bluebird":"^3.1.1","gulp":"4.0.2","gulp-babel":"8.0.0","gulp-changed":"4.0.1","gulp-eslint":"6.0.0","gulp-xo":"0.22.0","load-plugins":"^2.1.2","mocha":"^6.2.0","moment":"^2.10.3","request":"^2.58.0","should":"^13.2.3","vorpal-less":"0.0.13","xo":"0.24.0"},"dependencies":{"babel-polyfill":"^6.3.14","chalk":"^2.4.2","in-publish":"^2.0.0","inquirer":"7.0.0","lodash":"^4.17.15","log-update":"^3.3.0","minimist":"^1.2.0","node-localstorage":"^1.3.1","strip-ansi":"^5.2.0","wrap-ansi":"^6.0.0","json-stringify-safe":"^5.0.1"},"engines":{"node":">= 8.0.0"},"xo":{"space":true,"rules":{"no-eval":0,"no-unused-expressions":0,"max-nested-callbacks":0,"no-proto":0,"wrap-iife":0,"global-require":0,"no-negated-condition":0,"no-loop-func":0,"no-implicit-coercion":0,"no-use-extend-native/no-use-extend-native":0,"no-undef":0}},"gitHead":"4115d68cc0bbe3d61503a2cb000b445b54a29c3a","_id":"@moleculer/vorpal@1.11.5","_nodeVersion":"8.12.0","_npmVersion":"6.10.1","dist":{"integrity":"sha512-E1lm/o7Wi5WgbXU3YwRv175fXgvExB1ZzIRAGemV8NH2j7D1hAaYUREfhdA7ut3sMe3VBqfTMNaOKoBO44BxFA==","shasum":"542f030e33b64afcf316c35e492fc3b9fca407af","tarball":"https://registry.npmjs.org/@moleculer/vorpal/-/vorpal-1.11.5.tgz","fileCount":17,"unpackedSize":133538,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJdgNZhCRA9TVsSAnZWagAAPicP/jiHS/45UUU9vQbW5gVv\nxDygbTr32RIBocHFnclEYEdrO/4af+elKNeffCeyFmUGFOmBtFsT6pACdlTw\nURvUoFnZ9Rz73w5WXwYRnPwPiOUmIssPUwCRk8mTjq4o4B1YI0Lk4hOz+P5W\ngsZDES+L1rXLqoCdBiHaT2O9YJ7riSYyoMNDKcXHDput99J1oTYzNVtoFKpf\nM0Ma9F4fWVVZzfuVApG7JAsKeCM+MVmVeHCH5KKXZ8S4hju8h0rpi/HZ0Avk\nil4wl9XKeYe7TdC2l10PUw9P8xp6cSsQF6fhYwi+yBF/MV5qBKNh3o5rc1hP\ngev7fa2bRJ0LQLDgZPHV6g1QVU7yz9vxSVFT3xcbaqMs6sEj7vmDAnrzN/rg\njHbtjYSGnrmqLssAsKT3cDUmcabZB99CTmjf7EOmgJeCfnYk/q0xsNHJoJtS\nqSLJtbcn/95LUU4sHxffoARHiQm5JSgJ6T/1puBt2T4fj2PkIsbJ5aRJEjQZ\ntJzwKPt33GG+xv1rze6p1P+xYNHzBCRB5w95J4QgzPX3c7yQVGM5qayWPfFI\nmuivyP1hcCdOzfEZy1A+rJE0OHfNAGG65Hz3UI8MPhI6cOGSruuplxoHuvMw\ntGV8Q8pfAI5AtMnPJ7qED8r4D3ejBVuF8SwnHV97y1XxuLSkB2Nj6CBkyhNT\nfMJi\r\n=j7JB\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIDtKBdYJJaCG3A8O62XrTjJn3AWdWtY1BzAgg6bBuTIzAiEAve//e+IdtvdPVXSmpNaezwipKiPMmPSaUxMSogKjWx0="}]},"maintainers":[{"name":"icebob","email":"mereg.norbert@gmail.com"}],"_npmUser":{"name":"icebob","email":"mereg.norbert@gmail.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/vorpal_1.11.5_1568724576805_0.7890162826012854"},"_hasShrinkwrap":false}},"time":{"created":"2019-09-17T12:49:36.655Z","1.11.5":"2019-09-17T12:49:36.913Z","modified":"2022-04-06T06:15:33.916Z"},"maintainers":[{"email":"andre.maz.90@gmail.com","name":"andre.mazayev"},{"email":"mck321@gmail.com","name":"shawnmcknight"},{"email":"mereg.norbert@gmail.com","name":"icebob"}],"description":"Node's first framework for building immersive CLI apps.","homepage":"https://github.com/moleculerjs/vorpal#readme","keywords":["api","cli","repl","shell","immersive","framework","app","application","command","commander","automated","prompt","inquirer"],"repository":{"type":"git","url":"git+https://github.com/moleculerjs/vorpal.git"},"author":{"name":"MoleculerJS"},"bugs":{"url":"https://github.com/moleculerjs/vorpal/issues"},"license":"MIT","readme":"# Vorpal\r\n\r\n\r\n[![Build Status](https://travis-ci.org/dthree/vorpal.svg)](https://travis-ci.org/dthree/vorpal/)\r\n<a href=\"https://www.npmjs.com/package/vorpal\">\r\n  <img src=\"https://img.shields.io/npm/dt/vorpal.svg\" alt=\"NPM Downloads\" />\r\n</a>\r\n[![Package Quality](http://npm.packagequality.com/shield/vorpal.svg)](http://packagequality.com/#?package=vorpal)\r\n<a href=\"https://www.npmjs.com/package/vorpal\">\r\n  <img src=\"https://img.shields.io/npm/v/vorpal.svg\" alt=\"NPM Version\" />\r\n</a>\r\n[![XO code style](https://img.shields.io/badge/code_style-XO-5ed9c7.svg)](https://github.com/sindresorhus/xo)\r\n\r\n> Conquer the command-line.\r\n\r\n```text\r\n              (O)\r\n              <M\r\n   o          <M\r\n  /| ......  /:M\\------------------------------------------------,,,,,,\r\n(O)[ vorpal ]::@+}==========================================------------>\r\n  \\| ^^^^^^  \\:W/------------------------------------------------''''''\r\n   o          <W\r\n              <W\r\n              (O)\r\n```\r\n\r\nVorpal is Node's first framework for building interactive CLI applications. With a simple and powerful API, Vorpal opens the door to a new breed of rich, immersive CLI environments like [cash](https://github.com/dthree/cash) and [wat](https://github.com/dthree/wat).\r\n\r\n## Notice\r\n\r\nThis is now an [OPEN Open Source](http://openopensource.org/) project. I am not able to invest a significant amount of time into maintaining Vorpal and so am looking for volunteers who would like to be active maintainers of the project. If you are interested, shoot me a note.\r\n\r\n## Contents\r\n\r\n* [Introduction](#introduction)\r\n* [Getting Started](#getting-started)\r\n* [API](#api)\r\n* [Extensions](#extensions)\r\n* [FAQ](#faq)\r\n* [License](#license)\r\n\r\n## Introduction\r\n\r\nInspired by and based on [commander.js](https://www.npmjs.com/package/commander), Vorpal is a framework for building immersive CLI applications built on an interactive prompt provided by [inquirer.js](https://www.npmjs.com/package/inquirer). Vorpal launches Node into an isolated CLI environment and provides a suite of API commands and functionality including:\r\n\r\n* [x] Simple, powerful command creation\r\n* [x] Supports optional, required and variadic arguments and options\r\n* [x] Piped commands\r\n* [x] Persistent command history\r\n* [x] Built-in help\r\n* [x] Built-in tabbed auto-completion\r\n* [x] Command-specific auto-completion\r\n* [x] Customizable prompts\r\n* [x] Extensive terminal control\r\n* [x] Custom event listeners\r\n* [x] And more\r\n\r\nVorpal supports [community extensions](https://github.com/vorpaljs/awesome-vorpaljs), which empower it to do awesome things such as [piping commands to less](https://github.com/vorpaljs/vorpal-less), [importing commands live](https://github.com/vorpaljs/vorpal-use) or supporting a [built-in REPL](https://github.com/vorpaljs/vorpal-repl).\r\n\r\nMade with :heart: by [dthree](https://github.com/dthree).\r\n\r\n## Getting Started\r\n\r\n##### Quick Start\r\n\r\nInstall `vorpal` into your project:\r\n\r\n```bash\r\n$ npm install vorpal --save\r\n```\r\n\r\nCreate a `.js` file and add the following:\r\n\r\n```js\r\nconst vorpal = require('vorpal')();\r\n\r\nvorpal\r\n  .command('foo', 'Outputs \"bar\".')\r\n  .action(function(args, callback) {\r\n    this.log('bar');\r\n    callback();\r\n  });\r\n\r\nvorpal\r\n  .delimiter('myapp$')\r\n  .show();\r\n```\r\nThis creates an instance of Vorpal, adds a command which logs \"bar\", sets the prompt delimiter to say \"myapp$\", and shows the prompt.\r\n\r\nRun your project file. Your Node app has become a CLI:\r\n\r\n```bash\r\n$ node server.js\r\nmyapp~$\r\n```\r\n\r\nTry out your \"foo\" command.\r\n\r\n```bash\r\nmyapp~$ foo\r\nbar\r\nmyapp~$\r\n```\r\n\r\nNow type \"help\" to see Vorpal's built in commands in addition to \"foo\":\r\n\r\n```bash\r\nmyapp~$ help\r\n\r\n  Commands\r\n\r\n    help [command]    Provides help for a given command.\r\n    exit [options]    Exits instance of Vorpal.\r\n    foo               Outputs \"bar\".\r\n\r\nmyapp~$\r\n```\r\n\r\nThere's the basics. Once you get the hang of it, [follow this tutorial](http://developer.telerik.com/featured/creating-node-js-command-line-utilities-improve-workflow/) or read on to learn what else Vorpal can do.\r\n\r\n##### Community\r\n\r\nQuestions? Use the `vorpal.js` StackOverflow tag for fast answers that help others, or jump into chat on Gitter.\r\n\r\n- [Stack Overflow](http://stackoverflow.com/questions/tagged/vorpal.js) \r\n- [Gitter Chat](https://gitter.im/dthree/vorpal?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge) \r\n- [Vorpal extensions](https://github.com/vorpaljs/awesome-vorpaljs#vorpal-extensions) \r\n- [Projects made with Vorpal](https://github.com/vorpaljs/awesome-vorpaljs) \r\n- [Follow @vorpaljs](https://twitter.com/vorpaljs) \r\n\r\n## [API](https://github.com/dthree/vorpal/wiki)\r\n\r\n##### [Command](https://github.com/dthree/vorpal/wiki/api-|-vorpal.command)\r\n- [`vorpal.command`](https://github.com/dthree/vorpal/wiki/api-%7C-vorpal.command#vorpalcommandcommand-description)\r\n- [`command.description`](https://github.com/dthree/vorpal/wiki/api-|-vorpal.command#commanddescriptionstring)\r\n- [`command.alias`](https://github.com/dthree/vorpal/wiki/api-%7C-vorpal.command#commandaliasname-names)\r\n- [`command.parse`](https://github.com/dthree/vorpal/wiki/api-|-vorpal.command#commandparseparsefunction)\r\n- [`command.option`](https://github.com/dthree/vorpal/wiki/api-|-vorpal.command#commandoptionstring-description)\r\n- [`command.hidden`](https://github.com/dthree/vorpal/wiki/api-|-vorpal.command#commandhidden)\r\n- [`command.remove`](https://github.com/dthree/vorpal/wiki/api-|-vorpal.command#commandremove)\r\n- [`command.help`](https://github.com/dthree/vorpal/wiki/api-|-vorpal.command#commandhelp)\r\n- [`command.autocomplete`](https://github.com/dthree/vorpal/wiki/api-|-vorpal.command#commandautocompletearray-or-object-or-function)\r\n- [`command.action`](https://github.com/dthree/vorpal/wiki/api-|-vorpal.command#commandactionfunction)\r\n- [`command.cancel`](https://github.com/dthree/vorpal/wiki/api-|-vorpal.command#commandcancelfunction)\r\n\r\n##### [Mode](https://github.com/dthree/vorpal/wiki/API-|-vorpal.mode)\r\n- [`vorpal.mode`](https://github.com/dthree/vorpal/wiki/API-%7C-vorpal.mode#vorpalmodecommand-description)\r\n- [`mode.delimiter`](https://github.com/dthree/vorpal/wiki/API-|-vorpal.mode#modedelimiterstring)\r\n- [`mode.init`](https://github.com/dthree/vorpal/wiki/API-|-vorpal.mode#modeinitfunction)\r\n- [`mode.action`](https://github.com/dthree/vorpal/wiki/API-|-vorpal.mode#modeactionfunction)\r\n\r\n##### [Catch](https://github.com/dthree/vorpal/wiki/API-|-vorpal.catch)\r\n- [`vorpal.catch`](https://github.com/dthree/vorpal/wiki/API-%7C-vorpal.catch#catchcommand-description)\r\n\r\n##### [CommandInstance](https://github.com/dthree/vorpal/wiki/API-|-CommandInstance)\r\n- [`commandInstance.log`](https://github.com/dthree/vorpal/wiki/API-%7C-CommandInstance#commandinstancelogstring-strings)\r\n- [`commandInstance.prompt`](https://github.com/dthree/vorpal/wiki/API-%7C-CommandInstance#commandinstancepromptobject-callback)\r\n- [`commandInstance.delimiter`](https://github.com/dthree/vorpal/wiki/API-%7C-CommandInstance#commandinstancedelimiterstring)\r\n\r\n##### [UI](https://github.com/dthree/vorpal/wiki/api-|-vorpal.ui)\r\n- [`ui.delimiter`](https://github.com/dthree/vorpal/wiki/api-|-vorpal.ui#uidelimitertext)\r\n- [`ui.input`](https://github.com/dthree/vorpal/wiki/api-|-vorpal.ui#uiinputtext)\r\n- [`ui.imprint`](https://github.com/dthree/vorpal/wiki/api-|-vorpal.ui#uiimprint)\r\n- [`ui.submit`](https://github.com/dthree/vorpal/wiki/api-|-vorpal.ui#uisubmittext)\r\n- [`ui.cancel`](https://github.com/dthree/vorpal/wiki/api-|-vorpal.ui#uicancel)\r\n- [`ui.imprint`](https://github.com/dthree/vorpal/wiki/api-|-vorpal.ui#uiimprint)\r\n- [`ui.redraw`](https://github.com/dthree/vorpal/wiki/api-|-vorpal.ui#uiredrawtext-text)\r\n- [`ui.redraw.clear`](https://github.com/dthree/vorpal/wiki/api-|-vorpal.ui#uiredrawclear)\r\n- [`ui.redraw.done`](https://github.com/dthree/vorpal/wiki/api-|-vorpal.ui#uiredrawdone)\r\n\r\n##### [Vorpal](https://github.com/dthree/vorpal/wiki/API-|-vorpal)\r\n- [`.parse`](https://github.com/dthree/vorpal/wiki/API-%7C-vorpal#vorpalparseargv-options)\r\n- [`.delimiter`](https://github.com/dthree/vorpal/wiki/API-%7C-vorpal#vorpaldelimiterstring)\r\n- [`.show`](https://github.com/dthree/vorpal/wiki/API-%7C-vorpal#vorpalshow)\r\n- [`.find`](https://github.com/dthree/vorpal/wiki/API-%7C-vorpal#vorpalfindstring)\r\n- [`.exec`](https://github.com/dthree/vorpal/wiki/API-%7C-vorpal#vorpalexeccommand-callback)\r\n- [`.execSync`](https://github.com/dthree/vorpal/wiki/API-%7C-vorpal#vorpalexecsynccommand-options)\r\n- [`.log`](https://github.com/dthree/vorpal/wiki/API-%7C-vorpal#vorpallogstring-strings)\r\n- [`.history`](https://github.com/dthree/vorpal/wiki/API-%7C-vorpal#vorpalhistoryid)\r\n- [`.localStorage`](https://github.com/dthree/vorpal/wiki/API-%7C-vorpal#vorpallocalstorageid)\r\n- [`.help`](https://github.com/dthree/vorpal/wiki/API-%7C-vorpal#vorpalhelpfunction)\r\n- [`.pipe`](https://github.com/dthree/vorpal/wiki/API-%7C-vorpal#vorpalpipefunction)\r\n- [`.use`](https://github.com/dthree/vorpal/wiki/API-%7C-vorpal#vorpaluseextension)\r\n\r\n##### [Events](https://github.com/dthree/vorpal/wiki/Docs-%7C-Events)\r\n\r\n\r\n## Extensions\r\n\r\nYou can build your own Vorpal commands and extensions.\r\n\r\n- [List of awesome extensions](https://github.com/vorpaljs/awesome-vorpaljs#vorpal-extensions)\r\n- [Building your own extension](https://github.com/dthree/vorpal/wiki/Docs-%7C-Creating-Extensions)\r\n\r\n\r\n## [FAQ](https://github.com/dthree/vorpal/wiki/FAQ)\r\n\r\n- [What is an \"immersive CLI app?\"](https://github.com/dthree/vorpal/wiki/FAQ#what-is-an-immersive-cli-app)\r\n- [Wasn't this called Vantage?](https://github.com/dthree/vorpal/wiki/FAQ#uh-wasnt-this-called-vantage)\r\n\r\n\r\n## Why Vorpal?\r\n\r\n```text\r\nOne, two! One, two! and through and through\r\nThe vorpal blade went snicker-snack!\r\nHe left it dead, and with its head\r\nHe went galumphing back.\r\n\r\nLewis Carroll, Jabberwocky\r\n```\r\n\r\n\r\n##### Life Goals:\r\n\r\n- <s>Build a popular framework based on the [Jabberwocky](https://en.wikipedia.org/wiki/Jabberwocky) poem.</s>\r\n\r\n\r\n## License\r\n\r\nMIT © [David Caccavella](https://github.com/dthree)\r\n","readmeFilename":"README.md"}