@types/prompts

Basic Text Prompt

This feature allows you to create a basic text prompt where the user can input a string. The example asks for the user's name and then greets them.

const prompts = require('prompts');

(async () => {
  const response = await prompts({
    type: 'text',
    name: 'value',
    message: 'What is your name?'
  });
  console.log(`Hello, ${response.value}!`);
})();

Select Prompt

This feature allows you to create a select prompt where the user can choose from a list of options. The example lets the user pick a color from a list.

const prompts = require('prompts');

(async () => {
  const response = await prompts({
    type: 'select',
    name: 'color',
    message: 'Pick a color',
    choices: [
      { title: 'Red', value: 'red' },
      { title: 'Green', value: 'green' },
      { title: 'Blue', value: 'blue' }
    ],
    initial: 1
  });
  console.log(`You chose: ${response.color}`);
})();

Confirm Prompt

This feature allows you to create a confirm prompt where the user can answer with a yes or no. The example asks if the user wants to continue and logs the response.

const prompts = require('prompts');

(async () => {
  const response = await prompts({
    type: 'confirm',
    name: 'value',
    message: 'Do you want to continue?'
  });
  console.log(response.value ? 'Continuing...' : 'Aborted');
})();