krz/yoshi-cli

Archived

A password manager for the command line. cli password-manager terminal

Commit 45a19f18e9

45a19f18e9fc707ce7c5e289ef37ce3c598a7498

parent: fd957ba8f5

Unregistered key

Christian Cleberg <156287552+ccleberg@users.noreply.github.com> · 2024-11-07 18:33 UTC
committer: <noreply@github.com>

enhance user docs

Layout: unified · split

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