Commit 45a19f18e9
Unregistered key
Layout: unified · split
README.md +18 −21
| @@ -5,10 +5,7 @@ allows you to manage accounts and generate random passwords containing ASCII | ||
| 5 | 5 | letters, numbers, and punctuation (min. 8 characters) or XKCD-like passphrases |
| 6 | 6 | (min. 3 words). |
| 7 | 7 | |
| 8 | Please note that the script is written in Python 3 - you may need to run the | |
| 9 | script with the `python3` command instead of `python` if your system uses a | |
| 10 | default of Python 2. See the Installation & Usage sections below for more | |
| 11 | information. | |
| 8 | See the Installation & Usage sections below for more information. | |
| 12 | 9 | |
| 13 | 10 | # Table of Contents |
| 14 | 11 | |
| @@ -24,7 +21,7 @@ information. | ||
| 24 | 21 | ## PyPi |
| 25 | 22 | |
| 26 | 23 | ```bash |
| 27 | pip install yoshi-cli | |
| 24 | pipx install yoshi-cli | |
| 28 | 25 | ``` |
| 29 | 26 | |
| 30 | 27 | ## Manual |
| @@ -33,8 +30,8 @@ To run the script locally, run the following commands: | ||
| 33 | 30 | |
| 34 | 31 | ```bash |
| 35 | 32 | git clone REPO_URL |
| 36 | cd yoshi | |
| 37 | pip install . | |
| 33 | cd yoshi-cli | |
| 34 | pipx install . | |
| 38 | 35 | ``` |
| 39 | 36 | |
| 40 | 37 | # Usage |
| @@ -42,7 +39,7 @@ pip install . | ||
| 42 | 39 | [(Back to top)](#table-of-contents) |
| 43 | 40 | |
| 44 | 41 | All commands can be passed to the program with the following template: |
| 45 | `python3 src/yoshi/cli.py <COMMAND> <FLAG> <PARAMETER>` | |
| 42 | `yoshi <COMMAND> <FLAG> <PARAMETER>` | |
| 46 | 43 | |
| 47 | 44 |  |
| 48 | 45 | |
| @@ -60,42 +57,42 @@ All commands can be passed to the program with the following template: | ||
| 60 | 57 | </thead> |
| 61 | 58 | <tbody> |
| 62 | 59 | <tr> |
| 63 | <td>help</td> | |
| 64 | <td>h</td> | |
| 60 | <td>--help</td> | |
| 61 | <td>-h</td> | |
| 65 | 62 | <td>Print the welcome message</td> |
| 66 | 63 | </tr> |
| 67 | 64 | <tr> |
| 68 | <td>new</td> | |
| 69 | <td>n</td> | |
| 65 | <td>--new</td> | |
| 66 | <td>-n</td> | |
| 70 | 67 | <td>Create a new account</td> |
| 71 | 68 | </tr> |
| 72 | 69 | <tr> |
| 73 | <td>list</td> | |
| 74 | <td>l</td> | |
| 70 | <td>--list</td> | |
| 71 | <td>-l</td> | |
| 75 | 72 | <td>List all saved accounts</td> |
| 76 | 73 | </tr> |
| 77 | 74 | <tr> |
| 78 | <td>edit</td> | |
| 79 | <td>e</td> | |
| 75 | <td>--edit</td> | |
| 76 | <td>-e</td> | |
| 80 | 77 | <td>Edit a saved account (see below for required flags)</td> |
| 81 | 78 | </tr> |
| 82 | 79 | <tr> |
| 83 | <td>delete</td> | |
| 84 | <td>d</td> | |
| 80 | <td>--delete</td> | |
| 81 | <td>-d</td> | |
| 85 | 82 | <td>Delete a saved account (see below for required flags)</td> |
| 86 | 83 | </tr> |
| 87 | 84 | <tr> |
| 88 | <td>purge</td> | |
| 85 | <td>--purge</td> | |
| 89 | 86 | <td>N/A</td> |
| 90 | 87 | <td>Purge all accounts and delete the vault</td> |
| 91 | 88 | </tr> |
| 92 | 89 | <tr> |
| 93 | <td>encrypt</td> | |
| 90 | <td>--encrypt</td> | |
| 94 | 91 | <td>N/A</td> |
| 95 | 92 | <td>Encrypt the vault database (see below for required flags)</td> |
| 96 | 93 | </tr> |
| 97 | 94 | <tr> |
| 98 | <td>decrypt</td> | |
| 95 | <td>--decrypt</td> | |
| 99 | 96 | <td>N/A</td> |
| 100 | 97 | <td>Decrypt the vault database (see below for required flags)</td> |
| 101 | 98 | </tr> |