pwgn-cli

🔐 a basic password generator command line interface

This projects includes Node, TypeScript, TSlint, Jest, GitHub Actions & Codecov.

Table Of Content

• I - Install
• II - Usage
• III - Documentation
• IV - Options
• V - Scripts
• VI - License

I - Install

$ npm i -g pwgn-cli

II - Usage

$ pwgn --help

    [email protected]

    Usage
        $ pwgn [-a | --all] [-n | --numbers] [-u | --uppercases]
            [-s | --special-characters] [-l input | --length input]
            [-h | --help] [-v | --version]

    Options
        -a, --all                   Add uppercases, numbers & special characters
                                    to the generation
        -n, --numbers               Add numbers to the generation
        -s, --special-characters    Add special characters to the generation
        -u, --uppercases            Add uppercases to the generation
        -l, --length input         Set the password length (min: 8 / max: 25)

        -h, --help                  Display help informations
        -v, --version               Display the package version

III - Documentation & Coverage

You can find the pwgn documentation here, generated with TSDoc & TypeDoc.

You can find the coverage status here, generated with Jest.

IV - Options

Length: -l input | --length input

$ pwgn -l 24

Your password:

gujoxyysvuoqufbuhpivvype

Complexity

All-in-one: -a | --all

$ pwgn -a

Your password:

w5g>y^U\zN[e%W8F

Numbers: -n | --numbers

$ pwgn -n

Your password:

7bh2vcae1OgOx7i4

Uppercases: -u | --uppercases

$ pwgn -u

Your password:

TOPpojJbRkhVXeyJ

Special characters: -s | --special-characters

$ pwgn -s

Your password:

*jmk<mv*,+x!zo`h

You can mix params too

$ pwgn -n -s

Your password:

21)*bq@#$4]-+8ve

V - Scripts

• Lint .ts files:
  • npm run lint
  • npm run lint:fix - fix warnings
• Build .ts files & convert output to an executable
  • npm run build
• Test your code:
  • npm run test
  • npm run test:watch - test when a file changed
• Check your code before pushing:
  • npm run check
• Start the process:
  • npm run start
• generate documentation:
  • npm run doc

VI - License

Under MIT license.