Documentation Menu

Hookmetry CLI & Local Tunneling

The Hookmetry CLI is an npm package that allows you to instantly forward incoming webhooks from your public Hookmetry endpoints directly to your local development server, bypassing firewalls and NATs. It is the ultimate alternative to Ngrok.

How to Use the CLI

Install the Hookmetry CLI globally on your machine using npm:

npm install -g @hookmetry/cli

1. Get your CLI Token & Log In

Navigate to your Endpoints Dashboard. Next to any active endpoint, click the Tunnel button. A modal will appear with your secure CLI token. Run the following command and paste your token:

hookmetry login

2. Start the tunnel interactively

Once logged in, you can start tunneling by running `listen` without any flags. The CLI will fetch your endpoints and let you select one interactively!

hookmetry listen --port 3000

Note: Change --port 3000 to match the port your local backend (e.g. Node.js, Django, Laravel) is running on.

Alternatively, skip the prompt by passing the endpoint ID: hookmetry listen --endpoint YOUR_ENDPOINT_ID --port 3000

3. Explore all commands

The Hookmetry CLI has several useful commands built-in (like viewing your active endpoints or checking your login status). To see all available commands and options, run:

hookmetry --help

Security & Authentication

The CLI uses a secure, long-lived JWT token to authenticate with the Hookmetry WebSocket relay. This token is generated specifically for your account. You should treat this token like a password and avoid committing it to version control.

  • Connections are secured via wss:// (WebSocket Secure).
  • Payloads are encrypted in transit.
  • If a token is compromised, you can revoke it via your account settings.

Why Hookmetry over Ngrok?

Persistent URLs

Unlike the free tier of Ngrok, Hookmetry provides persistent endpoint URLs forever. You never have to update your Stripe or GitHub webhook settings every time you restart the CLI.

Built-in Observability

Not only does the webhook get forwarded to your localhost, but it is also stored in the Hookmetry dashboard where you can inspect headers, payloads, and replay it instantly.

Start Tunneling Webhooks Now

Sign up for Hookmetry to instantly forward incoming webhooks to your local environment.

Was this page helpful?

Your feedback helps us improve the docs.