1 .\" Copyright (c) 2022, 2023 Omar Polo <op@omarpolo.com>
2 .\"
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.
6 .\"
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.
14 .Dd January 2, 2023
15 .Dt PLASS 1
16 .Os
17 .Sh NAME
18 .Nm plass
19 .Nd manage passwords
20 .Sh SYNOPSIS
21 .Nm
22 .Op Fl h
23 .Ar command
24 .Op Ar argument ...
25 .Sh DESCRIPTION
26 .Nm
27 is a simple password manager.
28 Passwords are stored as a directory tree where every password is a
29 file encrypted with
30 .Xr gpg 1 .
31 .Pp
32 A password store is a
33 .Xr got 1
34 repository with a worktree checked out at
35 .Pa ~/.password-store .
36 The only restriction is that a special file called
37 .Pa .gpg-id
38 containing the GPG recipient must exist in the root of the directory tree
39 for most
40 .Nm
41 commands to work.
42 .Pp
43 Password entries can be referenced using the path relative to the
44 store directory.
45 The file extension
46 .Dq \&.gpg
47 can be omitted.
48 .Pp
49 .Nm
50 provides global and command-specific options.
51 Global options must precede the command name, and are as follows:
52 .Bl -tag -width Ds
53 .It Fl h
54 Display usage information and exit immediately.
55 .El
56 .Pp
57 The following commands are available:
58 .Bl -tag -width Ds
59 .It Cm cat Ar entries ...
60 Decrypt and print the content of
61 .Ar entries
62 in the given order.
63 .It Cm edit Ar entry
64 Modify the content of the given
65 .Ar entry
66 using an editor.
67 .It Cm find Op Ar pattern
68 Print the entries of the store one per line, optionally filtered by
69 the case-insensitive
70 .Ar pattern .
71 .It Cm mv Ar from Ar to
72 Rename a password entry, doesn't work with directories.
73 .Ar from
74 must exist and
75 .Ar to
76 mustn't.
77 .It Cm rm Ar entries ...
78 Remove the given
79 .Ar entries
80 from the store.
81 .It Cm tee Oo Fl q Oc Ar entry
82 Persist the data read from standard input into the store under the given
83 .Ar entry
84 name and then print it again on the standard output unless the
85 .Fl q
86 option is given.
87 .El
88 .Sh ENVIRONMENT
89 .Bl -tag -width Ds
90 .It Ev PLASS_GPG
91 Path to the
92 .Xr gpg 1
93 executable.
94 .It Ev PLASS_STORE
95 Alternative path to the password store directory tree.
96 .It Ev VISUAL , Ev EDITOR
97 The editor spawned by
98 .Nm
99 .Cm edit .
100 If not set, the
101 .Xr ed 1
102 text editor will be used in order to given it the attention
103 it deserves.
104 .El
105 .Sh FILES
106 .Bl -tag -width Ds
107 .It Pa ~/.password-store
108 Default password store.
109 .It Pa ~/.password-store/.gpg-id
110 File containing the GPG recipient used to encrypt the passwords.
111 .El
112 .Sh EXIT STATUS
113 .Ex -std
114 .Sh EXAMPLES
115 A got repository and password store can be initialized as follows:
116 .Bd -literal -offset indent
117 $ mkdir ~/.password-store
118 $ echo foo@example.com > ~/.password-store/.gpg-id
119 $ gotadmin init ~/git/pass.git
120 $ got import -r ~/git/pass.git -m 'initial import' ~/.password-store
121 $ got checkout -E ~/git/pass.git ~/.password-store
122 .Ed
123 .Pp
124 see
125 .Xr got 1
126 for more information.
127 .Pp
128 To migrate from
129 .Xr pass 1 ,
130 delete
131 .Pa ~/.password-store
132 and check out it again using
133 .Xr got 1 .
134 .Pp
135 Generate a random password and save it to the clipboard:
136 .Bd -literal -offset indent
137 $ pwg | plass tee entry/name | xsel -b
138 .Ed
139 .Pp
140 Display the entries matching
141 .Sq key
142 arranged comfortably for reading in a terminal window:
143 .Bd -literal -offset indent
144 $ plass find key | rs
145 .Ed
146 .Pp
147 Enable tab-completion of
148 .Nm
149 command names and entries in
150 .Xr ksh 1 :
151 .Bd -literal -offset indent
152 $ set -A complete_plass_1 -- cat edit find mv rm tee
153 $ set -A complete_plass -- $(plass find)
154 .Ed
155 .Sh SEE ALSO
156 .Xr got 1 ,
157 .Xr gpg 1 ,
158 .Xr pwg 1
159 .Sh HISTORY
160 .Nm
161 was heavily influenced by
162 .Xr pass 1
163 in the design, but it's a different implementation that prioritizes ease
164 of use and composability.
165 .Sh AUTHORS
166 .An -nosplit
167 The
168 .Nm
169 utility was written by
170 .An Omar Polo Aq Mt op@omarpolo.com .
171 .Sh CAVEATS
172 .Nm
173 .Cm find
174 output format isn't designed to handle files containing newlines.
175 Use
176 .Xr find 1
177 .Fl print0
178 or similar if it's a concern.
179 .Pp
180 .Nm
181 .Cm mv
182 is not able to move directory trees, only file entries.
183 .Pp
184 There isn't an
185 .Cm init
186 sub-command, the store initialization must be performed manually.