{"id":23439816,"url":"https://github.com/mockoon/cli-action","last_synced_at":"2025-09-10T19:36:12.285Z","repository":{"id":178335397,"uuid":"661707590","full_name":"mockoon/cli-action","owner":"mockoon","description":"GitHub Action for Mockoon CLI","archived":false,"fork":false,"pushed_at":"2024-02-13T20:01:20.000Z","size":18,"stargazers_count":2,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-05-01T09:41:31.333Z","etag":null,"topics":["api","cli","mock","mock-api","mock-data","mock-server","mocking","mocking-server","mocking-utility","openapi","prototyping","rest","rest-api","server"],"latest_commit_sha":null,"homepage":"https://mockoon.com/cli/","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mockoon.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-07-03T13:18:32.000Z","updated_at":"2023-12-08T00:54:50.000Z","dependencies_parsed_at":"2024-02-13T20:42:20.937Z","dependency_job_id":null,"html_url":"https://github.com/mockoon/cli-action","commit_stats":null,"previous_names":["mockoon/github-actions"],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mockoon%2Fcli-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mockoon%2Fcli-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mockoon%2Fcli-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mockoon%2Fcli-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mockoon","download_url":"https://codeload.github.com/mockoon/cli-action/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248103869,"owners_count":21048245,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","cli","mock","mock-api","mock-data","mock-server","mocking","mocking-server","mocking-utility","openapi","prototyping","rest","rest-api","server"],"created_at":"2024-12-23T15:36:20.764Z","updated_at":"2025-09-10T19:36:12.256Z","avatar_url":"https://github.com/mockoon.png","language":null,"readme":"\u003cdiv align=\"center\"\u003e\n  \u003ca href=\"https://mockoon.com\" alt=\"mockoon logo\"\u003e\n    \u003cimg width=\"200\" height=\"200\" src=\"https://mockoon.com/images/logo-square-app.png\"\u003e\n  \u003c/a\u003e\n  \u003cbr\u003e\n  \u003ca href=\"https://mockoon.com/\"\u003e\u003cimg src=\"https://img.shields.io/badge/Website-Go-green.svg?style=flat-square\u0026colorB=1997c6\"/\u003e\u003c/a\u003e\n  \u003ca href=\"https://mockoon.com/newsletter/\"\u003e\u003cimg src=\"https://img.shields.io/badge/Newsletter-Subscribe-green.svg?style=flat-square\"/\u003e\u003c/a\u003e\n  \u003cbr\u003e\n  \u003cbr\u003e\n  \u003ch1\u003e@Mockoon/cli GitHub Action\u003c/h1\u003e\n\u003c/div\u003e\n\nMockoon is the easiest and quickest way to design and run mock APIs. No remote deployment, no account required, free and open-source.\n\nIt combines a [desktop application](https://mockoon.com/download/) to design and run mock servers locally, and a [CLI](https://mockoon.com/cli/) to self-host your fake APIs. A [cloud](#subscribe-to-mockoon-cloud) is also available to collaborate with your team, keep your data in sync, and deploy your mock APIs.\n\nAPI mocking helps you speed up development and third-party API integration by reducing dependency on external services and their limitations: rate limits, costs, availability, etc.\nIt also allows you to test your applications in a controlled environment with predictable responses, status codes, and latencies, and easily simulate edge cases and error scenarios.\nFinally, you can onboard new team members faster by providing them with a consistent and reliable environment to test and develop their applications.\n\n➡️ [Download](https://mockoon.com/download/)\n\n\u003cdiv align=\"center\"\u003e\n  \u003cimg width=\"50%\" src=\"https://mockoon.com/images/hero-repo.png\"\u003e\n\u003c/div\u003e\n\n## GitHub Action Usage\n\nMockoon CLI, being a JavaScript application, can run on any environment where Node.js is installed, including continuous integration systems like GitHub Actions.\n\nThis GitHub Action allows you to run Mockoon CLI in your workflows.\n\nSeveral parameters are available to customize the behavior of the action:\n\n- The `version` of the CLI, default to `latest`.\n- The `data-file`, pointing to a [Mockoon data file](https://mockoon.com/docs/latest/mockoon-data-files/data-files-location/) stored in the repository.\n- A `port` on which the mock server will run, default to `3000`.\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@v3\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## Mockoon version compatibility\n\nThis action is compatible with the following Mockoon CLI versions:\n\n| Mockoon CLI version | Action version |\n| ------------------- | -------------- |\n| \u003c6.0.0              | v1             |\n| \u003e=6.0.0             | v2             |\n\n## CLI's documentation\n\nMockoon CLI is available as an [NPM package](https://www.npmjs.com/package/@mockoon/cli). Please check our [dedicated documentation](https://github.com/mockoon/mockoon/blob/main/packages/cli/README.md) to learn how to install and use it.\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/docs/latest/mockoon-cloud/api-mock-cloud-deployments/)\n- 🔄️ [data synchronization and real-time collaboration](https://mockoon.com/docs/latest/mockoon-cloud/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\u003cdiv align=\"center\" style=\"margin-top:20px;margin-bottom:20px;\"\u003e\n\u003ca href=\"https://mockoon.com/cloud/\"\u003e\u003cimg src=\"https://mockoon.com/images/cloud-btn.png?\" width=\"250\" alt=\"cloud button\" /\u003e\u003c/a\u003e\n\u003c/div\u003e\n\n## Mockoon's documentation\n\nYou will find Mockoon's [documentation](https://mockoon.com/docs/latest/about/) on the official website. It covers Mockoon's most complex features. Feel free to contribute or ask for new topics to be covered.\n\n## Changelogs\n\nYou will find Mockoon applications [changelogs](https://mockoon.com/releases/) on the official website.\n\n## Support/feedback\n\nYou can discuss all things related to Mockoon 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","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmockoon%2Fcli-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmockoon%2Fcli-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmockoon%2Fcli-action/lists"}