bentoctl.md

bentoctl: the Bento deployment command line management tool

This command line tool offers a series of commands and parameters that are helpful to set up the Docker environment for Bento services. It is designed to facilitate fast development and have better cross-platform compatibility versus the old Makefile.

Prerequisites

This CLI is specified by a Python module, py_bentoctl, launched by a Bash script, ./bentoctl.bash. The Bash wrapper loads various .env files to set up the Bento environment.

The bentoctl script depends on Python packages, we recommend using a virtual environment for this.

# Create a venv under ./env
python3 -m venv env

# Activate the python env
source env/bin/activate

# Install dependencies
pip3 install -r requirements.txt

To make interacting with the CLI quicker, consider adding an alias for calling bentoctl.bash, putting the following in your .bash_aliases, .bash_profile or .zshrc file:

Bash/ZSH: alias bentoctl="./bentoctl.bash"

For a quick setup, use the following to append the alias to the file of your choice.

# Optional: create an alias for bentoctl (run from project's root)
echo "alias bentoctl=${PWD}/bentoctl.bash" > ~/.bash_aliases

# Now RESTART your terminal and re-source the virtualenv, OR run:
source ~/.bash_aliases

# Then, use your alias!
bentoctl --help

Usage

For an overview of bentoctl's features, type the following from the root of the project:

./bentoctl.bash

Note: the flags --debug, -d are intended for interactive remote Python debugging of the bentoctl module itself. See VSCode instructions or PyCharm instructions for IDE setup.

Next steps

• Installation
• Development