Skip to content

Commit

Permalink
update readme to match output
Browse files Browse the repository at this point in the history
  • Loading branch information
atoponce committed Apr 1, 2021
1 parent fd9c534 commit 759e7d8
Showing 1 changed file with 23 additions and 17 deletions.
40 changes: 23 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,59 +8,65 @@ needed to view the characters correctly.

Options are:

Usage: node main.js [OPTION [ARG]]...
Usage: nodepassgen [OPTION [ARG]]...
NOTE: A Unicode font may be needed to view some of the passwords correctly.
-h, --help Print this help and exit.
-a, --alternate WORDLIST Choose an alternate wordlist. Default is Trump.
WORDLIST must be one of:
Deseret, Colors, Elvish, Klingon, PGP,
Rockyou, Shavian, Simpsons, Trump
Deseret, Colors, Elvish, English, Klingon,
PGP, Pokerware, Rockyou, Shavian, Simpsons,
S/KEY, Trump.
NOTE: "English" combines every English word list.
-b, --bitcoin LANGUAGE Choose a Bitcoin language. Default is English.
LANGUAGE must be one of:
Chinese, Czech, English, French, Italian,
Japanese, Korean, Portuguese
Japanese, Korean, Portuguese.
NOTE: Simplified Chinese is the default Chinese
character set. If you want to use Traditional
Chinese, use --traditional.
-B, --bubble Choose Bubble Babble encoding.
-d, --diceware LANGUAGE Choose a Diceware language. Default is English.
LANGUAGE must be one of:
Basque, Beale, Bulgarian, Catalan, Chinese,
Czech, Danish, Dutch, English, Esperanto,
Estonian, Finnish, French, German, Greek,
Hebrew, Hungarian, Italian, Japanese, Latin,
Maori, Norwegian, Polish, Portuguese,
Maori, NLP, Norwegian, Polish, Portuguese,
Romanian, Russian, Slovak, Slovenian, Spanish
Swedish, Turkish
Swedish, Turkish.
NOTE: NLP is "Natural Language Passwords".
-D, --dicekey Generate a hard-coded 198-bit entropy text-based
DiceKeys key. Format of the key is:
<character><side><orientation> where:
<character>: Shuffled A-Z without Q
<side>: Random side 1-6 of the die
<orientation>: Random N,E,S,W cardinal direction
<orientation>: Random t,r,b,l direction
-e, --eff WORDLIST Choose an EFF wordlist. Default is Short.
WORDLIST must be one of:
Distant, Long, Potter, Short, Trek, Wars.
-H, --hyphenate Hyphenate Diceware, EFF, & Alternate passphrases.
Distant, Long, Potter, Short, Thrones, Trek,
Wars.
-H, --hyphenate Hyphenate Alternate, Bitcoin, Diceware, EFF, and
system passphrases.
-j, --json Output the passwords and meta in JSON format.
-k, --kpop Choose Korean K-pop words.
-m, --min-entropy NUMBER Set a minimum entropy in bits. Default is 70.
-n, --ninja Choose Secret Ninja encoding.
-o, --only GENERATOR Choose a generator instead of printing all six.
GENERATOR must be one of:
Alternate, Bitcoin, Diceware, EFF,
Pseudowords, Random, System
-r, --random SET Choose from a string set. Default is Base94
Pseudowords, Random, System.
-p, --pseudowords OPTION Choose a Pseudowords option. Default is Apple.
OPTION must be one of:
Apple, Babble, K-pop, Ninja.
-r, --random SET Choose from a string set. Default is Base94.
SET must be one of:
Base256, Base188, Base94, Base85, Base64,
Base62, Base58, Base52, Base36, Base32,
Base26, Base16, Base10, Base8, Base2, Coins,
DNA, Emoji
DNA, Emoji.
NOTE: Braile Base256, use -R, --braille.
-R, --braille Use Braille patterns for Base256.
-s, --system Use /usr/share/dict/words for the passphrase.
NOTE: larger word lists have more obscure words.
-t, --traditional Use Traditional Chinese with Bitcoin.


Output can be valid JSON, meant to be both human and machine parseable. Default
is unformatted plaintext:
Expand All @@ -70,7 +76,7 @@ is unformatted plaintext:
Bitcoin(English): marine zone system type middle tilt margin
Diceware(English): boone ani nuclei cuba bhoy shied
EFF(Short): hush blot agent ounce trash chess hub
Pseudowords(Apple_Inc): Qihxes-rebvir-3arrid
Pseudowords(Apple): Qihxes-rebvir-3arrid
Random(Base94): XuLk?26Y!DS

$ nodepassgen -j | jq
Expand Down Expand Up @@ -105,7 +111,7 @@ is unformatted plaintext:
},
{
"Generator": "Pseudowords",
"Wordlist": "Apple_Inc",
"Wordlist": "Apple",
"Password": "9imken-tipnub-zezvaB",
"Characters": 20,
"Entropy": 72
Expand Down

0 comments on commit 759e7d8

Please sign in to comment.