75 lines
2.2 KiB
Markdown
75 lines
2.2 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.
|
|
|
|
> [!WARNING]
|
|
> I do not recommend using these word-number pairs as long term security.
|
|
>
|
|
> This project was built for a niche instance where I needed to make up a lot of these types of pairs.
|
|
|
|
## Installation
|
|
### macOS Apple Silicon
|
|
1. Open a terminal and run
|
|
```bash
|
|
curl -fsSL https://git.briannelson.dev/brian/rusty-pw/raw/branch/main/install.sh | sh
|
|
```
|
|
2. Run `rusty-pw` to generate your first word-number pair
|
|
|
|
### NixOS Flakes
|
|
1. Add the flake to your inputs
|
|
```nix
|
|
rusty-pw = {
|
|
url = "git+https://git.briannelson.dev/brian/rusty-pw";
|
|
inputs.nixpkgs.follows = "nixpkgs";
|
|
};
|
|
```
|
|
2. Add the input to your configuration as an overlay
|
|
```nix
|
|
{ inputs, pkgs, ... }:
|
|
|
|
{
|
|
nixpkgs.overlays = [
|
|
inputs.rusty-pw.overlays.default
|
|
];
|
|
|
|
environment.systemPackages = with pkgs; [ rusty-pw ];
|
|
}
|
|
```
|
|
3. Rebuild your system and run `rusty-pw` to generate your first word-number pair
|
|
|
|
## 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 |
|
|
|
|
|
|
## Usage
|
|
```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`
|