PowerShell Module

Installing the Keeper Commander PowerShell Module

Overview

A version of Keeper Commander is developed in .Net with a PowerShell module. This is published to the PowerShell Gallery as the PowerCommander module. This document provides instructions for installing and using this PowerShell Module.

PowerShell CLI

Keeper's PowerShell command-line tool (PowerCommander) provides basic vault access and administrative functions.

PowerShell module for Keeper Commander is available on the PowerShell Gallery:

To install PowerCommander from PowerShell Gallery:

GitHub Repository

To run the PowerCommander module from the source, refer to the following GitHub Link:

https://github.com/Keeper-Security/keeper-sdk-dotnet/tree/master/PowerCommander

Installation Troubleshooting

Set Execution Policy Permissions

If you are unable to run PowerCommander commands, you may need to set the Execution Policy. To check this, run the following command:

Your output would be similar to this:

If the Scope for your installation is Undefined or Restricted, set it to Unrestricted with the following command:

Note: The above command sets the CurrentUser scope

Logging in with Biometric Authentication

If biometric authentication is configured on your device, you can use Windows Hello to log in to Keeper Commander. This allows you to bypass both the Master Password and two-factor authentication (2FA) for a faster, secure login experience.

For Windows users, ensure Windows Hello is configured:

  • Navigate to Settings > Accounts > Sign-in options > Windows Hello

  • Set up Face recognition, Fingerprint, or PIN

Register Biometric Authentication

First, login to Keeper Commander with your Master Password (or SSO), then register biometric authentication:

Biometric authentication prompt (fingerprint or Face ID) will be displayed.

Register by authenticating with your fingerprint or faceID when prompted by the system.

With successful fingerprint or faceID authentication the registration will be completed:

Device Registration

To use biometric authentication as your default login method, you must register your device

PowerCommander Commands

Login Commands

Cmdlet name
Alias
Description

kc

Login to Keeper

kq

Logout and clear the data

Biometric Login Commands

Cmdlet name
Alias
Description

Registers a new biometric credential (Windows Hello/WebAuthn)

Checks if a biometric credential exists for the current user

Lists all biometric credentials registered for the current user

Removes the biometric credential from the current user

Record Commands

Cmdlet name
Alias
Description

kc

Login to Keeper server

ks

Sync with Keeper server

Logout and clear the data

Get-KeeperLocation

kpwd

Print current Keeper folder

kcd

Change Keeper folder

Get-KeeperChildItem

kdir

Display subfolder and record names in the current Keeper folder

ko

Get Keeper object by UID

kr

Enumerate all records

kadd

Add/Modify Keeper record

kdel

Delete Keeper record

ksf

Enumerate all shared folders

kmv

Move records to Keeper folder

kmkdir

Create Keeper folder

Edit-KeeperFolder

krmdir

Remove Keeper folder

krti

Get Record Type Information

Copy-KeeperToClipboard

kcc

Copy record password to clipboard

Show-TwoFactorCode

2fa

Display Two Factor Code

kda

Download file attachments

Copy-KeeperFileAttachmentToStream

Download file attachement to stream

Upload file attachment to a record

kwhoami

Print account license information

Print the current device settings

this-device

Modifies the current device settings

Get-KeeperPasswordVisible

Show/hide secret fields setting

Set-KeeperPasswordVisible

Sets whether password fields should be visible or not

Add a new custom Keeper Record Type.

Update an existing custom Keeper Record Type.

Delete a custom Keeper Record Type by its ID.

Imports custom record types into Keeper from a JSON file.

Downloads custom record types from Keeper Vault to a JSON file.

Get-KeeperRecordPassword

Gets the password from a Keeper record by name, title, UID, or record object.

Get-KeeperPasswordReport

Generate comprehensive password security report for Keeper records.

Sharing Cmdlets

Cmdlet name
Alias
Description

kshrsh

Show a record sharing information

kshr

Share a record with user

kushr

Remove record share from user

ktr

Transfer record ownership to user

kshf

Add a user or team to a shared folder

kushf

Remove a user or team from a shared folder

kat

Get available teams

kotsg

Get One-Time Shares for a record

kotsn

