wiremock/wiremock-cli repository overview

⁠WireMock CLI

The WireMock CLI is a command line interface to help with interacting with WireMock Cloud⁠.

Full documentation of the CLI can be found on the WireMock Cloud documentation site⁠.

The CLI is also distributed as an NPM package as @wiremock/cli⁠.

⁠Usage

You will typically want to mount the configuration volume and working directory in order to make your credentials, configuration and work persistent. Mount points:

• /etc/wiremock-cli - configuration
• /work - working directory
• /var/logs - log files, if you want to examine them easily

Full documentation of the CLI can be found on the WireMock Cloud documentation site⁠. With these directories mounted you should be able to interact with the CLI in the documented manner.

⁠Examples

⁠Logging in

docker run \
  -v ~/.config/wiremock-cli:/etc/wiremock-cli \
  wiremock/wiremock-cli:latest \
  login

⁠Recording

docker run \
  -v ~/.config/wiremock-cli:/etc/wiremock-cli \
  wiremock/wiremock-cli:latest \
  -p 8000:8000 \
  record https://example.com

⁠Run Mock APIs Locally

docker run \
  -v ~/.config/wiremock-cli:/etc/wiremock-cli \
  -v $(pwd):/work \
  wiremock/wiremock-cli:latest \
  pull mock-api --all

# Publish ports for each of the running Mock APIs - example only shows 2
docker run \
  -v ~/.config/wiremock-cli:/etc/wiremock-cli \
  -v $(pwd):/work \
  -p 8080:8080 \
  -p 8081:8081 \
  wiremock/wiremock-cli:latest

Running locally uses the default CMD of run, which is only available with a valid license file. Contact the WireMock team⁠ to request a license file.

⁠License

Copyright 2021-2025 WireMock Inc.

The wiremock-cli is licensed under and subject to the WireMock Inc. Terms and Conditions⁠. By accessing this container and its software you agree to the WireMock Inc. Terms and Conditions⁠.

If you do not agree, do not access or use this software.