Inquirer

npx @inquirer/demo@latest

Installation

Note

Inquirer recently underwent a rewrite from the ground up to reduce the package size and improve performance. The previous version of the package is still maintained (though not actively developed), and offered hundreds of community contributed prompts that might not have been migrated to the latest API. If this is what you're looking for, theprevious package is over here.

Usage

import{input}from'@inquirer/prompts';constanswer=awaitinput({message:'Enter your name'});

Prompts

Input

import{input}from'@inquirer/prompts';

Select

import{select}from'@inquirer/prompts';

Checkbox

import{checkbox}from'@inquirer/prompts';

Confirm

import{confirm}from'@inquirer/prompts';

Search

import{search}from'@inquirer/prompts';

Password

import{password}from'@inquirer/prompts';

Expand

import{expand}from'@inquirer/prompts';

Editor

import{editor}from'@inquirer/prompts';

Number

import{number}from'@inquirer/prompts';

Raw List

import{rawlist}from'@inquirer/prompts';

Create your own prompts

Advanced usage

Warning

When providing an input stream or pipingprocess.stdin, it's very likely you need to callprocess.stdin.setRawMode(true)before calling inquirer functions. Node.js usually does it automatically, but when we shadow the stdin, Node can loss trackand not know it has to. If the prompt isn't interactive (arrows don't work, etc), it's likely due to this.

import{confirm}from'@inquirer/prompts';constallowEmail=awaitconfirm({message:'Do you allow us to send you email?'},{output:newStream.Writable({write(chunk,_encoding,next){// Do somethingnext();},}),clearPromptOnDone:true,},);

Canceling prompt

// Example 1: using built-in AbortSignal utilitiesimport{confirm}from'@inquirer/prompts';constanswer=awaitconfirm({ ...},{signal:AbortSignal.timeout(5000)});

// Example 2: implementing custom cancellation with an AbortControllerimport{confirm}from'@inquirer/prompts';constcontroller=newAbortController();setTimeout(()=>{controller.abort();// This will reject the promise},5000);constanswer=awaitconfirm({ ...},{signal:controller.signal});

Recipes

Handlingctrl+c gracefully

ExitPromptError: User force closed the prompt with 0 null  at file://example/packages/core/dist/esm/lib/create-prompt.js:55:20  at Emitter.emit (file://example/node_modules/signal-exit/dist/mjs/index.js:67:19)  at #processEmit (file://example/node_modules/signal-exit/dist/mjs/index.js:236:27)  at #process.emit (file://example/node_modules/signal-exit/dist/mjs/index.js:187:37)  at process.callbackTrampoline (node:internal/async_hooks:130:17)

process.on('uncaughtException',(error)=>{if(errorinstanceofError&&error.name==='ExitPromptError'){console.log('👋 until next time!');}else{// Rethrow unknown errorsthrowerror;}});

Get answers in an object

import{input,confirm}from'@inquirer/prompts';constanswers={firstName:awaitinput({message:"What's your first name?"}),allowEmail:awaitconfirm({message:'Do you allow us to send you email?'}),};console.log(answers.firstName);

Ask a question conditionally

import{input,confirm}from'@inquirer/prompts';constallowEmail=awaitconfirm({message:'Do you allow us to send you email?'});letemail;if(allowEmail){email=awaitinput({message:'What is your email address'});}

Get default value after timeout

import{input}from'@inquirer/prompts';constanswer=awaitinput({message:'Enter a value (timing out in 5 seconds)'},{signal:AbortSignal.timeout(5000)},).catch((error)=>{if(error.name==='AbortPromptError'){return'Default value';}throwerror;});

Using as pre-commit/git hooks, or scripts

"precommit":"my-script < /dev/tty"

#!/bin/shexec< /dev/ttynode my-script.js

Using with nodemon

npx nodemon ./packages/demo/demos/password.mjs --no-stdin

# One of depending on your neednode --watch script.jsnode --watch-path=packages/ packages/demo/

Wait for config

import{confirm}from'@inquirer/prompts';constanswer=awaitconfirm({message:awaitgetMessage()});

Usage withnpx within bash scripts

name=$(npx -y @inquirer-cli/input -r"What is your name?")echo"Hello,$name!"

$ npm version$(npx -y @inquirer-cli/select -c patch -c minor -c major'Select Version')

Community prompts

? Choose an option:>   Run command (D)    Quit (Q)

? Choose a file Open <O> Edit <E> Delete <X>❯ image.png  audio.mp3  code.py

Choose between choices? (Press<space> to select,<Up and Down> to move rows,<Left and Right> to move columns)┌──────────┬───────┬───────┐│ 1-2 of 2 │ Yes?  │ No?|├──────────┼───────┼───────┤│ Choice 1 │ [ ◯ ] │   ◯|├──────────┼───────┼───────┤│ Choice 2 │   ◯   │   ◯|└──────────┴───────┴───────┘

? Do you want to continue? no / yes

? Which PRs and in what order would you like to merge? (Press <space> to select, <a> to toggle all, <i> to invert selection, <ctrl+up> to move item up, <ctrl+down> to move item down, and <enter> to proceed)❯ ◯ PR 1  ◯ PR 2  ◯ PR 3

? Choose your OS, IDE, PL, etc. (Press <tab> to select/deselect, <backspace> to remove selectedoption, <enter> to select option)>>  vue>[ ] vue [ ] vuejs [ ] fuelphp [ ] venv [ ] vercel (Use arrow keys to reveal more options)

? Select a file:/main/path/├── folder1/├── folder2/├── folder3/├── file1.txt├── file2.pdf└── file3.jpg (not allowed)━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━Use ↑↓ to navigate through the listPress<esc> to navigate to the parent directoryPress<enter> toselecta file or navigate to a directory

Directory size: loading...? Choose an option❯ Rename  Copy  Delete

Directory size: 123M? Choose an option❯ Rename  Copy  Delete

? Configure your development workflow:  [1] Set up CI/CD pipeline❯ [3] Code quality tools  [ ] Documentation  [2] Performance monitoring ──────────────- Legacy system (disabled)(Linting, formatting, and analysis)

? Select colors [searching: "re"]❯ ◉ The red color  ◯ The green color  ◉ The purple color  ◯ The orange color↑↓ navigate • space de/select • type search • 2 selected  • ⏎ submit

License