Skip to main content

Installation

proxymock does some pretty heavy duty work all from the command line. Using the cli, you can automate the creation of simulation environments, record new traffic, modify transactions and replay.

Install proxymock via Command Line

warning

The proxymock cli is currently only available for MacOS and Linux. Instructions for Windows are included below in case you want to do some offroading.

Install the cli via Homebrew:

brew install speedscale/tap/proxymock

That's all you need. You can stop reading now.


Ok, you didn't stop reading so here are some manual instructions if you don't use Homebrew:

sh -c "$(curl -Lfs https://downloads.speedscale.com/proxymock/install-proxymock)"

You can inspect the install script to see what it does.

tip

To install non interactively (like in CI/CD) set the SPEEDSCALE_API_KEY environment variable. This is an Enterprise feature.

If you need to Install a specific version, you can do so by passing it to the install script:

sh -c "$(curl -Lfs https://downloads.speedscale.com/proxymock/install-proxymock)" -s v1.4.63

Install proxymock via VSCode (beta)

  1. Go to the Extensions view (Ctrl+Shift+X on Windows or Command+Shift+X on MacOS/Linux) in Visual Studio Code
  2. Search for proxymock
  3. Click install

The extension will install an additional command line tool called proxymock which is used to create and manage your mock servers. You don't need to manually install this, but you can learn more about it by checking out the manual instructions below.

note

The proxymock extension will re-use the existing Speedscale Enterprise installation if present.