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
36 .Pq or Ev PLASS_STORE .
37 The only restriction is that a special file called
39 containing the GPG recipient must exist in the root of the directory tree
44 Password entries can be referenced using the path relative to the
50 The following commands are available:
52 .It Cm cat Ar entries ...
53 Decrypt and print the content of
56 .It Cm find Op Ar pattern
57 Print the entries of the store one per line, optionally filtered by
59 .It Cm gen Oo Fl nq Oc Oo Fl c Ar chars Oc Oo Fl l Ar length Oc Ar entry
60 Generate and persist a password for the given
64 can be used to control the characters allowed in the password
67 i.e. all the printable ASCII characters)
74 flag is provided, print the generated password.
77 flag is given the password won't be persisted and the
80 .It Cm mv Ar from Ar to
81 Rename a password entry, doesn't work with directories.
86 .It Cm rm Ar entries ...
90 .It Cm tee Oo Fl q Oc Ar entry
91 Prompt for a password and persist it into the store under the given
93 name and the print it again on the standard output unless the
100 default range of characters to use to generate passwords.
110 Default length for the generated passwords.
112 Path to the password store directory tree.
116 .It Pa ~/.password-store
117 Password store used by default.
118 .It Pa ~/.password-store/.gpg-id
119 File containing the GPG recipient used to encrypt the passwords.
122 A got repository and password store can be initialized as follows:
123 .Bd -literal -offset indent
124 $ mkdir ~/.password-store
125 $ echo foo@example.com > ~/.password-store/.gpg-id
126 $ gotadmin init ~/git/pass.git
127 $ got import -r ~/git/pass.git -m 'initial import' ~/.password-store
128 $ got checkout -E ~/git/pass.git ~/.password-store
133 for more information.
138 .Pa ~/.password-store
139 and check out it again using
142 To generate a temporary random password use
143 .Bd -literal -offset indent
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.