pash/README.md

70 lines
1.4 KiB
Markdown
Raw Normal View History

2019-02-24 14:48:54 -06:00
# pash
A simple password manager using GPG.
2019-02-25 00:55:10 -06:00
## Table of Contents
2019-02-25 00:54:14 -06:00
<!-- vim-markdown-toc GFM -->
* [Dependencies](#dependencies)
* [Usage](#usage)
* [FAQ](#faq)
2019-02-25 00:54:32 -06:00
* [Where are passwords stored?](#where-are-passwords-stored)
2019-02-25 00:54:14 -06:00
* [TODO](#todo)
<!-- vim-markdown-toc -->
2019-02-24 16:04:26 -06:00
## Dependencies
2019-02-25 01:04:16 -06:00
- `bash 4+`
- `gpg` or `gpg2`
2019-02-24 16:04:26 -06:00
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
2019-02-25 10:15:37 -06:00
[a]dd [name]: Create a new entry in the password store.
[d]el [name]: Delete an entry from the password store.
2019-02-25 00:48:54 -06:00
[s]how [name]: Show password from an entry in the password store.
[l]ist: List all entries from the password store.
OPTIONS
2019-02-25 13:49:31 -06:00
-t Print list output as a tree.
2019-02-25 00:48:54 -06:00
c Copy password to clipboard.
2019-02-25 13:49:31 -06:00
l Length of generated passwords.
n Limit passwords to alphanumeric characters.
2019-02-25 00:48:54 -06:00
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-25 00:53:48 -06:00
## FAQ
2019-02-25 00:54:32 -06:00
### Where are passwords stored?
2019-02-25 00:53:48 -06:00
The passwords are store in GPG encrypted files located at `${XDG_DATA_HOME:=$HOME/.local/share}/pash}`.
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.
2019-02-25 13:46:57 -06:00
- [x] 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.