Installation

Installation Methods

mocks can be installed in several ways. Choose the method that best fits your environment.

Homebrew (macOS)

If you’re using Homebrew on macOS, you can install from the dedicated tap:

brew install mocks-rs/tap/mocks

npm (Node.js)

If you’re using Node.js, you can install mocks globally via npm:

npm install -g @mocks-rs/mocks

Or use it without installing:

npx @mocks-rs/mocks --help

Example usage with npx:

# Initialize a storage file
npx @mocks-rs/mocks init storage.json

# Run the mock server
npx @mocks-rs/mocks run storage.json

System Requirements: Node.js 18.0.0 or higher

Cargo (Rust)

If you have a Rust development environment, you can install directly from cargo:

cargo install mocks

Binary Download

You can download pre-built binaries for your platform from the GitHub Releases page:

1. Visit GitHub Releases
2. Select the binary for your platform from the latest version assets
3. Extract the downloaded file and place it in an executable location

Verification

After installation, you can verify the installation with the following commands:

mocks --version

mocks --help

System Requirements

• Supported OS: Linux, macOS, Windows
• Minimum Rust Version: 1.78.0+ (when installing via Cargo)

Next Steps

Once installation is complete, try creating your first mock API with the Quick Start guide.