Developer Mode

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

Installation

If you are a developer and you plan to create Python source code or set up a development environment based on the Github repository, you can use a virtual environment to isolate the environment for testing. Follow the below instructions:

1. Clone/Download the Commander Repository

Clone or download the Commander repository from: https://github.com/Keeper-Security/Commander

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

2. Install Python3

Find the most recent Python3 installation from python.org

3. Install Virtualenv

$ sudo pip3 install virtualenv

4. Create and activate the virtual environment for your keeper project

Mac OS / Linux

$ cd /path/to/Commander
$ virtualenv -p python3 venv
$ source venv/bin/activate

Windows

C:\> cd \path\to\Commander
C:\> virtualenv venv
C:\> .\venv\Scripts\activate

Virtualenv creation and activation differs on Mac OS/Linux and Windows operating systems. Please follow the corresponding instructions.

5. Install Commander to the virtual environment

(venv) $ pip install -r requirements.txt
(venv) $ pip install -e .

🎉 Setup Complete

You should be able to now login to the CLI by typing:

keeper shell

Additional Plugins

Keeper supports plugins for various 3rd party systems for password reset integration. Depending on the plugin, you will need to also install the modules required by that plugin. For example, our MySQL plugin requires the PyMySQL module.

See Password Rotation Plugins section for more information about Commander plugins.

Usage

After you have installed Keeper Commander in developer mode, you can simply login using the keeper shell command:

Run Commander from the Command Line

Sample Python Code

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