enquirer
Advanced tools
Package description
The enquirer npm package is a stylish, intuitive, and user-friendly way to interact with users via the command line. It provides a rich set of prompt types and utilities to make CLI development easier and more interactive.
Text Input
This feature allows you to ask users for text input. The example shows how to ask for a username.
const { prompt } = require('enquirer');
prompt({
type: 'input',
name: 'username',
message: 'What is your username?'
}).then(answer => console.log('Username:', answer.username));Password Input
This feature enables you to securely ask users for a password, hiding their input on the screen.
const { prompt } = require('enquirer');
prompt({
type: 'password',
name: 'password',
message: 'What is your password?'
}).then(answer => console.log('Password:', answer.password));Multiple Choice (Select)
This feature allows users to choose from a list of options. The example demonstrates asking users to pick a color from a list.
const { prompt } = require('enquirer');
prompt({
type: 'select',
name: 'color',
message: 'Pick a color',
choices: ['Red', 'Green', 'Blue']
}).then(answer => console.log('Selected color:', answer.color));Checkbox
This feature lets users select multiple options from a list. The example asks users to select their favorite fruits.
const { prompt } = require('enquirer');
prompt({
type: 'multiselect',
name: 'fruits',
message: 'What are your favorite fruits?',
choices: ['Apple', 'Orange', 'Grape', 'Watermelon']
}).then(answer => console.log('Favorite fruits:', answer.fruits));Inquirer.js is a common alternative to Enquirer with a similar feature set for creating interactive CLI prompts. It's known for its wide adoption and extensive plugin system but is generally considered to be heavier than Enquirer.
Prompts is a lightweight, minimal alternative that focuses on simplicity and performance. While it offers a similar range of prompt types to Enquirer, it might not be as feature-rich or extensible.
Readme
Stylish CLI prompts that are user-friendly, intuitive and easy to create.
>_ Prompts should be more like conversations than inquisitions▌
Enquirer is fast, easy to use, and lightweight enough for small projects, while also being powerful and customizable enough for the most advanced use cases.
Install with npm:
$ npm install --save enquirer@beta
(Requires Node.js 8.6 or higher. Please let us know if you need support for an earlier version by creating an issue.)
Get started with Enquirer, the most powerful and easy-to-use Node.js library for creating interactive CLI prompts.
Pass a question object to run a single prompt.
const { prompt } = require('enquirer');
const response = await prompt({
type: 'input',
name: 'username',
message: 'What is your username?'
});
console.log(response);
//=> { username: 'jonschlinkert' }
(Examples with await need to be run inside an async function)
Pass an array of "question" objects to run a series of prompts.
const response = await prompt([
{
type: 'input',
name: 'name',
message: 'What is your name?'
},
{
type: 'input',
name: 'username',
message: 'What is your username?'
}
]);
console.log(response);
//=> { name: 'Edward Chan', username: 'edwardmchan' }
Create an instance of Enquirer.
Params
options {Object}: (optional) Options to use with all prompts.answers {Object}: (optional) Answers object to initialize with.Example
const Enquirer = require('enquirer');
const enquirer = new Enquirer();
Register a custom prompt type.
Params
type {String}fn {Function|Prompt}: Prompt class, or a function that returns a Prompt class.returns {Object}: Returns the Enquirer instanceExample
const Enquirer = require('enquirer');
const enquirer = new Enquirer();
enquirer.register('customType', require('./custom-prompt'));
Prompt function that takes a "question" object or array of question objects, and returns an object with responses from the user.
Params
questions {Array|Object}: Options objects for one or more prompts to run.returns {Promise}: Promise that returns an "answers" object with the user's responses.Example
const Enquirer = require('enquirer');
const enquirer = new Enquirer();
(async() => {
const response = await enquirer.prompt({
type: 'input',
name: 'username',
message: 'What is your username?'
});
console.log(response);
})();
Use an enquirer plugin.
Params
plugin {Function}: Plugin function that takes an instance of Enquirer.returns {Object}: Returns the Enquirer instance.Example
const Enquirer = require('enquirer');
const enquirer = new Enquirer();
const plugin = enquirer => {
// do stuff to enquire instance
};
enquirer.use(plugin);
Programmatically cancel all prompts.
Params
plugin {Function}: Plugin function that takes an instance of Enquirer.returns {Object}: Returns the Enquirer instance.Example
const Enquirer = require('enquirer');
const enquirer = new Enquirer();
enquirer.use(plugin);
Prompt function that takes a "question" object or array of question objects, and returns an object with responses from the user.
Params
questions {Array|Object}: Options objects for one or more prompts to run.returns {Promise}: Promise that returns an "answers" object with the user's responses.Example
const { prompt } = require('enquirer');
(async() => {
const response = await prompt({
type: 'input',
name: 'username',
message: 'What is your username?'
});
console.log(response);
})();
TODO
Each prompt takes an options object (aka "question" object), that implements the following interface:
{
type: string | function,
name: string | function,
message: string | function | async function,
initial: string | function | async function
format: function | async function,
answer: function | async function,
validate: function | async function
}
| Property | Type | Description |
|---|---|---|
type (required) | string, function | Enquirer uses this value to determine the type of prompt to run, but it's optional when prompts are run directly. |
name (required) | string, function | Used as the key for the answer on the returned values (answers) object. |
message (required) | string, function | The message to display when the prompt is rendered in the terminal. |
initial (optional) | string, function | The default value to return if the user does not supply a value. |
format (optional) | function | Function to format user input in the terminal. |
result (optional) | function | Function to format the final, submitted value before it's returned. |
validate (optional) | function | Function to validate the submitted value before it's returned. This function may return a boolean or a string. If a string is returned it will be used as the validation error message. |
Example
const question = {
type: 'select',
name: 'color',
message: 'Favorite color?',
initial: 1,
choices: [
{ name: 'red', message: 'Red', value: '#ff0000' },
{ name: 'green', message: 'Green', value: '#00ff00' },
{ name: 'blue', message: 'Blue', value: '#0000ff' }
]
};
Choice {
name: string;
message: string | undefined;
value: string | undefined;
hint: string | undefined;
disabled: boolean | string | undefined;
enabled: boolean | undefined;
}
| Property | Type | Description |
|---|---|---|
name | string | The unique id for a choice |
message | string | The message to display |
value | string | The value to return if the choice is selected |
alias | string | Single character to use when keypress shortcuts are supported |
hint | string | |
error | string | |
disabled | boolean | |
separator | boolean | |
selected | boolean |
MacBook Pro, Intel Core i7, 2.5 GHz, 16 GB.
Time it takes for the module to load the first time (average of 3 runs):
enquirer: 4.013ms
inquirer: 286.717ms
prompts: 17.010ms
Thanks to derhuerst, creator of prompt libraries such as prompt-skeleton, which influenced some of the concepts we used in our prompts.
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:
$ npm install && npm test
(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)
To generate the readme, run the following command:
$ npm install -g verbose/verb#dev verb-generate-readme && verb
| Commits | Contributor |
|---|---|
| 72 | jonschlinkert |
| 12 | doowb |
| 1 | mischah |
| 1 | skellock |
Jon Schlinkert
Copyright © 2018, Jon Schlinkert. Released under the MIT License.
FAQs
Stylish, intuitive and user-friendly prompt system. Fast and lightweight enough for small projects, powerful and extensible enough for the most advanced use cases.
We found that enquirer demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
The Python Software Foundation has secured a 5-year sponsorship from Fastly that supports PSF's activities and events, most notably the security and reliability of the Python Package Index (PyPI).
Security News
LDAPjs, an LDAP Client and Server API for Node.js, was decommissioned after its maintainer received an abusive email from a user, raising concerns about this form of abuse as a potential attack vector.
Security News
CISA launched a new project called Vulnrichment to enrich CVEs with details that help prioritize patching and mitigation efforts, as the NVD backlog of unenriched CVEs awaiting analysis surpasses 10,000.