Pular para o conteúdo principal

CLI

Nomenclatura herdada

Este pacote atualmente usa convenções de nomenclatura herdadas de sua dependência upstream. As referências a "plebbit" em comandos, saída e configuração serão migradas para "bitsocial" em uma versão futura. A funcionalidade não é afetada.

O bitsocial-cli é uma ferramenta de linha de comando para interagir com o backend do protocolo Bitsocial. Ele permite executar um daemon P2P local, criar e configurar comunidades e publicar conteúdo – tudo a partir do terminal.

Ele é construído sobre plebbit-js e é usado por 5chan e Seedit para criação de comunidades e gerenciamento de nós.

Instalação

Binários pré-construídos estão disponíveis para Windows, macOS e Linux. Baixe a versão mais recente para sua plataforma no GitHub:

Baixar das versões do GitHub

Após o download, torne o binário executável (macOS/Linux):

chmod +x bitsocial-cli

Executando o Daemon

O uso mais comum da CLI é executar um nó Bitsocial. O daemon inicia a camada de rede P2P e expõe uma API local à qual os clientes podem se conectar.

bitsocial-cli daemon

Na primeira inicialização, o daemon gera links para o WebUI, uma interface gráfica baseada em navegador para gerenciar seu nó, comunidades e configurações. Isso é útil se você preferir uma GUI em vez de comandos de terminal.

Comandos principais

ComandoDescrição
daemonInicie o nó Bitsocial P2P
create subplebbitCrie uma nova comunidade
subplebbit editAtualizar configurações da comunidade (título, descrição, regras)
subplebbit listListar comunidades hospedadas neste nó
subplebbit startComece a servir uma comunidade específica
subplebbit stopPare de servir uma comunidade específica

Execute qualquer comando com --help para ver as opções e sinalizadores disponíveis:

bitsocial-cli daemon --help
bitsocial-cli create subplebbit --help

Fluxo de trabalho típico

Um fluxo de configuração comum para hospedar uma nova comunidade:

# 1. Inicie o daemon
bitsocial-cli daemon

# 2. Em outro terminal, crie uma comunidade
bitsocial-cli create subplebbit

# 3. Configure a comunidade
bitsocial-cli subplebbit edit <address> --title "My Community" --description "A decentralized forum"

# 4. Comece a servir
bitsocial-cli subplebbit start <address>

A comunidade agora está ativa na rede Bitsocial e acessível a partir de qualquer cliente compatível.

Ligações