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

  1. List Command

  2. Search Command

  3. Get Command

  4. This Device Command

  5. Login Command

  6. Logout Command

  7. Whoami Command

  8. Biometric Command

  9. Sync Down Command

  10. Version Command

  11. Clear Command

  12. Quit Command

  13. Generate Command

  14. List Team Command

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:

My Vault> search login --limit 1
  #  Record UID              Title       Type   Info                                        
---  ----------------------  ----------  -----  --------------------------------------------
  1  record_uid              Example RP  login  [email protected] (at) http://localhost:5000/

First 1 found records are shown.
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

var records = Vault.KeeperRecords;

More details on how we implemented can be found here.

Power Commander

Command: Get-KeeperRecord

Flags:

  • Uid : returns record with matching Uid

  • Filter : Matches record content with what is given and returns matching ones

Example:

PS> Get-KeeperRecord -Filter "Demo Record"

UID                    Type  Title         Info
---                    ----  -----         ----
record_uid             login Demo Record 1 [email protected] (at) https://demo.acmecorp.com
record_uid             login Demo Record 2 [email protected] (at) https://acmecorp.com
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:


My Vault> search -c r record_title

  #  Record UID              Type    Title         Description
---  ----------------------  ------  ------------  -----------------------------------------
  1  record_uid                      record_title
Python SDK

Function: find_records

records = [x for x in vault.vault_data.find_records(criteria=Optional[str], record_type=Optional[Union[str, Iterable[str]]], record_version=Optional[Union[int, Iterable[int]]])]

  • 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 CLI

Command: get

Flags:

  • uid : Uid of Record or Shared folder or Folder

Example:

My Vault> get <UID>                       

                    Record UID:  <UID>                
                          Type:  login                                 
                         Title:  Login Record                          
                         Notes:                                        
                      $passkey:                                        
                        $login:  [email protected]                   
                     $password:  random password                  
                          $url:                                        
                      $fileRef:                                        
                 Last Modified:  Wednesday, August 13, 2025 12:04:28 PM
                                                                       
                   User Shares:                                        
       [email protected]  Can Edit                              
       [email protected]  Owner                                 
                                                                       
                Shared Folders:                                        
                New Test Folder  Read Only
DotNet SDK

The current implementation of the command in Dotnet CLI follows searching of the given UID among different categories

vault.TryGetKeeperRecord(uid, out var record)

If UID is not found in record, then we move ahead to searching for UID among folders

vault.TryGetSharedFolder(uid, out var sf)

If UID is not found in shared folder, then we check folders

vault.TryGetFolder(uid, out var f
Power Commander

Command: Get-KeeperRecord

Alias : kr

Flags:

  • Uid : returns record with matching Uid

  • Filter : Matches record content with what is given and returns matching ones

Example:

PS > Get-KeeperRecord -Uid record_uid

UID                    Type  Title        Info
---                    ----  -----        ----
record_uid             login Login Record [email protected]
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:

My Vault> get record_uid

                 UID: record_uid
                Type: login               
               Title: test
               login: 134234           
            password: ********            
                 url: https://email.com   

User Permissions:

User: [email protected]
Shareable: Yes
Read-Only: No


Shared Folder Permissions:

Shared Folder UID: shared_folder_uid


Share Admins:
[email protected]
Python SDK

Function: load_record

record = vault.vault_data.load_record(record_uid=uid)

The load_record returns the record details. There are 4 types of records:

  • PasswordRecord - legacy or general

  • TypedRecord

  • FileRecord

  • ApplicationRecord

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:

My Vault > sync-down
DotNet SDK

Function: 

public async Task SyncDown(bool fullSync = false)

or

public Task ScheduleSyncDown(TimeSpan delay, bool fullSync = false)

Flag: 

await vault.SyncDown();
Power Commander

Command : Sync-Keeper

Flag :

  • -SyncRecordTypes : re-syncs record types

Example:

PS > > Sync-Keeper -SyncRecordTypes                
Cleared local record type cache for re-sync.
Syncing vault with Keeper server...
Vault sync completed.
Python CLI

Command: sync-down

Flag:

  • -h, --help : show this help message and exit

  • -f, --force : full data sync

Example:

My Vault> sync-down -f
Syncing...
Python SDK

Function: sync_down

def sync_down(self, force=False)

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:

My Vault> version
Invalid command: version

My Vault> logout

Not logged in> version
Keeper Client Version: c17.0.0
DotNet SDK

Function: Not Supported

Power Commander

Command: Get-Module -Name PowerCommander -ListAvailable

Example:

PS > Get-Module -Name PowerCommander -ListAvailable


    Directory: C:\Program Files (x86)\WindowsPowerShell\Modules


ModuleType Version    Name                                ExportedCommands
---------- -------    ----                                ----------------
Script     1.0.7      PowerCommander                      {Connect-Keeper, Sync-Keeper, Disconnect-Keeper, Get-Keepe...
Python CLI

Command : version

Example:

My Vault> version
Commander Version  17.0.0
Python SDK

Function: Not Supported

Clear Command

Clears the CLI terminal screen for better readability.

DotNet CLI

Command : clear

Example:

My Vault > clear
DotNet SDK

Function: Not Supported

Power Commander

Command: Clear

Python CLI

Command: clear

Example:

My Vault > clear
Python SDK

Function: Not Supported

Quit Command

Terminates the current Keeper Commander CLI session and exits the application.

DotNet CLI

Command: quit

Example:

My Vault > quit
DotNet SDK

Function: Not Supported

Power Commander

Command: kq

Alias: Disconnect-Keeper

Python CLI

Command: quit

Example:

My Vault > quit
Python SDK

Function: Not Supported

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.

DotNet CLI

Command: Coming Soon

DotNet SDK

Function: Not Supported

Power Commander

Command: Coming Soon

Python CLI

Command: Coming Soon

Python SDK

Function: Not Supported

PreviousAudit Alert CommandsNextThis Device Commands

Last updated

Was this helpful?