If you’re currently in a
virtualenv, please run
to disable it before proceeding.
We recommend installing
caliban using pipx. pipx is
a tool that lets you install command line utilities written in Python into their
own virtual environments, completely isolated from your system python packages.
You don’t HAVE to do this - you can install caliban in your global environment,
or in a virtualenv - but
pipx is the sanest way we’ve found to install
Python CLI command tools.
Before you install Caliban, you’ll need to visit the Prerequisites page and make sure you have Docker installed and the correct version of Python 3.
pipx into your global python environment like this:
python3 -m pip install --user pipx python3 -m pipx ensurepath
pipx is installed, use it to install
pipx install caliban
If you don’t want to use pipx, install Caliban via pip:
pip install -U caliban
pipx, upgrading Caliban is simple. The following command will do it:
pipx upgrade caliban
If you’ve installed Caliban with pip:
pip upgrade caliban
Check your Installation¶
To check if all is well, run