# getpass

> getpass for node.js

Latest version **0.1.7** (published 2017-04-25) · MIT license · 0 weekly downloads

## Install

```sh
npm install getpass
pnpm add getpass
yarn add getpass
bun add getpass
```

## Health

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

Positive: has types package; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.7 |
| Published | 2017-04-25 |
| First published | 2016-04-21 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | separate (@types/getpass) |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 18 |
| Author | Alex Wilson |
| Maintainers | arekinath |

## Links

- npm: https://www.npmjs.com/package/getpass
- Repository: https://github.com/arekinath/node-getpass
- Homepage: https://github.com/arekinath/node-getpass#readme
- Issues: https://github.com/arekinath/node-getpass/issues
- npm.io page: https://npm.io/package/getpass

## Dependencies (1)

- [assert-plus](https://npm.io/package/assert-plus.md) ^1.0.0

## Recent versions

- 0.1.7 (latest) — 2017-04-25
- 0.1.6 — 2016-04-29
- 0.1.5 — 2016-04-21
- 0.1.4 — 2016-04-21
- 0.1.3 — 2016-04-21
- 0.1.2 — 2016-04-21
- 0.1.1 — 2016-04-21
- 0.1.0 — 2016-04-21

## README

## getpass

Get a password from the terminal. Sounds simple? Sounds like the `readline`
module should be able to do it? NOPE.

## Install and use it

```bash
npm install --save getpass
```

```javascript
const mod_getpass = require('getpass');
```

## API

### `mod_getpass.getPass([options, ]callback)`

Gets a password from the terminal. If available, this uses `/dev/tty` to avoid
interfering with any data being piped in or out of stdio.

This function prints a prompt (by default `Password:`) and then accepts input
without echoing.

Parameters:

 * `options`, an Object, with properties:
   * `prompt`, an optional String
 * `callback`, a `Func(error, password)`, with arguments:
   * `error`, either `null` (no error) or an `Error` instance
   * `password`, a String

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