lightctl is Lightup's CLI tool.
Setup virtual env (optional)
We prefer that lightctl is installed in a virtual environment to isolate from other dependencies on the system:
pip install virtualenv
python3 -m venv .lightctl
source .lightctl/bin/activate
Install using pip (Preferred):
pip install lightctl==1.0.0
Install from source (if needed)
In the very rare case where you would like to install it from source - you can run the following commands:
python3 setup.py build
python3 setup.py install
Verify with:
lightctl version
lightctl --help
You can check the usage of lightctl using the following command:
lightctl --help
Lightctl relies on API credentials associated with a specific Lightup cluster. Please see Lightup documentation to see how to get these credentials on a per cluster basis. These credentials can be saved under ~/.lightup/credential. If saved in a different path, use the command as follows:
LIGHTCTL_CREDENTIAL_PATH=<path-to-credential> lightctl ...
or
export LIGHTCTL_CREDENTIAL_PATH=<path-to-credential>
lightctl ...
Lightctl operates on data objects within the context of a workspace. Commands involve workspace id as a parameter. In the absence of a workspace id parameter, lightctl will use a default workspace (which may or may not exist on your system)
lightctl --workspace <workspace id> ....
In order to set the base workspace, you can set the environment variable:
export LIGHTCTL_DEFAULT_WORKSPACE=<workspace id>
lightctl ...
You can setup the environment using the following command:
source ./dev.sh
Currently, we test lightctl using the integration tests pointed to a test cluster. Test coverage is sparse. Unit and integration tests are needed.