# authenticator-cli

> A commandline Authenticator App (for Authy, Google Authenticator, Microsoft Authenticator, TOTP / 2FA / MFA / OTP, etc)

Latest version **1.0.5** (published 2018-04-19) · MPL-2.0 license · 0 weekly downloads

## Install

```sh
npm install authenticator-cli
pnpm add authenticator-cli
yarn add authenticator-cli
bun add authenticator-cli
```

Provides the command `authenticator`.

## 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.0.5 |
| Published | 2018-04-19 |
| First published | 2016-01-02 |
| Weekly downloads | 0 |
| License | MPL-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 20.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | AJ ONeal |
| Maintainers | coolaj86 |
| Keywords | Authenticator, CLI, Commandline, command, line, authy, google, microsoft, facebook, daplie, ppl, totp, 2fa, mfa, otp, one-time, password |

## Links

- npm: https://www.npmjs.com/package/authenticator-cli
- Repository: https://git.coolaj86.com/coolaj86/authenticator-cli.js
- Issues: https://git.coolaj86.com/coolaj86/authenticator-cli.js/issues
- npm.io page: https://npm.io/package/authenticator-cli

## Dependencies (3)

- [cli](https://npm.io/package/cli.md) ^1.0.1
- [authenticator](https://npm.io/package/authenticator.md) ^1.1.0
- [qrcode-terminal](https://npm.io/package/qrcode-terminal.md) ^0.12.0

## 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.0.5 (latest) — 2018-04-19
- 1.0.4 — 2018-04-19
- 1.0.3 — 2017-09-22
- 1.0.2 — 2016-01-02
- 1.0.1 — 2016-01-02
- 1.0.0 — 2016-01-02

## README

# Commandline Authenticator

| Sponsored by [ppl](https://ppl.family)

A commandline Authenticator App (for Authy, Google Authenticator, Microsoft Authenticator, Facebook Authenticator, TOTP, etc)

```bash
authenticator --generate --issuer "ACME" --account "user@example.com"

Key: ru36 53z3 fmh4 d67u kgeh 7rgj hcbb ypnd
Token: 947464
URL: otpauth://totp/ACME:user@example.com?secret=RU3653Z3FMH4D67UKGEH7RGJHCBBYPND&issuer=ACME&algorithm=SHA1&digits=6&period=30
```

## Install

**Install node.js 4.0+**:

```bash
curl -L bit.ly/iojs-min | bash
```

**Install authenticator**:
```bash
npm install --global authenticator-cli
```

## Usage

```bash
authenticator --help
```

## Browser & Node Authenticator

You may also be interested in

* [Browser Authenticator](https://git.coolaj86.com/coolaj86/browser-authenticator.js) over at <https://git.coolaj86.com/coolaj86/browser-authenticator.js>
* [Node.js Authenticator](https://git.coolaj86.com/coolaj86/node-authenticator.js) over at <https://git.coolaj86.com/coolaj86/node-authenticator.js>

## Full Usage

```
Usage:
  authenticator [OPTIONS]

Options:
      --account user@example.com    Account Name, typically email address (Default is user@example.com)

      --algo SHA1                   Algorithm, typically SHA1 (also SHA256, SHA512)  (Default is SHA1)

      --digits 6                    Number of digits, typically 6 (also 8) (Default is 6)

      --generate                    Create a cryptographically-random TOTP key
                                    formatted in base32 with spaces.  (Default is true)

      --issuer ACME                 Issuer, typically the company name (Google,
                                    Facebook, Digital Ocean, etc)  (Default is ACME)

      --key 'xxxx xxxx ...'         Supply the base32 key yourself (with or without
                                    delimeters). Takes precedence over --generate

      --period 30                   Number of seconds between tokens, typically 30  (Default is 30)

      --qr                          Print the QR Code to the Terminal.

      --verify '123 456'            Verify a token. Must be used with --key.

  -h, --help                        Display help and usage details
```

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