CLI

CLI#

There are several ways to install and run the Olvid CLI. The first (and recommended) method is the one used on our πŸš€ Quickstart page. However, there are other possibilities!

Note

To run the CLI outside of daemon Docker Compose configuration, it is necessary for the daemon to expose its port 50051. Remember to check that the daemon service in your docker-compose.yaml file contains the following lines.

  ports:
  - 50051:50051

To allow the CLI to connect to the daemon, you will need to retrieve your daemon’s administrator key. It is usually found in the environment of your daemon. You can check its value in the docker-compose.yaml file at the daemon’s environment section. This is the value of an environment variable that starts with OLVID_ADMIN_CLIENT_KEY. For more details on the administrator keys of the daemon check this page.

Install

pip3 install olvid-bot

Install

docker pull olvid/bot-python-runner

Configure

export OLVID_ADMIN_CLIENT_KEY=adminClientKey
export OLVID_DAEMON_TARGET=localhost:50051

or

echo OLVID_ADMIN_CLIENT_KEY=adminClientKey >> .env
echo OLVID_DAEMON_TARGET=localhost:50051 >> .env

Start

python3 -m olvid-bot
# ou si votre PATH est correctement configurΓ©
olvid-cli

Start

docker run --rm -it \
  -e OLVID_ADMIN_CLIENT_KEY=adminClientKey \
  -e OLVID_DAEMON_TARGET=localhost:50051 \
  olvid/bot-python-runner

You should now see a prompt consisting of a number and the > character. If this is not the case, please visit our troubleshooting page πŸ‘©β€πŸ”§ Troubleshooting. Otherwise, you can continue with our usage page 🏁 Usage to understand how the tool works.