xpg 0.19.5

xkcd-style password generator
Documentation

About

xkcd-style password generator

xkcd #936: Password Strength

Usage

$ xpg -h
xpg 0.19.5 <https://crates.io/crates/xpg>

xkcd-style password generator

Usage: xpg [OPTIONS] [PATTERNS]...

Arguments:
  [PATTERNS]...  Pattern(s) (see note 1) [default: `wwww`, `-L`: `{a}`]

Options:
  -s, --shuffle             Shuffle characters
  -c, --count <NUMBER>      Number of passwords (0:∞ ) [default: 1]
  -l, --length <NUMBER>     Length
  -m, --minimum <NUMBER>    Minimum length
  -M, --maximum <NUMBER>    Maximum length
  -a, --attempts <NUMBER>   Attempts (see note 2) [default: 10]
  -C, --config <PATH>       Configuration file
  -e, --extended            Merge extended words (see note 3)
  -A, --apply-case <STYLE>  Apply case style [possible values: upper, lower,
                            title, camel, pascal, upper-camel, snake, constant,
                            upper-snake, screaming-snake, kebab, cobol,
                            upper-kebab, train, flat, upper-flat, sentence]
  -L, --list                List words in `{sub}`(s)
  -d, --dump-config         Print configuration
  -r, --readme              Print readme
  -h, --help                Print help
  -V, --version             Print version

---

Notes

1. Patterns
    * Words
        * `W`: WORD
        * `w`: word
        * `T`: Word
        * `k`: `shuffle(cccc(c|d)(C|c))`
        * `{sub}`: see `WordKind`s section in readme
    * Characters
        * `C`: A-Z
        * `c`: a-z
        * `d`: 0-9
        * `s`: `~!@#$%^&*-_=+;:,./?()[]{}<>`
        * `a`: `C` | `c` | `d` | `s`
    * Special
        * `keychain`
        * `codename`
        * `codename-series`
        * `haiku--` | `haiku-condensed`
        * `haiku-` | `haiku-with-syllables-condensed`
        * `haiku`
        * `haiku+` | `haiku-with-syllables`
        * `haiku++` | `haiku-full`
        * `haiku+++` | `haiku-full-with-syllables`

2. Ten attempts are made to satisfy the given length requirements by default;
   use `-a N` and set `N` to the number of attempts to increase chances.
   It will exit with an error if unable to satisfy requirements; some
   configurations will always produce an error.

3. Extended words are only available in exclusively extended word kinds by
   default; however, with `-e`, they are merged with regular word kinds; use
   with the `-L` option to see its effect.

$ xpg -V
xpg 0.19.5

See also the Configuration section below.

Examples

$ xpg
villagewrittenfallsuppose

Generate 10 passwords

$ xpg -c 10
expressstrangeseasonsubstances
destroyuntilmouthsilver
brightflowerwhetherline
growbodyjordannatural
gaindescribefriendnature
touchreasonworefellow
octobercommondarewants
noneoppositeeveryonemouth
saturdaystrangeloseaugust
tomorrowrootbuildingnovember

Generate passwords forever

or until Ctrl+C / SIGINT

$ xpg -c 0
starswindhappyapril
threesignmeetingtook
moonquicklywritesilent
capitalawaycornerbroke
battleelectrictoldmember
killanswerdollarpounds
whatwheelsfriendsbarbados
weretrueshotaddition
purefridaynieceyourself
dollarsbankeveryoneable
^C

Generate a password with 8 words

$ xpg wwwwwwww
understoodactionagainstgeneralsupposekilledwarsawhome

Generate 10 passwords with 8 words

$ xpg wwwwwwww -c 10
koreaarrivefarmerscurrentrushshirtbeenguard
supposespotpleasuresomeonewhosecommonindiaentire
brokenshotbrotherbackstandbelievewaterproud
conditionsclothrockthentearknownwaterhear
replythendiscoverpeacewrotetexaslaughterpretty
enemyunderlinedollarhuntingtradehearchurchsometimes
coverhuntsandgeneralhopequietbarbadosonce
carryraiseconditionbehindlargealthoughdiscovereditaly
amsterdamlittlestreethuntingdifficultoftenwingsexperience
wingmostallowletterbusydoesaustriasomeone

