whatisgithub

What is vorpal?

dthree/vorpal — explained in plain English

Analysis updated 2026-06-26

5,635JavaScriptAudience · developerComplexity · 2/5Setup · easy

In one sentence

Vorpal is a Node.js library for building interactive command-line apps with a persistent shell prompt, built-in tab-completion, command history, and piping, though the project is no longer actively maintained.

Mindmap

mindmap
  root((Vorpal))
    What it does
      Persistent CLI prompt
      Command definitions
      Piping commands
      Workflow modes
    Features
      Tab auto-complete
      Command history
      Built-in help
      Community extensions
    Tech Stack
      Node.js
      JavaScript
      npm
    Audience
      Node.js developers
      CLI tool builders
Click or tap to explore — scroll the page freely

Code map

Detail Auto

An interactive map of this repo's files and how they connect — its source is parsed live in your browser. Click Visualize to build it.

filefunction / class

What do people build with it?

USE CASE 1

Build a polished interactive CLI tool where users type commands into a persistent prompt instead of running one-off scripts.

USE CASE 2

Add tab-auto-completion and command history to a Node.js developer tool without implementing those features yourself.

USE CASE 3

Create workflow modes in a CLI app that temporarily restrict and change available commands while a user is inside a sub-task.

USE CASE 4

Add a built-in REPL to a Node.js service so developers can inspect live state from the command line.

What is it built with?

JavaScriptNode.js

How does it compare?

dthree/vorpallebab/lebabassaf/zombie
Stars5,6355,6365,631
LanguageJavaScriptJavaScriptJavaScript
Setup difficultyeasyeasyeasy
Complexity2/51/52/5
Audiencedeveloperdeveloperdeveloper

Figures from each repo's GitHub metadata at analysis time.

How do you get it running?

Difficulty · easy Time to first run · 5min

Project is no longer actively maintained, check for unmaintained-dependency risk before adopting in production.

The specific license is not mentioned in the explanation.

So what is it?

Vorpal is a Node.js framework for building interactive command-line applications. Rather than a simple script that runs once and exits, a Vorpal app launches its own persistent prompt where users type commands and get responses, similar to how a shell like Bash works but built entirely within your application. You define commands with a short API: give a command a name, describe what arguments and options it accepts, and attach a function that runs when it is called. Vorpal handles the rest: it provides built-in help output, persistent command history, tab-based auto-completion (including custom completions per command), and the ability to pipe commands together. You can also define "modes" that change the prompt and behavior temporarily while the user is inside a particular workflow. The library is installed via npm and targets Node.js developers who want to ship a polished interactive tool rather than a flat script. A small ecosystem of community extensions adds features like paging output through a pager, importing new commands at runtime, or adding a built-in read-eval-print loop (REPL) to inspect state. The project notes that it is now in "open open source" mode: the original author is not actively maintaining it and is looking for volunteers to take over. This is worth knowing before adopting it for a production project, as it may not receive regular updates. The README includes a quick-start example that turns a plain Node file into a working CLI in about ten lines of code.

Copy-paste prompts

Prompt 1
I'm building a Node.js CLI tool with multiple commands. Show me how to use Vorpal to create a persistent shell prompt with help, history, and tab-completion.
Prompt 2
How do I add a custom auto-completion handler to a Vorpal command so users can tab-complete values fetched from an API?
Prompt 3
Show me how to use Vorpal's pipe feature to chain two commands together so the output of the first becomes input to the second.
Prompt 4
I want a Vorpal mode that changes the prompt and restricts available commands while a user is editing a config. How do I set that up?

Frequently asked questions

What is vorpal?

Vorpal is a Node.js library for building interactive command-line apps with a persistent shell prompt, built-in tab-completion, command history, and piping, though the project is no longer actively maintained.

What language is vorpal written in?

Mainly JavaScript. The stack also includes JavaScript, Node.js.

What license does vorpal use?

The specific license is not mentioned in the explanation.

How hard is vorpal to set up?

Setup difficulty is rated easy, with roughly 5min to a first successful run.

Who is vorpal for?

Mainly developer.

Open on GitHub → Ask about another repo

This repo across BitVibe Labs

Verify against the repo before relying on details.