@inquirer/password

@inquirer/password

Interactive password input component for command line interfaces. Supports input validation and masked or transparent modes.

Installation

yarn	pnpm
yarn add @inquirer/prompts	pnpm add @inquirer/prompts
bun	deno
bun add @inquirer/prompts	deno add npm:@inquirer/prompts
npm
npm install @inquirer/prompts
Or
yarn	pnpm
yarn add @inquirer/password	pnpm add @inquirer/password
bun	deno
bun add @inquirer/password	deno add npm:@inquirer/password
npm
npm install @inquirer/password

On Deno, prompts detect the terminal's unicode and color support from the environment, so run your script with --allow-env.

Usage

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

const answer = await password({ message: 'Enter your name' });

Options

Property	Type	Required	Description
message	string	yes	The question to ask
mask	boolean | string	no	Show a * mask over the input, use a custom mask character, or keep it transparent.
toggleMask	boolean	no	Allow the user to press ctrl+t to temporarily reveal the typed value. Defaults to true; set to false to disable both the shortcut and its help line.
validate	string => boolean | string | Promise<boolean | string>	no	On submit, validate the filtered answered content. When returning a string, it'll be used as the error message displayed to the user. Note: returning a rejected promise, we'll assume a code error happened and crash.
theme	See Theming	no	Customize look of the prompt.

Theming

You can theme a prompt by passing a theme object option. The theme object only need to includes the keys you wish to modify, we'll fallback on the defaults for the rest.

type Theme = {
  prefix: string | { idle: string; done: string };
  spinner: {
    interval: number;
    frames: string[];
  };
  style: {
    answer: (text: string) => string;
    message: (text: string, status: 'idle' | 'done' | 'loading') => string;
    error: (text: string) => string;
    help: (text: string) => string;
    maskedText: string;
    keysHelpTip: (keys: [key: string, action: string][]) => string | undefined;
  };
};

maskedText is the inline tip shown when mask is off and the value is hidden (default: [input is masked]).

theme.style.keysHelpTip

This function customizes the keyboard shortcut help displayed on the line below the prompt. It receives [['ctrl+t', 'toggle visibility']] while the value is hidden. Use it to change the formatting or localize the action, or return undefined to hide the help line entirely.

theme: {
  style: {
    keysHelpTip: (keys) =>
      keys.map(([key, action]) => `${key}: ${action}`).join(' | '),
  },
}

License

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

Similar packages

Other packages similar to @inquirer/password

prompt-password

A focused terminal password prompt that masks input. It serves a similar purpose, while @inquirer/password fits into Inquirer's prompt ecosystem and conventions.

enquirer

A broader interactive-prompt library that includes password-style prompts alongside other prompt types. It offers a larger prompt toolkit, whereas @inquirer/password is focused on password entry within Inquirer.

prompts

A general-purpose interactive prompt library with a password prompt type. It provides multiple prompt types in one package; @inquirer/password is a dedicated Inquirer prompt package.

@inquirer/input

An Inquirer package for ordinary text input. It shares the Inquirer ecosystem and interactive terminal workflow, but is intended for visible text rather than masked password entry.