Miscellaneous Commands
This page gives information of helpful commands for miscellaneous functionality.
Overview
This section covers general-purpose commands within the Keeper Commander CLI that support everyday tasks and CLI environment management. Rather than focusing on record-specific operations, these commands help you navigate, configure, and manage the Commander session itself.
Command
The Following commands are supported
Action Report
Search Command
This command returns all records available in Keeper Vault that meet the defined criteria. Criteria are text or word which should be present in the record.
DotNet CLI
Command: search
Flags:
argument 1: pattern to match in search--verbose: show all data--limit: number of records to show
Example:
DotNet SDK
Function: Vault.KeeperRecords
There is no specific function for this. we just get keeper records and then we regex match each record data
More details on how we implemented can be found here.
Power Commander
Command: Get-KeeperRecord
Flags:
Uid: returns record with matching UidFilter: Matches record content with what is given and returns matching ones
Example:
Python CLI
Command: search
Flags:
-v --verbose Show detailed verbose ourput
-c --categories Single letter input to specify record, team or shared folder
pattern Search criteria for vault objects
Example:
Python SDK
Function: find_records
criteria -> Text to be present in the record
record_types -> Return record of given record types
record_version -> Return record of given record version
Get Command
This command returns information for a given UID. The UID can be for a record, folder, shared folder or a team. The information can be printed as a json or as a list of details
DotNet SDK
The current implementation of the command in Dotnet CLI follows searching of the given UID among different categories
If UID is not found in record, then we move ahead to searching for UID among folders
If UID is not found in shared folder, then we check folders
Power Commander
Command: Get-KeeperRecord
Alias : kr
Flags:
Uid: returns record with matching UidFilter: Matches record content with what is given and returns matching ones
Example:
Python CLI
Command: get <UID>
Flags:
--format Supported display types - json, details, fields or password
--unmask Show sensitive data in output such as passwords
--legacy Show typed records as legacy
Example:
Python SDK
Function: load_record
The load_record returns the record details. There are 4 types of records:
PasswordRecord- legacy or generalTypedRecordFileRecordApplicationRecord
These classes are defined in keepersdk.vault.vault_record
Sync Down Command
Synchronises the local vault by downloading and decrypting the latest data from the server. This ensures local CLI access has up-to-date information.
DotNet CLI
Command: sync-down
Flag:
--reset (Default: false): resets on-disk storage--help: Display this help screen.--version: Display version information.
Example:
Python CLI
Command: sync-down
Flag:
-h, --help: show this help message and exit-f, --force: full data sync
Example:
Version Command
Shows the version of the Keeper Commander CLI, along with environment details like installation path and OS.
DotNet CLI
Command: version
This command doesn't work if user is logged in. the user needs to be logged out to use this command.
Example:
Clear Command
Clears the CLI terminal screen for better readability.
Quit Command
Terminates the current Keeper Commander CLI session and exits the application.
Generate Command
Generates strong, random passwords with customisable options such as length, character sets (letters, numbers, symbols), and can copy output to clipboard or format it as JSON or a table.
Python CLI
Command: Generate
Flag:
-h, --help: show this help message and exit.--clipboard, -cc: Copy to clipboard.--quiet, -q: Only print password list.--password-list, -p: Also print password list apart from formatted table or json--output, -o: Output to specified file.--format, -f:Output format for displaying password, strength, and BreachWatch if available(table,json).--json-indent, -i: JSON format indent (0 for compact, >0 for pretty print).--no-breachwatch, -nb: Skip BreachWatch detection if BreachWatch is enabled for this account.--number, -n: NUMBER Number of passwords
Random:
--count, -c: LENGTH Length of password.-r, --rules: RULES Use comma separated complexity integers (uppercase, lowercase, numbers, symbols).--symbols, -s: Minimum number of symbols in password or 0 for none.--digits, -d: Minimum number of digits in password or 0 for none.--uppercase, -u: Minimum number of uppercase letters in password or 0 for none.--lowercase, -l: Minimum number of lowercase letters in password or 0 for none.
Keeper Passphrase:
--recoveryphrase: Generate Generate a 24-word recovery phrase.
Diceware:
--dice-rolls, -dr: Number of dice rolls.--delimiter, -dl: Word delimiter(Optional) .--word-list: File path to word list(Optional).
Crypto:
--crypto: Generate crypto wallet passphrase
Example:
Reset Password Command
This command replaces the current user's existing password with the newly provided one.
Python CLI
Command: reset-password
Flag:
--delete-ssodeletes SSO master password--currentthe current master password--newthe new password to set as master password
Examples:
Verify Records
Check for record format integrity and perform necessary repairs to record structure.
Verify Shared Folders
Check for records in shared folders that do not have the correct shared data key, then add the correct key where needed
Last updated
Was this helpful?

