Commit 538ce4bd60
Verified · cmc
Layout: unified · split
README.nfo deleted −45
| @@ -1,45 +0,0 @@ | ||
| 1 | ┌──────────────────────────────────────────────────────────────┐ | |
| 2 | │ Y O S H I [ KRZ ] krz.sh │ | |
| 3 | └──────────────────────────────────────────────────────────────┘ | |
| 4 | ||
| 5 | WHAT | |
| 6 | command-line password manager in python + sqlite3. manages accounts | |
| 7 | and generates random passwords (ascii, min 8 chars) or xkcd-style | |
| 8 | passphrases (min 3 words). | |
| 9 | ||
| 10 | INSTALL | |
| 11 | pypi: | |
| 12 | ||
| 13 | pipx install yoshi-cli | |
| 14 | ||
| 15 | manual: | |
| 16 | ||
| 17 | git clone REPO_URL | |
| 18 | cd yoshi-cli | |
| 19 | pipx install . | |
| 20 | ||
| 21 | USE | |
| 22 | yoshi <COMMAND> <FLAG> <PARAMETER> | |
| 23 | ||
| 24 | commands: | |
| 25 | --help -h print the welcome message | |
| 26 | --new -n create an account | |
| 27 | --list -l list saved accounts | |
| 28 | --edit -e edit an account (needs --uuid and --field) | |
| 29 | --delete -d delete an account (needs --uuid) | |
| 30 | --purge purge all accounts, delete the vault | |
| 31 | --encrypt encrypt the vault (needs --generate or --keyfile) | |
| 32 | --decrypt decrypt the vault (optional --keyfile) | |
| 33 | ||
| 34 | flags: | |
| 35 | --uuid -u account uuid | |
| 36 | --field -f account field to edit | |
| 37 | --generate -g generate a new key when encrypting | |
| 38 | --keyfile -k path to a saved key file | |
| 39 | ||
| 40 | CONTRIBUTING | |
| 41 | fork, add features, open a pull request. | |
| 42 | ||
| 43 | ┌──────────────────────────────────────────────────────────────┐ | |
| 44 | │ krz.sh │ | |
| 45 | └──────────────────────────────────────────────────────────────┘ | |
README.org added +49
| @@ -0,0 +1,49 @@ | ||
| 1 | #+title: yoshi | |
| 2 | ||
| 3 | * what | |
| 4 | command-line password manager in python + sqlite3. manages accounts | |
| 5 | and generates random passwords (ascii, min 8 chars) or xkcd-style | |
| 6 | passphrases (min 3 words). | |
| 7 | ||
| 8 | * install | |
| 9 | - pypi: | |
| 10 | ||
| 11 | #+begin_src sh | |
| 12 | pipx install yoshi-cli | |
| 13 | #+end_src | |
| 14 | ||
| 15 | - manual: | |
| 16 | ||
| 17 | #+begin_src sh | |
| 18 | git clone REPO_URL | |
| 19 | cd yoshi-cli | |
| 20 | pipx install . | |
| 21 | #+end_src | |
| 22 | ||
| 23 | * use | |
| 24 | #+begin_src sh | |
| 25 | yoshi <COMMAND> <FLAG> <PARAMETER> | |
| 26 | #+end_src | |
| 27 | ||
| 28 | #+begin_example | |
| 29 | commands: | |
| 30 | --help -h print the welcome message | |
| 31 | --new -n create an account | |
| 32 | --list -l list saved accounts | |
| 33 | --edit -e edit an account (needs --uuid and --field) | |
| 34 | --delete -d delete an account (needs --uuid) | |
| 35 | --purge purge all accounts, delete the vault | |
| 36 | --encrypt encrypt the vault (needs --generate or --keyfile) | |
| 37 | --decrypt decrypt the vault (optional --keyfile) | |
| 38 | #+end_example | |
| 39 | ||
| 40 | #+begin_example | |
| 41 | flags: | |
| 42 | --uuid -u account uuid | |
| 43 | --field -f account field to edit | |
| 44 | --generate -g generate a new key when encrypting | |
| 45 | --keyfile -k path to a saved key file | |
| 46 | #+end_example | |
| 47 | ||
| 48 | * contributing | |
| 49 | fork, add features, open a pull request. | |