Miscellaneous Commands

Helpful commands for miscellaneous functionality.

Commands

Keeper Command Reference

Whether using the interactive shell, CLI or JSON config file, Keeper supports the following commands, each command supports additional parameters and options.

To get help on a particular command, run:

help <command>

this-device

Set device logout and persistent login preferences

login

whoami

information on logged in user

logout

logout from Leeper

help

documentation on a given Commander command

sync-down or d

download, sync, and decrypt vault

version or v

display Commander version and path information

clear or c

clear the screen

run-batch or run

Execute commands sequentially from the provided file.

generate

Generate a secure password

verify-records

Verify the integrity of imported records

verify-shared-folders

Verify the integrity of records in shared folders

reset-password

Reset the master password

sync-security-data

Calculate and update security data for all user-owned password records (enterprise only)

sleep

Add delay (in seconds) between batch commands

keeper-fill

Display or manage KeeperFill settings

2fa

2FA settings management

this-device command

Command: this-device

Detail: Set device logout and persistent login preferences

Parameters:

None

Switches:

rename <Name of Device>: Change the name of the device

persistent-login <ON|OFF>: Turn on or off the "Stay Logged In" setting for your account

ip-auto-approve <ON|OFF>: Control the IP Address device auto-approval security setting for your account

no-yubikey-pin <ON|OFF>: Turn on or off the PIN usage on Security Key (Webauthn) devices.

timeout: Set inactivity duration before automatic logout. Default unit is minutes (can be set to hours or days by appending "h" or "d", respectively).

Examples:

this-device
this-device rename "My MacOS CLI"
this-device persistent-login ON
this-device register
this-device ip-auto-approve ON
this-device timeout 10
this-device timeout 24h

Display the available options
Rename the device that shows up in access logs
Enable "Stay Logged In" on the account
Register the user's "encrypted data key" with the server, for use in persistent login sessions
Enables IP Address auto-approval (applies to master password logins only)
Set the inactivity timeout to 10 minutes
Set the inactivity timeout to 24 hours

Command: login

Detail: Login to Keeper

Parameters:

Email address of account to login to

Switches:

-p, --password password of Keeper account

You will be prompted to enter the password if it is not provided with the switch

Examples:

login john.doe@keepersecurity.com
login jane.doe@keepersecurity.com -p BhR!jeL4*2_zQ

whoami command

Command: whoami

Detail: Display information about the currently logged in user

Switches:

-v, --verbose include current datacenter and Commander environment

Examples:

whoami
whoami -v

See detailed user information
See detailed user information with the current datacenter and environment

Example Output:

My Vault> whoami
        Logged in as: jane.doe@keepersecurity.com

             Account                 Type: Enterprise
                             Renewal Date: Jul 29, 2021
             Storage             Capacity: 1000GB
                                    Usage: 0%
                             Renewal Date: Jul 29, 2021

logout command

Command: logout

Detail: Logout of Keeper

Examples:

logout

Logout of Keeper

help command

Command: help

Detail: Display information about a given Commander command or a list of all available commands.

Parameters:

A Commander command to see information for. To see a list of all available commands, leave unspecified.

Examples:

help add
help sync-down
help

See detailed information on add command
See detailed information on sync-down command
See list of all available commands

create-account command

Command: create-account

Details: Create a Keeper Account. You will be prompted to enter a password for the account, and then a verification email code.

Parameters:

Email address to use for the account.

Examples:

create-account example@keepersecurity.com

sync-down command

Command: sync-down or d

Detail: Download, sync, and decrypt vault

Examples:

sync-down

Sync vault
Sync vault

version command

Command: version or v

Detail: Display Commander version and path information

Switches:

-v display information about the underlying SDK, OS, working directory, and configuration file

Examples:

version
v -v

Show current Commander version
Show current Commander version, as well as the SDK version, OS, working directory, and configuration file

clear command

Command: clear or c

Detail: Clear all lines from the screen

Examples:

clear

clear all lines from the screen

run-batch command

Command: run-batch or run

