tUpdate README - safe - password protected secret keeper
HTML git clone git://git.z3bra.org/safe.git
DIR Log
DIR Files
DIR Refs
DIR README
DIR LICENSE
---
DIR commit abc98ebaee60796bd9e4340ddd4fe6afbd2645fe
DIR parent 1a8146eb3d01081a1e74ece9c2d57ca0e585921e
HTML Author: Willy Goiffon <dev@z3bra.org>
Date: Wed, 12 Jun 2019 13:35:42 +0200
Update README
Diffstat:
M README | 18 ++++++++++++------
1 file changed, 12 insertions(+), 6 deletions(-)
---
DIR diff --git a/README b/README
t@@ -4,21 +4,27 @@ Store your secrets in an encrypted safe, protected by a password.
## usage
- safe [-ad] [-f socket] [secret..]
+ safe [-hp] [-f socket] [[-a] secret]
# add a secret to your safe
safe -a my/deepest/secret < cute-kitten.gif
+ # retrieve a secret from your safe
+ safe my/deepest/secret
+
# list all your deepest secrets
find .secrets -type f
- # start a safe agent
- safe -d
+ # start a safe agent, export variables to the environment
+ # and push your key to it
+ eval $(safe-agent &)
+ safe -p
+
+ # have the agent forget the key
+ kill -USR1 $SAFE_PID
- # retrieve a secret from your safe
- safe my/deepest/secret
-## goals
+## features
+ Only require a master password to unlock
+ Provide a way to open/lock the safe (agent)