Create One-Time Share

kotsr

Remove One-Time Share

Enterprise Cmdlets

Cmdlet name
Alias
Description

ked

Sync Keeper enterprise information

ken

Enumerate all enterprise nodes

keu

Enumerate all enterprise users

ket

Enumerate all enterprise teams

Get-KeeperEnterpriseTeamUser

ketu

Get a list of enterprise users for team

kena

Create Node (new)

invite-user

Invite User to Enterprise (new)

lock-user

Lock Enterprise User

unlock-user

Unlock Enterprise User

transfer-user

Transfer user account to another user

delete-user

Delete Enterprise User

ker

Enumerate all enterprise roles (new)

Get-KeeperMspLicenses

msp-license

Return MSP licenses

Switch-KeeperMC

switch-to-mc

Switch to Managed Company (new)

Switch-KeeperMSP

switch-to-msp

Switch back to MSP (new)

Get-KeeperManagedCompany

kmc

Enumerate all enterprise managed companies

New-KeeperManagedCompany

kamc

Create Managed Company

Remove-KeeperManagedCompany

krmc

Remove Managed Company

Edit-KeeperManagedCompany

kemc

Edit Managed Company

Get-MspBillingReport

Run MSP Billing Report

Get-KeeperNodeName

Return Name of current Enterprise Node

Get-KeeperRoleName

Get Display Name of Enterprise Role

Create an enterprise team

Get-KeeperEnterpriseRoleUsers

Get a list of enterprise users for a role

Get-KeeperEnterpriseRoleTeams

Get a list of enterprise teams for a role

Get-KeeperEnterpriseAdminRole

Get a list of Administrator Permissions

Remove-KeeperEnterpriseTeamMember

Removes existing enterprise users from a Keeper team.

Add-KeeperEnterpriseTeamMember

Adds existing enterprise users to a Keeper team.

Secret Manager Cmdlets

Cmdlet name
Alias
Description

ksm

Enumerate all Keeper Secret Manager Applications

ksm-create

Add a Keeper Secret Manager Application

Delete a Keeper Secret Manager Application

ksm-share

Add a shared folder to KSM Application

ksm-unshare

Remove a Shared Folder from KSM Application

ksm-addclient

Add a client/device to KSM Application

ksm-rmclient

Remove a client/device from KSM Application

Grant Keeper Secret Manager Application Access to a user

Revoke Keeper Secret Manager Application Access from a user

BreachWatch Commands

Cmdlet name
Alias
Description

List passwords which are breached based on breachwatch

check a given password against breachwatch passwords

Ignore a given record from breachwatch alerts

Get-KeeperIgnoredBreachWatchRecords

list ignored breachwatch records

Biometric Login Support Commands

Cmdlet name
Alias
Description

Registers a new biometric credential (Windows Hello/WebAuthn)

Checks if a biometric credential exists for the current user

Lists all biometric credentials registered for the current user

Removes the biometric credential from the current user

Additional Commands

Not all capabilities of Keeper Commander (Python) have been added to the PowerShell module. We add them on request by customers. If you have requests for our engineering team, please email [email protected].

Examples

Connect To Keeper Account

List the content of Keeper folder

  • f - folder

  • r - record

  • S - shared

  • A - file attachments

  • O - owner

Show Two Factor Code for all records in the current Keeper folder

Show Two Factor Code for all records in the Vault.

where

  • kr is alias for Get-KeeperRecord

  • 2fa is alias for Show-TwoFactorCode

Copy record password to clipboard

where

  • contro is a substring of the record title. See last entry of kdir output in example #2

  • kcc is alias for Copy-KeeperToClipboard

or

'ktY3jEBqwFDi9UYZSxmIpw' is the Record UID of the same record

Add/Modify Keeper record

creates a legacy record in Keeper

creates a record of login type in Keeper

generates a new password for existing record

Pre-defined fields supported by both legacy and typed records

  • login Login

  • password Password

  • url Website Address

Copy owned record to folder

copies all records in the current Keeper folder to the folder with name 'Shared Folder'

List all enterprise users

Create a new Managed Company

Switch to a new Managed Company

Last updated

Was this helpful?