Files
rusty-pw/README.md
2026-10-23 13:09:02 -04:00

40 lines
1.3 KiB
Markdown

# rusty-pw
Rusty PW is a rust based generator for simple passwords. The list of words can be found at [./words.txt](./words.txt). This is a list of 200, 5 letters words that are school appropriate.
## Options
Here is a list of all the options available. None of these are required and a single word with 4 digits can be generated with `rusty-pw`
| Option | Description | Default | Required |
| --- | --- | --- | --- |
| `--words` | Set number of words | `1` | No |
| `--digits` | Set number of digits | `4` | No |
| `--bulk` | Generate multiple items | `1` | No |
| `--sep` | Seperator between words | "" | No |
| `--save` | Export to a save file | | No |
| `--out` | Output file name | `rusty-pw` | No |
## Useage
```bash
Random word + number generator
Usage: rusty-pw [OPTIONS]
Options:
--words <WORDS> [default: 1]
--digits <DIGITS> [default: 4]
--bulk <BULK> [default: 1]
--sep <SEP> [default: ""]
--save <SAVE> [possible values: csv, txt]
--out <OUT> [default: rusty-pw]
-h, --help Print help
-V, --version Print version
```
## Features to add
- [x] option flag for multiple words or more numbers
- `--digits 6` or `--words 2`
- [x] option flag for an array of combinations for bulk generating
- `--bulk 10`
- [x] option flag to export to .csv or .txt file
- `--save csv`