Skip to main content

CLI Installation

The webhook CLI tool provides real-time monitoring and local forwarding capabilities for webhook events. Follow these steps to get it installed and running.

Prerequisites​

  • Node.js: Version 16 or higher
  • npm: Usually comes with Node.js

Installation​

Install the webhook CLI globally to use it from anywhere:

npm install -g @hookvm/cli

Local Installation​

For project-specific installation:

npm install @hookvm/cli

Then run using npx:

npx hookvm --help

Verify Installation​

Check that the installation was successful:

hookvm --version

You should see output similar to:

hookVM CLI v1.0.0

Quick Test​

Test the CLI with the help command:

hookvm --help

This will display all available commands and options:

Usage: hookvm [options] [command]

Webhook monitoring and management CLI tool

Options:
  -V, --version      display version number
  -h, --help         display help for command

Commands:
  listen <endpoint>  Monitor webhook events in real-time
  help [command]     display help for command

Next Steps​

Now that you have the CLI installed, you can:

  1. Connect to your webhook endpoint
  2. Start monitoring webhook events
  3. Set up local forwarding

Troubleshooting​

Permission Errors (macOS/Linux)​

If you get permission errors during global installation:

sudo npm install -g @hookvm/cli

Or use a Node version manager like nvm to avoid permission issues.

Command Not Found​

If the webhook command is not found after installation:

  1. Check if npm global bin directory is in your PATH:

    npm config get prefix

  2. Add the bin directory to your PATH in your shell profile:

    export PATH="$(npm config get prefix)/bin:$PATH"

Update CLI​

To update to the latest version:

npm update -g @hookvm/cli

Ready to connect? Continue to Connecting to Endpoints