CLI

CLI#

Il existe plusieurs manières d’installer et de lancer la CLI Olvid. La première (recommandée) est celle utilisée dans notre page 🚀 Quickstart. Mais il existe d’autres possibilités !

Note

Pour exécuter la CLI en dehors de la configuration Docker Compose du daemon, il est nécessaire que celui-ci daemon expose son port 50051. Pensez à vérifier que le service daemon de votre fichier docker-compose.yaml contient les lignes suivantes.

  ports:
  - 50051:50051

Pour permettre à la CLI de se connecter au daemon, il vous faudra récupérer la clé administrateur de votre daemon. Elle se trouve normalement dans l’environnement de votre daemon. Vous pouvez vérifier sa valeur dans le fichier docker-compose.yaml à la section environnement du daemon. Il s’agit de la valeur d’une variable d’environnement qui commence par OLVID_ADMIN_CLIENT_KEY.
Pour plus de détails sur les clés d’administration du daemon rendez-vous ici.

Python

Installation

pip3 install olvid-bot

Docker

Installation

docker pull olvid/bot-python-runner:2.0.1

Python

Configuration

export OLVID_ADMIN_CLIENT_KEY=adminClientKey
export OLVID_DAEMON_URL=http://localhost:50051

ou

echo OLVID_ADMIN_CLIENT_KEY=adminClientKey >> .env
echo OLVID_DAEMON_URL=http://localhost:50051 >> .env

Lancement

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

Docker

Lancement

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

Vous devriez maintenant voir un prompt constitué d’un nombre et du caractère >. Si ce n’est pas le cas, rendez-vous sur notre page 👩‍🔧 Dépannage. Sinon, vous pouvez continuer avec notre page 🏁 Utilisation pour comprendre le fonctionnement de l’outil.