README
Vorpal
Conquer the command-line.
(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
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:
- Simple, powerful command creation
- Supports optional, required and variadic arguments and options
- Piped commands
- Persistent command history
- Built-in help
- Built-in tabbed auto-completion
- Command-specific auto-completion
- Customizable prompts
- Extensive terminal control
- Custom event listeners
- 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:
$ npm install vorpal --save
Create a .js
file and add the following:
const vorpal = require('vorpal')();
vorpal
.command('foo', 'Outputs "bar".')
.action(function(args, callback) {
this.log('bar');
callback();
});
vorpal
.delimiter('myapp