| api-token | WireMock Cloud API token. Required for push/pull/environments-create and for post-run-pull in ephemeral mode.
| no | — |
| wiremock-dir | Path to the directory containing wiremock.yaml (and profile files), relative to the workspace root. Default: .wiremock
| no | .wiremock |
| run | Shell command to execute while the Runner container is live. When set, the Action starts a wiremock/wiremock-runner container, waits for it to be healthy, executes this command, then stops the container. SECURITY: this command runs via `bash -c` and inherits the full runner environment, including all workflow secrets. Never set this from untrusted GitHub event data (PR titles, issue bodies, workflow_dispatch inputs) — see the README's Security section.
| no | — |
| mode | Runner mode for the ephemeral container. One of: serve, record-many. Default: serve.
| no | serve |
| ports | Comma-separated list of mock API ports to expose from the container. Must match port values in wiremock.yaml. Example: '8080,8081'
| no | 8080 |
| runner-admin-port | Port for the Runner admin HTTP interface. Default: 9999.
| no | 9999 |
| runner-version | Docker image tag for wiremock/wiremock-runner. Default: latest.
| no | latest |
| profile | Environment profile name. Activates wiremock-<profile>.yaml overlay. Example: staging, development
| no | — |
| post-run-pull | When 'true' and mode is record-many, automatically pull recorded stubs from WireMock Cloud after recording stops. Requires api-token.
| no | false |
| command | CLI operation to perform. One of:
push — push local stubs to WireMock Cloud
pull — pull stubs from WireMock Cloud
environments-create — create a new environment/profile in Cloud
record-flush — flush buffered recordings to Cloud
record-stop — switch Runner from record-many to serve
record-flush-and-stop — flush then switch to serve (recommended)
mode-switch — switch Runner to any mode
resolve-urls — parse wiremock.yaml, verify Runner health,
and emit service URLs as step outputs
| no | — |
| mock-api | Name of the mock API as defined in wiremock.yaml. Used with push, pull, and environments-create. Optional when all: 'true'.
| no | — |
| all | When 'true', passes --all to push/pull (processes all APIs).
| no | false |
| runner-admin-url | Base URL of a running Runner's admin API. Used by record-flush, record-stop, record-flush-and-stop, mode-switch, and resolve-urls. Default: http://localhost:9999
| no | http://localhost:9999 |
| include-services | Comma-separated list of service keys to record. When omitted, all services are recorded. Example: invoicing-api,payment-api
| no | — |
| target-mode | Target mode for the mode-switch command. One of: serve, record-many.
| no | — |
| runner-config | YAML string of additional config fields passed to the Runner's mode-switch endpoint as the `config` object. Example:
runner-config: |
max-batch-requests: 50
| no | — |
| force | When 'true' and command is environments-create, fail hard if the profile already exists instead of skipping silently.
| no | false |
| wiremock-cli-version | npm version tag for @wiremock/cli. Default: latest.
| no | latest |
| health-check-retries | Number of times to poll /__/health before failing. Default: 30.
| no | 30 |
| health-check-interval | Seconds between health check polls. Default: 2.
| no | 2 |