> 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/welcome.md).

# Welcome

Connect local code, run by developers or AI coding agents, to your live Kubernetes cluster

mirrord is a tool that lets developers and AI coding agents run local code as if it were running inside a Kubernetes cluster, without building container images or deploying. Your code still runs locally, but mirrord proxies incoming and outgoing traffic, environment variables, and files back and forth between your local process and the cluster.

The result is that your local process behaves as if it's running in the cloud, even though it's still running on your machine. Use mirrord to read from the live cluster (things like real env vars, real service responses, real queue contents) when writing or generating code, so your code is grounded in what's actually deployed. Then run it against those same services once it's written, and find out immediately whether it works instead of waiting on CI and staging.

This works for a single service, or for several at once with [`mirrord up`](/mirrord/docs/using-mirrord/multiple-concurrent-sessions.md), which runs multiple mirrord sessions from a single config file.

AI coding agents like Claude Code, Cursor, and Codex can [use mirrord](/mirrord/docs/use-cases/using-mirrord-with-ai.md) the same way: reading the cluster to generate code grounded in real env vars, service responses, and queue contents, and then running the code against real cluster services to catch integration issues and iterate until it works end-to-end.

For the full list of coding agents, IDEs, CI systems, message queues, databases, and Kubernetes platforms that mirrord works with, see [mirrord integrations](https://metalbear.com/mirrord/integrations/).

<table data-card-size="large" data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th><th data-hidden data-card-cover data-type="files"></th></tr></thead><tbody><tr><td><strong>Quick Start</strong></td><td>Install mirrord and run your first session in minutes.</td><td><a href="/mirrord/docs/getting-started/quick-start.md">Quick Start</a></td><td><a href="https://2838204941-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FghNlSpMkqkYKZCZQsHRt%2Fuploads%2Fgit-blob-4b751160828149094539de39047b1a8f6ef01c8a%2Fcard-quick-start.png?alt=media">card-quick-start.png</a></td></tr><tr><td><strong>What is mirrord?</strong></td><td>Understand how mirrord works and how it's different from alternatives.</td><td><a href="/mirrord/docs/getting-started/what-is-mirrord.md">What is mirrord?</a></td><td><a href="https://2838204941-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FghNlSpMkqkYKZCZQsHRt%2Fuploads%2Fgit-blob-be85f1e0ad07a59cec573d2eca8e77f6928405d3%2Fcard-what-is-mirrord.png?alt=media">card-what-is-mirrord.png</a></td></tr><tr><td><strong>Use Cases</strong></td><td>Remocal development, CI/CD integration, using mirrord with AI agents, and more.</td><td><a href="/mirrord/docs/use-cases/local-development.md">Remocal Development</a></td><td><a href="https://2838204941-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FghNlSpMkqkYKZCZQsHRt%2Fuploads%2Fgit-blob-bd8e1fc220f02b773889d3000bd9dd83f866cfcc%2Fcard-use-cases.png?alt=media">card-use-cases.png</a></td></tr><tr><td><strong>Guides</strong></td><td>Step-by-step guides for debugging microservices in Kubernetes with mirrord.</td><td><a href="https://metalbear.com/mirrord/docs/guides/">https://metalbear.com/mirrord/docs/guides/</a></td><td><a href="https://2838204941-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FghNlSpMkqkYKZCZQsHRt%2Fuploads%2Fgit-blob-8f617153f1969fa6a492d53efaad2e78353a630f%2Fcard-guides.png?alt=media">card-guides.png</a></td></tr></tbody></table>

### Open source vs Teams

mirrord's core functionality is free and open source. [mirrord for Teams](https://metalbear.com/mirrord/pricing) adds the mirrord Operator, enabling concurrent cluster usage, advanced traffic control, and organizational governance.


---

# 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/welcome.md?ask=<question>&goal=<user_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.