keeper-admin

Keeper Commander CLI (keeper)

Commander is Keeper's full-featured admin CLI and terminal UI. Everything available in the Keeper Vault UI and Admin Console can be done via Commander. It authenticates as a user (not a machine application) and provides the full breadth of vault, enterprise, and PAM operations.

Official documentation

• Commander CLI - overview, installation, and shell usage
• Secrets Manager (KSM) - creating KSM Applications and Client Devices that ksm uses; runtime secret injection belongs in the keeper-secrets skill

When to Use Commander vs KSM

Need	Tool
Enterprise admin (users, teams, roles, nodes)	keeper
Create KSM Applications and Client Devices	keeper
Password rotation setup/management	keeper
Launch remote sessions (SSH, RDP, DB)	keeper
Import/export vault data	keeper
Interactive vault browsing	keeper
Run as REST API service	keeper
Compliance reporting and audit	keeper
Retrieve secrets for an app at runtime	Use ksm - see keeper-secrets skill
Inject secrets into env vars / config files	Use ksm - see keeper-secrets skill

Prerequisites

1. Python 3.10+
2. Install: pip install keepercommander
3. A Keeper account with appropriate admin permissions
4. Tmux

Check installation: keeper version

Workflow

1. Use references/commander-commands.md for interacting with Keeper commander, Use --help for getting more information for the command.
2. Verify the session is opened via interactive tmux session.
3. Verify available binaries in related python environments:

• keeper --help
• ksm --help

4. Confirm session or auth state before any secret read.
5. Check login status using whoami, if not logged in, complete login process and then continue rest flow.
6. ALWAYS ask the user inputs for REQUIRED fields, DONT GUESS REQUIRED fields.
7. For any record management operations or record sharing operation, VERIFY if the record is a Classic record type or New record type.
8. If a record or folder type is NEW or Nested Sub Folder the use nsf commands. Refer references/nested-sub-folders.md for nsf commands.
9. Search or inspect metadata first, then retrieve only the exact requested field, do not expose any sensitive data.
10. Prefer secret injection or one-command environment scoping over writing secrets to disk.
11. If syntax differs from expectation, fall back to --help and Keeper docs immediately.
12. ALWAYS ask confirmation from users for any delete operations.

REQUIRED tmux session

The shell tool uses a fresh TTY per command. To preserve Keeper interactive context, authentication state, and MFA prompts, run interactive Keeper commands or secrets manager command inside a dedicated tmux session.

Example pattern:

SOCKET_DIR="${TMUX_SOCKET_DIR:-${TMPDIR:-/tmp}/keeper-tmux-sockets}"
mkdir -p "$SOCKET_DIR"
SOCKET="$SOCKET_DIR/keeper-commander.sock"
SESSION="keeper-auth-$(date +%Y%m%d-%H%M%S)"

tmux -S "$SOCKET" new -d -s "$SESSION" -n shell
tmux -S "$SOCKET" send-keys -t "$SESSION":0.0 -- "keeper shell || keeper-commander shell || bash" Enter
tmux -S "$SOCKET" capture-pane -p -J -t "$SESSION":0.0 -S -120

Then drive the session carefully:

tmux -S "$SOCKET" send-keys -t "$SESSION":0.0 -l -- "whoami"
tmux -S "$SOCKET" send-keys -t "$SESSION":0.0 Enter
tmux -S "$SOCKET" capture-pane -p -J -t "$SESSION":0.0 -S -120

Kill the tmux session when the task is complete unless the user wants a persistent Keeper shell.

Authentication

# Interactive login (preferred — credentials are not passed as CLI arguments)
keeper shell
# Prompts for email + master password + 2FA

# Persistent login (recommended for ongoing CLI use)
keeper shell
My Vault> this-device register
My Vault> this-device persistent-login ON

# Biometric authentication (supported platforms)
My Vault> biometric register

Do not pass master passwords, API tokens, or vault field values on the command line (e.g. --password), in URLs, or in generated scripts—they appear in process listings and shell history. For automation, use interactive setup once, enable persistent device login where appropriate, or follow the official Commander CLI documentation for supported non-interactive patterns.

Vault Operations

Browse & Search

My Vault> list                    # List records in current folder
My Vault> ls -l                   # Detailed listing with UIDs
My Vault> search "database"       # Search across all records
My Vault> tree                    # Show folder tree
My Vault> cd "Shared Folder"      # Navigate to folder
My Vault> get <RECORD_UID>        # Show full record details

Record Management

1. While create a new record ALWAYS ask user "Use Classic Permission Model?"
2. If user says Yes, then use classic commands, Otherwise use nsf or Nested sub folder commands.
3. Classic workflows supports record-add command and new workflows support Nested Sub Folder Commands.

