Configuring the WireMock CLI

The WireMock CLI provides a config subcommand that allows you to configure the behavior of your CLI installation.

Configuration values can be retrieved using wiremock config get <key>, set using wiremock config set <key> <value>, and unset using wiremock config unset <key>. You can clear all configured keys by executing wiremock config clear. Available config keys that you can set are api_token and api_endpoint.

For comprehensive documentation of how each config command works, in the CLI, you can append a -h or --help to the end of any subcommand to view the command’s help text. For example, wiremock config set -h.

​

Configuring your API token

Your API token is used to authenticate with WireMock Cloud when performing actions like recording or managing your mock APIs. Setting your API token using the config subcommand is an alternative to the login command. To set your API token, execute the following command

wiremock config set api_token <API_TOKEN>

with <API_TOKEN> replaced with your API token, available at https://app.wiremock.cloud/account/security.

​

Configuring your API endpoint

The CLI’s configured API endpoint is the base URL of the API server that the CLI uses to perform actions like recording or managing your mock APIs. By default, this endpoint is https://api.wiremock.cloud, the endpoint used by WireMock Cloud’s SaaS edition (more information on using WireMock Cloud’s API can be found in the API reference). To set your API endpoint to a custom URL, execute the following command

wiremock config set api_endpoint <API_ENDPOINT>

with <API_ENDPOINT> replaced with your API endpoint URL. The API endpoint for your on-premise installation of WireMock Cloud will have the format https://api.wiremock.<your_subdomain>. Consult your system administrator if you are unsure of the exact URL to use.