Detail: Execute commands sequentially from the provided file.

Switches:

-d [seconds] Specify a delay of this number of seconds in between commands. This will help in preventing throttling on the backend.

-q Quiet mode

-n or --dry-run Preview the commands that will be run without execution.

Examples:

run-batch -d 10 "C:\path\to\commands.txt"

run-batch -d 2 "/path/on/linux/to/commands.txt"

run-batch --dry-run -d 1 commands.txt

generate command

Requires Commander v16.5.10+

Command: generate

Detail: Generate a secure password

Switches:

-cc or --clipboard-copy copy the created password to the clipboard

-nb or --no-breachwatch skip Breachwatch check

-f <{table, json}> or --format <{table, json}> select an output method for the generated password

requires Commander v16.5.11+

-i <NUMBER> or --json-indent <NUMBER> with json format:

0 for plain json output
a number greater than 0 to select the indentation for easy to read output
requires Commander v16.5.11+

-n [NUMBER] or --number [NUMBER] create the given number of passwords

-c [LENGTH] or --count [LENGTH] length of the password

-s [SYMBOLS] or --symbols [SYMBOLS] minimum number of special symbols to include in the password

-d [DIGITS] or --digits [DIGITS] minimum number of digits to include in the password

-u [UPPERCASE] or --uppercase [UPPSERCASE] minimum number of uppercase letters to include in the password

-l [LOWERCASE] or --lowercase [LOWERCASE] minimum number of lowercase letters to include in the password

-dr [DICE_ROLLS] or --dice-rolls [DICE_ROLLS] number of dice rolls

Examples:

generate
generate -cc -c 12 -u 2 -s 2
generate --format json -i 0
generate --dice-rolls=6 --number=10 --no-breachwatch

Generate a secure password
Generate a secure password that is 12 characters longs with at least 2 uppercase letters and 2 symbols and copy the password to the system clipboard
Generate a password and show password strength, and Breachwatch result in plain json format
Generate 10 diceware passwords of 6 words

generate dice-roll passwords

Requires Commander v16.7.6+

Command: generate --dice-rolls

Detail: Generate a dice roll secure password consisting of random words

Switches:

-dr or --dice-rolls <NUMBER OF WORDS TO GENERATE> generate a dice roll password, and identify how many words to generate

--word-list <WORD LIST FILENAME>optionally use a file of words to use as a wordlist

Examples:

generate --dice-rolls 6
generate --dice-roll 5 --word-list "words.txt"

generate a password of 6 random words
generate a password of 5 random words from the given file of words

verify-records command

Command: verify-records

Detail: Check for record format integrity and perform necessary repairs to record structure. Edge cases are added to this command when issues in the field are reported to Keeper support.

Examples:

verify-records

There are 23 record(s) to be corrected
Do you want to proceed? [y/n]: y

verify-shared-folders command

Command: verify-shared-folders

Parameters

Name or UID of shared folder to check. Leave blank to check all

Detail: Check for records in shared folders that do not have the correct shared data key, then add the correct key where needed

Examples:

verify-shared-folders

There are 2 record key(s) to be corrected
 x4qAxrfilDryCbNCoTqZ8A  MyRecord
 D9QWFSNliXJU86-VI3zyMw  Twitter Login
Do you want to proceed? [y/n]:

reset-password command

Command: reset-password

Detail: reset the account's master password

Switches:

--delete-sso deletes SSO master password

--current the current master password

--new the new password to set as master password

Examples:

