vorpal 0,1,1,1,4,3,2 travis-ci gulp npm

Node's framework for interactive CLIs.

Vorpal

Build Status NPM Downloads Package Quality NPM Version XO code style > Conquer the command-line. text (O) <M o <M /| ...... /:M\------------------------------------------------,,,,,, (O)[ vorpal ]::@+}==========================================------------> \| ^^^^^^ \:W/------------------------------------------------'''''' o <W <W (O) Vorpal 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 and wat.

Notice

This is now an OPEN Open Source 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.

Contents

* Introduction * Getting Started * API * Extensions * FAQ * License

Introduction

Inspired by and based on commander.js, Vorpal is a framework for building immersive CLI applications built on an interactive prompt provided by inquirer.js. Vorpal launches Node into an isolated CLI environment and provides a suite of API commands and functionality including: * [x] Simple, powerful command creation * [x] Supports optional, required and variadic arguments and options * [x] Piped commands * [x] Persistent command history * [x] Built-in help * [x] Built-in tabbed auto-completion * [x] Command-specific auto-completion * [x] Customizable prompts * [x] Extensive terminal control * [x] Custom event listeners * [x] And more Vorpal supports community extensions, which empower it to do awesome things such as piping commands to less, importing commands live or supporting a built-in REPL. Made with :heart: by dthree.

Getting Started

Quick Start

Install vorpal into your project: bash $ npm install vorpal --save Create a .js file and add the following: js const vorpal = require('vorpal')(); vorpal .command('foo', 'Outputs "bar".') .action(function(args, callback) { this.log('bar'); callback(); }); vorpal .delimiter('myapp$') .show(); This creates an instance of Vorpal, adds a command which logs “bar”, sets the prompt delimiter to say “myapp$”, and shows the prompt. Run your project file. Your Node app has become a CLI: bash $ node server.js myapp~$ Try out your “foo” command. bash myapp~$ foo bar myapp~$ Now type “help” to see Vorpal’s built in commands in addition to “foo”: bash myapp~$ help Commands help [command] Provides help for a given command. exit [options] Exits instance of Vorpal. foo Outputs "bar". myapp~$ There’s the basics. Once you get the hang of it, follow this tutorial or read on to learn what else Vorpal can do.

Community

Questions? Use the vorpal.js StackOverflow tag for fast answers that help others, or jump into chat on Gitter. - Stack Overflow - Gitter Chat - Vorpal extensions - Projects made with Vorpal - Follow @vorpaljs

API

Command

Related Repositories

vorpal

vorpal

Node's framework for interactive CLIs. ...

cliffy

cliffy

Framework for Interactive CLIs - An alternative to Vorpal ...

awesome-vorpal

awesome-vorpal

A curated list of delightful Vorpal extensions. ...

birdknife

birdknife

birdknife is a Twitter CLI based on Vorpal inspired by TTYtter. ...

vorpal-repl

vorpal-repl

Simple REPL extension for vantage.js ...


Top Contributors

dthree scotthovestadt jackyjieliu drewbrokke jeff-1amstudios melonmanchan mvayngrib alansouzati da70 fredericgrati alferov matt-oc naltun eliperelman gsklee hnordt dashlanebot pra85 zakhenry fiatjaf e-jigsaw

Dependencies

package version
babel-polyfill ^6.3.14
chalk ^1.1.0
in-publish ^2.0.0
inquirer 0.11.0
lodash ^4.5.1
log-update ^1.0.2
minimist ^1.2.0
node-localstorage ^0.6.0
strip-ansi ^3.0.0
wrap-ansi ^2.0.0
dev babel ^6.3.26
babel-core ^6.4.5
babel-preset-es2015 ^6.3.13
bluebird ^3.1.1
gulp ^3.9.0
gulp-babel ^6.1.2
gulp-changed ^1.3.0
gulp-eslint ^1.1.1
gulp-xo ^0.7.0
load-plugins ^2.1.0
mocha ^2.2.5
moment ^2.10.3
request ^2.58.0
should ^6.0.3
vorpal-less 0.0.4
vorpal-repl ^1.1.8
xo ^0.9.0

Releases

-   v1.4.0 zip tar
-   v1.3.34 zip tar
-   v1.3.33 zip tar
-   v1.3.32 zip tar
-   v1.3.31 zip tar
-   v1.3.30 zip tar
-   v1.3.29 zip tar
-   v1.3.28 zip tar
-   v1.3.27 zip tar
-   v1.3.26 zip tar
-   v1.3.25 zip tar
-   v1.3.24 zip tar
-   v1.3.23 zip tar
-   v1.3.22 zip tar
-   v1.3.21 zip tar
-   v1.3.20 zip tar
-   v1.3.19 zip tar
-   v1.3.18 zip tar
-   v1.3.17 zip tar
-   v1.3.16 zip tar
-   v1.3.15 zip tar
-   v1.3.14 zip tar
-   v1.3.13 zip tar
-   v1.3.12 zip tar
-   v1.3.11 zip tar
-   v1.3.10 zip tar
-   v1.3.9 zip tar
-   v1.3.8 zip tar
-   v1.3.7 zip tar
-   v1.3.6 zip tar