Package Exports

inquirer
inquirer/lib/prompts/base
inquirer/lib/prompts/confirm
inquirer/lib/prompts/input
inquirer/lib/prompts/list

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (inquirer) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Inquirer.js

A collection of common interactive command line user interfaces.

Goal and philosophy

We strive at providing easily embeddable and beatiful command line interface for Node.js ; some hope in becoming the CLI Xanadu.

Inquirer should ease the process of asking end user questions, parsing, validating answers, and providing error feedback.

Inquirer provide the user interface, and the inquiry session flow. If you're searching for a full blown command line program utility, then check out Commander.js (inspired by) or Charm (used internally).

Documentation

Installation

npm install inquirer

var inquirer = require("inquirer");
inquirer.prompt([/* Pass your questions in here */], function( answers ) {
    // Use user feedback for... whatever!!
});

Examples (Run it and see it)

Checkout the examples/ folder for code and interface examples.

node examples/pizza.js
# etc

Methods

`inquirer.prompt( questions, callback )`

Launch the prompt interface (inquiry session)

questions (Array) contains Question Object
callback (Function) first parameter is the Answers Object

Objects

Question

A question object is a hash containing question related values:

type: (String) Type of the prompt. Defaults: input - Possible values: input, confirm, list, rawlist
name: (String) The name to use when storing the answer in the anwers hash.
message: (String) The question to print.
default: (String) Default value to use if nothing is entered
choices: (Array) Choices array.
Values can be simple strings, or objects containing a name (to display) and a value properties (to save in the answers hash).
validate: (Function) Receive the user input and should return true if the value is valid, and an error message (String) otherwise. If no error message is returned, a default one is provided.
filter: (Function) Receive the user input and return the filtered value to be used inside the program. The value returned will be added to the Answers hash.

Answers

A key/value hash containing the client answers in each prompt.

Key The name property of the question object
Value (Depends on the prompt)
- confirm: (Boolean)
- input : User input (String)
- rawlist, list : Selected choice value (or name if no value specified) (String)

Prompts

List - `{ type: "list" }`

Take type, name, message, choices[, filter] properties.

What about the toping?
  [X] Peperonni and chesse
  [ ] All dressed
  [ ] Hawaïan
(Use arrow key)

Raw List - `{ type: "rawlist" }`

Take type, name, message, choices[, filter] properties.

You also get a free 2L liquor! Which one?
  1) Pepsi
  2) 7up
  3) Coke
  Default (1)

Confirm - `{ type: "confirm" }`

Take type, name, message properties.

Hi, welcome to Node Pizza plaza. Is it for a delivery? (Y/n)

Input - `{ type: "input" }`

Take type, name, message[, default, filter, validate] properties.

Before leaving, any comments on your purchase experience? (default "Nope, all good!"):

News on the march (Release notes)

0.1.0 : First official release. There's 4 prompt types: input, confirm, list and rawlist. There's functionnality to allow the validation of input, and the filtering of values.

inquirer