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
51 provides global and command-specific options.
52 Global options must precede the command name, and are as follows:
55 Display usage information and exit immediately.
58 The following commands are available:
60 .It Cm cat Ar entries ...
61 Decrypt and print the content of
64 .It Cm find Op Ar pattern
65 Print the entries of the store one per line, optionally filtered by
67 .It Cm gen Oo Fl nq Oc Oo Fl c Ar chars Oc Oo Fl l Ar length Oc Ar entry
68 Generate and persist a password for the given
72 can be used to control the characters allowed in the password
75 i.e. all the printable ASCII characters)
82 flag is provided, print the generated password.
85 flag is given the password won't be persisted and the
88 .It Cm mv Ar from Ar to
89 Rename a password entry, doesn't work with directories.
94 .It Cm rm Ar entries ...
98 .It Cm tee Oo Fl q Oc Ar entry
99 Persist the data read from standard input into the store under the given
101 name and the print it again on the standard output unless the
108 default range of characters to use to generate passwords.
118 Default length for the generated passwords.
120 Path to the password store directory tree.
124 .It Pa ~/.password-store
125 Password store used by default.
126 .It Pa ~/.password-store/.gpg-id
127 File containing the GPG recipient used to encrypt the passwords.
132 A got repository and password store can be initialized as follows:
133 .Bd -literal -offset indent
134 $ mkdir ~/.password-store
135 $ echo foo@example.com > ~/.password-store/.gpg-id
136 $ gotadmin init ~/git/pass.git
137 $ got import -r ~/git/pass.git -m 'initial import' ~/.password-store
138 $ got checkout -E ~/git/pass.git ~/.password-store
143 for more information.
148 .Pa ~/.password-store
149 and check out it again using
152 To generate a temporary random password use
153 .Bd -literal -offset indent
157 Display the entries matching
159 arranged comfortably for reading in a terminal window:
160 .Bd -literal -offset indent
161 $ plass find key | rs
169 was heavily influenced by
171 in the design, but it's a different implementation that prioritizes ease
172 of use and composability.
177 utility was written by
178 .An Omar Polo Aq Mt op@omarpolo.com .
182 output format isn't designed to handle files containing newlines.
186 or similar if it's a concern.
190 is not able to move directory trees, only file entries.
194 sub-command, the store initialization must be performed manually.