promptSecret

import { promptSecret } from "jsr:@ende/cli";

function

function promptSecret(message: string = Secret, options?: PromptSecretOptions): string | null

Shows the given message and waits for the user's input. Returns the user's input as string. This is similar to prompt() but it print user's input as * to prevent password from being shown. Use an empty mask if you don't want to show any character.

message: string = Secret

The prompt message to show to the user.

options?: PromptSecretOptions

The options for the prompt.

Returns

The string that was entered or null if stdin is not a TTY.

Example: Usage

import { promptSecret } from "@ende/cli/prompt-secret";

const password = promptSecret("Please provide the password:");
if (password !== "some-password") {
  throw new Error("Access denied");
}

Source