Ga naar hoofdinhoud

CLI

De bitsocial-cli is een opdrachtregelprogramma voor interactie met de backend van het Bitsocial-protocol. Hiermee kunt u een lokale P2P-daemon uitvoeren, communities maken en configureren en inhoud publiceren - allemaal vanaf de terminal.

Het is gebouwd bovenop de gedeelde clientlaag van het Bitsocial-protocol en wordt gebruikt door 5kan en Zaad voor het creëren van community's en knooppuntbeheer.

Installatie

Vooraf gebouwde binaire bestanden zijn beschikbaar voor Windows, macOS en Linux. Download de nieuwste release voor uw platform vanaf GitHub:

Downloaden van GitHub-releases

Maak na het downloaden het binaire bestand uitvoerbaar (macOS/Linux):

chmod +x bitsocial-cli

Het uitvoeren van de Daemon

Het meest voorkomende gebruik van de CLI is het uitvoeren van een Bitsocial-knooppunt. De daemon start de P2P-netwerklaag en stelt een lokale API beschikbaar waarmee clients verbinding kunnen maken.

bitsocial-cli daemon

Bij de eerste keer opstarten voert de daemon links uit naar de WebUI, een browsergebaseerde grafische interface voor het beheren van uw knooppunt, communities en instellingen. Dit is handig als u de voorkeur geeft aan een GUI boven terminalopdrachten.

Belangrijkste acties

ActieBeschrijving
Start de daemonStart het Bitsocial P2P-knooppunt
Creëer een communityCreëer een nieuwe community
Een community bewerkenCommunity-instellingen bijwerken (titel, beschrijving, regels)
Lijst lokale gemeenschappenGeef community's weer die op dit knooppunt worden gehost
Start een communityBegin met het bedienen van een specifieke gemeenschap
Stop een gemeenschapStop met het bedienen van een specifieke community

Voer de CLI uit met --help om de huidige opdrachtnamen en vlaggen te zien die worden weergegeven door uw geïnstalleerde release:

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

Typische workflow

Een algemene installatiestroom voor het hosten van een nieuwe community:

# 1. Start the daemon
bitsocial-cli daemon

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

Van daaruit gebruikt u de communitybeheeropdrachten van de geïnstalleerde release om een community te maken, te configureren en te bedienen. Eenmaal gestart, is de community live op het Bitsocial-netwerk en toegankelijk via compatibele klanten.

Koppelingen