Commit: d48a5604551447c15fc43fdf5a9aeba87bdf8d60 Parent: 115e463b65bd55eef1a3250327184aa0b6d33bd1 Author: Klemens Nanni Date: Thu, 3 Mar 2016 15:27:31 +0100 Add simple and readable README Diffstat:
| A | README.md | | | 45 | +++++++++++++++++++++++++++++++++++++++++++++ |
1 file changed, 45 insertions(+), 0 deletions(-)
diff --git a/README.md b/README.md @@ -0,0 +1,45 @@ +tpm - tiny password manager +=========================== + +This is a fork of [nmeum's tpm](https://github.com/nmeum/tpm), I felt like changing things here and there +was necessary to finally get the password manager that suits my needs. + +From the original project: + +> tpm is a tiny shell script which is heavily inspired and largely compatible +> with [pass](http://zx2c4.com/projects/password-store). Just like pass it uses gpg2(1) to securely store your passwords, +> the major difference between pass and tpm is that the latter is a lot more +> minimal. Furthermore, tpm is written entirely in POSIX shell. + +--- + +Create a new entry with a random password using `pwgen`: + + $ pwgen -1 | tpm insert system/new-user + +Create a new entry called *system/root*: + + $ tpm insert system/root + +Write your *system/root* password to standard output: + + $ tpm show system/root + +Write the entry's password that matches the given pattern to standard output: + + $ tpm show em/r*t + $ tpm show sys*ot + $ tpm show root + +Copy your *system/root* password to the primary selection using `xclip`: + + $ tpm show system/root | tr -d '\n' | xclip + +List all entries of the group *system*: + + $ tpm list system + +--- + +Also see my aliases in *.mksh/tpm.sh* from my [dotfiles](https://notabug.org/kl3/dotfiles) repository for other +examples on how to make tpm even easier to use.