Global Options

Root flags and parameters supported for the Keeper Commander executable

A number of flags and arguments can be set with the keeper / keeper-commander.exe executable to customize the Commander experience:

--server, -ks: Pre-set the Keeper region, equivalent to server command (US, EU, AU, CA, JP, GOV).

--user, -ku: Pre-set email address, equivalent to login command.

--password, -kp: Master password for the user logging in.

--config: Location of the config file to authenticate with (see more in Configuration File).

--data-dir: Directory to use for Commander data (config, cache, etc.). Overrides environment variables.

--proxy: Pre-set the proxy server, equivalent to proxy command.

--debug: Flag to pre-set debug mode, equivalent to debug command - useful for debugging problems before the shell is available.

--silent: Flag to turn off all logging statements and warnings - useful to reduce the noise when recording logs from stdout. --batch-mode: Flag to run multiple commands in batch without interactive mode. More information below.

--new-login: Flag to force full login (bypass persistent login).

--version: Flag to display version.

--unmask-all: Flag to disable default masking of sensitive information (e.g., passwords) in output.

--fail-on-throttle: Flag to disable default client-side pausing of command execution and re-sending of requests upon server-side throttling.

--config-file: Flag to store credentials in config.json instead of the OS-native keychain.

Batch Mode through STDIN

You can batch execute a series of commands and pipe the file to STDIN of Commander. For example, create a text file called test.cmd with the following lines:

add --login=[e-mail] --pass=somemasterpass --url=https://google.com --force "Some Record Title"
upload-attachment --file="/path/to/some/file.txt" "Some Record Title"
share-record --email="[e-mail]" --write "Some Record Title"

To run this file in a batch mode:

cat test.cmd | keeper --batch-mode -

or

keeper test.cmd

Handling Errors

The batch execution is aborted if some command returns failure. Use @ in front of the command to suppress the possible command error.

record-add --title="Sample Login 123" --record-type=login --folder="Personal Folder" login=username password=$GEN url=https://www.google.com "License ID"="9ACB123" url.AlternateURL=https://amazon.com
upload-attachment --file="/path/to/some/file.txt" "Sample Login 123"
share-record --email="[e-mail]" --write "Sample Login 123"

Batch Mode in Windows

Following example shows how to execute three commands using Windows command line:

(echo ls -l && echo whoami && echo tree) | keeper --batch-mode -

Combining Batch Mode and Persistent Login

By setting up a persistent login configuration (as described in Configuration File), you can execute a series of batch commands without any prompt for login. For example:

$ keeper --config=my_config.json bunch_of_commands.cmd

Batch Mode from the CLI

Keeper supports a batch mode from within the CLI which can conveniently execute commands sequentially.

The command is called "run-batch" and can be executed like below:

My Vault> run-batch -d 10 "C:\My Drive\Keeper\commands.txt"

In this example, each command is executed with a delay of 10 seconds in between.

On Linux environments, the path can also be specified such as:

My Vault> run-batch -d 5 "/path/to/file.txt"