Git-Mirrors/keepassxc
1
0
Fork 0
mirror of https://github.com/keepassxreboot/keepassxc.git synced 2024-12-15 02:34:20 -05:00
Code Issues Packages Projects Releases Wiki Activity
0654ffc117
keepassxc/share/docs/man/keepassxc-cli.1

256 lines
9.0 KiB
Groff
Raw Normal View History

CLI password generation options cleanup (#3275) Summary of changes: * Extract function for creating password generator from options into `Generate` command. This function is now reused in `Add` and `Edit` commands. * Updated manpage with missing password generation options. * Updated manpage with missing longer forms of password generation options. * Added unit tests for new password generation options in `Add` and `Edit`. * Handle case when `-g` and `-p` options are used at the same time. This PR adds password generation functionalities while reducing code duplication, but at the cost of 2 small breaking changes: * The password generation option for `Add` and `Edit` for specifying password length is now `-L` instead of `-l`, to not clash with the `-l --lower` option. * The `-u` shorthand for the `--upper` option has to be removed, to not clash with the `-u --username` option. * Add -U variant for uppercase.
2019-08-30 22:50:32 -04:00
.TH KEEPASSXC-CLI 1 "June 15, 2019"
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
Add keepassxc man page and move cli man page to share folder (#3665)
2019-10-25 14:45:38 -04:00
.B [
-I options
.B ]
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).
CLI password generation options cleanup (#3275) Summary of changes: * Extract function for creating password generator from options into `Generate` command. This function is now reused in `Add` and `Edit` commands. * Updated manpage with missing password generation options. * Updated manpage with missing longer forms of password generation options. * Added unit tests for new password generation options in `Add` and `Edit`. * Handle case when `-g` and `-p` options are used at the same time. This PR adds password generation functionalities while reducing code duplication, but at the cost of 2 small breaking changes: * The password generation option for `Add` and `Edit` for specifying password length is now `-L` instead of `-l`, to not clash with the `-l --lower` option. * The `-u` shorthand for the `--upper` option has to be removed, to not clash with the `-u --username` option. * Add -U variant for uppercase.
2019-08-30 22:50:32 -04:00
The same password generation options as documented for the generate command can be used when the \fI-g\fP option is set.
CLI : basic entry manipulation commands. (#919) * CLI : basic entry manipulation commands. * Code review.
2017-09-06 09:14:41 -04:00
CLI: add 'analyze' subcommand for offline HIBP breach checks This new subcommand checks all passwords in the given database against a given list of SHA-1 password hashes. Such lists are available from the "Have I Been Pwned" project at https://haveibeenpwned.com/Passwords. Note that this support offline checking only. The HIBP project also provides a web API for checking specific hash ranges; this is not currently supported.
2019-06-24 18:03:42 -04:00
.IP "analyze [options] <database>"
CLI: Add interactive session mode command `open` This change adds a GNU Readline-based interactive mode to keepassxc-cli. If GNU Readline is not available, commands are just read from stdin with no editing or auto-complete support. DatabaseCommand is modified to add the path to the current database to the arguments passed to executeWithDatabase. In this way, instances of DatabaseCommand do not have to prompt to re-open the database after each invocation, and existing command implementations do not have to be changed to support interactive mode. This change also introduces a new way of handling commands between interactive and batch modes. * Fixes #3224. * Ran make format
2019-09-13 09:49:03 -04:00
Analyzes passwords in a database for weaknesses.
CLI: add 'analyze' subcommand for offline HIBP breach checks This new subcommand checks all passwords in the given database against a given list of SHA-1 password hashes. Such lists are available from the "Have I Been Pwned" project at https://haveibeenpwned.com/Passwords. Note that this support offline checking only. The HIBP project also provides a web API for checking specific hash ranges; this is not currently supported.
2019-06-24 18:03:42 -04:00
Adding manpage
2017-08-21 21:33:49 -04:00
.IP "clip [options] <database> <entry> [timeout]"
CLI: add commands to show and copy TOTP to clipboard (#2454) * Add CLI commands show --totp and totp-clip for handling TOTPs, resolves #2429. * Adding tests for new CLI TOTP commands * Update keepassxc-cli man page.
2018-11-09 21:58:42 -05:00
Copies the password or the current TOTP (\fI-t\fP option) 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.
Adding manpage
2017-08-21 21:33:49 -04:00
CLI: Add interactive session mode command `open` This change adds a GNU Readline-based interactive mode to keepassxc-cli. If GNU Readline is not available, commands are just read from stdin with no editing or auto-complete support. DatabaseCommand is modified to add the path to the current database to the arguments passed to executeWithDatabase. In this way, instances of DatabaseCommand do not have to prompt to re-open the database after each invocation, and existing command implementations do not have to be changed to support interactive mode. This change also introduces a new way of handling commands between interactive and batch modes. * Fixes #3224. * Ran make format
2019-09-13 09:49:03 -04:00
.IP "close"
In interactive mode, closes the currently opened database (see \fIopen\fP).
Add create command to keepassxc-cli (#2540) * Add tests for CLI::Create
2018-12-19 23:10:46 -05:00
.IP "create [options] <database>"
Creates a new database with a key file and/or password. The key file will be created if the file that is referred to does not exist. If both the key file and password are empty, no database will be created.
update cli manpage
2018-01-31 05:15:23 -05:00
.IP "diceware [options]"
CLI: Add interactive session mode command `open` This change adds a GNU Readline-based interactive mode to keepassxc-cli. If GNU Readline is not available, commands are just read from stdin with no editing or auto-complete support. DatabaseCommand is modified to add the path to the current database to the arguments passed to executeWithDatabase. In this way, instances of DatabaseCommand do not have to prompt to re-open the database after each invocation, and existing command implementations do not have to be changed to support interactive mode. This change also introduces a new way of handling commands between interactive and batch modes. * Fixes #3224. * Ran make format
2019-09-13 09:49:03 -04:00
Generates a random diceware passphrase.
add diceware and passgen to the cli interface
2018-01-19 09:48:40 -05:00
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).
CLI password generation options cleanup (#3275) Summary of changes: * Extract function for creating password generator from options into `Generate` command. This function is now reused in `Add` and `Edit` commands. * Updated manpage with missing password generation options. * Updated manpage with missing longer forms of password generation options. * Added unit tests for new password generation options in `Add` and `Edit`. * Handle case when `-g` and `-p` options are used at the same time. This PR adds password generation functionalities while reducing code duplication, but at the cost of 2 small breaking changes: * The password generation option for `Add` and `Edit` for specifying password length is now `-L` instead of `-l`, to not clash with the `-l --lower` option. * The `-u` shorthand for the `--upper` option has to be removed, to not clash with the `-u --username` option. * Add -U variant for uppercase.
2019-08-30 22:50:32 -04:00
The same password generation options as documented for the generate command can be used when the \fI-g\fP option is set.
CLI : basic entry manipulation commands. (#919) * CLI : basic entry manipulation commands. * Code review.
2017-09-06 09:14:41 -04:00
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
CLI: Add interactive session mode command `open` This change adds a GNU Readline-based interactive mode to keepassxc-cli. If GNU Readline is not available, commands are just read from stdin with no editing or auto-complete support. DatabaseCommand is modified to add the path to the current database to the arguments passed to executeWithDatabase. In this way, instances of DatabaseCommand do not have to prompt to re-open the database after each invocation, and existing command implementations do not have to be changed to support interactive mode. This change also introduces a new way of handling commands between interactive and batch modes. * Fixes #3224. * Ran make format
2019-09-13 09:49:03 -04:00
.IP "exit"
Exits interactive mode. Synonymous with \fIquit\fP.
CLI: Export database as CSV * Changed `Extract` to `Export` to support additional formats * Allow database expot as CSV. Added a `--format` option to the `Export` command for that, which defaults to xml, so the current behavior is unchanged. *The `CsvExporter` had to be refactored a bit, but nothing major. It can now print to a file or return a string.
2019-06-16 21:33:13 -04:00
.IP "export [options] <database>"
Exports the content of a database to standard output in the specified format (defaults to XML).
Adding manpage
2017-08-21 21:33:49 -04:00
update cli manpage
2018-01-31 05:15:23 -05:00
.IP "generate [options]"
CLI: Add interactive session mode command `open` This change adds a GNU Readline-based interactive mode to keepassxc-cli. If GNU Readline is not available, commands are just read from stdin with no editing or auto-complete support. DatabaseCommand is modified to add the path to the current database to the arguments passed to executeWithDatabase. In this way, instances of DatabaseCommand do not have to prompt to re-open the database after each invocation, and existing command implementations do not have to be changed to support interactive mode. This change also introduces a new way of handling commands between interactive and batch modes. * Fixes #3224. * Ran make format
2019-09-13 09:49:03 -04:00
Generates a random password.
.IP "help [command]"
Displays a list of available commands, or detailed information about the specified command.
update cli manpage
2018-01-31 05:15:23 -05:00
CLI: Add Import XML command (#3572) The CLI now contains an "import" command that creates a new database from the specified XML export. The new database is in kdbx 4 format, and does not currently accept a keyfile in database creation. This change is required to create new databases from XML backups. Fixes #2458
2019-10-14 08:37:26 -04:00
.IP "import [options] <xml> <database>"
Imports the contents of an XML database to the target database.
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: Add group commands
2019-09-12 11:08:28 -04:00
.IP "mkdir [options] <database> <group>"
Adds a new group to a database.
.IP "mv [options] <database> <entry> <group>"
Moves an entry to a new group.
CLI: Add interactive session mode command `open` This change adds a GNU Readline-based interactive mode to keepassxc-cli. If GNU Readline is not available, commands are just read from stdin with no editing or auto-complete support. DatabaseCommand is modified to add the path to the current database to the arguments passed to executeWithDatabase. In this way, instances of DatabaseCommand do not have to prompt to re-open the database after each invocation, and existing command implementations do not have to be changed to support interactive mode. This change also introduces a new way of handling commands between interactive and batch modes. * Fixes #3224. * Ran make format
2019-09-13 09:49:03 -04:00
.IP "open [options] <database>"
Opens the given database in a shell-style interactive mode. This is useful for performing multiple operations on a single database (e.g. \fIls\fP followed by \fIshow\fP).
.IP "quit"
Exits interactive mode. Synonymous with \fIexit\fP.
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.
CLI: Add group commands
2019-09-12 11:08:28 -04:00
.IP "rmdir [options] <database> <group>"
Removes a group from a database. If the database has a recycle bin, the group will be moved there. If the group 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>"
CLI: add commands to show and copy TOTP to clipboard (#2454) * Add CLI commands show --totp and totp-clip for handling TOTPs, resolves #2429. * Adding tests for new CLI TOTP commands * Update keepassxc-cli man page.
2018-11-09 21:58:42 -05:00
Shows the title, username, password, URL and notes of a database entry. Can also show the current TOTP. Regarding the occurrence of multiple entries with the same name in different groups, everything stated in the \fIclip\fP command section also applies here.
Adding manpage
2017-08-21 21:33:49 -04:00
.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 debug info to CLI. Adding debug info to the CLI and the general option of the main Qt app. Also took time to: * use `EXIT_SUCCESS`/`EXIT_FAILURE` constants for main.cpp (this is what is used in `src/cli`); * fixed `m_initalized` typo; * added info on debugging mode being disabled or not; * regrouped Qt related stuff in the debug output.
2019-02-18 20:17:28 -05:00
.IP "--debug-info"
Displays debugging information.
Adding manpage
2017-08-21 21:33:49 -04:00
.IP "-k, --key-file <path>"
CLI: Add interactive session mode command `open` This change adds a GNU Readline-based interactive mode to keepassxc-cli. If GNU Readline is not available, commands are just read from stdin with no editing or auto-complete support. DatabaseCommand is modified to add the path to the current database to the arguments passed to executeWithDatabase. In this way, instances of DatabaseCommand do not have to prompt to re-open the database after each invocation, and existing command implementations do not have to be changed to support interactive mode. This change also introduces a new way of handling commands between interactive and batch modes. * Fixes #3224. * Ran make format
2019-09-13 09:49:03 -04:00
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.
Adding manpage
2017-08-21 21:33:49 -04:00
Adding --no-password option to CLI I also added tests for the --key-file option, which was untested.
2019-03-24 08:51:40 -04:00
.IP "--no-password"
CLI: Add interactive session mode command `open` This change adds a GNU Readline-based interactive mode to keepassxc-cli. If GNU Readline is not available, commands are just read from stdin with no editing or auto-complete support. DatabaseCommand is modified to add the path to the current database to the arguments passed to executeWithDatabase. In this way, instances of DatabaseCommand do not have to prompt to re-open the database after each invocation, and existing command implementations do not have to be changed to support interactive mode. This change also introduces a new way of handling commands between interactive and batch modes. * Fixes #3224. * Ran make format
2019-09-13 09:49:03 -04:00
Deactivates the password key for the database.
Adding --no-password option to CLI I also added tests for the --key-file option, which was untested.
2019-03-24 08:51:40 -04:00
CLI: Add Yubikey unlock support
2019-09-21 12:31:44 -04:00
.IP "-y, --yubikey <slot>"
Specifies a yubikey slot for unlocking the database. In a merge operation this option is used to specify the yubikey slot for the first database.
Adding --quiet option to the CLI. (#2507)
2018-11-28 11:24:12 -05:00
.IP "-q, --quiet <path>"
CLI: Add interactive session mode command `open` This change adds a GNU Readline-based interactive mode to keepassxc-cli. If GNU Readline is not available, commands are just read from stdin with no editing or auto-complete support. DatabaseCommand is modified to add the path to the current database to the arguments passed to executeWithDatabase. In this way, instances of DatabaseCommand do not have to prompt to re-open the database after each invocation, and existing command implementations do not have to be changed to support interactive mode. This change also introduces a new way of handling commands between interactive and batch modes. * Fixes #3224. * Ran make format
2019-09-13 09:49:03 -04:00
Silences password prompt and other secondary outputs.
Adding --quiet option to the CLI. (#2507)
2018-11-28 11:24:12 -05:00
Adding manpage
2017-08-21 21:33:49 -04:00
.IP "-h, --help"
Displays help information.
.IP "-v, --version"
Adding debug info to CLI. Adding debug info to the CLI and the general option of the main Qt app. Also took time to: * use `EXIT_SUCCESS`/`EXIT_FAILURE` constants for main.cpp (this is what is used in `src/cli`); * fixed `m_initalized` typo; * added info on debugging mode being disabled or not; * regrouped Qt related stuff in the debug output.
2019-02-18 20:17:28 -05:00
Displays the program version.
Adding manpage
2017-08-21 21:33:49 -04:00
CLI : basic entry manipulation commands. (#919) * CLI : basic entry manipulation commands. * Code review.
2017-09-06 09:14:41 -04:00
.SS "Merge options"
Add CLI --dry-run option for merge (#3254)
2019-06-18 21:45:24 -04:00
.IP "-d, --dry-run <path>"
CLI: Add interactive session mode command `open` This change adds a GNU Readline-based interactive mode to keepassxc-cli. If GNU Readline is not available, commands are just read from stdin with no editing or auto-complete support. DatabaseCommand is modified to add the path to the current database to the arguments passed to executeWithDatabase. In this way, instances of DatabaseCommand do not have to prompt to re-open the database after each invocation, and existing command implementations do not have to be changed to support interactive mode. This change also introduces a new way of handling commands between interactive and batch modes. * Fixes #3224. * Ran make format
2019-09-13 09:49:03 -04:00
Prints the changes detected by the merge operation without making any changes to the database.
Add CLI --dry-run option for merge (#3254)
2019-06-18 21:45:24 -04:00
CLI: Fix keyfile from/to parameter collision in merge command Rename 'k' to 'f' because 'k' is already used to specify the key for the target database of the merge * Remove short -f option from keepassxc-cli.1 * Remove -f option from keepassxc-cli merge * Add test cases covering cli options for merge * Add functional test for merge with keys
2019-12-21 09:46:01 -05:00
.IP "--key-file-from <path>"
CLI: Add interactive session mode command `open` This change adds a GNU Readline-based interactive mode to keepassxc-cli. If GNU Readline is not available, commands are just read from stdin with no editing or auto-complete support. DatabaseCommand is modified to add the path to the current database to the arguments passed to executeWithDatabase. In this way, instances of DatabaseCommand do not have to prompt to re-open the database after each invocation, and existing command implementations do not have to be changed to support interactive mode. This change also introduces a new way of handling commands between interactive and batch modes. * Fixes #3224. * Ran make format
2019-09-13 09:49:03 -04:00
Sets the path of the key file for the second database.
CLI : basic entry manipulation commands. (#919) * CLI : basic entry manipulation commands. * Code review.
2017-09-06 09:14:41 -04:00
Adding --no-password option to CLI I also added tests for the --key-file option, which was untested.
2019-03-24 08:51:40 -04:00
.IP "--no-password-from"
CLI: Add interactive session mode command `open` This change adds a GNU Readline-based interactive mode to keepassxc-cli. If GNU Readline is not available, commands are just read from stdin with no editing or auto-complete support. DatabaseCommand is modified to add the path to the current database to the arguments passed to executeWithDatabase. In this way, instances of DatabaseCommand do not have to prompt to re-open the database after each invocation, and existing command implementations do not have to be changed to support interactive mode. This change also introduces a new way of handling commands between interactive and batch modes. * Fixes #3224. * Ran make format
2019-09-13 09:49:03 -04:00
Deactivates password key for the database to merge from.
Adding --no-password option to CLI I also added tests for the --key-file option, which was untested.
2019-03-24 08:51:40 -04:00
CLI: Add Yubikey unlock support
2019-09-21 12:31:44 -04:00
.IP "--yubikey-from <slot>"
Yubikey slot for the second database.
CLI : basic entry manipulation commands. (#919) * CLI : basic entry manipulation commands. * Code review.
2017-09-06 09:14:41 -04:00
.IP "-s, --same-credentials"
CLI: Add interactive session mode command `open` This change adds a GNU Readline-based interactive mode to keepassxc-cli. If GNU Readline is not available, commands are just read from stdin with no editing or auto-complete support. DatabaseCommand is modified to add the path to the current database to the arguments passed to executeWithDatabase. In this way, instances of DatabaseCommand do not have to prompt to re-open the database after each invocation, and existing command implementations do not have to be changed to support interactive mode. This change also introduces a new way of handling commands between interactive and batch modes. * Fixes #3224. * Ran make format
2019-09-13 09:49:03 -04:00
Uses the same credentials for unlocking both databases.
CLI : basic entry manipulation commands. (#919) * CLI : basic entry manipulation commands. * Code review.
2017-09-06 09:14:41 -04:00
.SS "Add and edit options"
CLI password generation options cleanup (#3275) Summary of changes: * Extract function for creating password generator from options into `Generate` command. This function is now reused in `Add` and `Edit` commands. * Updated manpage with missing password generation options. * Updated manpage with missing longer forms of password generation options. * Added unit tests for new password generation options in `Add` and `Edit`. * Handle case when `-g` and `-p` options are used at the same time. This PR adds password generation functionalities while reducing code duplication, but at the cost of 2 small breaking changes: * The password generation option for `Add` and `Edit` for specifying password length is now `-L` instead of `-l`, to not clash with the `-l --lower` option. * The `-u` shorthand for the `--upper` option has to be removed, to not clash with the `-u --username` option. * Add -U variant for uppercase.
2019-08-30 22:50:32 -04:00
The same password generation options as documented for the generate command can be used
with those 2 commands when the -g option is set.
CLI : basic entry manipulation commands. (#919) * CLI : basic entry manipulation commands. * Code review.
2017-09-06 09:14:41 -04:00
.IP "-u, --username <username>"
CLI: Add interactive session mode command `open` This change adds a GNU Readline-based interactive mode to keepassxc-cli. If GNU Readline is not available, commands are just read from stdin with no editing or auto-complete support. DatabaseCommand is modified to add the path to the current database to the arguments passed to executeWithDatabase. In this way, instances of DatabaseCommand do not have to prompt to re-open the database after each invocation, and existing command implementations do not have to be changed to support interactive mode. This change also introduces a new way of handling commands between interactive and batch modes. * Fixes #3224. * Ran make format
2019-09-13 09:49:03 -04:00
Specifies the username of the entry.
CLI : basic entry manipulation commands. (#919) * CLI : basic entry manipulation commands. * Code review.
2017-09-06 09:14:41 -04:00
.IP "--url <url>"
CLI: Add interactive session mode command `open` This change adds a GNU Readline-based interactive mode to keepassxc-cli. If GNU Readline is not available, commands are just read from stdin with no editing or auto-complete support. DatabaseCommand is modified to add the path to the current database to the arguments passed to executeWithDatabase. In this way, instances of DatabaseCommand do not have to prompt to re-open the database after each invocation, and existing command implementations do not have to be changed to support interactive mode. This change also introduces a new way of handling commands between interactive and batch modes. * Fixes #3224. * Ran make format
2019-09-13 09:49:03 -04:00
Specifies the URL of the entry.
CLI : basic entry manipulation commands. (#919) * CLI : basic entry manipulation commands. * Code review.
2017-09-06 09:14:41 -04:00
.IP "-p, --password-prompt"
CLI: Add interactive session mode command `open` This change adds a GNU Readline-based interactive mode to keepassxc-cli. If GNU Readline is not available, commands are just read from stdin with no editing or auto-complete support. DatabaseCommand is modified to add the path to the current database to the arguments passed to executeWithDatabase. In this way, instances of DatabaseCommand do not have to prompt to re-open the database after each invocation, and existing command implementations do not have to be changed to support interactive mode. This change also introduces a new way of handling commands between interactive and batch modes. * Fixes #3224. * Ran make format
2019-09-13 09:49:03 -04:00
Uses a password prompt for the entry's password.
CLI : basic entry manipulation commands. (#919) * CLI : basic entry manipulation commands. * Code review.
2017-09-06 09:14:41 -04:00
.IP "-g, --generate"
CLI: Add interactive session mode command `open` This change adds a GNU Readline-based interactive mode to keepassxc-cli. If GNU Readline is not available, commands are just read from stdin with no editing or auto-complete support. DatabaseCommand is modified to add the path to the current database to the arguments passed to executeWithDatabase. In this way, instances of DatabaseCommand do not have to prompt to re-open the database after each invocation, and existing command implementations do not have to be changed to support interactive mode. This change also introduces a new way of handling commands between interactive and batch modes. * Fixes #3224. * Ran make format
2019-09-13 09:49:03 -04:00
Generates a new password for the entry.
CLI : basic entry manipulation commands. (#919) * CLI : basic entry manipulation commands. * Code review.
2017-09-06 09:14:41 -04:00
.SS "Edit options"
.IP "-t, --title <title>"
CLI: Add interactive session mode command `open` This change adds a GNU Readline-based interactive mode to keepassxc-cli. If GNU Readline is not available, commands are just read from stdin with no editing or auto-complete support. DatabaseCommand is modified to add the path to the current database to the arguments passed to executeWithDatabase. In this way, instances of DatabaseCommand do not have to prompt to re-open the database after each invocation, and existing command implementations do not have to be changed to support interactive mode. This change also introduces a new way of handling commands between interactive and batch modes. * Fixes #3224. * Ran make format
2019-09-13 09:49:03 -04:00
Specifies the title of the entry.
CLI : basic entry manipulation commands. (#919) * CLI : basic entry manipulation commands. * Code review.
2017-09-06 09:14:41 -04:00
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"
CLI: Add interactive session mode command `open` This change adds a GNU Readline-based interactive mode to keepassxc-cli. If GNU Readline is not available, commands are just read from stdin with no editing or auto-complete support. DatabaseCommand is modified to add the path to the current database to the arguments passed to executeWithDatabase. In this way, instances of DatabaseCommand do not have to prompt to re-open the database after each invocation, and existing command implementations do not have to be changed to support interactive mode. This change also introduces a new way of handling commands between interactive and batch modes. * Fixes #3224. * Ran make format
2019-09-13 09:49:03 -04:00
Performs advanced analysis on the password.
Rename EntropyMeter -> Estimate (#1250) * EntropyMeter -> Estimate * Cleaning estimate * Documentation * clang-formatting /cli
2017-12-04 09:46:23 -05:00
CLI: add 'analyze' subcommand for offline HIBP breach checks This new subcommand checks all passwords in the given database against a given list of SHA-1 password hashes. Such lists are available from the "Have I Been Pwned" project at https://haveibeenpwned.com/Passwords. Note that this support offline checking only. The HIBP project also provides a web API for checking specific hash ranges; this is not currently supported.
2019-06-24 18:03:42 -04:00
.SS "Analyze options"
.IP "-H, --hibp <filename>"
CLI: Add interactive session mode command `open` This change adds a GNU Readline-based interactive mode to keepassxc-cli. If GNU Readline is not available, commands are just read from stdin with no editing or auto-complete support. DatabaseCommand is modified to add the path to the current database to the arguments passed to executeWithDatabase. In this way, instances of DatabaseCommand do not have to prompt to re-open the database after each invocation, and existing command implementations do not have to be changed to support interactive mode. This change also introduces a new way of handling commands between interactive and batch modes. * Fixes #3224. * Ran make format
2019-09-13 09:49:03 -04:00
Checks if any passwords have been publicly leaked, by comparing against the given
CLI: add 'analyze' subcommand for offline HIBP breach checks This new subcommand checks all passwords in the given database against a given list of SHA-1 password hashes. Such lists are available from the "Have I Been Pwned" project at https://haveibeenpwned.com/Passwords. Note that this support offline checking only. The HIBP project also provides a web API for checking specific hash ranges; this is not currently supported.
2019-06-24 18:03:42 -04:00
list of password SHA-1 hashes, which must be in "Have I Been Pwned" format. Such
files are available from https://haveibeenpwned.com/Passwords; note that they
are large, and so this operation typically takes some time (minutes up to an
hour or so).
CLI: add commands to show and copy TOTP to clipboard (#2454) * Add CLI commands show --totp and totp-clip for handling TOTPs, resolves #2429. * Adding tests for new CLI TOTP commands * Update keepassxc-cli man page.
2018-11-09 21:58:42 -05:00
.SS "Clip options"
.IP "-t, --totp"
CLI: Add interactive session mode command `open` This change adds a GNU Readline-based interactive mode to keepassxc-cli. If GNU Readline is not available, commands are just read from stdin with no editing or auto-complete support. DatabaseCommand is modified to add the path to the current database to the arguments passed to executeWithDatabase. In this way, instances of DatabaseCommand do not have to prompt to re-open the database after each invocation, and existing command implementations do not have to be changed to support interactive mode. This change also introduces a new way of handling commands between interactive and batch modes. * Fixes #3224. * Ran make format
2019-09-13 09:49:03 -04:00
Copies the current TOTP instead of current password to clipboard. Will report
an error if no TOTP is configured for the entry.
CLI: add commands to show and copy TOTP to clipboard (#2454) * Add CLI commands show --totp and totp-clip for handling TOTPs, resolves #2429. * Adding tests for new CLI TOTP commands * Update keepassxc-cli man page.
2018-11-09 21:58:42 -05:00
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>..."
CLI: Add interactive session mode command `open` This change adds a GNU Readline-based interactive mode to keepassxc-cli. If GNU Readline is not available, commands are just read from stdin with no editing or auto-complete support. DatabaseCommand is modified to add the path to the current database to the arguments passed to executeWithDatabase. In this way, instances of DatabaseCommand do not have to prompt to re-open the database after each invocation, and existing command implementations do not have to be changed to support interactive mode. This change also introduces a new way of handling commands between interactive and batch modes. * Fixes #3224. * Ran make format
2019-09-13 09:49:03 -04:00
Shows the named attributes. This option can be specified more than once,
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
with each attribute shown one-per-line in the given order. If no attributes are
CLI: add commands to show and copy TOTP to clipboard (#2454) * Add CLI commands show --totp and totp-clip for handling TOTPs, resolves #2429. * Adding tests for new CLI TOTP commands * Update keepassxc-cli man page.
2018-11-09 21:58:42 -05:00
specified and \fI-t\fP is not specified, a summary of the default attributes is given.
CLI: do not display protected fields by default.
2019-10-28 13:27:29 -04:00
Protected attributes will be displayed in clear text if specified explicitly by this option.
.IP "-s, --show-protected"
Shows the protected attributes in clear text.
CLI: add commands to show and copy TOTP to clipboard (#2454) * Add CLI commands show --totp and totp-clip for handling TOTPs, resolves #2429. * Adding tests for new CLI TOTP commands * Update keepassxc-cli man page.
2018-11-09 21:58:42 -05:00
.IP "-t, --totp"
CLI: Add interactive session mode command `open` This change adds a GNU Readline-based interactive mode to keepassxc-cli. If GNU Readline is not available, commands are just read from stdin with no editing or auto-complete support. DatabaseCommand is modified to add the path to the current database to the arguments passed to executeWithDatabase. In this way, instances of DatabaseCommand do not have to prompt to re-open the database after each invocation, and existing command implementations do not have to be changed to support interactive mode. This change also introduces a new way of handling commands between interactive and batch modes. * Fixes #3224. * Ran make format
2019-09-13 09:49:03 -04:00
Also shows the current TOTP, reporting an error if no TOTP is configured for
the entry.
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
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>"
CLI: Add interactive session mode command `open` This change adds a GNU Readline-based interactive mode to keepassxc-cli. If GNU Readline is not available, commands are just read from stdin with no editing or auto-complete support. DatabaseCommand is modified to add the path to the current database to the arguments passed to executeWithDatabase. In this way, instances of DatabaseCommand do not have to prompt to re-open the database after each invocation, and existing command implementations do not have to be changed to support interactive mode. This change also introduces a new way of handling commands between interactive and batch modes. * Fixes #3224. * Ran make format
2019-09-13 09:49:03 -04:00
Sets the desired number of words for the generated passphrase. [Default: 7]
update cli manpage
2018-01-31 05:15:23 -05:00
use default password lenght + minor fixes
2018-01-20 20:32:46 -05:00
.IP "-w, --word-list <path>"
CLI: Add interactive session mode command `open` This change adds a GNU Readline-based interactive mode to keepassxc-cli. If GNU Readline is not available, commands are just read from stdin with no editing or auto-complete support. DatabaseCommand is modified to add the path to the current database to the arguments passed to executeWithDatabase. In this way, instances of DatabaseCommand do not have to prompt to re-open the database after each invocation, and existing command implementations do not have to be changed to support interactive mode. This change also introduces a new way of handling commands between interactive and batch modes. * Fixes #3224. * Ran make format
2019-09-13 09:49:03 -04:00
Sets the 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.
add diceware and passgen to the cli interface
2018-01-19 09:48:40 -05:00
CLI: Export database as CSV * Changed `Extract` to `Export` to support additional formats * Allow database expot as CSV. Added a `--format` option to the `Export` command for that, which defaults to xml, so the current behavior is unchanged. *The `CsvExporter` had to be refactored a bit, but nothing major. It can now print to a file or return a string.
2019-06-16 21:33:13 -04:00
.SS "Export options"
.IP "-f, --format"
Format to use when exporting. Available choices are xml or csv. Defaults to xml.
Document list -R option.
2018-11-08 14:42:44 -05:00
.SS "List options"
.IP "-R, --recursive"
CLI: Add interactive session mode command `open` This change adds a GNU Readline-based interactive mode to keepassxc-cli. If GNU Readline is not available, commands are just read from stdin with no editing or auto-complete support. DatabaseCommand is modified to add the path to the current database to the arguments passed to executeWithDatabase. In this way, instances of DatabaseCommand do not have to prompt to re-open the database after each invocation, and existing command implementations do not have to be changed to support interactive mode. This change also introduces a new way of handling commands between interactive and batch modes. * Fixes #3224. * Ran make format
2019-09-13 09:49:03 -04:00
Recursively lists the elements of the group.
Document list -R option.
2018-11-08 14:42:44 -05:00
CLI: Add 'flatten' option to the 'ls' command (#3276) * Fixes #925 * Add 'flatten' option to CLI ls command * Add test for Group::hierarchy() and man page for ls --flatten * Rename group sort test to align with others
2019-06-18 20:42:19 -04:00
.IP "-f, --flatten"
Flattens the output to single lines. When this option is enabled, subgroups and subentries will be displayed with a relative group path instead of indentation.
Document list -R option.
2018-11-08 14:42:44 -05:00
update cli manpage
2018-01-31 05:15:23 -05:00
.SS "Generate options"
.IP "-L, --length <length>"
CLI: Add interactive session mode command `open` This change adds a GNU Readline-based interactive mode to keepassxc-cli. If GNU Readline is not available, commands are just read from stdin with no editing or auto-complete support. DatabaseCommand is modified to add the path to the current database to the arguments passed to executeWithDatabase. In this way, instances of DatabaseCommand do not have to prompt to re-open the database after each invocation, and existing command implementations do not have to be changed to support interactive mode. This change also introduces a new way of handling commands between interactive and batch modes. * Fixes #3224. * Ran make format
2019-09-13 09:49:03 -04:00
Sets the desired length for the generated password. [Default: 16]
add diceware and passgen to the cli interface
2018-01-19 09:48:40 -05:00
CLI password generation options cleanup (#3275) Summary of changes: * Extract function for creating password generator from options into `Generate` command. This function is now reused in `Add` and `Edit` commands. * Updated manpage with missing password generation options. * Updated manpage with missing longer forms of password generation options. * Added unit tests for new password generation options in `Add` and `Edit`. * Handle case when `-g` and `-p` options are used at the same time. This PR adds password generation functionalities while reducing code duplication, but at the cost of 2 small breaking changes: * The password generation option for `Add` and `Edit` for specifying password length is now `-L` instead of `-l`, to not clash with the `-l --lower` option. * The `-u` shorthand for the `--upper` option has to be removed, to not clash with the `-u --username` option. * Add -U variant for uppercase.
2019-08-30 22:50:32 -04:00
.IP "-l --lower"
CLI: Add interactive session mode command `open` This change adds a GNU Readline-based interactive mode to keepassxc-cli. If GNU Readline is not available, commands are just read from stdin with no editing or auto-complete support. DatabaseCommand is modified to add the path to the current database to the arguments passed to executeWithDatabase. In this way, instances of DatabaseCommand do not have to prompt to re-open the database after each invocation, and existing command implementations do not have to be changed to support interactive mode. This change also introduces a new way of handling commands between interactive and batch modes. * Fixes #3224. * Ran make format
2019-09-13 09:49:03 -04:00
Uses lowercase characters for the generated password. [Default: Enabled]
add diceware and passgen to the cli interface
2018-01-19 09:48:40 -05:00
CLI password generation options cleanup (#3275) Summary of changes: * Extract function for creating password generator from options into `Generate` command. This function is now reused in `Add` and `Edit` commands. * Updated manpage with missing password generation options. * Updated manpage with missing longer forms of password generation options. * Added unit tests for new password generation options in `Add` and `Edit`. * Handle case when `-g` and `-p` options are used at the same time. This PR adds password generation functionalities while reducing code duplication, but at the cost of 2 small breaking changes: * The password generation option for `Add` and `Edit` for specifying password length is now `-L` instead of `-l`, to not clash with the `-l --lower` option. * The `-u` shorthand for the `--upper` option has to be removed, to not clash with the `-u --username` option. * Add -U variant for uppercase.
2019-08-30 22:50:32 -04:00
.IP "-U --upper"
CLI: Add interactive session mode command `open` This change adds a GNU Readline-based interactive mode to keepassxc-cli. If GNU Readline is not available, commands are just read from stdin with no editing or auto-complete support. DatabaseCommand is modified to add the path to the current database to the arguments passed to executeWithDatabase. In this way, instances of DatabaseCommand do not have to prompt to re-open the database after each invocation, and existing command implementations do not have to be changed to support interactive mode. This change also introduces a new way of handling commands between interactive and batch modes. * Fixes #3224. * Ran make format
2019-09-13 09:49:03 -04:00
Uses uppercase characters for the generated password. [Default: Enabled]
add diceware and passgen to the cli interface
2018-01-19 09:48:40 -05:00
CLI password generation options cleanup (#3275) Summary of changes: * Extract function for creating password generator from options into `Generate` command. This function is now reused in `Add` and `Edit` commands. * Updated manpage with missing password generation options. * Updated manpage with missing longer forms of password generation options. * Added unit tests for new password generation options in `Add` and `Edit`. * Handle case when `-g` and `-p` options are used at the same time. This PR adds password generation functionalities while reducing code duplication, but at the cost of 2 small breaking changes: * The password generation option for `Add` and `Edit` for specifying password length is now `-L` instead of `-l`, to not clash with the `-l --lower` option. * The `-u` shorthand for the `--upper` option has to be removed, to not clash with the `-u --username` option. * Add -U variant for uppercase.
2019-08-30 22:50:32 -04:00
.IP "-n --numeric"
CLI: Add interactive session mode command `open` This change adds a GNU Readline-based interactive mode to keepassxc-cli. If GNU Readline is not available, commands are just read from stdin with no editing or auto-complete support. DatabaseCommand is modified to add the path to the current database to the arguments passed to executeWithDatabase. In this way, instances of DatabaseCommand do not have to prompt to re-open the database after each invocation, and existing command implementations do not have to be changed to support interactive mode. This change also introduces a new way of handling commands between interactive and batch modes. * Fixes #3224. * Ran make format
2019-09-13 09:49:03 -04:00
Uses numbers characters for the generated password. [Default: Enabled]
add diceware and passgen to the cli interface
2018-01-19 09:48:40 -05:00
CLI password generation options cleanup (#3275) Summary of changes: * Extract function for creating password generator from options into `Generate` command. This function is now reused in `Add` and `Edit` commands. * Updated manpage with missing password generation options. * Updated manpage with missing longer forms of password generation options. * Added unit tests for new password generation options in `Add` and `Edit`. * Handle case when `-g` and `-p` options are used at the same time. This PR adds password generation functionalities while reducing code duplication, but at the cost of 2 small breaking changes: * The password generation option for `Add` and `Edit` for specifying password length is now `-L` instead of `-l`, to not clash with the `-l --lower` option. * The `-u` shorthand for the `--upper` option has to be removed, to not clash with the `-u --username` option. * Add -U variant for uppercase.
2019-08-30 22:50:32 -04:00
.IP "-s --special"
CLI: Add interactive session mode command `open` This change adds a GNU Readline-based interactive mode to keepassxc-cli. If GNU Readline is not available, commands are just read from stdin with no editing or auto-complete support. DatabaseCommand is modified to add the path to the current database to the arguments passed to executeWithDatabase. In this way, instances of DatabaseCommand do not have to prompt to re-open the database after each invocation, and existing command implementations do not have to be changed to support interactive mode. This change also introduces a new way of handling commands between interactive and batch modes. * Fixes #3224. * Ran make format
2019-09-13 09:49:03 -04:00
Uses special characters for the generated password. [Default: Disabled]
add diceware and passgen to the cli interface
2018-01-19 09:48:40 -05:00
CLI password generation options cleanup (#3275) Summary of changes: * Extract function for creating password generator from options into `Generate` command. This function is now reused in `Add` and `Edit` commands. * Updated manpage with missing password generation options. * Updated manpage with missing longer forms of password generation options. * Added unit tests for new password generation options in `Add` and `Edit`. * Handle case when `-g` and `-p` options are used at the same time. This PR adds password generation functionalities while reducing code duplication, but at the cost of 2 small breaking changes: * The password generation option for `Add` and `Edit` for specifying password length is now `-L` instead of `-l`, to not clash with the `-l --lower` option. * The `-u` shorthand for the `--upper` option has to be removed, to not clash with the `-u --username` option. * Add -U variant for uppercase.
2019-08-30 22:50:32 -04:00
.IP "-e --extended"
CLI: Add interactive session mode command `open` This change adds a GNU Readline-based interactive mode to keepassxc-cli. If GNU Readline is not available, commands are just read from stdin with no editing or auto-complete support. DatabaseCommand is modified to add the path to the current database to the arguments passed to executeWithDatabase. In this way, instances of DatabaseCommand do not have to prompt to re-open the database after each invocation, and existing command implementations do not have to be changed to support interactive mode. This change also introduces a new way of handling commands between interactive and batch modes. * Fixes #3224. * Ran make format
2019-09-13 09:49:03 -04:00
Uses 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
CLI password generation options cleanup (#3275) Summary of changes: * Extract function for creating password generator from options into `Generate` command. This function is now reused in `Add` and `Edit` commands. * Updated manpage with missing password generation options. * Updated manpage with missing longer forms of password generation options. * Added unit tests for new password generation options in `Add` and `Edit`. * Handle case when `-g` and `-p` options are used at the same time. This PR adds password generation functionalities while reducing code duplication, but at the cost of 2 small breaking changes: * The password generation option for `Add` and `Edit` for specifying password length is now `-L` instead of `-l`, to not clash with the `-l --lower` option. * The `-u` shorthand for the `--upper` option has to be removed, to not clash with the `-u --username` option. * Add -U variant for uppercase.
2019-08-30 22:50:32 -04:00
.IP "-x --exclude <chars>"
Comma-separated list of characters to exclude from the generated password. None is excluded by default.
.IP "--exclude-similar"
Exclude similar looking characters. [Default: Disabled]
.IP "--every-group"
Include characters from every selected group. [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>.
Reference in New Issue Copy Permalink