> For the complete documentation index, see [llms.txt](https://metalbear.com/mirrord/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://metalbear.com/mirrord/docs/getting-started/installing-mirrord.md).

# Installing mirrord

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

* [**CLI**](/mirrord/docs/getting-started/installing-mirrord/cli.md) - Install the mirrord command-line tool directly
* [**VS Code**](/mirrord/docs/getting-started/installing-mirrord/vscode.md) - Install the mirrord extension for Visual Studio Code and compatible editors (Cursor, Windsurf, etc.)
* [**JetBrains IDEs**](/mirrord/docs/getting-started/installing-mirrord/intellij.md) - Install the mirrord plugin for JetBrains IDEs (IntelliJ, PyCharm, GoLand, etc.)

mirrord runs natively on Windows — no WSL needed. If you still prefer to use WSL, see our [**WSL setup guide**](/mirrord/docs/getting-started/installing-mirrord/wsl.md).

### Local Requirements

For your local machine, you may use any of:

* MacOS (Intel, Apple Silicon)
* Linux (x86\_64)
* Windows (x86\_64), WSL (x86\_64)

kubectl needs to be configured on the local machine.

### mirrord Operator

If you're planning to use [mirrord for Teams](https://app.metalbear.com), you'll also need to install the mirrord Operator in your cluster. See the [mirrord Operator](/mirrord/docs/getting-started/installing-mirrord/operator.md) page for installation instructions.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://metalbear.com/mirrord/docs/getting-started/installing-mirrord.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.