]> Sergey Matveev's repositories - passman.git/blobdiff - README
Use recfile and age
[passman.git] / README
diff --git a/README b/README
new file mode 100644 (file)
index 0000000..356fd49
--- /dev/null
+++ b/README
@@ -0,0 +1,21 @@
+passman -- simple password manager
+It stores passwords in single recfile
+(https://www.gnu.org/software/recutils/), that is by default encrypted
+by age (https://github.com/FiloSottile/age) with the passphrase and
+compressed by zstd.
+
+* passman add NAME [PASSWORD]
+  Appends NAME credential with optional password to the database. If
+  password is not provided, then it will be autogenerated.
+* passman has NAME
+  Just returns if specified credential exists.
+* passman gen
+  Prints autogenerated password.
+* passman mod
+  Decrypts whole database to temporary file and runs editor on it.
+* passman NAME
+  Search for specified credential. That can be regexp. If more than
+  single entity is found, then print found names. If single entity is
+  found, then its basename (last part after the slash) is copied to
+  primary X11 buffer, and password is copied to clipboard buffer. Then
+  sleep for ten seconds and clear the clipboard.