pash/README.md

51 lines
998 B
Markdown
Raw Normal View History

2019-02-24 14:48:54 -06:00
# pash
A simple password manager using GPG.
2019-02-24 16:04:26 -06:00
## Dependencies
- `bash`
- `gpg2`
2019-02-25 00:48:54 -06:00
**Clipboard Support**:
- `xclip` or `tmux`
2019-02-24 16:04:26 -06:00
## Usage
2019-02-24 16:05:02 -06:00
Examples: `pash add web/gmail`, `pash list`, `pash del google`, `pash show github`.
2019-02-24 16:04:26 -06:00
```
2019-02-25 00:48:54 -06:00
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.
2019-02-24 16:04:26 -06:00
```
2019-02-24 14:48:54 -06:00
## TODO
2019-02-24 15:07:37 -06:00
- [x] Add support for not generating passwords.
2019-02-24 15:48:31 -06:00
- [x] Add support for categories.
- [ ] Add an optional `tree` view.
2019-02-24 17:10:26 -06:00
- [x] Add support for both `gpg` and `gpg2`.
2019-02-25 00:49:19 -06:00
- [x] Man page.
- [x] Setup automatic linting.
- [x] Documentation.