reset-password --current MyOldPassword --new lTo@KjCitMPs+R[16HX

Hint: you can use the generate command to generate a secure password within Commander

sync-security-data command

Command: sync-security-data or ssd

This command is available only to enterprise users

Detail: Calculate and update security data for all user-owned password records in the user's vault. Used to correct mis-matching summary security audit scores as seen by the user (in their vault) and by an enterprise administrator (either in the admin console app or via a call to security-audit-report in Commander)

Parameters:

Name(s), path(s), or UID(s) of records to sync. Omit this optional parameter to sync security data for all eligible records. Ignored if --hard option specified (hard-sync requires that all eligible vault records be synced)

Switches:

--hard, -hs Perform a "hard-sync" of security data (forces a reset and recalculation of summary security scores admin-side)

--quiet, -q Run command with minimal screen output

Examples:

sync-security-data
sync-security-data --hard
sync-security-data oY5F-KAdtqOloUanBb7dxQ Team1/Shares/Login-Record
sync-security-data --hard -q

Do a "soft-sync" of user's security data (update security data but don't reset summary scores admin-side)
Do a "hard-sync" of user's security data (see documentation for --hard switch/flag above for more details)
Do a "soft-sync" for records w/ UID = oY5F-KAdtqOloUanBb7dxQ and folder path of Team1/Shares/Login-Record.
Do a "hard-sync" of all eligible records while minimizing screen output

Hint: If the total password record count shown in the user's vault (in "Security Audit" view) differs from the corresponding value shown in the admin console (also in "Security Audit" view) or the output of Commander's security-audit-report --show-updated command, use the --hard flag to force a summary security audit score reset/re-calculation to re-align those values.

To ensure proper re-alignment of summary security audit-scores between the user's vault and the enterprise's admin console, any open instances of the admin console app must be closed prior to running this command. Once the user has executed this command (with the appropriate flag/switch as detailed above), an enterprise administrator must then run security-audit-report --save in Commander to update the corresponding admin-side summary security audit scores.

sleep

This command is deprecated. If your goal is to add delay between commands, please refer to the run-batch command.

Command: sleep

Detail: Add delay (in seconds) between batch commands

Switches:

The number of seconds, the delay, to be added between batch commands

Example:

sleep 5

Sleep for 5 seconds

keeper-fill command

Command: keeper-fill

Detail: Display or manage KeeperFill settings. For example, this allows you to view/change the "Autofill" and "Auto Submit" preferences on a specific Keeper record.

keeper-fill command [--options]

Command    Description
---------  -------------------------------------
list       Displays KeeperFill settings.
set        Sets KeeperFill settings.

To get help on the command run:

My Vault> keeper-fill <command> -h

Possible values for "set" command: none, off, on.

If set to "none", the behavior of the browser extension is to follow the user preference (in the browser extension general Settings screen). If the value is set to "on" or "off", the browser extension will follow the setting for the record.

Example commands:

My Vault> keeper-fill list / --recursive
My Vault> keeper-fill set / --recursive --auto-fill=none
My Vault> keeper-fill set <RECORD_UID> --auto-submit=off
My Vault> keeper-fill set <RECORD_UID> --auto-fill=on

2fa command

Command: 2fa

Detail: Display, add, or delete manage 2FA settings.

2fa command [--options]

Command    Description
---------  ------------------------------
list       Displays a list of 2FA methods
add        Add 2FA method
delete     Delete 2FA method

To get help on the command run:

My Vault> 2fa <command> -h

Example commands:

My Vault> 2fa list 
2FA authentication expires: Never

  #  Method        Channel UID             Name         Created              Phone Number
---  ------------  ----------------------  -----------  -------------------  --------------
  1  TOTP          scbqsym0rRAWhDFZqfClY                2021-09-20 16:07:01
  2  Backup Codes  I2KObaAfoQpfDJVjDKNFB   Backup Code  2022-02-11 14:18:12
  

My Vault> 2fa delete scbqsym0rRAWhDFZqfClY
My Vault> 2fa add --method=totp --name="Google Authenticator"
My Vault> 2fa add --method=key --key-pin --name="Yubikey"

PreviousMSP Management Commands NextTroubleshooting

Last updated 5 months ago

Commands

Keeper Command Reference

this-device command

login command

whoami command

Example Output:

logout command

help command

create-account command

sync-down command

version command

clear command

run-batch command

generate command

generate dice-roll passwords

verify-records command

verify-shared-folders command

reset-password command

sync-security-data command

sleep

keeper-fill command

2fa command