Skip to content
HookNexus

CLI installation

The HookNexus CLI connects your terminal to your account so you can manage endpoints, stream live webhooks, and (on Pro) forward traffic to a local server.

Requirements

  • Node.js 18 or later (LTS recommended)
  • npm, pnpm, or yarn for global installs

Install

Terminal window
npm install -g hooknexus

Sign in

HookNexus uses your browser for OAuth (GitHub or Google).

  1. Run:

    Terminal window
    hooknexus login

  2. Complete sign-in in the browser window that opens.

  3. Return to the terminal when the CLI reports success.

Verify the installation

Terminal window
hooknexus --version

You should see the CLI version number. Run hooknexus --help for a full command list.

Update

Terminal window
npm update -g hooknexus

Uninstall

Terminal window
npm uninstall -g hooknexus

Optional login methods

  • API token: hooknexus login --token <your-token> for CI or headless environments.
  • Environment variable: set HOOKNEXUS_TOKEN instead of storing credentials in scripts.

Next steps