Skip to content

Commit

Permalink
Update README.md with keygenerator information
Browse files Browse the repository at this point in the history
  • Loading branch information
rafaelperoco committed Feb 27, 2024
1 parent 6583fe6 commit 36539fb
Showing 1 changed file with 44 additions and 29 deletions.
73 changes: 44 additions & 29 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,56 +1,71 @@
# pwdgen documentation
# keygenerator

## about
keygenerator is a robust command-line interface (CLI) tool written in Go that generates secure, random passwords. It offers flexibility in password generation through various flags, allowing you to customize the length and complexity of your passwords.

pwdgen is a simple password generator written in Go. It generates passwords with a length of 20 characters by default.
## Installation

## install

```bash
curl -OL https://github.com/rafaelperoco/pwdgen/releases/download/v0.1.0/pwdgen_0.1.0_linux_amd64.tar.gz
tar -xvf pwdgen_0.1.0_linux_amd64.tar.gz
sudo mv pwdgen /usr/local/bin
```
To install keygenerator, execute the following commands in your terminal:

## usage
```text
```shell
curl -OL https://github.com/rafaelperoco/keygenerator/releases/download/v0.1.0/keygenerator_1.0.0_linux_amd64.tar.gz
tar -xvf keygenerator_0.1.0_linux_amd64.tar.gz
sudo mv keygenerator /usr/local/bin
```

## Usage
To generate a password, simply run keygenerator in your terminal. By default, it generates a 20-character password using letters and numbers.

```shell
keygenerator -h
A CLI tool to generate passwords with entropy and complexity

Usage:
pwdgen [flags]
keygenerator [flags]

Flags:
-e, --exclude string exclude characters from the password
-h, --help help for pwdgen
-h, --help help for keygenerator
-n, --length int length of the password (default 20)
-l, --letters use letters and numbers
-s, --special use letters, numbers and special characters
```

## Examples

Generate a 20-character password using letters and numbers:

```bash
pwdgen
keygenerator
```

```bash
pwdgen -n 10

Generate a 10-character password using letters and numbers:

```bash
keygenerator -n 10
```

```bash
pwdgen -l

Generate a 20-character password using just letters:

```bash
keygenerator -l
```

```bash
pwdgen -s

Generate a 20-character password using letters, numbers and special characters:

```bash
keygenerator -s
```

```bash
pwdgen -e 0oO1l

Generate a 20-character password using letters and numbers, excluding the characters 0, o, O, 1 and l:

```bash
keygenerator -e 0oO1l
```

Generate a 10-character password using letters and numbers, excluding the characters 0, o, O, 1 and l:

```bash
pwdgen -n 10 -l -e 0oO1l
keygenerator -n 10 -l -e 0oO1l
```

## License
Expand All @@ -63,4 +78,4 @@ Rafael Peroco

## Contributing

Feel free to open issues and pull requests.
Feel free to open issues and pull requests.

0 comments on commit 36539fb

Please sign in to comment.