3.0.1 • Published 1 year ago

passworth-cli v3.0.1

Weekly downloads
-
License
MIT
Repository
github
Last release
1 year ago

passworth cli NPM Libraries.io dependency status for latest release GitHub commit activity GitHub repo size npm

passworth-cli

This is a command-line interface (CLI) tool for generating passwords with customizable settings. This tool was built using Node.js and the yargs package for parsing command-line arguments.

Demo

https://passworth.nfinit3.io/

Getting Started

Installation

npm i passworth-cli -g

Usage

passworth [options]

Options:

  • -l, --length number: The length of the password. Defaults to 12.
  • -n, --numbers boolean: Include numbers in the password. Defaults to true.
  • -u, --uppercase boolean: Include uppercase letters in the password. Defaults to true.
  • -s, --special boolean: Include special characters in the password. Defaults to true.
  • -h, --help: Show help.

Example:

passworth // Generates a random password with all default options and copies it to clipboard.
passworth -l 16 -n false // Generates a random password of 16 characters length with no numbers and copies it to clipboard.

This will generate a random password of 16 characters length and no numbers and copy the same to clipboard.

Use in your NodeJS Project

passworth-cli also provides you a module to use in your NodeJS projects for generating random passwords on the fly.

Installation

npm i passworth-cli --save

Usage

import { passworth } from 'passworth-cli';
const password = passworth(); //Generates a Random password with all paramaeters as True and length of 12 => 'AY[5c[=K0MaD'

With Paramaters

import { passworth } from 'passworth-cli';
const password = passworth(16, true, false, false); //Generates a Random password of 16 Chars with numbers and lowercases and no Special Characters or UpperCase => 'n3g1kacfqdv2owta'

You can also provide options using JSON format

import { passworth } from 'passworth-cli';
const options = {
    length: 4,
    numbers: false,
    symbols: true,
    uppercase: true,
};
const password = passworth(options); //Generates a Random password of 4 Chars with no digits => 'Qb]p'

License

This project is licensed under the MIT License - see the LICENSE file for details.