keepassxc/src/cli/keepassxc-cli.1

.TH KEEPASSXC-CLI 1 "Nov 04, 2018"

.SH NAME
keepassxc-cli \- command line interface for the \fBKeePassXC\fP password manager.

.SH SYNOPSIS
.B keepassxc-cli
.I command
.RI [ options ]

.SH DESCRIPTION
\fBkeepassxc-cli\fP is the command line interface for the \fBKeePassXC\fP password manager. It provides the ability to query and modify the entries of a KeePass database, directly from the command line.

.SH COMMANDS

.IP "add [options] <database> <entry>"
Adds a new entry to a database. A password can be generated (\fI-g\fP option), or a prompt can be displayed to input the password (\fI-p\fP option).

.IP "clip [options] <database> <entry> [timeout]"
Copies the password of a database entry to the clipboard. If multiple entries with the same name exist in different groups, only the password for the first one is going to be copied. For copying the password of an entry in a specific group, the group path to the entry should be specified as well, instead of just the name. Optionally, a timeout in seconds can be specified to automatically clear the clipboard.

.IP "diceware [options]"
Generate a random diceware passphrase.

.IP "edit [options] <database> <entry>"
Edits a database entry. A password can be generated (\fI-g\fP option), or a prompt can be displayed to input the password (\fI-p\fP option).

.IP "estimate [options] [password]"
Estimates the entropy of a password. The password to estimate can be provided as a positional argument, or using the standard input.

.IP "extract [options] <database>"
Extracts and prints the contents of a database to standard output in XML format.

.IP "generate [options]"
Generate a random password.

.IP "locate [options] <database> <term>"
Locates all the entries that match a specific search term in a database.

.IP "ls [options] <database> [group]"
Lists the contents of a group in a database. If no group is specified, it will default to the root group.

.IP "merge [options] <database1> <database2>"
Merges two databases together. The first database file is going to be replaced by the result of the merge, for that reason it is advisable to keep a backup of the two database files before attempting a merge. In the case that both databases make use of the same credentials, the \fI--same-credentials\fP or \fI-s\fP option can be used.

.IP "rm [options] <database> <entry>"
Removes an entry from a database. If the database has a recycle bin, the entry will be moved there. If the entry is already in the recycle bin, it will be removed permanently.

.IP "show [options] <database> <entry>"
Shows the title, username, password, URL and notes of a database entry. Regarding the occurrence of multiple entries with the same name in different groups, everything stated in the \fIclip\fP command section also applies here.

.SH OPTIONS

.SS "General options"

.IP "-k, --key-file <path>"
Specifies a path to a key file for unlocking the database. In a merge operation this option is used to specify the key file path for the first database.

.IP "-h, --help"
Displays help information.

.IP "-v, --version"
Shows the program version.


.SS "Merge options"

.IP "-f, --key-file-from <path>"
Path of the key file for the second database.

.IP "-s, --same-credentials"
Use the same credentials for unlocking both database.


.SS "Add and edit options"

.IP "-u, --username <username>"
Specify the username of the entry.

.IP "--url <url>"
Specify the URL of the entry.

.IP "-p, --password-prompt"
Use a password prompt for the entry's password.

.IP "-g, --generate"
Generate a new password for the entry.

.IP "-l, --password-length"
Specify the length of the password to generate.


.SS "Edit options"

.IP "-t, --title <title>"
Specify the title of the entry.


.SS "Estimate options"

.IP "-a, --advanced"
Perform advanced analysis on the password.


.SS "Show options"

.IP "-a, --attributes <attribute>..."
Names of the attributes to show. This option can be specified more than once,
with each attribute shown one-per-line in the given order. If no attributes are
specified, a summary of the default attributes is given.


.SS "Diceware options"

.IP "-W, --words <count>"
Desired number of words for the generated passphrase. [Default: 7]

.IP "-w, --word-list <path>"
Path of the wordlist for the diceware generator. The wordlist must have > 1000 words,
otherwise the program will fail. If the wordlist has < 4000 words a warning will
be printed to STDERR.


.SS "List options"

.IP "-R, --recursive"
Recursively list the elements of the group.


.SS "Generate options"

.IP "-L, --length <length>"
Desired length for the generated password. [Default: 16]

.IP "-l"
Use lowercase characters for the generated password. [Default: Enabled]

.IP "-u"
Use uppercase characters for the generated password. [Default: Enabled]

.IP "-n"
Use numbers characters for the generated password. [Default: Enabled]

.IP "-s"
Use special characters for the generated password. [Default: Disabled]

.IP "-e"
Use extended ASCII characters for the generated password. [Default: Disabled]


.SH REPORTING BUGS
Bugs and feature requests can be reported on GitHub at https://github.com/keepassxreboot/keepassxc/issues.

