xkcd-style password generator
$ xpg -h
xpg 0.17.1 <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:
-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, toggle, camel, pascal, upper-camel, snake,
upper-snake, screaming-snake, kebab, cobol,
upper-kebab, train, flat, upper-flat, alternating,
random, pseudo-random]
-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.17.1
See also the Configuration section below.
$ xpg
giftwhethersupplyhowever
$ xpg -c 10
opinionsavenightpretty
typegaincosttried
frenchbusycoastcent
governmentlefthoursdesign
sideknowescapefood
desireflatpubliccompound
septemberbabyorderspell
thrownherewrotesweet
niecethroughfamilytemperature
darklargeweightdistant
or until Ctrl+C / SIGINT
$ xpg -c 0
mountainlifesomeonepicked
senselisbondevicefavor
numbersuccesscopenhagensouth
glossaryhimselfreallyscience
stationhearathensshoe
againtoolsdoctortokyo
evenhappenfloridasudden
glossaryneptunepickedplains
stringpresidentsslowcanada
reachhavanafivehurry
^C
$ xpg wwwwwwww
goldmercurytogethergainjupiterglossarydifferentaunt
$ xpg wwwwwwww -c 10
becausechildrensailshoulderexperimentsurfacelondonspread
hundrednumberfootfigureaustraliasoonwheelsexcept
egypttakencooltodayladyfebruarystreamspoke
thenwhilesentbreadintobonesthrewmile
centsmastersuitelectricitybestrivercurrentafrica
shirtrepresentsizeweekjourneyrussiasecondsmall
mistercoastagreedbonesprobableangrygladwedge
realizemetalcoatpaidmexicothrewtriedactually
beingsmellsurprisewrongbutterstrangeroxygeninches
neckthissuggestedseptembermileparticularguideshirt
$ xpg wwddd
blackfinish751
$ xpg wwss
willparty~(
$ xpg wwds
clothfurther8.
$ xpg wwwwcc
themselvesrealizephrasecoveredwi
$ xpg wwwwCC
minutesmemberssquareorderVY
$ xpg TTTT
HistoryEuropeNumberMaster
$ xpg WWWW
SOUNDGROWTRIESDECIDE
An "any" character can be a lowercase letter, uppercase letter, digit, or symbol.
$ xpg wwwwaaaaa
evergentlekepttiny{mb,u
$ xpg www -m 15
differentwinterfair
$ xpg www -M 20
sharpdesertshoes
$ xpg www -m 20 -M 25 -a 1000
laughedactuallycross
See also Usage note 2.
$ xpg wwddds -l 16 -a 1000
springmodern086>
See also Usage note 2.
$ xpg '1TT!'
1SubjectHeight!
$ xpg 's{adj}{adj}{n}dd'
.steelfeltlife74
$ xpg 'ww{ext}'
industryauntcyllene
$ xpg 'ww{T:ext}'
raisemainMneme
$ xpg 'ww{W:ext}'
busyseasonGEORGIA
$ xpg -ec 10 TTTT
YardRiverIndustryBurning
HeardRepeatedSoundPlace
RollFrontEnteredHope
ThrowGiftCallirrhoeBranches
HusbandCareVowelOslo
DiscoverWhetherPersephoneOhio
TinyCountryPropertyReally
DivisionMightTookBell
YourDuskBetterCopy
NaiadMexicoSouthdakotaAlready
$ xpg keychain
ykgNss-amccvl-i2xvye
$ xpg codename
BROAD EFFECT
$ xpg codename-series
GREATFOOT HUGECOLOR
GREATFOOT SEVENBEHIND
GREATFOOT WIDEMETHOD
GREATFOOT ADVANCENOTICE
GREATFOOT RATHERCONSONANT
GREATFOOT CORRECTTELL
GREATFOOT SLOWWALL
GREATFOOT ENOUGHMOUTH
GREATFOOT WORNPRODUCTS
GREATFOOT FULLUNCLE
$ xpg codename-series -c 20
EIGHTABOVE LEFTLOSS
EIGHTABOVE REALSATURDAY
EIGHTABOVE BOTTOMFOOT
EIGHTABOVE EARLYSIZE
EIGHTABOVE UNDEREFFECT
EIGHTABOVE NEXTREPLY
EIGHTABOVE EVENEQUATION
EIGHTABOVE MODERNRIGHT
EIGHTABOVE ONCESTICK
EIGHTABOVE BRITISHVIEW
EIGHTABOVE ABOVEBATTERY
EIGHTABOVE THROWNANYTHING
EIGHTABOVE CURRENTINSTRUMENTS
EIGHTABOVE DARKSUNDAY
EIGHTABOVE ANGRYEXAMPLE
EIGHTABOVE DISTANTWONDER
EIGHTABOVE EQUALGOODBYE
EIGHTABOVE ACTIONFLOOR
EIGHTABOVE FAIRPEOPLE
EIGHTABOVE NINECAME
$ xpg haiku
Life sound various / Signal pick sentence wind coat / Considerable
$ xpg haiku+
Receive scene over (2,1,2) / Experiment follow jump (4,2,1) / Battery poem shop (3,1,1)
$ xpg haiku-
Continued-drawing(3,2)/Electricity-whether(5,2)/Vermont-agree-though(2,2,1)
$ xpg haiku--
Birds-deal-foreign-huge/Silent-industry-plains-killed/Gentleman-waves-since
$ xpg haiku++
Particular ride
Animal everything last
Electricity
$ xpg haiku+++
Yourself electric (2,3)
Open presidents first sure (2,3,1,1)
Hold japanese wild (1,3,1)
$ xpg -e haiku
South Carolina / Nearly New Mexico life / Join even silent
$ xpg aaaaaaaaaaaaaaaaaaaa
j}E)>,7pMDPoa,@sCDuP
This works because a character-only pattern is padded to the minimum length with the last character.
$ xpg a -m 20
!zD}9{5QJ$U,@lQ0zc@x
$ xpg wwww WWWW TTTT
goldbonelisbonwagon
EXPRESSHAVESPOTTRAVEL
CarryFingerBotswanaPattern
$ xpg -A upper 'T T T T'
ENGINE NOON BLOCK SAYS
$ xpg -A lower 'T T T T'
across soon ship green
$ xpg -A title 'T T T T'
Which Yellow China Shore
$ xpg -A toggle 'T T T T'
jUMP dRINK wASH mAIL
$ xpg -A camel 'T T T T'
presidentsPoleTravelKind
$ xpg -A pascal 'T T T T'
SisterSeemNovemberCare
$ xpg -A upper-camel 'T T T T'
ThickUsualStudentsCome
$ xpg -A snake 'T T T T'
shape_built_being_answer
$ xpg -A upper-snake 'T T T T'
BESIDE_HOLE_SOIL_CELLS
$ xpg -A screaming-snake 'T T T T'
SEPTEMBER_HAND_COTTON_POSITION
$ xpg -A kebab 'T T T T'
mine-rain-partial-burn
$ xpg -A cobol 'T T T T'
SOUTH-SPELL-STORM-PLEASURE
$ xpg -A upper-kebab 'T T T T'
WORK-HOLD-INFORMATION-REPLY
$ xpg -A train 'T T T T'
Huge-After-Blow-Love
$ xpg -A flat 'T T T T'
swedenweightcentsnote
$ xpg -A upper-flat 'T T T T'
PRODUCTSOPINIONSTOPENEMY
$ xpg -A alternating 'T T T T'
cAtTlE mUcH wEdNeSdAy NaTuRaL
$ xpg -A random 'T T T T'
sToP FREnCH aunt maTch
$ xpg -A pseudo-random 'T T T T'
PhrAsE eNTerED tRavEl PRoBabLY
$ xpg '{a:1}-{W:a:2}-{T:a:3}-{olympian:4}-{T:ext:5}'
dusk-POLAND-Havana-aphrodite-Philophrosyne
$ xpg -L '{color}'
black
blue
brown
gray
green
white
yellow
$ xpg -L '{W:color}'
BLACK
BLUE
BROWN
GRAY
GREEN
WHITE
YELLOW
$ xpg -L '{T:color}'
Black
Blue
Brown
Gray
Green
White
Yellow
$ xpg -L '{color}' |wc -l
7
$ xpg -L '{color}' '{W:el}'
black
blue
brown
gray
green
white
yellow
GOLD
IRON
LEAD
MERCURY
OXYGEN
SILVER
$ xpg -L |wc -l
1257
$ xpg -Le |wc -l
1403
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
- AllExtended /
{a.ext}
- All /
{a}
- Adjective /
{adj}
- Color* /
{color}
- Nationality /
{nat}
- Color* /
- Adverb /
{adv}
- Conjunction /
{conj}
- Interjection /
{i}
- Noun /
{n}
- PluralNoun /
{n.pl}
- Pronoun /
{n.pro}
- SingularNoun /
{n.s}
- Astronomy /
{ast}
- Moon /
{moon}
- Planet /
{planet}
- Moon /
- Color* /
{color}
- Day /
{day}
- Month /
{mon}
- ProperNoun /
{n.prop}
- Element /
{el}
- Name /
{name}
- FemaleName /
{fname}
- MaleName /
{mname}
- FemaleName /
- Place /
{place}
- City /
{city}
- Continent /
{cont}
- Country /
{country}
- UsState /
{us-state}
- City /
- Mythology /
{myth}
- GreekMyth /
{greekmyth}
- Olympian /
{olympian}
- Chthonic /
{chthonic}
- Olympian /
- RomanMyth /
{romanmyth}
- GreekMyth /
- Element /
- Astronomy /
- PluralNoun /
- Preposition /
{prep}
- Verb /
{v}
- AuxiliaryVerb /
{v.aux}
- IntransitiveVerb /
{v.int}
- TransitiveVerb /
{v.tr}
- VerbPast /
{v.past}
- AuxiliaryVerb /
- Adjective /
- Extended /
{ext}
- Noun /
{n}
- SingularNoun /
{n.s}
- Astronomy /
{ast}
- Moon /
{moon}
- MarsMoon /
{marsmoon}
- JupiterMoon /
{jupitermoon}
- SaturnMoon /
{saturnmoon}
- UranusMoon /
{uranusmoon}
- NeptuneMoon /
{neptunemoon}
- MarsMoon /
- Moon /
- Astronomy /
- SingularNoun /
- Noun /
- All /
Notes
-
WordKind /
{sub}
-
It is only necessary to set the most descriptive
WordKind
(s) since they are automatically included in the larger word kinds. -
The
characters
object value must contain theC
,c
, andd
keys with non-empty values. Additional keys/values can be added and used. -
{sub}
s produce lowercase words by default, but if prefixed withW:
orT:
words will be uppercase or title case, respectively: i.e.{W:sub}
or{T:sub}
(replacesub
with an actual{sub}
name above). -
{sub}
s include all words by default, but if suffixed with:N
whereN
is a number, it will only include words with that number of syllables: i.e.{sub:N}
(replacesub
with an actual{sub}
name above andN
with the desired number of syllables ~1-5).
Please find the CHANGELOG.md
in the repository.
- Word list originated from Bart Busschots' HSXKPasswd Perl module (GitHub, CPAN: Crypt::HSXKPasswd), specifically lib/Crypt/HSXKPasswd/Dictionary/EN.pm@1d88564:38