Aller au contenu principal

CLI

Le bitsocial-cli est un outil de ligne de commande permettant d'interagir avec le backend du protocole Bitsocial. Il vous permet d'exécuter un démon P2P local, de créer et de configurer des communautés et de publier du contenu, le tout depuis le terminal.

Il est construit au-dessus de la couche client du protocole Bitsocial partagé et est utilisé par 5chan et Seedit pour la création de communauté et la gestion de nœuds.

Mise en place

Des binaires prédéfinis sont disponibles pour Windows, macOS et Linux. Téléchargez la dernière version pour votre plateforme depuis GitHub :

Télécharger à partir des versions GitHub

Après le téléchargement, rendez l'exécutable binaire (macOS/Linux) :

chmod +x bitsocial-cli

Exécuter le démon

L'utilisation la plus courante de la CLI consiste à exécuter un nœud Bitsocial. Le démon démarre la couche réseau P2P et expose une API locale à laquelle les clients peuvent se connecter.

bitsocial-cli daemon

Au premier lancement, le démon génère des liens vers WebUI, une interface graphique basée sur un navigateur pour gérer votre nœud, vos communautés et vos paramètres. Ceci est utile si vous préférez une interface graphique aux commandes du terminal.

Actions clés

ActionsDescriptif
Démarrez le démonLancez le nœud Bitsocial P2P
Créer une communautéCréer une nouvelle communauté
Modifier une communautéMettre à jour les paramètres de la communauté (titre, description, règles)
Liste des communautés localesRépertorier les communautés hébergées sur ce nœud
Démarrer une communautéCommencez à servir une communauté spécifique
Arrêter une communautéArrêter de servir une communauté spécifique

Exécutez la CLI avec --help pour voir les noms de commandes et les indicateurs actuels exposés par votre version installée :

bitsocial-cli --help
bitsocial-cli daemon --help

Flux de travail typique

Un flux de configuration courant pour héberger une nouvelle communauté :

# 1. Start the daemon
bitsocial-cli daemon

# 2. In another terminal, inspect the available community-management commands
bitsocial-cli --help

À partir de là, utilisez les commandes de gestion de communauté de la version installée pour créer, configurer et commencer à servir une communauté. Une fois démarrée, la communauté est en direct sur le réseau Bitsocial et accessible depuis les clients compatibles.

Liens