pash/README.md

51 lines
998 B
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# pash
A simple password manager using GPG.
## Dependencies
- `bash`
- `gpg2`
**Clipboard Support**:
- `xclip` or `tmux`
## Usage
Examples: `pash add web/gmail`, `pash list`, `pash del google`, `pash show github`.
```
SYNOPSIS
pash [ add|del|show|list ] [name] [ -ncqhv ] [ -l length ]
COMMANDS
[a]dd [name]: Create a new entry in the password store.
[d]el [name]: Delete an entry from the password store.
[s]how [name]: Show password from an entry in the password store.
[l]ist: List all entries from the password store.
OPTIONS
n Limit passwords to alphanumeric characters.
l Length of generated passwords.
c Copy password to clipboard.
q Don't print password to stdout.
h Show usage and exit.
v Show version and exit.
```
## TODO
- [x] Add support for not generating passwords.
- [x] Add support for categories.
- [ ] Add an optional `tree` view.
- [x] Add support for both `gpg` and `gpg2`.
- [ ] Man page.
- [ ] Setup automatic linting.
- [ ] Documentation.