Перейти до основного вмісту

CLI

Застаріле найменування

У цьому пакеті наразі використовуються застарілі угоди про іменування, успадковані від його початкової залежності. Посилання на «plebbit» у командах, виводі та конфігурації буде переміщено до «bitsocial» у майбутньому випуску. Функціональність не змінена.

bitsocial-cli — це інструмент командного рядка для взаємодії з серверною частиною протоколу Bitsocial. Він дозволяє запускати локальний демон P2P, створювати та налаштовувати спільноти, а також публікувати вміст — і все це з терміналу.

Він створений на основі plebbit-js і використовується 5chan і Seedit для створення спільноти та керування вузлом.

монтаж

Попередньо зібрані двійкові файли доступні для Windows, macOS і Linux. Завантажте останню версію для вашої платформи з GitHub:

Завантажити з GitHub Releases

Після завантаження створіть двійковий виконуваний файл (macOS/Linux):

chmod +x bitsocial-cli

Запуск Демона

Найпоширенішим використанням CLI є запуск вузла Bitsocial. Демон запускає мережевий рівень P2P і надає локальний API, до якого клієнти можуть підключитися.

bitsocial-cli daemon

Під час першого запуску демон видає посилання на WebUI, графічний інтерфейс на основі браузера для керування вашим вузлом, спільнотами та налаштуваннями. Це корисно, якщо ви віддаєте перевагу графічному інтерфейсу, а не командам терміналу.

Ключові команди

КомандаОпис
daemonЗапустіть вузол Bitsocial P2P
create subplebbitСтворити нову спільноту
subplebbit editОновити налаштування спільноти (назва, опис, правила)
subplebbit listСписок спільнот, розміщених на цьому вузлі
subplebbit startПочніть обслуговувати певну спільноту
subplebbit stopПрипинити обслуговування певної спільноти

Виконайте будь-яку команду за допомогою --help, щоб побачити доступні параметри та позначки:

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

Типовий робочий процес

Загальний процес налаштування для розміщення нової спільноти:

# 1. Запустіть демон
bitsocial-cli daemon

# 2. В іншому терміналі створіть спільноту
bitsocial-cli create subplebbit

# 3. Налаштуйте спільноту
bitsocial-cli subplebbit edit <address> --title "My Community" --description "A decentralized forum"

# 4. Почніть подавати
bitsocial-cli subplebbit start <address>

Тепер спільнота працює в мережі Bitsocial і доступна з будь-якого сумісного клієнта.

Посилання