1 .\" Copyright (c) 2021, 2022 Omar Polo <op@omarpolo.com>
3 .\" Permission to use, copy, modify, and distribute this software for any
4 .\" purpose with or without fee is hereby granted, provided that the above
5 .\" copyright notice and this permission notice appear in all copies.
7 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
8 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
9 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
10 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
11 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
12 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
13 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
27 is a simple password manager.
28 Passwords are stored as a directory tree where every password is a
34 repository with a worktree checked out at
35 .Pa ~/.password-store .
36 The only restriction is that a special file called
38 containing the GPG recipient must exist in the root of the directory tree
43 Password entries can be referenced using the path relative to the
50 provides global and command-specific options.
51 Global options must precede the command name, and are as follows:
54 Display usage information and exit immediately.
57 The following commands are available:
59 .It Cm cat Ar entries ...
60 Decrypt and print the content of
63 .It Cm find Op Ar pattern
64 Print the entries of the store one per line, optionally filtered by
66 .It Cm mv Ar from Ar to
67 Rename a password entry, doesn't work with directories.
72 .It Cm rm Ar entries ...
76 .It Cm tee Oo Fl q Oc Ar entry
77 Persist the data read from standard input into the store under the given
79 name and the print it again on the standard output unless the
94 Alternative path to the password store directory tree.
98 .It Pa ~/.password-store
99 Password store used by default.
100 .It Pa ~/.password-store/.gpg-id
101 File containing the GPG recipient used to encrypt the passwords.
106 A got repository and password store can be initialized as follows:
107 .Bd -literal -offset indent
108 $ mkdir ~/.password-store
109 $ echo foo@example.com > ~/.password-store/.gpg-id
110 $ gotadmin init ~/git/pass.git
111 $ got import -r ~/git/pass.git -m 'initial import' ~/.password-store
112 $ got checkout -E ~/git/pass.git ~/.password-store
117 for more information.
122 .Pa ~/.password-store
123 and check out it again using
126 Generate a random password and save it to the clipboard:
127 .Bd -literal -offset indent
128 $ pwg | plass tee entry/name | xsel -b
131 Display the entries matching
133 arranged comfortably for reading in a terminal window:
134 .Bd -literal -offset indent
135 $ plass find key | rs
138 Enable tab-completion of
140 command names and entries in
142 .Bd -literal -offset indent
143 $ set -A complete_plass_1 -- cat find mv rm tee
144 $ set -A complete_plass -- $(plass find)
152 was heavily influenced by
154 in the design, but it's a different implementation that prioritizes ease
155 of use and composability.
160 utility was written by
161 .An Omar Polo Aq Mt op@omarpolo.com .
165 output format isn't designed to handle files containing newlines.
169 or similar if it's a concern.
173 is not able to move directory trees, only file entries.
177 sub-command, the store initialization must be performed manually.