CLI Installation

The Webhook Simulator CLI tool is a powerful command-line interface that allows you to listen for webhook events, forward them to your local development environment, and trigger custom events for testing.

Prerequisites

Before installing the Webhook Simulator CLI, ensure you have the following:

A macOS operating system (support for other operating systems coming soon)
Homebrew package manager installed

Installation Steps

Open your terminal.
Run the following command to tap into our Homebrew repository:

brew tap mmpsoftware/ws-cli

Install the CLI tool using Homebrew:

brew install ws-cli

This command will download and install the latest version of the Webhook Simulator CLI tool.

Verifying the Installation

To verify that the installation was successful, run:

ws-cli --version

This should display the version number of the installed CLI tool.

Updating the CLI

To update the CLI tool to the latest version, run:

brew upgrade ws-cli

Next Steps

After installation, you'll need to authenticate the CLI tool with your Webhook Simulator account. See the CLI Authentication guide for more information.

Cross-platform Support We're working on bringing Webhook Simulator CLI to other operating systems. Stay tuned for updates!