1KEEPASSXC-CLI(1) General Commands Manual KEEPASSXC-CLI(1)
2
6 keepassxc-cli - command line interface for the KeePassXC password man‐
7 ager.
8
11 keepassxc-cli command [options]
12
15 keepassxc-cli is the command line interface for the KeePassXC password
16 manager. It provides the ability to query and modify the entries of a
17 KeePass database, directly from the command line.
18
21 add [options] <database> <entry>
22 Adds a new entry to a database. A password can be generated (-g
23 option), or a prompt can be displayed to input the password (-p
24 option).
25 clip [options] <database> <entry> [timeout]
28 Copies the password or the current TOTP (-t option) of a data‐
29 base entry to the clipboard. If multiple entries with the same
30 name exist in different groups, only the password for the first
31 one is going to be copied. For copying the password of an entry
32 in a specific group, the group path to the entry should be spec‐
33 ified as well, instead of just the name. Optionally, a timeout
34 in seconds can be specified to automatically clear the clip‐
35 board.
36 create [options] <database>
39 Creates a new database with a key file and/or password. The key
40 file will be created if the file that is referred to does not
41 exist. If both the key file and password are empty, no database
42 will be created.
43 diceware [options]
46 Generate a random diceware passphrase.
47 edit [options] <database> <entry>
50 Edits a database entry. A password can be generated (-g option),
51 or a prompt can be displayed to input the password (-p option).
52 estimate [options] [password]
55 Estimates the entropy of a password. The password to estimate
56 can be provided as a positional argument, or using the standard
57 input.
58 extract [options] <database>
61 Extracts and prints the contents of a database to standard out‐
62 put in XML format.
63 generate [options]
66 Generate a random password.
67 locate [options] <database> <term>
70 Locates all the entries that match a specific search term in a
71 database.
72 ls [options] <database> [group]
75 Lists the contents of a group in a database. If no group is
76 specified, it will default to the root group.
77 merge [options] <database1> <database2>
80 Merges two databases together. The first database file is going
81 to be replaced by the result of the merge, for that reason it is
82 advisable to keep a backup of the two database files before
83 attempting a merge. In the case that both databases make use of
84 the same credentials, the --same-credentials or -s option can be
85 used.
86 rm [options] <database> <entry>
89 Removes an entry from a database. If the database has a recycle
90 bin, the entry will be moved there. If the entry is already in
91 the recycle bin, it will be removed permanently.
92 show [options] <database> <entry>
95 Shows the title, username, password, URL and notes of a database
96 entry. Can also show the current TOTP. Regarding the occurrence
97 of multiple entries with the same name in different groups,
98 everything stated in the clip command section also applies here.
99
102 General options
103 --debug-info
104 Displays debugging information.
105 -k, --key-file <path>
108 Specifies a path to a key file for unlocking the database. In a
109 merge operation this option is used to specify the key file path
110 for the first database.
111 --no-password
114 Deactivate password key for the database.
115 -q, --quiet <path>
118 Silence password prompt and other secondary outputs.
119 -h, --help
122 Displays help information.
123 -v, --version
126 Displays the program version.
127 Merge options
131 -f, --key-file-from <path>
132 Path of the key file for the second database.
133 --no-password-from
136 Deactivate password key for the database to merge from.
137 -s, --same-credentials
140 Use the same credentials for unlocking both database.
141 Add and edit options
145 -u, --username <username>
146 Specify the username of the entry.
147 --url <url>
150 Specify the URL of the entry.
151 -p, --password-prompt
154 Use a password prompt for the entry's password.
155 -g, --generate
158 Generate a new password for the entry.
159 -l, --password-length
162 Specify the length of the password to generate.
163 Edit options
167 -t, --title <title>
168 Specify the title of the entry.
169 Estimate options
173 -a, --advanced
174 Perform advanced analysis on the password.
175 Clip options
179 -t, --totp
180 Copy the current TOTP instead of current password to clipboard.
181 Will report an error if no TOTP is configured for the entry.
182 Show options
186 -a, --attributes <attribute>...
187 Names of the attributes to show. This option can be specified
188 more than once, with each attribute shown one-per-line in the
189 given order. If no attributes are specified and -t is not speci‐
190 fied, a summary of the default attributes is given.
191 -t, --totp
194 Also show the current TOTP. Will report an error if no TOTP is
195 configured for the entry.
196 Diceware options
200 -W, --words <count>
201 Desired number of words for the generated passphrase. [Default:
202 7]
203 -w, --word-list <path>
206 Path of the wordlist for the diceware generator. The wordlist
207 must have > 1000 words, otherwise the program will fail. If the
208 wordlist has < 4000 words a warning will be printed to STDERR.
209 List options
213 -R, --recursive
214 Recursively list the elements of the group.
215 Generate options
219 -L, --length <length>
220 Desired length for the generated password. [Default: 16]
221 -l Use lowercase characters for the generated password. [Default:
224 Enabled]
225 -u Use uppercase characters for the generated password. [Default:
228 Enabled]
229 -n Use numbers characters for the generated password. [Default:
232 Enabled]
233 -s Use special characters for the generated password. [Default:
236 Disabled]
237 -e Use extended ASCII characters for the generated password.
240 [Default: Disabled]
241
246 Bugs and feature requests can be reported on GitHub at
247 https://github.com/keepassxreboot/keepassxc/issues.
248
251 This manual page was originally written by Manolis Agkopian
252 <m.agkopian@gmail.com>, and is maintained by the KeePassXC Team
253 <team@keepassxc.org>.
254 Nov 04, 2018 KEEPASSXC-CLI(1)