Set up the CLI

nn-webhooks is the command-line tool for Webhooks: one static binary for macOS, Linux and Windows, with nothing else to install. It publishes events, manages endpoints and redelivers failed deliveries. It is the only NimbusNexus CLI today. A CLI for Infrastructure is not available yet; use the REST API instead.

The current release is 0.7.0. Its archives and their checksums.txt are attached to each release of the public webhooks-go repository, and Homebrew installs the same archives.

1 · Install

macOS: Homebrew

Shell

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

The tap ships a cask, and Homebrew installs casks only on macOS. Upgrade later with brew upgrade nn-webhooks.

Linux and macOS: download

Set OS to linux or darwin and ARCH to amd64 or arm64. Then download the archive, check it against the release's checksums, and put the binary on your 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

The checksum step must print OK for the archive; stop there if it does not. Where shasum is missing, sha256sum --check --ignore-missing checksums.txt does the same. Without sudo, install into a directory you own that is on your PATH, for example ~/.local/bin.

Windows: download

In PowerShell, download the zip, compare its hash with the matching line of checksums.txt, then unpack it into a folder on your 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"

The two hashes must match. Then add %LOCALAPPDATA%\nn-webhooks to your PATH and run nn-webhooks version. On ARM, use windows_arm64 in both file names.

With a Go toolchain

Shell

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

This needs Go 1.25 or later. A binary built from source reports its SDK version with a +source suffix rather than a release number.

2 · Configure a key

On your own machine, sign in through the browser:

Shell

nn-webhooks login

It prints a code and opens your account console. Approve the request there, after checking the code matches, and the CLI saves a 90-day key to its profile. Sign in has the details.

To use a key you already have instead, such as one for CI, create a Webhooks key in your account console under API keys; Get an API key has the details. Then save it to a profile:

Shell

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

configure prompts for the key and stores it in ~/.config/nn-webhooks/credentials.json with mode 0600. whoami shows which URL and key would be used, and where each came from; it prints only the key's last four characters. In CI, skip the file and set the environment instead:

Shell

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

3 · Make a first call

Shell

nn-webhooks deliveries list

Every command prints JSON, so it pipes straight into jq. An empty items list means the key works and nothing has been delivered yet.

What's next

Webhooks CLI: every command, profiles, precedence and versions.
Webhooks API reference: each operation with its nn-webhooks command where there is one.
SDKs: the same operations from code.