Installation

mockd is distributed as a single binary with no external dependencies. Choose the installation method that works best for your environment.

Quick Install (Recommended)

The fastest way to install mockd on Linux or macOS:

curl -sSL https://get.mockd.io | sh

This detects your OS and architecture automatically and installs the latest release.

Homebrew (macOS / Linux)

brew install getmockd/tap/mockd

Binary Download

Download the latest release for your platform:

Linux (x86_64)

curl -sSL https://github.com/getmockd/mockd/releases/latest/download/mockd-linux-amd64 -o mockd
chmod +x mockd
sudo mv mockd /usr/local/bin/

Linux (ARM64)

curl -sSL https://github.com/getmockd/mockd/releases/latest/download/mockd-linux-arm64 -o mockd
chmod +x mockd
sudo mv mockd /usr/local/bin/

macOS (Intel)

curl -sSL https://github.com/getmockd/mockd/releases/latest/download/mockd-darwin-amd64 -o mockd
chmod +x mockd
sudo mv mockd /usr/local/bin/

macOS (Apple Silicon)

curl -sSL https://github.com/getmockd/mockd/releases/latest/download/mockd-darwin-arm64 -o mockd
chmod +x mockd
sudo mv mockd /usr/local/bin/

Windows

# Download from GitHub releases
Invoke-WebRequest -Uri "https://github.com/getmockd/mockd/releases/latest/download/mockd-windows-amd64.exe" -OutFile "mockd.exe"

# Add to PATH or move to a directory in your PATH

Verify the installation:

mockd --version

Windows

Using Go Install

If you have Go 1.25+ installed:

go install github.com/getmockd/mockd/cmd/mockd@latest

This installs mockd to your $GOPATH/bin directory. Make sure it’s in your PATH.

Download Binary

# Download latest release
Invoke-WebRequest -Uri "https://github.com/getmockd/mockd/releases/latest/download/mockd_windows_amd64.zip" -OutFile "mockd.zip"

# Extract
Expand-Archive -Path "mockd.zip" -DestinationPath "."

# Add to PATH (current session)
$env:PATH += ";$PWD"

# Or move to a directory in your PATH
Move-Item mockd.exe C:\Users\YourName\bin\

Using Scoop

If you have Scoop installed:

scoop install mockd

Verify Installation

mockd --version

Go Install (Linux/macOS)

If you have Go 1.25+ installed:

go install github.com/getmockd/mockd/cmd/mockd@latest

This installs mockd to your $GOPATH/bin directory. Make sure it’s in your PATH.

Docker

Pull and run the official Docker image:

Port 4280 serves mock traffic. Port 4290 is the Admin API for managing mocks at runtime.

# Pull the latest image
docker pull ghcr.io/getmockd/mockd:latest

# Run with both mock and admin ports exposed
docker run -p 4280:4280 -p 4290:4290 ghcr.io/getmockd/mockd

# Run with a local config file
docker run -p 4280:4280 -p 4290:4290 -v $(pwd)/mockd.yaml:/mockd.yaml ghcr.io/getmockd/mockd serve --config /mockd.yaml

Docker Compose

services:
  mockd:
    image: ghcr.io/getmockd/mockd:latest
    ports:
      - "4280:4280"  # Mock server
      - "4290:4290"  # Admin API
    volumes:
      - ./mockd.yaml:/mockd.yaml
    command: serve --config /mockd.yaml

Build from Source

Clone and build the project:

git clone https://github.com/getmockd/mockd.git
cd mockd
go build -o mockd ./cmd/mockd

Verify Installation

After installation, verify mockd is working:

# Check version
mockd --version

# Show help
mockd --help

# Start a simple mock server (creates default config if none exists)
mockd start

Next Steps

• Quickstart - Create your first mock API
• Core Concepts - Learn how mockd works