@clack/prompts

What is @clack/prompts?

@clack/prompts is an npm package designed to facilitate the creation of interactive command-line prompts. It provides a variety of prompt types to gather user input in a streamlined and user-friendly manner.

What are @clack/prompts's main functionalities?

Text Prompt

This feature allows you to prompt the user for a text input. The example code asks the user for their name and then greets them.

const { text } = require('@clack/prompts');

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

Select Prompt

This feature allows you to present a list of options for the user to select from. The example code asks the user to choose a color from a list of options.

const { select } = require('@clack/prompts');

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

Confirm Prompt

This feature allows you to ask the user a yes/no question. The example code asks the user if they want to continue and logs a message based on their response.

const { confirm } = require('@clack/prompts');

(async () => {
  const proceed = await confirm({
    message: 'Do you want to continue?'
  });
  console.log(proceed ? 'Continuing...' : 'Operation aborted.');
})();

Password Prompt

This feature allows you to securely prompt the user for a password. The example code asks the user to enter their password and logs a confirmation message.

const { password } = require('@clack/prompts');

(async () => {
  const secret = await password({
    message: 'Enter your password:'
  });
  console.log('Password received.');
})();

Other packages similar to @clack/prompts

inquirer

Inquirer.js is a popular library for creating interactive command-line interfaces. It offers a wide range of prompt types and is highly customizable. Compared to @clack/prompts, Inquirer.js has a larger community and more extensive documentation.

prompts

Prompts is a lightweight, beautiful, and user-friendly library for creating command-line prompts. It supports various prompt types and is known for its simplicity and ease of use. While @clack/prompts focuses on a streamlined API, Prompts offers more customization options.

enquirer

Enquirer is a powerful and flexible library for creating interactive command-line prompts. It supports a wide range of prompt types and offers advanced features like validation and conditional prompts. Enquirer is more feature-rich compared to @clack/prompts, but it may have a steeper learning curve.

README

@clack/prompts