kwallet-query - Man Page

KDE Wallet command-line manipulation tool

Examples (TL;DR)

List all entries in the Passwords folder of kdewallet: kwallet-query kdewallet [-l|--list-entries]
List all entries in a specific folder: kwallet-query kdewallet [-l|--list-entries] [-f|--folder] folder_name
List all available folders: kwallet-query kdewallet [-l|--list-entries] [-f|--folder] ""
Display help: kwallet-query [-h|--help]

kwallet-query comes in handy when shell scripts need to read or update the KDE Wallet. It works by manipulating the entries displayed in the KDE Wallet Manager utility. It’s only parameter is the walletname the tool should read or update. The operation mode is specified by the options.

Options

-h,--help: Display a short help message.
-l,--list-entries: List password entries. These are the folder names displayed in the KDE Wallet Manager utility. If the -f option is given, this will only display the subfolders of the specified folder.
-r,--read-password Entry: Read the contents of the given Entry from the Foldersection of the wallet and output it on the standard output. Maps are exported as JSON object.
-w,--write-password Entry: Write secrets to the given Entry under the Folder section of the given wallet. The secrets are read from the standard input. Maps take in input a well-formed JSON object. IMPORTANT previous wallet entry value will be overwritten by this option, so be careful when using it!
-f,--folder Folder: Set the wallet folder to Folder value. By default Passwords is used.
-v,--verbose: Output more information when performing the operation, to help debugging.

Exit Status

0: Success.
1: The wallet wallet was not found.
2: The wallet wallet could not be opened. For example, that would be an indication of a bad password entry or some other problem with the KDE Wallet system.
3: The Folder section was not found inside the wallet wallet. Perhaps the wallet file is corrupt?
4: The read or write operation has failed for some reason.