Python Developer Setup

Instructions for installation of Python-based Commander with the intent on modifying source code

Installation

To develop or test Keeper Commander from source, use a Python virtual environment to isolate dependencies.

Clone the Commander Repository

Clone the GitHub repository to your local machine: https://github.com/Keeper-Security/Commander

git clone https://github.com/Keeper-Security/Commander
cd Commander

The "master" branch will mirror the production release. The "release" branch references the upcoming release. To optionally switch to the release branch:

git checkout release

Install Python

Install the most recent Python3 installation from python.org.

Install Virtualenv

macOS / Linux

sudo pip3 install virtualenv

Windows

pip install virtualenv

Create and Activate Virtual Environment

macOS / Linux

virtualenv -p python3 venv
source venv/bin/activate

Windows

python -m venv venv
.\venv\Scripts\activate

Install Dependencies and Set Up in Dev Mode

pip install -r requirements.txt
pip install -e .

Setup Complete

You can now launch the Commander CLI:

keeper shell

See the Logging in section to understand the authentication process. Explore all of the Commands available.

---

Sample Python Code

Several standalone python scripts can be found here, with examples for searching records, creating teams and sharing folders, and more.