CLI einrichten

nn-webhooks ist das Kommandozeilentool für Webhooks: ein einzelnes statisches Binary für macOS, Linux und Windows, ohne dass Sie sonst etwas installieren müssen. Es veröffentlicht Events, verwaltet Endpoints und stellt fehlgeschlagene Zustellungen erneut zu. Es ist derzeit die einzige CLI von NimbusNexus. Eine CLI für Infrastruktur gibt es noch nicht; verwenden Sie stattdessen die REST-API.

Das aktuelle Release ist 0.7.0. Die Archive und ihre checksums.txt hängen an jedem Release des öffentlichen Repositorys webhooks-go, und Homebrew installiert dieselben Archive.

1 · Installation

macOS: Homebrew

Shell

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

Der Tap liefert ein Cask, und Homebrew installiert Casks nur unter macOS. Aktualisieren Sie später mit brew upgrade nn-webhooks.

Linux und macOS: Download

Setzen Sie OS auf linux oder darwin und ARCH auf amd64 oder arm64. Laden Sie dann das Archiv herunter, prüfen Sie es gegen die Prüfsummen des Releases und legen Sie das Binary in Ihren 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

Der Schritt mit der Prüfsumme muss für das Archiv OK ausgeben; brechen Sie ab, wenn das nicht der Fall ist. Wo shasum fehlt, macht sha256sum --check --ignore-missing checksums.txt dasselbe. Ohne sudo installieren Sie in ein Verzeichnis, das Ihnen gehört und in Ihrem PATH liegt, zum Beispiel ~/.local/bin.

Windows: Download

Laden Sie in PowerShell das Zip herunter, vergleichen Sie seinen Hash mit der passenden Zeile von checksums.txt und entpacken Sie es dann in einen Ordner in Ihrem 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"

Die beiden Hashes müssen übereinstimmen. Fügen Sie dann %LOCALAPPDATA%\nn-webhooks zu Ihrem PATH hinzu und führen Sie nn-webhooks version aus. Unter ARM verwenden Sie windows_arm64 in beiden Dateinamen.

Mit einer Go-Toolchain

Shell

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

Dafür brauchen Sie Go 1.25 oder neuer. Ein aus dem Quellcode gebautes Binary meldet seine SDK-Version mit dem Suffix +source statt mit einer Release-Nummer.

2 · Key konfigurieren

Auf Ihrem eigenen Rechner melden Sie sich über den Browser an:

Shell

nn-webhooks login

Der Befehl gibt einen Code aus und öffnet Ihre Kontokonsole. Prüfen Sie dort, ob der Code übereinstimmt, und genehmigen Sie dann die Anfrage; die CLI speichert einen Key mit 90 Tagen Laufzeit in ihrem Profil. Details finden Sie unter Anmelden.

Wenn Sie stattdessen einen Key verwenden wollen, den Sie bereits haben, etwa einen für die CI, erstellen Sie einen Webhooks-Key in Ihrer Kontokonsole unter API keys; Details finden Sie unter API-Key erstellen. Speichern Sie ihn dann in einem Profil:

Shell

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

configure fragt nach dem Key und speichert ihn mit dem Modus 0600 in ~/.config/nn-webhooks/credentials.json. whoami zeigt, welche URL und welcher Key verwendet würden und woher beide jeweils stammen; vom Key gibt es nur die letzten vier Zeichen aus. In der CI lassen Sie die Datei weg und setzen stattdessen Umgebungsvariablen:

Shell

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

3 · Ersten Aufruf senden

Shell

nn-webhooks deliveries list

Jeder Befehl gibt JSON aus, sodass Sie die Ausgabe direkt an jq weiterleiten können. Eine leere Liste items bedeutet, dass der Key funktioniert und noch nichts zugestellt wurde.

Nächste Schritte

CLI für Webhooks: alle Befehle, Profile, Rangfolge und Versionen.
Referenz für die Webhooks-API: jede Operation mit ihrem Befehl in nn-webhooks, sofern es einen gibt.
SDKs: dieselben Operationen aus Ihrem Code.