![\"Prompts\"](\"https://github.com/terkelg/prompts/raw/master/prompts.png\")
\n\n \n
\n \n ![\"version\"](\"https://img.shields.io/npm/v/prompts.svg\")
\n \n \n ![\"travis\"](\"https://img.shields.io/travis/terkelg/prompts.svg\")
\n \n \n ![\"downloads\"](\"https://img.shields.io/npm/dm/prompts.svg\")
\n \n \n
\n Lightweight, beautiful and user-friendly interactive prompts\n >_ Easy to use CLI prompts to enquire users for information▌\n
\n\n![\"example](\"https://github.com/terkelg/prompts/raw/master/media/example.gif\")
\n\n```js\nconst prompts = require('prompts');\n\n(async () => {\n const response = await prompts({\n type: 'number',\n name: 'value',\n message: 'How old are you?',\n validate: value => value < 18 ? `Nightclub is 18+ only` : true\n });\n\n console.log(response); // => { value: 24 }\n})();\n```\n\n> See [`example.js`](https://github.com/terkelg/prompts/blob/master/example.js) for more options.\n\n\n\n\n\n## ❯ Examples\n\n### Single Prompt\n\nPrompt with a single prompt object. Returns an object with the response.\n\n```js\nconst prompts = require('prompts');\n\n(async () => {\n const response = await prompts({\n type: 'text',\n name: 'meaning',\n message: 'What is the meaning of life?'\n });\n\n console.log(response.meaning);\n})();\n```\n\n### Prompt Chain\n\nPrompt with a list of prompt objects. Returns an object with the responses.\nMake sure to give each prompt a unique `name` property to prevent overwriting values.\n\n```js\nconst prompts = require('prompts');\n\nconst questions = [\n {\n type: 'text',\n name: 'username',\n message: 'What is your GitHub username?'\n },\n {\n type: 'number',\n name: 'age',\n message: 'How old are you?'\n },\n {\n type: 'text',\n name: 'about',\n message: 'Tell something about yourself',\n initial: 'Why should I?'\n }\n];\n\n(async () => {\n const response = await prompts(questions);\n\n // => response => { username, age, about }\n})();\n```\n\n### Dynamic Prompts\n\nPrompt properties can be functions too.\nPrompt Objects with `type` set to `falsy` values are skipped.\n\n```js\nconst prompts = require('prompts');\n\nconst questions = [\n {\n type: 'text',\n name: 'dish',\n message: 'Do you like pizza?'\n },\n {\n type: prev => prev == 'pizza' ? 'text' : null,\n name: 'topping',\n message: 'Name a topping'\n }\n];\n\n(async () => {\n const response = await prompts(questions);\n})();\n```\n\n\n\n\n\n## ❯ API\n\n### prompts(prompts, options)\n\nType: `Function`![\"text](\"https://github.com/terkelg/prompts/raw/master/media/text.gif\")
\n\n```js\n{\n type: 'text',\n name: 'value',\n message: `What's your twitter handle?`\n}\n```\n\n#### Options\n| Param | Type | Description |\n| ----- | :--: | ----------- |\n| message | `string` | Prompt message to display |\n| initial | `string` | Default string value |\n| style | `string` | Render style (`default`, `password`, `invisible`, `emoji`). Defaults to `default` |\n| format | `function` | Receive user input. The returned value will be added to the response object |\n| validate | `function` | Receive user input. Should return `true` if the value is valid, and an error message `String` otherwise. If `false` is returned, a default error message is shown |\n| onRender | `function` | On render callback. Keyword `this` refers to the current prompt |\n| onState | `function` | On state change callback. Function signature is an `object` with two properties: `value` and `aborted` |\n\n**↑ back to:** [Prompt types](#-types)\n\n***\n\n### password(message, [initial])\n> Password prompt with masked input.\n\nThis prompt is a similar to a prompt of type `'text'` with `style` set to `'password'`.\n\n#### Example\n![\"password](\"https://github.com/terkelg/prompts/raw/master/media/password.gif\")
\n\n```js\n{\n type: 'password',\n name: 'value',\n message: 'Tell me a secret'\n}\n```\n\n#### Options\n| Param | Type | Description |\n| ----- | :--: | ----------- |\n| message | `string` | Prompt message to display |\n| initial | `string` | Default string value |\n| format | `function` | Receive user input. The returned value will be added to the response object |\n| validate | `function` | Receive user input. Should return `true` if the value is valid, and an error message `String` otherwise. If `false` is returned, a default error message is shown |\n| onRender | `function` | On render callback. Keyword `this` refers to the current prompt |\n| onState | `function` | On state change callback. Function signature is an `object` with two properties: `value` and `aborted` |\n\n**↑ back to:** [Prompt types](#-types)\n\n***\n\n### invisible(message, [initial])\n> Prompts user for invisible text input.\n\nThis prompt is working like `sudo` where the input is invisible.\nThis prompt is a similar to a prompt of type `'text'` with style set to `'invisible'`.\n\n#### Example\n![\"invisible](\"https://github.com/terkelg/prompts/raw/master/media/invisible.gif\")
\n\n```js\n{\n type: 'invisible',\n name: 'value',\n message: 'Enter password'\n}\n```\n\n#### Options\n| Param | Type | Description |\n| ----- | :--: | ----------- |\n| message | `string` | Prompt message to display |\n| initial | `string` | Default string value |\n| format | `function` | Receive user input. The returned value will be added to the response object |\n| validate | `function` | Receive user input. Should return `true` if the value is valid, and an error message `String` otherwise. If `false` is returned, a default error message is shown |\n| onRender | `function` | On render callback. Keyword `this` refers to the current prompt |\n| onState | `function` | On state change callback. Function signature is an `object` with two properties: `value` and `aborted` |\n\n**↑ back to:** [Prompt types](#-types)\n\n***\n\n### number(message, initial, [max], [min], [style])\n> Prompts user for number input.\n\nYou can type in numbers and use up/down to increase/decrease the value. Only numbers are allowed as input. Hit tab to autocomplete to `initial` value when provided.\n\n#### Example\n![\"number](\"https://github.com/terkelg/prompts/raw/master/media/number.gif\")
\n\n```js\n{\n type: 'number',\n name: 'value',\n message: 'How old are you?',\n initial: 0,\n style: 'default',\n min: 2,\n max: 10\n}\n```\n\n#### Options\n| Param | Type | Description |\n| ----- | :--: | ----------- |\n| message | `string` | Prompt message to display |\n| initial | `number` | Default number value |\n| format | `function` | Receive user input. The returned value will be added to the response object |\n| validate | `function` | Receive user input. Should return `true` if the value is valid, and an error message `String` otherwise. If `false` is returned, a default error message is shown |\n| max | `number` | Max value. Defaults to `Infinity` |\n| min | `number` | Min value. Defaults to `-infinity` |\n| float | `boolean` | Allow floating point inputs. Defaults to `false` |\n| round | `number` | Round `float` values to x decimals. Defaults to `2` |\n| increment | `number` | Increment step when using arrow keys. Defaults to `1` |\n| style | `string` | Render style (`default`, `password`, `invisible`, `emoji`). Defaults to `default` |\n| onRender | `function` | On render callback. Keyword `this` refers to the current prompt |\n| onState | `function` | On state change callback. Function signature is an `object` with two properties: `value` and `aborted` |\n\n**↑ back to:** [Prompt types](#-types)\n\n***\n\n### confirm(message, [initial])\n> Classic yes/no prompt.\n\nHit y or n to confirm/reject.\n\n#### Example\n![\"confirm](\"https://github.com/terkelg/prompts/raw/master/media/confirm.gif\")
\n\n```js\n{\n type: 'confirm',\n name: 'value',\n message: 'Can you confirm?',\n initial: true\n}\n```\n\n\n#### Options\n| Param | Type | Description |\n| ----- | :--: | ----------- |\n| message | `string` | Prompt message to display |\n| initial | `boolean` | Default value. Default is `false` |\n| format | `function` | Receive user input. The returned value will be added to the response object |\n| onRender | `function` | On render callback. Keyword `this` refers to the current prompt |\n| onState | `function` | On state change callback. Function signature is an `object` with two properties: `value` and `aborted` |\n\n**↑ back to:** [Prompt types](#-types)\n\n***\n\n### list(message, [initial])\n> List prompt that return an array.\n\nSimilar to the `text` prompt, but the output is an `Array` containing the\nstring separated by `separator`.\n\n```js\n{\n type: 'list',\n name: 'value',\n message: 'Enter keywords',\n initial: '',\n separator: ','\n}\n```\n\n![\"list](\"https://github.com/terkelg/prompts/raw/master/media/list.gif\")
\n\n\n| Param | Type | Description |\n| ----- | :--: | ----------- |\n| message | `string` | Prompt message to display |\n| initial | `boolean` | Default value |\n| format | `function` | Receive user input. The returned value will be added to the response object |\n| separator | `string` | String separator. Will trim all white-spaces from start and end of string. Defaults to `','` |\n| onRender | `function` | On render callback. Keyword `this` refers to the current prompt |\n| onState | `function` | On state change callback. Function signature is an `object` with two properties: `value` and `aborted` |\n\n**↑ back to:** [Prompt types](#-types)\n\n***\n\n### toggle(message, [initial], [active], [inactive])\n> Interactive toggle/switch prompt.\n\nUse tab or arrow keys/tab/space to switch between options.\n\n#### Example\n![\"toggle](\"https://github.com/terkelg/prompts/raw/master/media/toggle.gif\")
\n\n```js\n{\n type: 'toggle',\n name: 'value',\n message: 'Can you confirm?',\n initial: true,\n active: 'yes',\n inactive: 'no'\n}\n```\n\n#### Options\n| Param | Type | Description |\n| ----- | :--: | ----------- |\n| message | `string` | Prompt message to display |\n| initial | `boolean` | Default value. Defaults to `false` |\n| format | `function` | Receive user input. The returned value will be added to the response object |\n| active | `string` | Text for `active` state. Defaults to `'on'` |\n| inactive | `string` | Text for `inactive` state. Defaults to `'off'` |\n| onRender | `function` | On render callback. Keyword `this` refers to the current prompt |\n| onState | `function` | On state change callback. Function signature is an `object` with two properties: `value` and `aborted` |\n\n**↑ back to:** [Prompt types](#-types)\n\n***\n\n### select(message, choices, [initial], [hint], [warn])\n> Interactive select prompt.\n\nUse up/down to navigate. Use tab to cycle the list.\n\n#### Example\n![\"select](\"https://github.com/terkelg/prompts/raw/master/media/select.gif\")
\n\n```js\n{\n type: 'select',\n name: 'value',\n message: 'Pick a color',\n choices: [\n { title: 'Red', description: 'This option has a description', value: '#ff0000' },\n { title: 'Green', value: '#00ff00', disabled: true },\n { title: 'Blue', value: '#0000ff' }\n ],\n initial: 1\n}\n```\n\n#### Options\n| Param | Type | Description |\n| ----- | :--: | ----------- |\n| message | `string` | Prompt message to display |\n| initial | `number` | Index of default value |\n| format | `function` | Receive user input. The returned value will be added to the response object |\n| hint | `string` | Hint to display to the user |\n| warn | `string` | Message to display when selecting a disabled option |\n| choices | `Array` | Array of strings or choices objects `[{ title, description, value, disabled }, ...]`. The choice's index in the array will be used as its value if it is not specified. |\n| onRender | `function` | On render callback. Keyword `this` refers to the current prompt |\n| onState | `function` | On state change callback. Function signature is an `object` with two properties: `value` and `aborted` |\n\n**↑ back to:** [Prompt types](#-types)\n\n***\n\n### multiselect(message, choices, [initial], [max], [hint], [warn])\n### autocompleteMultiselect(same)\n> Interactive multi-select prompt. \n> Autocomplete is a searchable multiselect prompt with the same options. Useful for long lists.\n\nUse space to toggle select/unselect and up/down to navigate. Use tab to cycle the list. You can also use right to select and left to deselect.\nBy default this prompt returns an `array` containing the **values** of the selected items - not their display title.\n\n#### Example\n![\"multiselect](\"https://github.com/terkelg/prompts/raw/master/media/multiselect.gif\")
\n\n```js\n{\n type: 'multiselect',\n name: 'value',\n message: 'Pick colors',\n choices: [\n { title: 'Red', value: '#ff0000' },\n { title: 'Green', value: '#00ff00', disabled: true },\n { title: 'Blue', value: '#0000ff', selected: true }\n ],\n max: 2,\n hint: '- Space to select. Return to submit'\n}\n```\n\n#### Options\n| Param | Type | Description |\n| ----- | :--: | ----------- |\n| message | `string` | Prompt message to display |\n| format | `function` | Receive user input. The returned value will be added to the response object |\n| instructions | `string` or `boolean` | Prompt instructions to display |\n| choices | `Array` | Array of strings or choices objects `[{ title, value, disabled }, ...]`. The choice's index in the array will be used as its value if it is not specified. |\n| optionsPerPage | `number` | Number of options displayed per page (default: 10) |\n| min | `number` | Min select - will display error |\n| max | `number` | Max select |\n| hint | `string` | Hint to display to the user |\n| warn | `string` | Message to display when selecting a disabled option |\n| onRender | `function` | On render callback. Keyword `this` refers to the current prompt |\n| onState | `function` | On state change callback. Function signature is an `object` with two properties: `value` and `aborted` |\n\nThis is one of the few prompts that don't take a initial value.\nIf you want to predefine selected values, give the choice object an `selected` property of `true`.\n\n**↑ back to:** [Prompt types](#-types)\n\n***\n\n### autocomplete(message, choices, [initial], [suggest], [limit], [style])\n> Interactive auto complete prompt.\n\nThe prompt will list options based on user input. Type to filter the list.\nUse ⇧/⇩ to navigate. Use tab to cycle the result. Use Page Up/Page Down (on Mac: fn + ⇧ / ⇩) to change page. Hit enter to select the highlighted item below the prompt.\n\nThe default suggests function is sorting based on the `title` property of the choices.\nYou can overwrite how choices are being filtered by passing your own suggest function.\n\n#### Example\n![\"auto](\"https://github.com/terkelg/prompts/raw/master/media/autocomplete.gif\")
\n\n```js\n{\n type: 'autocomplete',\n name: 'value',\n message: 'Pick your favorite actor',\n choices: [\n { title: 'Cage' },\n { title: 'Clooney', value: 'silver-fox' },\n { title: 'Gyllenhaal' },\n { title: 'Gibson' },\n { title: 'Grant' }\n ]\n}\n```\n\n#### Options\n| Param | Type | Description |\n| ----- | :--: | ----------- |\n| message | `string` | Prompt message to display |\n| format | `function` | Receive user input. The returned value will be added to the response object |\n| choices | `Array` | Array of auto-complete choices objects `[{ title, value }, ...]` |\n| suggest | `function` | Filter function. Defaults to sort by `title` property. `suggest` should always return a promise. Filters using `title` by default |\n| limit | `number` | Max number of results to show. Defaults to `10` |\n| style | `string` | Render style (`default`, `password`, `invisible`, `emoji`). Defaults to `'default'` |\n| initial | `string \\| number` | Default initial value |\n| fallback | `string` | Fallback message when no match is found. Defaults to `initial` value if provided |\n| onRender | `function` | On render callback. Keyword `this` refers to the current prompt |\n| onState | `function` | On state change callback. Function signature is an `object` with two properties: `value` and `aborted` |\n\nExample on what a `suggest` function might look like:\n```js\nconst suggestByTitle = (input, choices) =>\n Promise.resolve(choices.filter(i => i.title.slice(0, input.length) === input))\n```\n\n**↑ back to:** [Prompt types](#-types)\n\n***\n\n### date(message, [initial], [warn])\n> Interactive date prompt.\n\nUse left/right/tab to navigate. Use up/down to change date.\n\n#### Example\n![\"date](\"https://github.com/terkelg/prompts/raw/master/media/date.gif\")
\n\n```js\n{\n type: 'date',\n name: 'value',\n message: 'Pick a date',\n initial: new Date(1997, 09, 12),\n validate: date => date > Date.now() ? 'Not in the future' : true\n}\n```\n\n#### Options\n| Param | Type | Description |\n| ----- | :--: | ----------- |\n| message | `string` | Prompt message to display |\n| initial | `date` | Default date |\n| locales | `object` | Use to define custom locales. See below for an example. |\n| mask | `string` | The format mask of the date. See below for more information.