TypeScript icon, indicating that this package has built-in type declarations

1.2.0 • Public • Published


Simple interactive command line prompt to display a list of choices (single select.)

select prompt


npm install @inquirer/select

yarn add @inquirer/select


import select, { Separator } from '@inquirer/select';

const answer = await select({
  message: 'Select a package manager',
  choices: [
      name: 'npm',
      value: 'npm',
      description: 'npm is the most popular package manager',
      name: 'yarn',
      value: 'yarn',
      description: 'yarn is an awesome package manager',
    new Separator(),
      name: 'jspm',
      value: 'jspm',
      disabled: true,
      name: 'pnpm',
      value: 'pnpm',
      disabled: '(pnpm is not available)',


Property Type Required Description
message string yes The question to ask
choices Array<{ value: string, name?: string, description?: string, disabled?: boolean | string } | Separator> yes List of the available choices. The value will be returned as the answer, and used as display if no name is defined. Choices who're disabled will be displayed, but not selectable. The description will be displayed under the prompt when the cursor land over the choice.
pageSize number no By default, lists of choice longer than 7 will be paginated. Use this option to control how many choices will appear on the screen at once.

The Separator object can be used to render non-selectable lines in the choice list. By default it'll render a line, but you can provide the text as argument (new Separator('-- Dependencies --')). This option is often used to add labels to groups within long list of options.


Copyright (c) 2023 Simon Boudrias (twitter: @vaxilart)
Licensed under the MIT license.


npm i @inquirer/select

DownloadsWeekly Downloads






Unpacked Size

18.2 kB

Total Files


Last publish


  • sboudrias
  • danielchatfield
  • mischah