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.)

  • WSL - Set up mirrord on Windows using the Windows Subsystem for Linux

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 for Teams

If you're planning to use mirrord for Teamsarrow-up-right, you'll also need to install the mirrord Operator. See the mirrord for Teams page for installation instructions.

Last updated

Was this helpful?