Skip to main content
Apicentric provides multiple installation methods to suit your workflow. Choose the one that works best for you. If you have Node.js installed, this is the fastest way to get started. 
npx apicentric simulator start
The npm package wraps the native binary and downloads it on first use.

​
Verify installation

apicentric --version
The easiest way to install on macOS and Linux: 
brew install pmaojo/tap/apicentric

​
Update to latest version

brew upgrade apicentric

​
Verify installation

apicentric --version
Homebrew installations include all features (TUI, contract testing, MCP, IoT).

​
Install script (Unix)

Quick installation script for Linux and macOS: 
curl -fsSL https://raw.githubusercontent.com/pmaojo/apicentric/main/scripts/install.sh | sh
This script will:
  • Detect your platform and architecture automatically
  • Download the appropriate binary
  • Verify checksums for security
  • Install to /usr/local/bin (requires sudo)

​
Custom installation directory

Install to a directory that doesn’t require sudo: 
INSTALL_DIR=$HOME/.local/bin curl -fsSL https://raw.githubusercontent.com/pmaojo/apicentric/main/scripts/install.sh | sh
Then add to PATH: 
echo 'export PATH="$HOME/.local/bin:$PATH"' >> ~/.bashrc
source ~/.bashrc

​
Verify installation

apicentric --version

​
Windows PowerShell

For Windows users, use the PowerShell installation script: 
irm https://raw.githubusercontent.com/pmaojo/apicentric/main/scripts/install.ps1 | iex
This script will:
  • Download the Windows x64 binary
  • Verify checksums
  • Extract to %USERPROFILE%\.apicentric\bin
  • Add to PATH (restart terminal after installation)

​
Verify installation

apicentric --version
After installation, restart your terminal or PowerShell session to refresh the PATH.

​
Cargo (build from source)

If you have Rust installed, you can build from source with custom features:

​
Minimal build (fastest, ~1 minute)

cargo install apicentric --no-default-features --features minimal
Includes: Core simulator only 
cargo install apicentric --features cli-tools
Includes: Simulator, contract testing, and TUI

​
Full build (all features, ~3-5 minutes)

cargo install apicentric --features full
Includes: All features (TUI, MCP, GraphQL, scripting, AI, IoT, GUI)

​
Default build

cargo install apicentric
Includes: Simulator, contract testing, TUI, WebUI, GraphQL, IoT

​
Verify installation

apicentric --version
Building from source requires Rust 1.70 or later. Install Rust from rustup.rs.

​
Pre-built binaries

Download pre-built binaries for your platform from GitHub Releases.

​
Available platforms

  • Linux x64 (apicentric-linux-x64.tar.gz)
  • macOS x64 (apicentric-macos-x64.tar.gz)
  • macOS ARM64 (apicentric-macos-arm64.tar.gz)
  • Windows x64 (apicentric-windows-x64.zip)

​
Manual installation (Linux/macOS)

1

Download the binary

curl -LO https://github.com/pmaojo/apicentric/releases/latest/download/apicentric-linux-x64.tar.gz
2

Verify checksum (optional)

curl -LO https://github.com/pmaojo/apicentric/releases/latest/download/checksums.txt
sha256sum -c checksums.txt --ignore-missing
3

Extract

tar -xzf apicentric-linux-x64.tar.gz
4

Move to PATH

sudo mv apicentric /usr/local/bin/
sudo chmod +x /usr/local/bin/apicentric

​
Manual installation (Windows)

1

Download

Download apicentric-windows-x64.zip from releases
2

Extract

Extract the archive to a directory
3

Add to PATH

Move apicentric.exe to a directory in your PATH, or add the directory to your PATH environment variable

​
Docker

You can use the dockerize command to create a self-contained Docker image for your services. 
apicentric simulator dockerize --file <service1>.yaml [<service2>.yaml ...] --output ./my-service-docker
This generates a Dockerfile and .dockerignore in the output directory. Build and run: 
cd my-service-docker
docker build -t my-service .
docker run -p <port>:<port> my-service
See the Docker deployment guide for production deployment patterns.

​
Verification

After installation, verify that Apicentric is working correctly: 
# Check version
apicentric --version

# View help
apicentric --help

# List available commands
apicentric simulator --help
Expected output should show version information and available commands.

​
Feature flags

Different installation methods include different feature sets:
FeaturenpmHomebrewInstall ScriptCargo (default)Cargo (full)
Simulator✅✅✅✅✅
Contract Testing✅✅✅✅✅
TUI✅✅✅✅✅
WebUI✅✅✅✅✅
GraphQL✅✅✅✅✅
IoT Digital Twins✅✅✅✅✅
MCP❌✅✅❌✅
GUI❌❌❌❌✅
Scripting❌❌❌❌✅
For most users, the default feature set (npm, Homebrew, or install script) is sufficient.

​
Next steps

Quick start

Create your first mock API

CLI reference

Explore all commands

Run diagnostics

Use the doctor command to check your setup

Troubleshooting

Fix common installation issues

Build docs developers (and LLMs) love

Get started for freeTalk to us