.SH AUTHOR
This manual page was originally written by Manolis Agkopian <m.agkopian@gmail.com>,
and is maintained by the KeePassXC Team <team@keepassxc.org>.
Updating CLI man page authorship (#2456) 2018-11-09 19:15:50 -05:00			`.TH KEEPASSXC-CLI 1 "Nov 04, 2018"`
Adding manpage 2017-08-21 21:33:49 -04:00
			`.SH NAME`
			`keepassxc-cli \- command line interface for the \fBKeePassXC\fP password manager.`

			`.SH SYNOPSIS`
			`.B keepassxc-cli`
			`.I command`
Corrects ordering of command/opts in cli manpage 2018-07-22 11:20:50 -04:00			`.RI [ options ]`
Adding manpage 2017-08-21 21:33:49 -04:00
			`.SH DESCRIPTION`
CLI : basic entry manipulation commands. (#919) * CLI : basic entry manipulation commands. * Code review. 2017-09-06 09:14:41 -04:00			`\fBkeepassxc-cli\fP is the command line interface for the \fBKeePassXC\fP password manager. It provides the ability to query and modify the entries of a KeePass database, directly from the command line.`
Adding manpage 2017-08-21 21:33:49 -04:00
			`.SH COMMANDS`

CLI : basic entry manipulation commands. (#919) * CLI : basic entry manipulation commands. * Code review. 2017-09-06 09:14:41 -04:00			`.IP "add [options] <database> <entry>"`
			`Adds a new entry to a database. A password can be generated (\fI-g\fP option), or a prompt can be displayed to input the password (\fI-p\fP option).`

Adding manpage 2017-08-21 21:33:49 -04:00			`.IP "clip [options] <database> <entry> [timeout]"`
			`Copies the password of a database entry to the clipboard. If multiple entries with the same name exist in different groups, only the password for the first one is going to be copied. For copying the password of an entry in a specific group, the group path to the entry should be specified as well, instead of just the name. Optionally, a timeout in seconds can be specified to automatically clear the clipboard.`

update cli manpage 2018-01-31 05:15:23 -05:00			`.IP "diceware [options]"`
add diceware and passgen to the cli interface 2018-01-19 09:48:40 -05:00			`Generate a random diceware passphrase.`

CLI : basic entry manipulation commands. (#919) * CLI : basic entry manipulation commands. * Code review. 2017-09-06 09:14:41 -04:00			`.IP "edit [options] <database> <entry>"`
			`Edits a database entry. A password can be generated (\fI-g\fP option), or a prompt can be displayed to input the password (\fI-p\fP option).`

Rename EntropyMeter -> Estimate (#1250) * EntropyMeter -> Estimate * Cleaning estimate * Documentation * clang-formatting /cli 2017-12-04 09:46:23 -05:00			`.IP "estimate [options] [password]"`
			`Estimates the entropy of a password. The password to estimate can be provided as a positional argument, or using the standard input.`
Adding manpage 2017-08-21 21:33:49 -04:00
			`.IP "extract [options] <database>"`
			`Extracts and prints the contents of a database to standard output in XML format.`

update cli manpage 2018-01-31 05:15:23 -05:00			`.IP "generate [options]"`
fix cli commands, translations and codestyle 2018-02-05 19:17:36 -05:00			`Generate a random password.`
update cli manpage 2018-01-31 05:15:23 -05:00
Adding manpage 2017-08-21 21:33:49 -04:00			`.IP "locate [options] <database> <term>"`
			`Locates all the entries that match a specific search term in a database.`

			`.IP "ls [options] <database> [group]"`
			`Lists the contents of a group in a database. If no group is specified, it will default to the root group.`

			`.IP "merge [options] <database1> <database2>"`
			`Merges two databases together. The first database file is going to be replaced by the result of the merge, for that reason it is advisable to keep a backup of the two database files before attempting a merge. In the case that both databases make use of the same credentials, the \fI--same-credentials\fP or \fI-s\fP option can be used.`

CLI : basic entry manipulation commands. (#919) * CLI : basic entry manipulation commands. * Code review. 2017-09-06 09:14:41 -04:00			`.IP "rm [options] <database> <entry>"`
			`Removes an entry from a database. If the database has a recycle bin, the entry will be moved there. If the entry is already in the recycle bin, it will be removed permanently.`

Adding manpage 2017-08-21 21:33:49 -04:00			`.IP "show [options] <database> <entry>"`
			`Shows the title, username, password, URL and notes of a database entry. Regarding the occurrence of multiple entries with the same name in different groups, everything stated in the \fIclip\fP command section also applies here.`

			`.SH OPTIONS`

CLI : basic entry manipulation commands. (#919) * CLI : basic entry manipulation commands. * Code review. 2017-09-06 09:14:41 -04:00			`.SS "General options"`

Adding manpage 2017-08-21 21:33:49 -04:00			`.IP "-k, --key-file <path>"`
			`Specifies a path to a key file for unlocking the database. In a merge operation this option is used to specify the key file path for the first database.`

			`.IP "-h, --help"`
			`Displays help information.`

			`.IP "-v, --version"`
			`Shows the program version.`

CLI : basic entry manipulation commands. (#919) * CLI : basic entry manipulation commands. * Code review. 2017-09-06 09:14:41 -04:00
			`.SS "Merge options"`

			`.IP "-f, --key-file-from <path>"`
			`Path of the key file for the second database.`

			`.IP "-s, --same-credentials"`
			`Use the same credentials for unlocking both database.`


			`.SS "Add and edit options"`

			`.IP "-u, --username <username>"`
			`Specify the username of the entry.`

			`.IP "--url <url>"`
			`Specify the URL of the entry.`

			`.IP "-p, --password-prompt"`
			`Use a password prompt for the entry's password.`

			`.IP "-g, --generate"`
			`Generate a new password for the entry.`

			`.IP "-l, --password-length"`
			`Specify the length of the password to generate.`


			`.SS "Edit options"`

			`.IP "-t, --title <title>"`
			`Specify the title of the entry.`


Rename EntropyMeter -> Estimate (#1250) * EntropyMeter -> Estimate * Cleaning estimate * Documentation * clang-formatting /cli 2017-12-04 09:46:23 -05:00			`.SS "Estimate options"`

			`.IP "-a, --advanced"`
			`Perform advanced analysis on the password.`


cli: show: add --attributes flag (#1289) In order for scripting to be much simpler with `keepassxc-cli show`, provide a simple --attributesk API which effectively is just a CLI interface for entry->attributes()->value(...). This allows for more extensibility and prevents changes in our output formatting from breaking existing users of keepassxc-cli (if they use --attributes). Signed-off-by: Aleksa Sarai <cyphar@cyphar.com> 2017-12-16 19:14:39 -05:00			`.SS "Show options"`

			`.IP "-a, --attributes <attribute>..."`
			`Names of the attributes to show. This option can be specified more than once,`
			`with each attribute shown one-per-line in the given order. If no attributes are`
			`specified, a summary of the default attributes is given.`


add diceware and passgen to the cli interface 2018-01-19 09:48:40 -05:00			`.SS "Diceware options"`

update cli manpage 2018-01-31 05:15:23 -05:00			`.IP "-W, --words <count>"`
			`Desired number of words for the generated passphrase. [Default: 7]`

use default password lenght + minor fixes 2018-01-20 20:32:46 -05:00			`.IP "-w, --word-list <path>"`
add diceware and passgen to the cli interface 2018-01-19 09:48:40 -05:00			`Path of the wordlist for the diceware generator. The wordlist must have > 1000 words,`
			`otherwise the program will fail. If the wordlist has < 4000 words a warning will`
			`be printed to STDERR.`


Document list -R option. 2018-11-08 14:42:44 -05:00			`.SS "List options"`

			`.IP "-R, --recursive"`
			`Recursively list the elements of the group.`


update cli manpage 2018-01-31 05:15:23 -05:00			`.SS "Generate options"`

			`.IP "-L, --length <length>"`
			`Desired length for the generated password. [Default: 16]`
add diceware and passgen to the cli interface 2018-01-19 09:48:40 -05:00
			`.IP "-l"`
update cli manpage 2018-01-31 05:15:23 -05:00			`Use lowercase characters for the generated password. [Default: Enabled]`
add diceware and passgen to the cli interface 2018-01-19 09:48:40 -05:00
			`.IP "-u"`
update cli manpage 2018-01-31 05:15:23 -05:00			`Use uppercase characters for the generated password. [Default: Enabled]`
add diceware and passgen to the cli interface 2018-01-19 09:48:40 -05:00
			`.IP "-n"`
update cli manpage 2018-01-31 05:15:23 -05:00			`Use numbers characters for the generated password. [Default: Enabled]`
add diceware and passgen to the cli interface 2018-01-19 09:48:40 -05:00
			`.IP "-s"`
update cli manpage 2018-01-31 05:15:23 -05:00			`Use special characters for the generated password. [Default: Disabled]`
add diceware and passgen to the cli interface 2018-01-19 09:48:40 -05:00
			`.IP "-e"`
fix cli commands, translations and codestyle 2018-02-05 19:17:36 -05:00			`Use extended ASCII characters for the generated password. [Default: Disabled]`
add diceware and passgen to the cli interface 2018-01-19 09:48:40 -05:00


Adding reporting bugs section. 2017-08-22 17:16:59 -04:00			`.SH REPORTING BUGS`
			`Bugs and feature requests can be reported on GitHub at https://github.com/keepassxreboot/keepassxc/issues.`

Adding manpage 2017-08-21 21:33:49 -04:00			`.SH AUTHOR`
Updating CLI man page authorship (#2456) 2018-11-09 19:15:50 -05:00			`This manual page was originally written by Manolis Agkopian <m.agkopian@gmail.com>,`
			`and is maintained by the KeePassXC Team <team@keepassxc.org>.`