Generate a password with 2 words followed by 3 digits

$ xpg wwddd
cannotfoot243

Generate a password with 2 words followed by 2 symbols

$ xpg wwss
futurethrown[=

Generate a password with 2 words followed by a digit and a symbol

$ xpg wwds
gainarticle6/

Generate a password with 4 words followed by 2 lowercase letters

$ xpg wwwwcc
donedifficultshortstrangehz

Generate a password with 4 words followed by 2 uppercase letters

$ xpg wwwwCC
cowspaperstatementsingaporeJN

Generate a password with 4 title case words

$ xpg TTTT
LeavePluralQuicklyThese

Generate a password with 4 uppercase words

$ xpg WWWW
PLANTSSTUDENTSAUSTRALIAPLANET

Generate a password with 4 words followed by 5 any characters

An "any" character can be a lowercase letter, uppercase letter, digit, or symbol.

$ xpg wwwwaaaaa
variousspellbodychangeF0<9F

Generate a password with 3 words and at least 15 characters

$ xpg www -m 15
shownspentfather

Generate a password with 3 words and no more than 20 characters

$ xpg www -M 20
actuallydiedthought

Generate a password with 4 words and between 20 and 25 characters

$ xpg www -m 20 -M 25 -a 1000
containsouthquestions

See also Usage note 2.

Generate a password with 2 words, 3 digits, 1 symbol, and exactly 16 characters

$ xpg wwddds -l 16 -a 1000
londondemand337~

See also Usage note 2.

Generate a password with a 1, 2 title case words, and !

$ xpg '1TT!'
1LiftedFruit!

Generate a password with 1 symbol, 2 adjectives, 1 noun, and 2 digits

$ xpg 's{adj}{adj}{n}dd'
+decidedafraidbird40

Generate a password with 2 words and 1 extended word

$ xpg 'ww{ext}'
asiawordherse

Generate a password with 2 words and 1 title case extended word

$ xpg 'ww{T:ext}'
stepeverythingValetudo

Generate a password with 2 words and 1 uppercase extended word

$ xpg 'ww{W:ext}'
succeeddescribeCARPO

Generate 10 passwords with 4 title case words and extended words merged

$ xpg -ec 10 TTTT
SingaporeThusMusicDaily
SignalRuleFortiethTone
ThereforeTestDoubleBottle
KissWhomLeftCarry
VowelDamascusBelieveModern
ThickMannerOpinionBaby
MatterBirdRolledBelfast
VariousFebruaryCannotSpend
DelightEverAloneFool
WhereAfraidLargePass

Generate a keychain-style password

$ xpg keychain
ahhif3-hdfnyb-muiAqe

Generate a code name

$ xpg codename
CHARACTER ANGLE

Generate a code name series

$ xpg codename-series
IRONPRESIDENT SHARPYARD
IRONPRESIDENT FEELINGBONE
IRONPRESIDENT LEADCASE
IRONPRESIDENT WIDEFAMILY
IRONPRESIDENT TODAYSEED
IRONPRESIDENT USUALLYEQUATION
IRONPRESIDENT HUNDREDGENERAL
IRONPRESIDENT WHOSEAMOUNT
IRONPRESIDENT HOWEVERTILL
IRONPRESIDENT GREATQUIET

Generate a code name series with 20 code names

$ xpg codename-series -c 20
FINEWANT EASTSQUARE
FINEWANT WORNARMY
FINEWANT FOREIGNQUESTIONS
FINEWANT BOTTOMSTATION
FINEWANT TOGETHERDICTIONARY
FINEWANT LONEOTHER
FINEWANT SILENTSHAPE
FINEWANT GOLDFRUIT
FINEWANT RAISEDSYMBOLS
FINEWANT FOURTALK
FINEWANT MAJORINFORMATION
FINEWANT ANIMALINSECTS
FINEWANT BETTERMEET
FINEWANT STRAIGHTTRAINING
FINEWANT DOUBLEMAJOR
FINEWANT GROWNSHORE
FINEWANT ABLEBOTTOM
FINEWANT BROKENFINE
FINEWANT BROKEPLACE
FINEWANT SWEETLEADER

Generate a haiku

$ xpg haiku
Ridden shout around / Energy Alabama / Discover unit

Generate a haiku with syllable pattern

$ xpg haiku+
Ground rather bell bird (1,2,1,1) / Last repeated general (1,3,3) / Bulgaria doubt (4,1)

Generate a condensed haiku with syllable pattern

$ xpg haiku-
Delight-Asia-said(2,2,1)/Choose-judge-Chile-wild-bean-firm(1,1,2,1,1,1)/Fair-western-there-short(1,2,1,1)

Generate a condensed haiku

$ xpg haiku--
Pair-fifty-fifteen/Point-electricity-grown/Dictionary-song

Generate a haiku with newlines

$ xpg haiku++
Information brought
Electricity symbols
Building Montana

Generate a haiku with syllable pattern and newlines

$ xpg haiku+++
Hers September plains (1,3,1)
Electricity ship snow (5,1,1)
Considerable (5)

Generate a haiku with extended words

$ xpg -e haiku
Callirrhoe Wales / Plant push through Massachusetts / Phrase plural past dark

Generate a password with 20 any characters

$ xpg aaaaaaaaaaaaaaaaaaaa
^E?a4v([Q#ZSW]7Rcn[Q

Same as the previous example, but shorter

This works because a character-only pattern is padded to the minimum length with the last character.

$ xpg a -m 20
G(U(Lo-y6z,tBdwheUET

Generate a password with 5 lowercase, 1 uppercase, 1 digit, and 1 symbol

$ xpg cccccCds
kdxsgU1#

Generate a password with 5 lowercase, 1 uppercase, 1 digit, and 1 symbol and shuffle the characters

$ xpg -s cccccCds
nS8qygv>

Same as the previous example, but shorter

This works because a character-only pattern is padded to the minimum length with the last character.

$ xpg -sm 8 Cdsc
u^g3quXy

Generate 3 passwords each from a different pattern

$ xpg wwww WWWW TTTT
torefailgrassjapanese
PAGESHOULDPOLESING
ThisTrainingNounCalifornia

Apply upper casing

$ xpg -A upper 'T T T T'
SPAIN VERMONT IDEA GENERAL

Apply lower casing

$ xpg -A lower 'T T T T'
december wonder butter quiet

Apply title casing

$ xpg -A title 'T T T T'
Ridden Each Belgium Since

Apply camel casing

$ xpg -A camel 'T T T T'
detailsCarefullyYardSpot

Apply pascal casing

$ xpg -A pascal 'T T T T'
HomeGovernmentTriedBeautiful

Apply upper-camel casing

$ xpg -A upper-camel 'T T T T'
LetterGoldTwentyArrived

Apply snake casing

$ xpg -A snake 'T T T T'
point_sent_hand_partial

Apply upper-snake casing

$ xpg -A upper-snake 'T T T T'
WIFE_SELL_DAUGHTER_WEIGHT

Apply screaming-snake casing

$ xpg -A screaming-snake 'T T T T'
FENCE_SHOT_DAUGHTER_HERS

Apply kebab casing

$ xpg -A kebab 'T T T T'
while-waves-wore-church

Apply cobol casing

$ xpg -A cobol 'T T T T'
HELP-PAIR-SENT-PRACTICE

Apply upper-kebab casing

$ xpg -A upper-kebab 'T T T T'
TRUST-LADDER-THUS-TEAR

Apply train casing

$ xpg -A train 'T T T T'
Ring-Determine-View-Will

Apply flat casing

$ xpg -A flat 'T T T T'
alsostatementexperimentdivided

Apply upper-flat casing

$ xpg -A upper-flat 'T T T T'
SIGHTUNDERSTOODSAVESTREET

Generate a password with words with 1, 2, 3, 4, and 5 syllables

$ xpg '{a:1}-{W:a:2}-{T:a:3}-{olympian:4}-{T:ext:5}'
place-WEATHER-Electric-dionysus-Northcarolina

List the words in Color / {color}

$ xpg -L '{color}'
black
blue
brown
gray
green
white
yellow

List the words in Color / {color} in uppercase

$ xpg -L '{W:color}'
BLACK
BLUE
BROWN
GRAY
GREEN
WHITE
YELLOW

List the words in Color / {color} in title case

$ xpg -L '{T:color}'
Black
Blue
Brown
Gray
Green
White
Yellow

Count the words in Color / {color}

$ xpg -L '{color}' |wc -l
7

List the words in Color / {color} and Element / {W:el}

$ xpg -L '{color}' '{W:el}'
black
blue
brown
gray
green
white
yellow
GOLD
IRON
LEAD
MERCURY
OXYGEN
SILVER

Count words

$ xpg -L |wc -l
1257

Count words with extended

$ xpg -Le |wc -l
1403

Configuration

See config.json or use -d for the default configuration compiled into the binary executable.

If another file is placed at any of the following locations or the path provided via the -C option at runtime, it will be used instead.

  • Linux: /home/username/.config/xpg/config.json
  • Windows: C:\Users\username\AppData\Roaming\qtfkwk\xpg\config\config.json
  • macOS: /Users/username/Library/Application Support/com.qtfkwk.xpg/config.json

WordKinds

  • AllExtended / {a.ext}
    • All / {a}
      • Adjective / {adj}
        • Color* / {color}
        • Nationality / {nat}
      • Adverb / {adv}
      • Conjunction / {conj}
      • Interjection / {i}
      • Noun / {n}
        • PluralNoun / {n.pl}
        • Pronoun / {n.pro}
        • SingularNoun / {n.s}
          • Astronomy / {ast}
            • Moon / {moon}
            • Planet / {planet}
          • Color* / {color}
          • Day / {day}
          • Month / {mon}
          • ProperNoun / {n.prop}
            • Element / {el}
            • Name / {name}
              • FemaleName / {fname}
              • MaleName / {mname}
            • Place / {place}
              • City / {city}
              • Continent / {cont}
              • Country / {country}
              • UsState / {us-state}
            • Mythology / {myth}
              • GreekMyth / {greekmyth}
                • Olympian / {olympian}
                • Chthonic / {chthonic}
              • RomanMyth / {romanmyth}
      • Preposition / {prep}
      • Verb / {v}
        • AuxiliaryVerb / {v.aux}
        • IntransitiveVerb / {v.int}
        • TransitiveVerb / {v.tr}
        • VerbPast / {v.past}
    • Extended / {ext}
      • Noun / {n}
        • SingularNoun / {n.s}
          • Astronomy / {ast}
            • Moon / {moon}
              • MarsMoon / {marsmoon}
              • JupiterMoon / {jupitermoon}
              • SaturnMoon / {saturnmoon}
              • UranusMoon / {uranusmoon}
              • NeptuneMoon / {neptunemoon}

Notes

  1. WordKind / {sub}

  2. It is only necessary to set the most descriptive WordKind(s) since they are automatically included in the larger word kinds.

  3. The characters object value must contain the C, c, and d keys with non-empty values. Additional keys/values can be added and used.

  4. {sub}s produce lowercase words by default, but if prefixed with W: or T: words will be uppercase or title case, respectively: i.e. {W:sub} or {T:sub} (replace sub with an actual {sub} name above).

  5. {sub}s include all words by default, but if suffixed with :N where N is a number, it will only include words with that number of syllables: i.e. {sub:N} (replace sub with an actual {sub} name above and N with the desired number of syllables ~1-5).

Changelog

Please find the CHANGELOG.md in the repository.

References