Install the CLI

The hooksnode CLI sends the webhooks that your project receives to a port on your computer. See Listen.

Download the latest release

Binaries for macOS, Linux and Windows, on Intel and ARM.

Install

macOS (Homebrew)
macOS and Linux
Windows
Manual download

brew install mantissatech/tap/hooksnode

The macOS builds are signed and notarized by Apple, so they run without a Gatekeeper warning. Upgrade later with brew upgrade hooksnode.

Run the install script:

curl -fsSL https://github.com/mantissatech/hooksnode-cli/releases/latest/download/install.sh | sh

The script finds your OS and CPU, downloads the archive, checks it against checksums.txt, and puts hooksnode in /usr/local/bin. If it cannot write there, it uses ~/.local/bin.

Variable	Use
`HOOKSNODE_VERSION`	Install a given tag, for example `v1.0.0`. Default: the latest release.
`HOOKSNODE_INSTALL_DIR`	Install to this folder.

curl -fsSL https://github.com/mantissatech/hooksnode-cli/releases/latest/download/install.sh | HOOKSNODE_VERSION=v1.0.0 sh

Download hooksnode_windows_amd64.zip. On an ARM PC, download hooksnode_windows_arm64.zip.
Unzip it.
Move hooksnode.exe to a folder on your PATH.

hooksnode --version

Platform	Archive
macOS, Apple silicon	`hooksnode_darwin_arm64.tar.gz`
macOS, Intel	`hooksnode_darwin_amd64.tar.gz`
Linux, x86-64	`hooksnode_linux_amd64.tar.gz`
Linux, ARM64	`hooksnode_linux_arm64.tar.gz`
Windows, x86-64	`hooksnode_windows_amd64.zip`
Windows, ARM64	`hooksnode_windows_arm64.zip`

Check the download against checksums.txt:

tar -xzf hooksnode_linux_amd64.tar.gz
grep hooksnode_linux_amd64.tar.gz checksums.txt | sha256sum -c -
sudo mv hooksnode /usr/local/bin/

Check that it works:

hooksnode --version

On macOS, if Gatekeeper blocks a binary that you downloaded in a browser, run xattr -d com.apple.quarantine hooksnode. The install script does not need this.

Make an API key

In the dashboard, open your workspace → API keys → Create key. Copy the key. hooksnode shows it only once.

hooksnode login

Press Enter to use the default host (https://hooksnode.com), then paste the key. The CLI checks the key and saves it:

✓ logged in to https://hooksnode.com — 2 project(s) available

The CLI saves the key in ~/.hooksnode/config.json, which only you can read (mode 0600).

Configuration

The CLI reads each setting from, in order:

A flag: --api-key, --host
An environment variable: HOOKSNODE_API_KEY, HOOKSNODE_HOST
The config file

If you give a key but no host, the CLI uses https://hooksnode.com.

HOOKSNODE_API_KEY=... hooksnode listen 3000

Update

Run the install script again, or download the new archive. hooksnode --version shows the version, commit and build date.

Log out

hooksnode logout

This deletes the config file.

Get started

Sources

Destinations

Delivery

Monitoring

Local development

Workspaces

Download the latest release

Install

Configuration

Update

Log out

Download the latest release

​Install

​Sign in

​Configuration

​Update

​Log out

Install

Sign in

Configuration

Update

Log out