sts10 / rug

Generate random usernames

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

This project has moved to https://github.com/sts10/nametag

Rug (Random Username Generator)

This project has moved

Generates random usernames from a given word list.

$ rug
barbecuedreliance655
ace_conduit879
overdressed_leftover489
ill-considered_monopolization726
phantomsuspect347
badlevel251
precautionarywesterner537
horse-drawn_futility393
incompatiblecontingent628
vapid_protea736

Usage

USAGE:
    rug [FLAGS] [OPTIONS]

FLAGS:
    -h, --help          Prints help information
    -t, --title-case    Uses Title Case for words in generated usernames
    -V, --version       Prints version information
    -v, --verbose       Prints verbose output, including parameters as received

OPTIONS:
    -l, --list <list-file-path>       Provide a txt file with a list of words to generate username from randomly
    -m, --maximum <maximum-length>    Set maximum username length. Must be greater than 5 [default: 100]
    -n, --number <number-to-print>    Set how many random usernames to output [default: 10]

If the maximum option is set less than 11, rug will only pull one word from the word list. If it's set to 11 or higher, it will pull two words from the word list.

Note: This program is NOT intended to be used to create secure passwords. Do NOT use this program to create passwords.

Usage examples

  • rug generates 10 random usernames from included word lists (see below)
  • rug -l path/to/a/custom_wordlist.txt generates 10 random usernames using words from provided .txt file, where each word is on its own line
  • rug -n 5 -m 12 generates 5 random usernames with a maximum length of 12 characters.
  • rug -n 5 -t generates 5 random usernames where each word is in Title Case.

Installation

  1. Install Rust if you haven't already
  2. Run: cargo install --git https://github.com/sts10/rug

Changelog

0.4.0: As of v 0.4.0, by default, rug uses two word lists from the SecureDrop project. Since that project uses the AGPLv3 License, I'm also using that License for rug from this version forward. Previous versions of rug used the MIT License.

On the included word lists

If no word list is provided, rug uses one or two word lists from the SecureDrop project to create usernames. If the maximum length allows (or is not specified), usernames will be in "adjective + noun + number" format. If the maximum length is set below 11 characters, rug will use a "noun + number" format.

If the user provides a word list of their own, using the -l option, rug will use that provided list to generate both words.

About

Generate random usernames

License:GNU Affero General Public License v3.0


Languages

Language:Rust 100.0%