tessl/npm-vorpal

Node's first framework for building immersive CLI apps.

—

Pending

Overview

Eval results

Files

Application Configuration

Name: tessl/npm-vorpal
Author: tessl

Core configuration methods for setting up your CLI application including version, title, description, banner, and prompt delimiter.

Capabilities

Version Configuration

Sets the version of your application's API.

/**
 * Sets the version of your application's API
 * @param version - Version string for the application
 * @returns Vorpal instance for chaining
 */
function version(version: string): Vorpal;

Usage Example:

const vorpal = require('vorpal')();

vorpal
  .version('1.0.0');

Title Configuration

Sets the title of your application.

/**
 * Sets the title of your application
 * @param title - Title string for the application
 * @returns Vorpal instance for chaining
 */
function title(title: string): Vorpal;

Usage Example:

const vorpal = require('vorpal')();

vorpal
  .title('My CLI App');

Description Configuration

Sets the description of your application.

/**
 * Sets the description of your application
 * @param description - Description string for the application
 * @returns Vorpal instance for chaining
 */
function description(description: string): Vorpal;

Usage Example:

const vorpal = require('vorpal')();

vorpal
  .description('A powerful CLI application built with Vorpal');

Banner Configuration

Sets the banner of your application that displays when starting.

/**
 * Sets the banner of your application
 * @param banner - Banner string to display
 * @returns Vorpal instance for chaining
 */
function banner(banner: string): Vorpal;

Usage Example:

const vorpal = require('vorpal')();

vorpal
  .banner('Welcome to My CLI App v1.0.0');

Delimiter Configuration

Sets the permanent delimiter for this Vorpal server instance.

/**
 * Sets the permanent delimiter for CLI prompt
 * @param str - Delimiter string to display in prompt
 * @returns Vorpal instance for chaining
 */
function delimiter(str: string): Vorpal;

Usage Example:

const vorpal = require('vorpal')();

vorpal
  .delimiter('myapp$')
  .show();

Complete Configuration Example

const vorpal = require('vorpal')();

vorpal
  .version('1.2.0')
  .title('Data Processor CLI')
  .description('A tool for processing and transforming data files')
  .banner('Data Processor CLI v1.2.0 - Ready to process your data!')
  .delimiter('dataproc$')
  .show();

Install with Tessl CLI