From 5aac7b3af4969ca0f43abb6047845a51acf56401 Mon Sep 17 00:00:00 2001 From: Christian Cleberg Date: Sun, 2 Aug 2026 15:29:38 -0500 Subject: convert readme to nfo; relicense to 0bsd --- README.md | 181 -------------------------------------------------------------- 1 file changed, 181 deletions(-) delete mode 100644 README.md (limited to 'README.md') diff --git a/README.md b/README.md deleted file mode 100644 index 3093437..0000000 --- a/README.md +++ /dev/null @@ -1,181 +0,0 @@ -# Yoshi: A Password Manager - -A simple command-line pass manager, writtin in Python + SQLite3. This tool -allows you to manage accounts and generate random passwords containing ASCII -letters, numbers, and punctuation (min. 8 characters) or XKCD-like passphrases -(min. 3 words). - -See the Installation & Usage sections below for more information. - -# Table of Contents - -- [Installation](#installation) -- [Usage](#usage) - - [Arguments](#arguments) -- [Contributing](#contributing) - -# Installation - -[(Back to top)](#table-of-contents) - -## PyPi - -```bash -pipx install yoshi-cli -``` - -## Manual - -To run the script locally, run the following commands: - -```bash -git clone REPO_URL -cd yoshi-cli -pipx install . -``` - -![Yoshi CLI Installation](https://git.sr.ht/~cxc/yoshi-cli/blob/main/examples/installation.png) - -# Usage - -[(Back to top)](#table-of-contents) - -All commands can be passed to the program with the following template: -`yoshi ` - -![Yoshi CLI Help](https://git.sr.ht/~cxc/yoshi-cli/blob/main/examples/help.png) - -## Arguments - -### Summary - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ArgumentShortcutExplanation
--help-hPrint the welcome message
--new-nCreate a new account
--list-lList all saved accounts
--edit-eEdit a saved account (see below for required flags)
--delete-dDelete a saved account (see below for required flags)
--purgeN/APurge all accounts and delete the vault
--encryptN/AEncrypt the vault database (see below for required flags)
--decryptN/ADecrypt the vault database (see below for required flags)
- -#### Flags - -Flags for the `edit`, `e` command - both are required: - - - - - - - - - - - - - - - - - - - - - -
ArgumentShortcutExplanation
--uuid-uProvide the account UUID to edit
--field-fProvide the account field to edit
- -Flags for the `delete`, `d` command - this flag is required: - - - - - - - - - - - - - - - - -
ArgumentShortcutExplanation
--uuid-uProvide the account UUID to delete
- -Flags for the `encrypt` or `decrypt` command - you must provide at least one -when encrypting, none are required when decrypting: - - - - - - - - - - - - - - - - - - - - - -
ArgumentShortcutExplanation
--generate-gWhen encrypting, generate a new key
--keyfile-kWhen encrypting or decrypting, provide the path to a saved key file
- -![Yoshi CLI New Account](https://git.sr.ht/~cxc/yoshi-cli/blob/main/examples/accounts.png) - -# Contributing - -[(Back to top)](#table-of-contents) - -Any and all contributions are welcome. Feel free to fork the project, add -features, and submit a pull request. -- cgit v1.2.3