​
Overview

The WireMock CLI offers ways to get benefits of WireMock Cloud that are hard or impossible to achieve using the web interface.

​
Installation

You can install the WireMock CLI using npm:

npm install --global @wiremock/cli

​
Usage

A list of available commands can be found as follows:

wiremock -h

For any given command, additional help can be found as follows:

wiremock <command> -h

e.g.

wiremock record -h

​
Current Commands

​
Login

Most commands require you to have authenticated with WireMock Cloud. You can achieve this by running:

wiremock login

and following the instructions.

If you have set your API endpoint to a custom endpoint, wiremock login will no longer work, so setting your API token using the config subcommand is the only available method for authenticating.

​
Checking if logged in

Running

wiremock whoami

will either report the currently logged in user and exit successfully, or fail reporting that no-one is logged in.

​
Logout

Running

wiremock logout

will log the current user out.

​
Config

Command for configuring your WireMock CLI installation. See Configuring the CLI for details.

​
Mock APIs

Commands for managing your mock APIs. See Managing Mock APIs with the CLI for details.

​
Local Run

Command for running your mock APIs locally. See Running Mock APIs Locally for details.

​
Record

See detailed documentation at Recording using the WireMock CLI

​
Record Many

See detailed documentation at Multi-domain recording using the WireMock CLI

​
MCP

Runs an MCP server for use with AI tools. Intended to be called from the AI tool’s MCP configuration rather than directly in the terminal.

See detailed documentation at WireMock Cloud AI