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