Classic Commands

My Vault> record-add --record-type login --title "New Record" \
  --field login=admin
# Set passwords and other sensitive fields via interactive prompts, or supply values only from the user’s secure input—never embed sample secrets in commands.

My Vault> record-update -r <RECORD_UID>
# Or non-interactive field updates for non-secret fields only, e.g. --field login=newuser

My Vault> rm <RECORD_UID>

My Vault> record-history <RECORD_UID>

Sharing Workflow

1. ALWAYS get record details and check if the record or folder type is Classic or nested sub folder type.
2. IF record or folder type is nested sub folder then use nsf commands from references. Otherwise use the classic commands.
3. ALWAYS check if the given record or folder type is PamUser or PAM folder that stores PamUser type records, If YES then ask use if they want to auto rotate the password after a certain time or if access time provided is over.
4. ALWAYS ask user for setting up a expiration time while sharing a record or folder.
5. Use -h flag for the supporting flags.
6. MUST ask users inputs for permission flag, Once confirmed, then only share a record, Otherwise DONT proceed ahead.

Classic Commands

My Vault> share-record -e [email protected] -a grant -u <RECORD_UID>
My Vault> share-folder -e [email protected] -a grant -u <FOLDER_UID>

Import / Export

My Vault> import --format json records.json
My Vault> export --format json --output vault_export.json

Enterprise Administration

These commands require enterprise admin privileges.

User Management

My Vault> enterprise-user --add [email protected]
My Vault> enterprise-user --invite [email protected]
My Vault> enterprise-user --delete [email protected]
My Vault> enterprise-user --lock [email protected]
My Vault> enterprise-user --unlock [email protected]

Team & Role Management

My Vault> enterprise-team --add "Engineering Team"
My Vault> enterprise-role --add-user [email protected] --role "Admin Role"
My Vault> enterprise-role --enforcement MASTER_PASSWORD_MINIMUM_LENGTH:12

Device Approvals

My Vault> device-approve             # List pending approvals
My Vault> device-approve --approve <DEVICE_ID>
My Vault> device-approve --deny <DEVICE_ID>

Reporting

My Vault> audit-report --format csv --output audit.csv
My Vault> compliance-report

Secrets Manager Administration

Commander is used to create and manage the KSM Applications and Client Devices that the KSM CLI connects through.

# Create an Application
My Vault> secrets-manager app create --name "Production App" \
  --shared-folder <FOLDER_UID>

# List Applications
My Vault> secrets-manager app list

# Add a Client Device (generates One-Time Access Token)
My Vault> secrets-manager client add --app <APP_UID> \
  --name "Web Server 1" --unlock-ip

# Remove a Client Device
My Vault> secrets-manager client remove --app <APP_UID> \
  --client "Web Server 1"

# Share Application with another user
My Vault> secrets-manager share --app <APP_UID> --email [email protected]

The One-Time Access Token output from client add is configured on the target machine using the keeper-setup skill (token via KSM_CLI_TOKEN or other supported secure methods—not as a literal --token argument in shared examples or chat).

KeeperPAM Operations

# List PAM resources (gateways, connections)
My Vault> pam gateway list
My Vault> pam configuration list

# Launch SSH session
My Vault> connect <RECORD_UID>

# Manage password rotation
My Vault> pam rotation list
My Vault> pam rotation start --record <RECORD_UID>

Service Mode (REST API)

Commander can run as a headless REST API for automation.

keeper --batch-mode api-server --port 8089

Automation (Batch Commands)

# Run commands from a file
keeper --batch-mode --commands-file commands.txt

# Pipe commands
echo "list" | keeper --batch-mode --user [email protected]

References

• Use references/endpoint-privilege-management.md for endpoint privilege management commands like kepm, epm, pedm commands
• Use references/enterprise-mgmt.md for enterprise management scenarios and commands.
• Use references/pam-commands.md for privileged access management or KeeperPAM functionalities.
• Use references/msp-management.md for commands specific to Managed Service Provider (MSP) tenants

Guardrails

• NEVER expose the user's master password in logs, chat, or code.
• NEVER print secret field values into chat unless explicitly requested for a specific debugging purpose - and warn the user first.
• For destructive operations (delete user, delete record, modify role enforcement), always confirm with the user before executing.
• If the user needs runtime secret injection for an application, redirect them to the keeper-secrets skill and KSM CLI.
• Commander requires a full user login - it cannot be used in headless environments without persistent login configured.
• ALWAYS ask confirmation from users for any DELETE operations.

For detailed command reference, read references/commander-commands.md. For keeper:// URIs and ksm exec / ksm interpolate, see Keeper notation and the keeper-secrets skill.