Installing mirrord

How to install mirrord on your local machine

mirrord can be installed and used in several ways depending on your development workflow:

• CLI - Install the mirrord command-line tool directly

• VS Code - Install the mirrord extension for Visual Studio Code and compatible editors (Cursor, Windsurf, etc.)

• JetBrains IDEs - Install the mirrord plugin for JetBrains IDEs (IntelliJ, PyCharm, GoLand, etc.)

Using IDE extensions on Windows? See our WSL setup guide.

Local Requirements

For your local machine, you may use any of:

• MacOS (Intel, Apple Silicon)

• Linux (x86_64)

• Windows (x86_64), WSL (x86_64)

  • IDE plugins support for native mirrord for Windows is currently not supported

kubectl needs to be configured on the local machine.

mirrord Operator

If you're planning to use mirrord for Teams, you'll also need to install the mirrord Operator in your cluster. See the mirrord Operator page for installation instructions.