Installation

Imposter can be installed on Linux, macOS and Windows.

If you're looking to upgrade Imposter, see Upgrade.

Prerequisites

Imposter supports different mock engine types: Docker (default), JVM and native. For more information about configuring the engine type see:

• Docker engine (default)
• JVM engine
• Native engine

You must have at least one of the engine types configured to use Imposter.

Quick start

Use these instructions to get up and running quickly.

Homebrew

If you have Homebrew installed:

brew tap imposter-project/imposter
brew trust imposter-project/imposter
brew install imposter

Shell script

Or, use this one liner (macOS and Linux only):

curl -L https://raw.githubusercontent.com/imposter-project/imposter-cli/main/install/install_imposter.sh | bash -

Warning It is good practice to examine the script first.

See Releases for the latest version.

Manual install

macOS

Only ARM64 and Intel x86_64 are supported on macOS.

# see https://github.com/imposter-project/imposter-cli/releases
export IMPOSTER_CLI_VERSION=1.5.5

# choose one
export IMPOSTER_ARCH=arm64
#export IMPOSTER_ARCH=amd64

curl -L -o imposter-cli.tar.gz "https://github.com/imposter-project/imposter-cli/releases/download/v${IMPOSTER_CLI_VERSION}/imposter-cli_darwin_${IMPOSTER_ARCH}.tar.gz"
tar xvf imposter-cli.tar.gz
mv ./imposter /usr/local/bin/imposter

Linux

Intel x86_64, ARM32 and ARM64 are supported on Linux.

# see https://github.com/imposter-project/imposter-cli/releases
export IMPOSTER_CLI_VERSION=1.5.5

# choose one
#export IMPOSTER_ARCH=arm64
#export IMPOSTER_ARCH=arm
export IMPOSTER_ARCH=amd64

curl -L -o imposter-cli.tar.gz "https://github.com/imposter-project/imposter-cli/releases/download/v${IMPOSTER_CLI_VERSION}/imposter-cli_linux_${IMPOSTER_ARCH}.tar.gz"
tar xvf imposter-cli.tar.gz
mv ./imposter /usr/local/bin/imposter

Windows

Only Intel x86_64 is supported on Windows.

These instructions assume curl and unzip are available. You can also download the ZIP archive from the Releases page.

# see https://github.com/imposter-project/imposter-cli/releases
SET IMPOSTER_CLI_VERSION=1.5.5

curl.exe --output imposter-cli.zip --url "https://github.com/imposter-project/imposter-cli/releases/download/v%IMPOSTER_CLI_VERSION%/imposter-cli_windows_amd64.zip"
unzip.exe imposter-cli.zip

# use command (or add to PATH)
imposter.exe [command/args]

Uninstall

To uninstall, remove the imposter binary from /usr/local/bin (macOS and Linux only).

rm /usr/local/bin/imposter