> 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/quick-start/install-mirrord.md). # Install mirrord Install the mirrord CLI or the IDE extension on your machine, and check that your cluster meets the requirements. Install the CLI, the extension for your IDE, or both. For every IDE, coding agent and tool that mirrord works with, see [mirrord integrations](https://metalbear.com/mirrord/integrations/). ## Requirements * macOS (Intel or Apple Silicon), Linux (x86\_64 or arm64), or Windows (x86\_64). mirrord runs natively on Windows. If you prefer WSL, see the [WSL setup guide](https://metalbear.com/mirrord/docs/reference/wsl.md). * A kubeconfig that points at your cluster, the same one `kubectl` uses. * A cluster that meets the [Cluster Requirements](#cluster-requirements). ## Install {% tabs %} {% tab title="CLI (macOS/Linux)" %} ```bash brew install metalbear-co/mirrord/mirrord ``` or: ```bash curl -fsSL https://raw.githubusercontent.com/metalbear-co/mirrord/main/scripts/install.sh | bash ``` To install a specific release and check the download against the checksum published with it, pass the version and set `MIRRORD_CHECKSUM` to the SHA-256 of the `mirrord__.zip` asset shown on the [release page](https://github.com/metalbear-co/mirrord/releases). This is useful in CI, where a changed binary should fail the build rather than run: ```bash curl -fsSL https://raw.githubusercontent.com/metalbear-co/mirrord/main/scripts/install.sh \ | MIRRORD_CHECKSUM= MIRRORD_INSTALL_DIR="$HOME/.local/bin" bash -s -- ``` `MIRRORD_VERIFY=1` checks against the published checksum without pinning one, and `MIRRORD_INSTALL_DIR` picks the directory (no `sudo`). In GitHub Actions, [`metalbear-co/setup-mirrord`](https://github.com/metalbear-co/setup-mirrord) does the same and caches the binary between runs. {% endtab %} {% tab title="CLI (Windows)" %} ```powershell choco install mirrord ``` {% endtab %} {% tab title="VS Code / Cursor / Windsurf" %} Extensions → search **mirrord** → Install. Works with all VS Code forks (Cursor, Windsurf, Antigravity, PearAI, Trae). You can also download it from the [VS Code Marketplace](https://marketplace.visualstudio.com/items?itemName=MetalBear.mirrord). For settings and usage, see [VS Code](https://metalbear.com/mirrord/docs/ide-extensions/vscode.md). {% endtab %} {% tab title="JetBrains" %} Preferences → Plugins → search **mirrord** → Install. Works with IntelliJ, GoLand, PyCharm, and other JetBrains IDEs. You can also download it from the [JetBrains Marketplace](https://plugins.jetbrains.com/plugin/19772-mirrord). For settings and usage, see [JetBrains IDEs](https://metalbear.com/mirrord/docs/ide-extensions/intellij.md). {% endtab %} {% endtabs %} ## Check the install * **CLI:** run `mirrord --version`. It prints the installed version. * **VS Code:** a **mirrord** button with a circle appears in the status bar at the bottom of the window. * **JetBrains:** the mirrord icon appears in the navigation toolbar, top right. ## Cluster Requirements mirrord supports Kubernetes `1.22` or later. This applies to the open-source version and to the [mirrord Operator](https://metalbear.com/mirrord/docs/reference/operator.md). The nodes where agents run need Linux kernel `5.4` or later, and a containerd, CRI-O or Docker runtime. Some features need a newer Kubernetes version, listed in [Which Kubernetes versions does mirrord support?](https://metalbear.com/mirrord/docs/faq/limitations.md#which-kubernetes-versions-does-mirrord-support) ## Next steps * [Onboarding Wizard](https://metalbear.com/mirrord/docs/getting-started/quick-start/onboarding-wizard.md): generate a `mirrord-up.yaml` for your services. * [Starting your first session](https://metalbear.com/mirrord/docs/getting-started/quick-start/first-session.md): run your local code in the context of the cluster. * [Install the Operator](https://metalbear.com/mirrord/docs/getting-started/quick-start/install-the-operator.md): for teams sharing a cluster, the platform team installs it once per cluster. --- # 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 by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://metalbear.com/mirrord/docs/getting-started/quick-start/install-mirrord.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. 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.