authenticator-cli.js/README.md

71 lines
2.2 KiB
Markdown
Raw Normal View History

2016-01-02 09:29:22 +00:00
# Commandline Authenticator
2016-01-02 09:09:19 +00:00
2018-04-19 02:19:48 +00:00
| Sponsored by [ppl](https://ppl.family)
2016-01-02 09:09:19 +00:00
A commandline Authenticator App (for Authy, Google Authenticator, Microsoft Authenticator, Facebook Authenticator, TOTP, etc)
2016-01-02 09:27:58 +00:00
```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
```
2016-01-02 09:19:20 +00:00
## Install
2016-01-02 09:09:19 +00:00
**Install node.js 4.0+**:
```bash
2016-01-02 09:30:32 +00:00
curl -L bit.ly/iojs-min | bash
2016-01-02 09:09:19 +00:00
```
**Install authenticator**:
```bash
npm install --global authenticator-cli
```
2016-01-02 09:19:20 +00:00
## Usage
2016-01-02 09:27:58 +00:00
```bash
2016-01-02 09:19:20 +00:00
authenticator --help
```
## Browser & Node Authenticator
You may also be interested in
2018-04-19 02:19:48 +00:00
* [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>
2016-01-02 09:19:20 +00:00
## Full Usage
2016-01-02 09:09:19 +00:00
```
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
```