Skip to content
mockoon

GitHub Action

mockoon-cli

v2.0.0 Latest version

mockoon-cli

mockoon

mockoon-cli

Run Mockoon CLI as a GitHub Action

Installation

Copy and paste the following snippet into your .yml file.

              
- name: mockoon-cli

              
  uses: mockoon/[email protected]
Learn more about this action in mockoon/cli-action

Choose a version





@Mockoon/cli GitHub Action

Welcome to Mockoon official CLI's GitHub Action. Mockoon CLI is a lightweight and fast NPM package to deploy your mock APIs anywhere.

To learn more about Mockoon and Mockoon CLI, please visit the official website.

Mockoon CLI screenshot

GitHub Action Usage

name: Mockoon CLI demo

on:
  push:
    branches:
      - main

jobs:
  mockoon-cli-demo:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - name: Run Mockoon CLI
        uses: mockoon/cli-action@v2
        with:
          # Mockoon CLI version, default to 'latest'
          version: "latest"
          # Mockoon local data file or URL
          data-file: "./mockoon-data.json"
          # port, default to 3000
          port: 3000
      - name: Make test call
        run: curl -X GET http://localhost:3000/endpoint

Mockoon version compatibility

This action is compatible with the following Mockoon CLI versions:

Mockoon CLI version Action version
<6.0.0 v1
>=6.0.0 v2

Changelogs

You will find Mockoon applications changelogs on the official website.

Mockoon's documentation

You will find Mockoon's documentation on the official website. It covers the most complex features.

Sponsors

Mockoon is an open-source project built by volunteer maintainers. If you like our application, please consider sponsoring us and join all the Sponsors and Backers who helped this project over time!

sponsor button

Subscribe to Mockoon Pro

With advanced features for solo developers and teams, Mockoon Pro supercharges your API development:

Upgrade today and take your API development to the next level.

pro button

Support/feedback

You can discuss all things related to Mockoon's CLI, and ask for help, on the official community. It's also a good place to discuss bugs and feature requests before opening an issue on this repository. For more chat-like discussions, you can also join our Discord server.

Contributing

If you are interested in contributing to Mockoon, please take a look at the contributing guidelines.

Please also take a look at our Code of Conduct.

Roadmap

If you want to know what will be coming in the next release you can check the global Roadmap.

New releases will be announced on Mockoon's Twitter account @GetMockoon and through the newsletter to which you can subscribe here.