README.md

🔑 Silly Password Generator

Generate silly passwords that are secure and easy to use. Inspired by xkcd.

   

 

Documentation

Read the official documentation.

→ Generate Silly Passwords ←

Overview

Generate fun and silly passwords that are secure, easy to type, and easy to remember. Inspired by xkcd.

Would you rather use the password Tr0ub4dor&3 or exciting creepy macho tiger?

Using an unrestricted brute-force attack, the first would take 3 seconds to crack, and the second would take 1 month. Exciting creepy macho tigers for the win!

Features include:

• 💩 Fun passwords are better than boring ones
  • Why use lame and hard to remember passwords, when you can use fun ones... that are also secure?
• 👨‍🔬 Password analysis
  • Leverage the brainpower of at least a dozen nerds. This library makes sure your password is secure using zxcvbn.
• 🔐 Secure
  • Have I mentioned that they're secure? Well, they are!
• 🔢 Customizable
  • Choose from a set of options to customize your password.

Donate

If this project helped you, please consider buying me a coffee or sponsoring me. Your support is much appreciated!

 

Table of Contents

• Documentation
  • → Generate Silly Passwords ←
• Overview
  • Features include:
• Donate
• Table of Contents
• Installation
• Quick Start
  • Via Website
  • Via npm
  • Analyzing Password Strength
• TypeScript
• Icon Attribution
• Contributing
• ⭐ Found It Helpful? Star It!
• License

Installation

npm i silly-password-generator

Quick Start

Via Website

Go here: Silly Password Generator

Via npm

import { generateSillyPassword } from 'silly-password-generator';

// Use with no options to generate a 4-word silly password
generateSillyPassword(); // `thorough loud annoying penguin`

// Provide a custom word count if you'd like
generateSillyPassword({ wordCount: 7 }); // `glamorous large powerful fast black noisy clam`

// Capitalize the first letter of the resulting password
generateSillyPassword({ capitalize: true }); // `Curious fluffy excited copperhead`

// You can provide salt to strengthen your passwords, too. Salt is appended to the end.
generateSillyPassword({ salt: "!?!?" }); // `damned important envious pangolin!?!?`

Combine options as you see fit. The wordCount must be at least 1.

Analyzing Password Strength

This library uses zxcvbn to analyze password strength. This was written by a bunch of nerds, so you know it's legit.

import { analyzePassword } from 'silly-password-generator';

// Returns an object telling you how awesome or crappy your password is.
const results = analyzePassword(sillyPassword); 

See the zxcvbn Usage section for the properties available.

TypeScript

Type definitions have been included for TypeScript support.

Icon Attribution

Favicon by Twemoji.

Contributing

Open source software is awesome and so are you. 😎

Feel free to submit a pull request for bugs or additions, and make sure to update tests as appropriate. If you find a mistake in the docs, send a PR! Even the smallest changes help.

For major changes, open an issue first to discuss what you'd like to change.

⭐ Found It Helpful? Star It!

If you found this project helpful, let the community know by giving it a star: 👉⭐

License

See LICENSE.md.