Skip to content
dc edited this page Oct 11, 2015 · 18 revisions

API

Basic methods for a Vorpal instance, including an API for argument parsing, prompt control, logging, extensions and automation.

Create and customize the commands for your interactive CLI.

A special type of command that puts the user into a mode where-in everything typed is taken as a literal command.

A special type of command that's fired when the user runs text that hasn't been registered as a command.

Tools for direct and easy manipulation of your screen, including editing the prompt, user input and re-drawing the screen.

When a command is fired in Vorpal a commandInstance is created and exposed through the this in the context of the command. The instance exposes methods for logging and prompting mid-command.

Clone this wiki locally