Référence des commandes CLI

Hexabot CLI est un outil en ligne de commande puissant pour aider à gérer votre instance de chatbot Hexabot. Avec lui, vous pouvez créer de nouveaux projets, initialiser des environnements, démarrer des services en différents modes, exécuter des migrations de base de données, et plus encore. Le CLI vise à rendre la gestion de votre chatbot fluide et intuitive.

Pas encore familier avec Hexabot ? C'est une solution open-source de chatbot / agent qui permet aux utilisateurs de créer et gérer facilement des chatbots multicanaux, multilingues et propulsés par l'IA. Si vous souhaitez en savoir plus, veuillez visiter le dépôt officiel github.

Pour commencer

Prérequis

• Node.js >= 18.17.0

• npm (Node Package Manager)

• Docker installé

Installation

Installez Hexabot CLI globalement pour avoir un accès facile à ses commandes :

npm install -g hexabot-cli

Utilisation

Une fois installé, vous pouvez utiliser la hexabot commande dans votre terminal. Voici quelques-unes des commandes disponibles :

Commandes

create <projectName>

Créer un nouveau projet Hexabot.

hexabot create my-chatbot

Options :

• --template <template> : Spécifier un dépôt GitHub au format GITHUB_USERNAME/GITHUB_REPO pour utiliser un modèle personnalisé.

Exemple :

hexabot create my-chatbot --template myusername/my-template-repo

init

Initialiser l'environnement en copiant .env.example vers .env.

hexabot init

dev

Démarrer les services spécifiés en mode développement avec Docker Compose.

hexabot dev --services nlu,ollama

Options :

• --services <services> : Liste de services séparés par des virgules à activer.

start

Démarrer les services spécifiés avec Docker Compose.

hexabot start --services api,nlu

Options :

• --services <services> : Liste de services séparés par des virgules à activer.

migrate [args...]

Exécuter les migrations de base de données.

hexabot migrate

Vous pouvez également passer des arguments supplémentaires à la commande de migration.

start-prod

Démarrer les services spécifiés en mode production avec Docker Compose.

hexabot start-prod --services api,nlu

Options :

• --services <services> : Liste de services séparés par des virgules à activer.

stop

Arrêter les services Docker Compose spécifiés.

hexabot stop --services api,nlu

Options :

• --services <services> : Liste de services séparés par des virgules à arrêter.

destroy

Détruire les services Docker Compose spécifiés et supprimer les volumes.

hexabot destroy --services api,nlu

Options :

• --services <services> : Liste de services séparés par des virgules à détruire.

Flux de travail exemple

1. Créer un nouveau projet:

   hexabot create my-chatbot

   Ceci créera un nouveau dossier my-chatbot avec tous les fichiers nécessaires pour commencer.

2. Naviguez vers votre dossier de projet:

   cd my-chatbot

3. Installer les dépendances:

   npm install

4. Initialiser l'environnement:

   hexabot init

   Cette commande copie le .env.example fichier vers .env, que vous pouvez modifier pour personnaliser votre configuration.

5. Exécuter en mode développement:

   hexabot dev --services nlu,ollama

   Ceci démarre les services requis en mode développement.