\n\nWelcome to Mockoon's official CLI, a lightweight and fast NPM package to deploy your mock APIs anywhere.\nFeed it with a Mockoon's [data file](https://mockoon.com/docs/latest/mockoon-data-files/data-files-location/), or OpenAPI specification file (JSON or YAML), and you are good to go.\n\nThe CLI supports the same features as the main application: [templating system](https://mockoon.com/docs/latest/templating/overview/), [proxy mode](https://mockoon.com/docs/latest/server-configuration/proxy-mode/), [route response rules](https://mockoon.com/docs/latest/route-responses/dynamic-rules/), etc.\n\n\n\n- [Installation](#installation)\n- [Run a mock API with the CLI](#run-a-mock-api-with-the-cli)\n - [Use your Mockoon environment file](#use-your-mockoon-environment-file)\n - [Use an OpenAPI specification file](#use-an-openapi-specification-file)\n- [Compatibility](#compatibility)\n- [Commands](#commands)\n - [Start command](#start-command)\n - [Dockerize command](#dockerize-command)\n - [Import command](#import-command)\n - [Export command](#export-command)\n - [MCP command](#mcp-command)\n - [Help command](#help-command)\n- [Use the GitHub Action](#use-the-github-action)\n- [Docker image](#docker-image)\n - [Using the generic Docker image](#using-the-generic-docker-image)\n - [Using the `dockerize` command](#using-the-dockerize-command)\n- [Logs](#logs)\n- [Mockoon's documentation](#mockoons-documentation)\n- [Sponsors](#sponsors)\n- [Support/feedback](#supportfeedback)\n- [Contributing](#contributing)\n- [Roadmap](#roadmap)\n\n## Installation\n\n```sh-session\n$ npm install -g @mockoon/cli\n```\n\nUsage:\n\n```sh-session\n$ mockoon-cli COMMAND\n```\n\n## Changelogs\n\nYou will find Mockoon applications [changelogs](https://mockoon.com/releases/) on the official website.\n\n## Run a mock API with the CLI\n\n### Use your Mockoon environment file\n\nThe CLI can import and migrate data from older versions of Mockoon. However, it doesn't alter the file you provide and only migrates a copy. If you created your mock with a more recent version of the application, you need to update your CLI with the following command: `npm install -g @mockoon/cli`.\n\nYou can run your mock in one single step using the [start command](#mockoon-cli-start) and replacing `~/path/to/your-environment-file.json` by the actual location of your Mockoon environment file:\n\n```sh-sessions\n$ mockoon-cli start --data ~/path/to/your-environment-file.json\n```\n\n> To locate your environment file from the main application, right-click on a environment and select \"Show in folder\" in the context menu:\n> \n\nYou can also directly load Mockoon's environment file from a URL. To do so, provide the URL as the `data` parameter instead of a local path:\n\n```sh-sessions\n$ mockoon-cli start --data https://domain.com/your-environment-file.json\n```\n\n### Run a cloud-hosted Mockoon environment\n\nSince v9.5.0, you can also run a cloud-hosted Mockoon environment directly from the CLI by providing the cloud URL as the `data` parameter:\n\n```sh-sessions\n$ mockoon-cli start --data cloud://{UUID} --token {TOKEN}\n```\n\nWhere `{UUID}` is your environment's UUID and `{TOKEN}` is your Mockoon Cloud [access token](https://mockoon.com/cloud/docs/access-tokens/).\n\nThe application will provide you with the necessary **commands and instructions** to set up and run the mock on your own servers in the environment dropdown menu:\n\n\n\nLearn more about self-hosting cloud environments in the [official Mockoon Cloud documentation](https://mockoon.com/cloud/docs/api-mock-cloud-deployments/#self-host-with-the-cli).\n\n\n### Use an OpenAPI specification file\n\nAnother option is to directly pass an OpenAPI specification file as the `data` parameter. Mockoon supports both JSON and YAML formats in versions 2.0.0 and 3.0.0.\n\n> โ ๏ธ There is currently no equivalent between all the OpenAPI specifications and Mockoon's features ([more info](https://mockoon.com/docs/latest/openapi/openapi-specification-compatibility/)). If you want to run your Mockoon mock APIs with the CLI with all the features (templating, rules, etc.), you must use Mockoon's data files ([see above](#use-your-mockoon-environment-file)) directly, or you may lose part of your mock's behavior.\n\nYou can provide a path to a local OpenAPI specification file or directly the file's URL:\n\n```sh-sessions\n$ mockoon-cli start --data ~/path/to/your-opeanapi-file.yaml\n```\n\nOr,\n\n```sh-sessions\n$ mockoon-cli start --data https://domain.com/your-opeanapi-file.yaml\n```\n\n## Compatibility\n\nMockoon's CLI has been tested on Node.js versions 18, 20, 22 and 24.\n\n## Commands\n\n- [`start`](#start-command)\n- [`dockerize`](#dockerize-command)\n- [`import`](#import-command)\n- [`export`](#export-command)\n- [`validate`](#validate-command)\n- [`mcp`](#mcp-command)\n- [`help`](#help-command)\n\n### `start` command\n\nStarts one (or more) mock API from Mockoon's environment file(s) as a foreground process.\n\nThe mocks will run by default on the ports and hostnames specified in the files. You can override these values by using the `--port` and `--hostname` flags.\n`--data`, `--port`, `--hostname`, and `--public-base-url` flags support multiple entries to run multiple mock APIs at once (see examples below).\n\n> ๐ก To run the CLI as a background process, add an `&` at the end of the command: `mockoon-cli start -d ./data-file.json &`.\n\n**Usage**:\n`$ mockoon-cli start`\n\n**Options**:\n|Flag|Description|\n|-|-|\n|-d, --data |[required] Path(s) or URL(s) to your Mockoon file(s). Supports cloud URLs (e.g. `cloud://`, [see above](#run-a-cloud-hosted-mockoon-environment)).|\n|-p, --port |Override environment(s) port(s)|\n|-l, --hostname |Override default listening hostname(s)|\n|-c, --faker-locale | Faker locale (e.g. 'en', 'en_GB', etc. For supported locales, see below.)|\n|-s, --faker-seed | Number for the Faker.js seed (e.g. 1234)|\n|-t, --log-transaction | Log the full HTTP transaction (request and response)|\n|-X, --disable-log-to-file | Disable logging to file|\n|-e, --disable-routes | Disable route(s) by UUID or keyword present in the route's path (do not include a leading slash) or keyword present in a folder name. Use '\\*' to disable all routes.|\n|-r, --repair | If the data file seems too old, or an invalid Mockoon file, migrate/repair without prompting|\n|-x, --env-vars-prefix | Prefix for environment variables (default: 'MOCKOON\\_')|\n|-w, --watch | Watch local data file(s) for changes and restart the server when a change is detected (watch is using polling, see `--polling-interval` flag below)|\n|--polling-interval | Local files watch polling interval in milliseconds (default: 2000)|\n|--disable-admin-api | Disable the admin API, enabled by default (more info: https://mockoon.com/docs/latest/admin-api/overview/)|\n|--admin-api-token | Admin API bearer token(s). Provide once to reuse for all environments, or multiple times (or comma-separated) to set one token per environment. Can also be set with `MOCKOON_ADMIN_API_TOKEN`.|\n|--admin-api-cors-origin | Allowed CORS origin(s) for the admin API (e.g. 'https://app.example.com'). Provide multiple times or comma-separated for multiple origins. Use '\\*' to explicitly opt into wildcard CORS. When omitted, no CORS headers are emitted on admin API responses. Can also be set with `MOCKOON_ADMIN_API_CORS_ORIGIN`.|\n|--disable-tls | Disable TLS for all environments. TLS configuration is part of the environment configuration (more info: https://mockoon.com/docs/latest/server-configuration/serving-over-tls/)|\n|--max-transaction-logs | Maximum number of transaction logs to keep in memory for retrieval via the admin API (default: 100)|\n|--max-request-body-size | Maximum request body size for all content types (default: 100MB). Set to 0 to disable the limit. You can use either a raw byte count or a human-readable string (e.g. 104857600, 100MB, 10 GB, or 1.5kb).|\n|--enable-random-latency | Randomize global and responses latencies between 0 and the specified value (default: false)|\n|--proxy | Override the environment's proxy settings (options: 'enabled' or 'disabled')|\n|--public-base-url | Public base URL used to resolve [relative callback URLs](https://mockoon.com/docs/latest/callbacks/overview/#configure-a-callback) and for the [`baseUrl` templating helper](https://mockoon.com/docs/latest/templating/mockoon-request-helpers/#baseurl) (e.g. https://api.example.com or http://localhost:3000). Must include the protocol and port if non-standard.|\n|-k, --token | Access token used to fetch cloud-hosted Mockoon environments (see [access token documentation](https://mockoon.com/cloud/docs/access-tokens/))|\n|--max-callback-depth | Maximum call stack depth for route responses with callbacks (default: 100)|\n|--enable-route-metadata-headers | Add [route metadata headers](https://mockoon.com/docs/latest/response-configuration/response-headers/#mockoon-response-headers) to responses (UUID and response metadata) (default: false)|\n|--disable-external-refs | Disable fetching of external HTTP/HTTPS `$ref` references when loading OpenAPI specifications (default: false)|\n|-h, --help | Show CLI help|\n\n**Examples**:\n\n```bash\n$ mockoon-cli start --data ~/data.json\n$ mockoon-cli start --data ~/data.json --watch\n$ mockoon-cli start --data ~/data1.json ~/data2.json --port 3000 3001 --hostname 127.0.0.1 192.168.1.1\n$ mockoon-cli start --data https://file-server/data.json\n$ mockoon-cli start --data ~/data.json --log-transaction\n$ mockoon-cli start --data ~/data.json --disable-routes route1 route2 folder1\n$ mockoon-cli start --data ~/data.json --disable-routes=*\n$ mockoon-cli start --data ~/data.json --disable-routes \"*\"\n$ mockoon-cli start --data ~/data.json --public-base-url https://api.example.com\n$ mockoon-cli start --data ~/data.json --max-request-body-size 100MB\n$ mockoon-cli start --data cloud://def01727-aeb7-4cf1-9172-e0c38f22b224 --token mkn_sk_1234567890abcdef\n```\n\n#### Admin API\n\nEach running mock API has an admin API enabled by default and available at `/mockoon-admin/`. This API allows you to interact with the running mock API, retrieve logs, and more. You can disable it with the `--disable-admin-api` flag.\n\nWhen the admin API is enabled, bearer authentication is always enabled.\n\nYou can provide the admin API token with `--admin-api-token` (or `MOCKOON_ADMIN_API_TOKEN`). If no token is provided, a secure token is auto-generated at startup and printed in the logs.\n\n- Provide one token to reuse it for all environments.\n- Provide one token per environment when starting multiple environments in one command.\n- Send the token with the `Authorization: Bearer ` header.\n\nBy default, the admin API does not emit CORS headers, which prevents browser-based cross-origin requests. To allow specific origins (e.g. a frontend served from another domain), use `--admin-api-cors-origin` (or `MOCKOON_ADMIN_API_CORS_ORIGIN`):\n\n```bash\n$ mockoon-cli start --data ~/data.json --admin-api-cors-origin https://app.example.com\n$ mockoon-cli start --data ~/data.json --admin-api-cors-origin https://app.example.com https://admin.example.com\n```\n\nOnly requests whose `Origin` header matches one of the allowed values receive CORS headers. Use `--admin-api-cors-origin \"*\"` to explicitly opt into wildcard CORS (not recommended for exposed instances).\n\nTransaction logs returned by the admin API (`GET /mockoon-admin/logs` and the SSE event stream) have known-sensitive headers redacted (`authorization`, `proxy-authorization`, `cookie`, `set-cookie`, `x-api-key`, `api-key`, `x-auth-token`). For `authorization` / `proxy-authorization`, the auth scheme is preserved (e.g. `Bearer [REDACTED]`). Request and response bodies are not modified.\n\n> ๐ก To learn more about the admin API, check the [documentation](https://mockoon.com/docs/latest/admin-api/overview/).\n\n#### Faker.js options\n\n- **Locale**: You can set up Faker.js locale with the `--faker-locale` flag. If not provided, Faker.js will use the default locale: `en`. For a list of currently supported locales, you can check the [supported locales list](https://github.com/mockoon/mockoon/blob/main/packages/commons/src/models/faker.model.ts#L1) in Mockoon's commons library. You can also check [Faker.js locales list](https://fakerjs.dev/guide/localization.html#available-locales) for more information (โ ๏ธ Some locales may not yet be implemented in Mockoon).\n- **Seed**: You can set up Faker.js seed with the `--faker-seed` flag. If not provided, Faker.js will not use a seed. By providing a seed value, you can generate repeatable sequences of fake data. Using seeding will not always generate the same value but rather a predictable sequence.\n\n#### Customize the environment variables prefix\n\nYou can access environment variables in your routes' responses by using the [`{{getEnvVar 'VARIABLE_NAME'}}` templating helper](https://mockoon.com/docs/latest/variables/environment-variables/). By default, only the environment variables prefixed with `MOCKOON_` are available, for example, `MOCKOON_MY_VARIABLE`.\n\nYou can customize the prefix with the `--env-vars-prefix` flag. For example, if you set `--env-vars-prefix CUSTOM_PREFIX_`, you will be able to access the environment variable `CUSTOM_PREFIX_MY_VARIABLE` in your routes' responses. To disable the prefix, set it to an empty string: `--env-vars-prefix ''` or `--env-vars-prefix=`.\n\nThe prefix is also enforced when writing environment variables through the admin API: keys that do not start with the prefix are automatically prepended with it. When the prefix is empty, writes through the admin API are rejected to prevent arbitrary environment variable modifications (e.g. `PATH`, `NODE_OPTIONS`).\n\n#### Disabling routes\n\nYou can disable routes at runtime by providing their UUIDs or a keyword present in the route's path (do not include a leading slash). You can also disable all the routes present in a folder (including subfolders) by adding a keyword present in a folder name.\n\nThis is the counterpart of the \"Toggle route\" feature in the desktop application (right-click on a route -> \"Toggle route\").\n\nFor example, to disable all routes in a folder named `folder1`, and all routes having \"users\" in their paths, you can use `--disable-routes folder1 users`.\n\nTo disable all routes, use `--disable-routes=*` or `--disable-routes \"*\"`.\n\n### `dockerize` command\n\nGenerates a Dockerfile used to build a self-contained image of one or more mock API. After building the image, no additional parameters will be needed when running the container.\nThis command takes similar flags as the [`start` command](#mockoon-start).\nThe `--disable-log-to-file` flag will be enabled by default in the resulting Dockerfile.\n\nPlease note that this command will copy your Mockoon environments files you provide with the `--data` flag and put them side by side with the generated Dockerfile.\n\nFor more information on how to build the image: [Using the dockerize command](#using-the-dockerize-command)\n\n**Usage**:\n`$ mockoon-cli dockerize`\n\n**Options**:\n|Flag|Description|\n|-|-|\n|-d, --data | [required] Path or URL to your Mockoon file|\n|-p, --port | [required] Ports to expose in the Docker container. It should match the number of environment data files you provide with the --data flag.|\n|-o, --output | [required] Generated Dockerfile path and name (e.g. `./folder/Dockerfile`)|\n|-t, --log-transaction | Log the full HTTP transaction (request and response)|\n|-h, --help | Show CLI help|\n\n**Examples**:\n\n```bash\n$ mockoon-cli dockerize --data ~/data.json --output ./Dockerfile\n$ mockoon-cli dockerize --data ~/data1.json ~/data2.json --output ./Dockerfile\n$ mockoon-cli dockerize --data https://file-server/data.json --output ./Dockerfile\n```\n\n### `import` command\n\nImport a Swagger v2/OpenAPI v3 specification file (YAML or JSON).\n\nThe output file will not be prettified by default. You can prettify it using the `--prettify` flag described below.\n\nNote: This command is similar to the app's import feature, but it will not import directly to your desktop app. If you need to import and open in your desktop app, use the app's import feature instead.\n\n**Usage**:\n`$ mockoon-cli import`\n\n**Options**:\n|Flag|Description|\n|-|-|\n|-i, --input [required] |Path or URL to your Swagger v2/OpenAPI v3 file|\n|-o, --output [required] |Generated Mockoon path and name (e.g. `./environment.json`)|\n|-p, --prettify |Prettify output|\n|--disable-external-refs |Disable fetching of external HTTP/HTTPS `$ref` references when importing OpenAPI specifications (default: false)|\n|-h, --help |Show CLI help|\n\n**Examples**:\n\n```bash\n$ mockoon-cli import --input ~/input.json --output ./output.json\n$ mockoon-cli import --input ~/input.yaml --output ./output.json\n$ mockoon-cli import --input ~/input.json --output ./output.json --prettify\n```\n\n### `export` command\n\nExport a mock API to an OpenAPI v3 specification file (JSON or YAML).\n\nThe output file will not be prettified by default for JSON. You can prettify it using the `--prettify` flag described below.\n\n**Usage**:\n`$ mockoon-cli export`\n\n**Options**:\n|Flag|Description|\n|-|-|\n|-i, --input [required] |Path or URL to your Mockoon data file|\n|-o, --output [required] |Generated OpenApi v3 path and name (e.g. `./output.json`)|\n|-f, --format |Output format, \"json\" or \"yaml\" (default: \"json\")|\n|-p, --prettify |Prettify output (JSON only)|\n|-h, --help |Show CLI help|\n\n**Examples**:\n\n```bash\n$ mockoon-cli export --input ~/input.json --output ./output.json\n$ mockoon-cli export --input ~/input.json --output ./output.json --prettify\n$ mockoon-cli export --input ~/input.json --output ./output.yaml --format yaml\n```\n\n### `validate` command\n\nValidate a Mockoon [environment JSON file](https://mockoon.com/docs/latest/mockoon-data-files/data-files-location/#data-files-schema) against the schema:\n\n```sh-session\n$ mockoon-cli validate --data ~/data1.json ~/data2.json\n$ mockoon-cli validate --data https://file-server/data.json\n```\n\n> ๐ก The `--data` flag behaves like the `--data` flag in the `start` command, meaning you can provide multiple paths or URLs to validate multiple files at once.\n\nIf the files are valid, you will see:\n\n```\nโ Valid environment: ~/data1.json\nโ Valid environment: ~/data2.json\nโ All environments are valid\n```\n\nIf one or more files are invalid, you will see validation errors:\n\n```\nInvalid environment: ~/data1.json\n- \"name\" is required\n- \"port\" must be a number\nInvalid environment: ~/data2.json\n- \"routes\" must be an array\n ยป Error: Environments validation failed\n```\n\n> โ ๏ธ This command does not validate the OpenAPI specification files. OpenAPI files are validated by the [start command](#start-command) when you run it with an OpenAPI file as the `--data` parameter.\n\n### `mcp` command\n\nStarts a [Model Context Protocol (MCP)](https://modelcontextprotocol.io/) server that exposes Mockoon mocks to AI assistants (Claude, GitHub Copilot, Cursor, etc.).\n\n**Usage**:\n`$ mockoon-cli mcp`\n\nRunning the command in a terminal will print the configuration snippet to add to your MCP client.\n\n**Available MCP tools**:\n\n| Tool | Description |\n| --------------------- | -------------------------------------------------------------- |\n| `list_mocks` | List all local Mockoon mock files |\n| `start_mock` | Start a Mockoon mock server from a local mock file |\n| `stop_mock` | Stop a running mock server by UUID |\n| `list_running_mocks` | List all mock servers currently running in the MCP session |\n\n**Extra mock directories**:\n\nBy default, the MCP server looks for Mockoon mock files in the default desktop app storage directory (`%APPDATA%\\mockoon\\storage` on Windows, `~/Library/Application Support/mockoon/storage` on macOS, `~/.config/mockoon/storage` on Linux).\n\nTo include mock files from additional directories, set the `MOCKOON_DATA_DIRS` environment variable to a semicolon-separated list of paths in your MCP client configuration:\n\n```json\n{\n \"servers\": {\n \"mockoon\": {\n \"command\": \"mockoon-cli\",\n \"args\": [\"mcp\"],\n \"env\": {\n \"MOCKOON_DATA_DIRS\": \"/path/to/dir1;/path/to/dir2\"\n }\n }\n }\n}\n```\n\nMocks with the same UUID found in multiple directories are only listed once (the first occurrence wins).\n\n**Examples**:\n\n```bash\n$ mockoon-cli mcp\n```\n\n### `help` command\n\nReturns information about a command.\n\n**Usage**:\n`$ mockoon-cli help [COMMAND]`\n\n**Arguments and options**:\n|Flag|Description|\n|-|-|\n|COMMAND |command to show help for|\n|--all |see all commands in CLI|\n\n## Use the GitHub Action\n\nWe maintain a [GitHub Action](https://github.com/marketplace/actions/mockoon-cli) that allows you to run your Mockoon CLI in your CI/CD pipelines.\n\nYou can find a [sample workflow](https://github.com/marketplace/actions/mockoon-cli#github-action-usage) in the GitHub Action's documentation.\n\nHere is an example of a workflow that will run your mock API on every push to the `main` branch:\n\n```yaml\nname: Mockoon CLI demo\n\non:\n push:\n branches:\n - main\n\njobs:\n mockoon-cli-demo:\n runs-on: ubuntu-latest\n steps:\n - uses: actions/checkout@v4\n - name: Run Mockoon CLI\n uses: mockoon/cli-action@v2\n with:\n # Mockoon CLI version, default to 'latest'\n version: 'latest'\n # Mockoon local data file or URL\n data-file: './mockoon-data.json'\n # port, default to 3000\n port: 3000\n - name: Make test call\n run: curl -X GET http://localhost:3000/endpoint`\n```\n\n> ๐ก If you are building your own actions with the CLI, do not forget to add an `&` at the end of the command to run it in the background and avoid blocking the workflow: `mockoon-cli start -d ./data-file.json &`.\n\n## Docker image\n\n### Using the generic Docker image\n\nA generic Docker image is published on the [Docker Hub Mockoon CLI repository](https://hub.docker.com/r/mockoon/cli). It uses `node:26-alpine` and installs the latest version of Mockoon CLI.\n\nAll of `mockoon-cli start` flags (`--port`, etc.) must be provided when running the container.\n\nTo load the Mockoon data, you can either mount a local data file and pass `mockoon-cli start` flags at the end of the command:\n\n`docker run -d --mount type=bind,source=/home/your-data-file.json,target=/home/mockoon/data/your-data-file.json,readonly -p 3000:3000 mockoon/cli:latest --data /home/mockoon/data/your-data-file.json --port 3000`\n\nOr directly pass a URL to the `mockoon-cli start` command, without mounting a local data file:\n\n`docker run -d -p 3000:3000 mockoon/cli:latest -d https://raw.githubusercontent.com/mockoon/mock-samples/main/samples/generate-mock-data.json --port 3000`\n\nMockoon CLI's logs will be sent to stdout/stderr (console). File logging is disabled by default in the Docker image.\n\n#### Docker compose\n\nYou can also use `docker-compose` with a `docker-compose.yml` file:\n\n```\nmock-server:\n image: mockoon/cli:latest\n command: [\"--data\", \"/home/mockoon/data/your-data-file.json\", \"--port\", \"3000\"]\n healthcheck:\n test: [\"CMD-SHELL\", \"curl -f http://localhost:3000/your-healthcheck-route || exit 1\"]\n interval: 30s\n timeout: 5s\n retries: 2\n start_period: 10s\n volumes:\n - /home/your-data-file.json:/home/mockoon/data/your-data-file.json:readonly\n```\n\n> Please note that our [Docker image includes an `ENTRYPOINT`](https://github.com/mockoon/mockoon/blob/main/packages/cli/docker/Dockerfile#L16) that you may override or not. If you don't override it, and use Docker compose `command`, do not include `mockoon-cli start` as it is already included in the `ENTRYPOINT`.\n\nThis snippet also provides an optional healthcheck, which means you can block until the server is able to handle responses when bring it up by running `docker compose up --detach --wait`.\n\n> This example requires a `your-healthcheck-route` route configured to return a 200 status code without latency.\n\n### Using the `dockerize` command\n\nYou can use the [`dockerize` command](#mockoon-cli-dockerize) to generate a new Dockerfile that will allow you to build a self-contained image. Thus, no Mockoon CLI specific parameters will be needed when running the container.\n\n- Run the `dockerize` command:\n\n `mockoon-cli dockerize --data ./sample-data.json --port 3000 --output ./tmp/Dockerfile`\n\n- navigate to the `tmp` folder, where the Dockerfile has been generated and the environment file(s) copied:\n\n `cd tmp`\n\n- Build the image:\n\n `docker build -t mockoon-image .`\n\n- Run the container:\n\n `docker run -d -p :3000 mockoon-image`\n\n## Logs\n\nLogs are located in `~/.mockoon-cli/logs/{mock-name}.log`. This file contains all the log entries (all levels) produced by the running mock server. Most of the errors occurring in Mockoon CLI (or the main application) are not critical and therefore considered as normal output. As an example, if the JSON body from an entering request is erroneous, Mockoon will log a JSON parsing error, but it won't block the normal execution of the application.\n\nAs the CLI is running in the foreground, logs are also sent to stdout (console).\n\n### Transaction logging\n\nWhen using the `--log-transaction` flag, logs will contain the full transaction (request and response) with the same information you can see in the desktop application \"Logs\" tab.\n\nKnown-sensitive header values (`authorization`, `proxy-authorization`, `cookie`, `set-cookie`, `x-api-key`, `api-key`, `x-auth-token`) are replaced with `[REDACTED]` in both the CLI transaction logs and the admin API responses. For `authorization` / `proxy-authorization`, the auth scheme is preserved (e.g. `Bearer [REDACTED]`). Request and response bodies are not modified.\n\nExample:\n\n```json\n{\n \"app\": \"mockoon-server\",\n \"level\": \"info\",\n \"message\": \"Transaction recorded\",\n \"timestamp\": \"YYYY-MM-DDTHH:mm:ss.sssZ\",\n \"environmentName\": \"Demo API\",\n \"environmentUUID\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n \"requestMethod\": \"GET\",\n \"requestPath\": \"/test\",\n \"requestProxied\": false,\n \"responseStatus\": 200,\n \"transaction\": {\n \"proxied\": false,\n \"request\": {\n \"body\": \"{}\",\n \"headers\": [{ \"key\": \"accept\", \"value\": \"*/*\" }],\n \"method\": \"GET\",\n \"params\": [],\n \"query\": \"\",\n \"queryParams\": {},\n \"route\": \"/test\",\n \"urlPath\": \"/test\"\n },\n \"response\": {\n \"body\": \"{}\",\n \"headers\": [\n { \"key\": \"content-type\", \"value\": \"application/json; charset=utf-8\" }\n ],\n \"statusCode\": 200,\n \"statusMessage\": \"OK\"\n },\n \"routeResponseUUID\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n \"routeUUID\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\"\n }\n}\n```\n\nThe `transaction` model can be found [here](https://github.com/mockoon/mockoon/blob/main/packages/commons/src/models/server.model.ts#L27-L47).\n\n### Disable logging\n\nYou can disable the logging to the console by redirecting the stdout and stderr outputs:\n\n- Unix:\n\n ```sh-sessions\n mockoon-cli start --data ./data.json > /dev/null 2>&1\n ```\n\n or:\n\n ```sh-sessions\n mockoon-cli start --data ./data.json &> /dev/null\n ```\n\n- Windows (cmd):\n\n ```sh-sessions\n mockoon-cli start --data ./data.json 2> NUL\n ```\n\n or:\n\n ```sh-sessions\n mockoon-cli start --data ./data.json > NUL 2>&1\n ```\n\n- Windows (PowerShell):\n\n ```sh-sessions\n mockoon-cli start --data ./data.json 2> $null\n ```\n\n or:\n\n ```sh-sessions\n mockoon-cli start --data ./data.json > $null 2>&1\n ```\n\n- Cross platform: use `dev-null-cli` package\n ```sh-sessions\n mockoon-cli start --data ./data.json | npx dev-null\n ```\n\nYou can also disable file logging by using th `--disable-log-to-file` flag. This is enabled by default in the Docker image.\n\n## Mockoon's documentation\n\nYou will find Mockoon's [documentation](https://mockoon.com/docs/latest/about/) on the official website.\n\n## Support us!\n\nMockoon is proudly **independent** and **open-source**, maintained without external funding. We rely on both **sponsorships** and **Mockoon Cloud subscriptions** to keep improving the project and building new features. A **big thank you** to the companies below for supporting our work and helping us grow (and all the [sponsors](https://github.com/mockoon/mockoon/blob/main/backers.md) who helped this project over time!):\n\n### Platinum\n\n
\n\nIf you'd like to **support Mockoon** as well, you can **become a sponsor** or **subscribe to Mockoon Cloud**, every contribution helps keep the project alive and evolving. Thank you!\n\n
\n\n
\n\n## Subscribe to Mockoon Cloud\n\nWith advanced features for solo developers and teams, Mockoon Cloud supercharges your API development:\n\n- โ๏ธ [cloud deployments](https://mockoon.com/cloud/docs/api-mock-cloud-deployments/)\n- ๐๏ธ [data synchronization and real-time collaboration](https://mockoon.com/cloud/docs/data-synchronization-team-collaboration/)\n- ๐ค [AI powered API mocking](https://mockoon.com/ai-powered-api-mocking/)\n- ๐ Access to dozens of [ready-to-use JSON templates](https://mockoon.com/templates/).\n- ๐ฌ Priority support and training.\n\nUpgrade today and take your API development to the next level.\n\n
\n\n
\n\n## Support/feedback\n\nYou can discuss all things related to Mockoon's CLI, and ask for help, on the [official community](https://github.com/mockoon/mockoon/discussions). It's also a good place to discuss bugs and feature requests before opening an issue on this repository.\n\n## Contributing\n\nIf you are interested in contributing to Mockoon, please take a look at the [contributing guidelines](https://github.com/mockoon/mockoon/blob/main/CONTRIBUTING.md).\n\nPlease also take a look at our [Code of Conduct](https://github.com/mockoon/.github/blob/main/CODE_OF_CONDUCT.md).\n\n## Roadmap\n\nIf you want to know what will be coming in the next release you can check the global [Roadmap](https://mockoon.com/public-roadmap/) or [subscribe to our newsletter](https://mockoon.com/newsletter/).\n","readmeFilename":"README.md"}
![](\"https://mockoon.com/images/logo-square-cli.png\"){kind=logo}
\n \n ![](\"https://img.shields.io/badge/Download%20app-Go-green.svg?style=flat-square&colorB=1997c6\"/){kind=icon}
\n ![](\"https://img.shields.io/badge/Website-Go-green.svg?style=flat-square&colorB=1997c6\"/){kind=icon}
\n ![](\"https://img.shields.io/badge/Newsletter-Subscribe-green.svg?style=flat-square\"/){kind=icon}
\n ![](\"https://img.shields.io/npm/v/@mockoon/cli.svg?style=flat-square&colorB=cb3837\"/)
\n ![\"emqx](\"https://mockoon.com/images/sponsors/emqx.png\")
\n \n![\"sponsor](\"https://mockoon.com/images/sponsor-btn.png?\")
\n![\"cloud](\"https://mockoon.com/images/cloud-btn.png?\")
\n![\"GitHub](\"https://mockoon.com/images/sponsors/light/github.png\")
\n ![\"Localazy](\"https://mockoon.com/images/sponsors/light/localazy.png\")
\n ![\"SerpApi](\"https://mockoon.com/images/sponsors/light/serpapi.png\")
\n ![\"CodeRabbit](\"https://mockoon.com/images/sponsors/light/coderabbit.png\")
\n ![\"TestMu](\"https://mockoon.com/images/sponsors/light/testmuai.png\")
\n