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:

• An operating system that supports the CLI (see supported platforms below)
• The appropriate package manager for your system (e.g., Homebrew for macOS)

Supported Platforms

• macOS (ARM64 and x86_64)
• Linux (ARM64 and x86_64)
• Windows (x86_64)

Installation Steps

macOS

1. Open your terminal.

2. Run the following command to tap into our Homebrew repository:

brew tap mmpsoftware/ws-cli

3. 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.

Manual Installation (All Platforms)

If you prefer to install manually or if you're using a platform without a package manager, you can download the appropriate binary for your system:

• macOS ARM64: Download
• macOS x86_64: Download
• Linux ARM64: Download
• Linux x86_64: Download
• Windows x86_64: Download

After downloading, extract the archive and move the ws-cli binary to a location in your system's PATH.

For Linux and macOS:

tar -xzf homebrew-ws-cli_<OS>_<ARCH>.tar.gz
sudo mv ws-cli /usr/local/bin/

For Windows, extract the ZIP file and add the folder containing ws-cli.exe to your system's PATH.

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

macOS (Homebrew)

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

brew upgrade ws-cli

Manual Update (All Platforms)

For manual installations, download the latest version from the links provided in the Manual Installation section and replace your existing ws-cli binary.

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.

Source Code

If you're interested in building from source or contributing to the project, you can find the source code here:

• Source code (zip)
• Source code (tar.gz)

Package Manager Support for Linux and Windows We're working on bringing Webhook Simulator CLI to package managers for Linux (apt, yum, etc.) and Windows (Chocolatey, Scoop). Stay tuned for updates!

Signed Binaries and Installers We're in the process of implementing code signing for our binaries and creating official installers for a more secure and streamlined installation process.

For the most up-to-date information on supported platforms and installation methods, please check our GitHub releases page.