logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

xkcdpass - generate memorable, secure multiword passphrases

Author

       Ben Finney <ben+python@benfinney.id.au>

Description

       A flexible and scriptable password generator which generates strong passphrases, inspired by XKCD 936:

          $ xkcdpass
          > correct horse battery staple

Examples

xkcdpass

         Generates one passphrase with the default options. Example output:

            pinball previous deprive militancy bereaved numeric

       •
         xkcdpass --count=5 --acrostic='chaos' --delimiter='|' --min=5 --max=6 --valid_chars='[a-z]'

         Generates  5  passphrases, all from lower-case words and meeting the acrostic “chaos”, delimited by the
         “|” character. Example output:

            collar|highly|asset|ovoid|sultan
            caper|hangup|addle|oboist|scroll
            couple|honcho|abbot|obtain|simple
            cutler|hotly|aortae|outset|stool
            cradle|helot|axial|ordure|shale

History

       The xkcdpass command invokes the Python program xkcd_password.py.

       The inspiration for the program's purpose is the XKCD 936 <https://xkcd.com/936/>
        “Password Strength” cartoon.

       The application is maintained by Steven Tobin < <steven@steventob.in> >.

       This manual page was written by Ben Finney < <ben+python@benfinney.id.au> >.

Name

       xkcdpass - generate memorable, secure multiword passphrases

Options

--help
          Describe how to use this command.

       --wordfileWORDFILE, -wWORDFILE
          Specify that the file WORDFILE contains the list of valid words from which to generate passphrases.

       --minMIN_LENGTH
          Generate passphrases containing at least MIN_LENGTH words. (Default: 5)

       --maxMAX_LENGTH
          Generate passphrases containing at most MAX_LENGTH words. (Default: 9)

       --numwordsNUM_WORDS, -nNUM_WORDS
          Generate passphrases containing exactly NUM_WORDS words. (Default: 6)

       --interactive, -i
          Generate and output a passphrase, query the user to accept it, and loop until one is accepted.

       --valid-charsVALID_CHARS, -vVALID_CHARS
          Limit passphrases to only include words matching the regex pattern VALID_CHARS (e.g. '[a-z]').

       --verbose, -V
          Report various metrics for given options.

       --acrosticACROSTIC, -aACROSTIC
          Generate passphrases with an acrostic matching ACROSTIC.

       --countCOUNT, -cCOUNT
          Generate COUNT passphrases. (Default: 1)

       --delimiterDELIM, -dDELIM
          Separate words within a passphrase with DELIM. (Default: ' ')

       --separatorSEP, -sSEP
          Separate multiple passphrases with SEP. (Default: U+000A LINE FEED)

       --caseCASE, -CCASE
          Set the case of each word in the passphrase by method CASE.  (Default: lower)

          Valid CASE values are alternating, upper, lower, first, random.

Synopsis

xkcdpass [ option ... ]
       xkcdpass--help

See Also