# password-prompt

> cross-platform masked or hidden prompt

Latest version **1.1.3** (published 2023-07-25) · 0BSD license · 0 weekly downloads

## Install

```sh
npm install password-prompt
pnpm add password-prompt
yarn add password-prompt
bun add password-prompt
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.3 |
| Published | 2023-07-25 |
| First published | 2016-08-01 |
| Weekly downloads | 0 |
| License | 0BSD |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 4.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 22 |
| Author | Jeff Dickey @jdxcode |
| Maintainers | dickeyxxx, rasphilco, elbandito |
| Keywords | cli, input, password, prompt |

## Links

- npm: https://www.npmjs.com/package/password-prompt
- Repository: https://github.com/jdxcode/password-prompt
- Issues: https://github.com/jdxcode/password-prompt/issues
- npm.io page: https://npm.io/package/password-prompt

## Dependencies (2)

- [cross-spawn](https://npm.io/package/cross-spawn.md) ^7.0.3
- [ansi-escapes](https://npm.io/package/ansi-escapes.md) ^4.3.2

## Alternatives

- [@salesforce/cli](https://npm.io/package/@salesforce/cli.md) — 389.7K weekly downloads
- [@mintlify/cli](https://npm.io/package/@mintlify/cli.md) — 208.9K weekly downloads
- [@grafana/e2e-selectors](https://npm.io/package/@grafana/e2e-selectors.md) — 128.7K weekly downloads
- [mintlify](https://npm.io/package/mintlify.md) — 112.0K weekly downloads
- [@intlayer/cli](https://npm.io/package/@intlayer/cli.md) — 22.8K weekly downloads

## Recent versions

- 1.1.3 (latest) — 2023-07-25
- 1.1.2 — 2019-02-20
- 1.1.0 — 2019-02-19
- 1.0.7 — 2018-08-03
- 1.0.6 — 2018-05-10
- 1.0.5 — 2018-05-06
- 1.0.4 — 2018-01-20
- 1.0.3 — 2017-09-09
- 1.0.2 — 2016-08-01
- 1.0.1 — 2016-08-01
- 1.0.0 — 2016-08-01

## README

# password-prompt

Node cross-platform password prompt.

Supported Environments:

* Unix
* TTY or non-TTY
* cygwin
* Git Bash
* cmd.exe
* PowerShell
* cmder
* Console2

# API Reference
prompt -- Prompt for a password

**Returns**: <code>Promise.&lt;string&gt;</code> - input from user  

| Param | Type | Default | Description |
| --- | --- | --- | --- |
| [ask] | <code>string</code> |  | prompt output |
| [options] | <code>Object</code> |  |  |
| [options.method] | <code>string</code> | <code>&quot;mask&quot;</code> | mask or hide |

**Example**  
```js
let prompt = require('password-prompt')
let password = prompt('password: ')
// password: ******
```

---
_Source: https://npm.io/package/password-prompt · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._