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

Налаштування CLI

nn-webhooks — інструмент командного рядка для Webhooks: один статичний бінарний файл для macOS, Linux і Windows, більше нічого встановлювати не треба. Він публікує події, керує ендпоінтами й повторно надсилає невдалі доставки. Наразі це єдиний CLI NimbusNexus. CLI для інфраструктури поки немає; натомість використовуйте REST API.

Поточний реліз — 0.7.0. Його архіви та їхній checksums.txt додано до кожного релізу публічного репозиторію webhooks-go, і Homebrew встановлює ті самі архіви.

1 · Встановлення

macOS: Homebrew

Shell
brew install nimbusnexus/tap/nn-webhooks
nn-webhooks version

Tap постачає cask, а Homebrew встановлює cask-и лише на macOS. Пізніше оновлюйте командою brew upgrade nn-webhooks.

Linux і macOS: завантаження

Задайте OS значення linux або darwin, а ARCH — amd64 або arm64. Потім завантажте архів, звірте його з контрольними сумами релізу й покладіть бінарний файл у PATH:

Shell
VERSION=0.7.0
OS=linux
ARCH=amd64
BASE=https://github.com/NimbusNexus/webhooks-go/releases/download/v$VERSION
curl -fsSLO "$BASE/nn-webhooks_${VERSION}_${OS}_${ARCH}.tar.gz"
curl -fsSLO "$BASE/checksums.txt"
shasum -a 256 --check --ignore-missing checksums.txt
tar -xzf "nn-webhooks_${VERSION}_${OS}_${ARCH}.tar.gz" nn-webhooks
sudo install -m 0755 nn-webhooks /usr/local/bin/nn-webhooks
nn-webhooks version

Крок із контрольною сумою має вивести OK для архіву; якщо ні, зупиніться на цьому. Якщо shasum немає, те саме робить sha256sum --check --ignore-missing checksums.txt. Без sudo встановіть у каталог, що належить вам і є у вашому PATH, напр., ~/.local/bin.

Windows: завантаження

У PowerShell завантажте zip-архів, порівняйте його хеш із відповідним рядком checksums.txt, а потім розпакуйте його в теку з вашого PATH:

powershell
$Version = "0.7.0"
$Base = "https://github.com/NimbusNexus/webhooks-go/releases/download/v$Version"
Invoke-WebRequest "$Base/nn-webhooks_${Version}_windows_amd64.zip" -OutFile nn-webhooks.zip
Invoke-WebRequest "$Base/checksums.txt" -OutFile checksums.txt
(Get-FileHash nn-webhooks.zip -Algorithm SHA256).Hash.ToLower()
Select-String "windows_amd64.zip" checksums.txt
Expand-Archive nn-webhooks.zip -DestinationPath "$env:LOCALAPPDATA\nn-webhooks"

Обидва хеші мають збігатися. Потім додайте %LOCALAPPDATA%\nn-webhooks до свого PATH і виконайте nn-webhooks version. На ARM використовуйте windows_arm64 в обох назвах файлів.

З інструментарієм Go

Shell
go install github.com/NimbusNexus/webhooks-go/cmd/nn-webhooks@latest

Для цього потрібен Go 1.25 або новіший. Бінарний файл, зібраний із сирців, показує версію SDK із суфіксом +source, а не номер релізу.

2 · Налаштуйте ключ

На власному компʼютері увійдіть через браузер:

Shell
nn-webhooks login

Команда виводить код і відкриває консоль акаунта. Перевірте, що код збігається, схваліть там запит, і CLI збереже ключ на 90 днів у своєму профілі. Подробиці — у розділі Вхід.

Щоб натомість використати ключ, який у вас уже є, напр., для CI, створіть ключ Webhooks у консолі акаунта в розділі API keys; подробиці — у розділі Отримайте API-ключ. Потім збережіть його в профілі:

Shell
nn-webhooks configure --url https://webhooks.nimbusnexus.net
nn-webhooks whoami

configure запитує ключ і зберігає його в ~/.config/nn-webhooks/credentials.json з правами 0600. whoami показує, які URL і ключ буде використано і звідки взято кожен із них; із ключа виводяться лише останні чотири символи. У CI обійдіться без файлу й натомість задайте змінні середовища:

Shell
export NN_WEBHOOKS_URL=https://webhooks.nimbusnexus.net
export NN_WEBHOOKS_API_KEY="<your-api-key>"

3 · Перший виклик

Shell
nn-webhooks deliveries list

Кожна команда виводить JSON, тож її вивід можна одразу передати в jq. Порожній список items означає, що ключ працює, а доставок ще не було.

Що далі

  • CLI Webhooks: усі команди, профілі, пріоритет налаштувань і версії.
  • Довідник API Webhooks: кожна операція з відповідною командою nn-webhooks, якщо така є.
  • SDK: ті самі операції з коду.