# mirrord

## Documentation

- [Welcome](https://metalbear.com/mirrord/docs/welcome.md): Connect local code, run by developers or AI coding agents, to your live Kubernetes cluster
- [What is mirrord?](https://metalbear.com/mirrord/docs/getting-started/what-is-mirrord.md): How mirrord works and what mirrord for Teams adds
- [Quick Start](https://metalbear.com/mirrord/docs/getting-started/quick-start.md): How to (very) quickly start using mirrord
- [Onboarding Wizard](https://metalbear.com/mirrord/docs/getting-started/quick-start/onboarding-wizard.md): Using the mirrord wizard to speed up onboarding setup
- [Installing mirrord](https://metalbear.com/mirrord/docs/getting-started/installing-mirrord.md): How to install mirrord on your local machine
- [CLI](https://metalbear.com/mirrord/docs/getting-started/installing-mirrord/cli.md): Installing and using the mirrord CLI
- [VS Code](https://metalbear.com/mirrord/docs/getting-started/installing-mirrord/vscode.md): Installing and using the mirrord extension in Visual Studio Code
- [JetBrains IDEs](https://metalbear.com/mirrord/docs/getting-started/installing-mirrord/intellij.md): Installing and using the mirrord plugin in JetBrains IDEs
- [WSL](https://metalbear.com/mirrord/docs/getting-started/installing-mirrord/wsl.md): Installing and using mirrord on Windows with WSL
- [mirrord Operator](https://metalbear.com/mirrord/docs/getting-started/installing-mirrord/operator.md): Install and manage the mirrord Operator for Teams
- [Remocal Development](https://metalbear.com/mirrord/docs/use-cases/local-development.md): Run your code locally while it communicates with real cloud services
- [CI/CD Integration](https://metalbear.com/mirrord/docs/use-cases/mirrord-for-ci.md): How to use mirrord in a CI environment with \`mirrord ci\` commands.
- [Preview Environments](https://metalbear.com/mirrord/docs/use-cases/preview-environments.md): Ephemeral, isolated environments connected to your cluster
- [Preview Environments in CI](https://metalbear.com/mirrord/docs/use-cases/preview-environments/preview-environments-in-ci.md): How to automate preview environments in your CI pipeline with PR-based keys and header propagation
- [Using mirrord with AI](https://metalbear.com/mirrord/docs/use-cases/using-mirrord-with-ai.md): Configure AI coding agents to test code changes against your cluster using mirrord
- [Agent Skills for mirrord](https://metalbear.com/mirrord/docs/use-cases/using-mirrord-with-ai/ai-skills-plugin.md): Install the mirrord skills plugin to give AI coding assistants like Cursor and Claude Code domain-specific knowledge of how to work with mirrord.
- [Configure AI Agents to Use mirrord](https://metalbear.com/mirrord/docs/use-cases/using-mirrord-with-ai/the-meta-prompt.md): Configure AI coding agents to test code changes against your cluster using mirrord
- [Incoming Traffic](https://metalbear.com/mirrord/docs/using-mirrord/incoming-traffic.md): How mirrord handles incoming network traffic from the cluster
- [Filtering Incoming Traffic](https://metalbear.com/mirrord/docs/using-mirrord/incoming-traffic/filter-incoming-traffic.md): Steal a subset of incoming traffic using HTTP header, W3C baggage or tracestate, path or method filters
- [Filtering by JSON Body](https://metalbear.com/mirrord/docs/using-mirrord/incoming-traffic/filter-incoming-traffic/filtering-by-json-body.md): How to filter traffic by JSON body using mirrord
- [Debugging from Browser](https://metalbear.com/mirrord/docs/using-mirrord/incoming-traffic/filter-incoming-traffic/debug-from-browser.md): Use the Chrome extension to route browser traffic to your local process
- [Stealing HTTPS Requests](https://metalbear.com/mirrord/docs/using-mirrord/incoming-traffic/steal-https.md): Decrypt and steal HTTPS traffic using TLS certificates
- [Inspecting Live Traffic](https://metalbear.com/mirrord/docs/using-mirrord/incoming-traffic/inspect-live-traffic.md): Monitor incoming traffic to a pod using the mirrord dump command
- [Outgoing Traffic](https://metalbear.com/mirrord/docs/using-mirrord/outgoing-traffic.md): How mirrord handles outgoing network traffic from your local process
- [Filtering Outgoing Traffic](https://metalbear.com/mirrord/docs/using-mirrord/outgoing-traffic/filter-outgoing-traffic.md): Control which outgoing connections go through the cluster and which stay local
- [Environment Variables](https://metalbear.com/mirrord/docs/using-mirrord/environment-variables.md): Control which environment variables are loaded from the remote pod
- [File Operations](https://metalbear.com/mirrord/docs/using-mirrord/file-operations.md): Control which files your local process reads and writes remotely
- [Port Forwarding](https://metalbear.com/mirrord/docs/using-mirrord/port-forwarding.md): How to use mirrord for port forwarding
- [Connecting Tools to the Cluster](https://metalbear.com/mirrord/docs/using-mirrord/connecting-tools.md): Use mirrord to connect local tools like browsers, Postman, and database clients to cluster services
- [Web Browsing](https://metalbear.com/mirrord/docs/using-mirrord/connecting-tools/web-browsing.md): Using mirrord to browse using cluster networking
- [Postman](https://metalbear.com/mirrord/docs/using-mirrord/connecting-tools/postman.md): Connect Postman to your cluster via mirrord.
- [Running Without a Target](https://metalbear.com/mirrord/docs/using-mirrord/targetless.md): How to run mirrord without a remote target
- [Copying a Target](https://metalbear.com/mirrord/docs/using-mirrord/copy-target.md): Making mirrord copy a target and use the copy instead of the original
- [Local Containers](https://metalbear.com/mirrord/docs/using-mirrord/local-container.md): Running mirrord with local containers (Docker, Podman, nerdctl)
- [Seamless Multi-Cluster Development](https://metalbear.com/mirrord/docs/using-mirrord/multi-cluster.md): Multi-cluster mirrord lets developers intercept traffic from pods across several Kubernetes clusters at once, without switching kube contexts.
- [Multi-Cluster Setup](https://metalbear.com/mirrord/docs/using-mirrord/multi-cluster/multi-cluster-setup.md): Step-by-step guide to setting up multi-cluster mirrord: install the operator on every cluster, choose an authentication method, and connect them.
- [Multiple concurrent sessions (mirrord up)](https://metalbear.com/mirrord/docs/using-mirrord/multiple-concurrent-sessions.md): How to use mirrord up
- [Local UI](https://metalbear.com/mirrord/docs/using-mirrord/local-ui.md): Launch a local web dashboard that watches every active mirrord session
- [Subscribing to Events](https://metalbear.com/mirrord/docs/using-mirrord/subscribe.md): Stream a session's interception events as JSON with mirrord subscribe
- [Overview](https://metalbear.com/mirrord/docs/sharing-the-cluster/overview.md): How mirrord makes it possible for developers to use the same cluster concurrently.
- [Managing Sessions](https://metalbear.com/mirrord/docs/sharing-the-cluster/sessions.md): View and manage active mirrord sessions in the cluster
- [Policies](https://metalbear.com/mirrord/docs/sharing-the-cluster/policies.md): Limiting available features for selected targets with mirrord for Teams
- [Outgoing Traffic Policies](https://metalbear.com/mirrord/docs/sharing-the-cluster/policies/outgoing-traffic-policies.md): Restricting which resources and endpoints can be accessed when using mirrord
- [Profiles](https://metalbear.com/mirrord/docs/sharing-the-cluster/profiles.md): Reusable mirrord config templates
- [Queue Splitting](https://metalbear.com/mirrord/docs/sharing-the-cluster/queue-splitting.md): Sharing queues by splitting messages between multiple clients and the cluster
- [DB Branching](https://metalbear.com/mirrord/docs/sharing-the-cluster/db-branching.md): How to use mirrord to spin up an isolated DB branch for safe development and testing DB migrations
- [Branch Management](https://metalbear.com/mirrord/docs/sharing-the-cluster/db-branching/db-branch-management.md): How to manage isolated mirrord DB branches for visibility and control
- [Advanced Configuration](https://metalbear.com/mirrord/docs/sharing-the-cluster/db-branching/db-branching-advanced-config.md): Learn how to use mirrord’s advanced configuration options for database branching
- [Dashboard](https://metalbear.com/mirrord/docs/managing-mirrord/admin-dashboard.md): Dashboard for monitoring mirrord usage
- [Monitoring](https://metalbear.com/mirrord/docs/managing-mirrord/monitoring.md): Monitoring with mirrord for Teams
- [Security](https://metalbear.com/mirrord/docs/managing-mirrord/security.md): Security in mirrord for Teams
- [High Availability](https://metalbear.com/mirrord/docs/managing-mirrord/high-availability.md): High availability for mirrord Operator in Enterprise Tier
- [Scalability](https://metalbear.com/mirrord/docs/managing-mirrord/scalability.md): Default sizing, concurrent session guidance, and capacity validation for the mirrord Operator
- [License Server](https://metalbear.com/mirrord/docs/managing-mirrord/license-server.md): License Server
- [Versioning](https://metalbear.com/mirrord/docs/managing-mirrord/versioning.md): Versioning and compatibility between mirrord components
- [Jira Integration](https://metalbear.com/mirrord/docs/managing-mirrord/jira-integration.md): Recording and displaying user session metrics in Jira
- [General](https://metalbear.com/mirrord/docs/faq/general.md): General questions about mirrord.
- [Limitations](https://metalbear.com/mirrord/docs/faq/limitations.md): What are the limitations to using mirrord?
- [Comparisons](https://metalbear.com/mirrord/docs/faq/comparisons.md): How does mirrord compare to other solutions?
- [Troubleshooting](https://metalbear.com/mirrord/docs/faq/troubleshooting.md): Common issues and debugging utilities for mirrord
- [Utilities](https://metalbear.com/mirrord/docs/faq/troubleshooting/utilities.md): Lightweight options that provide additional insight when debugging mirrord
- [Common Issues](https://metalbear.com/mirrord/docs/faq/troubleshooting/common-issues.md): Some common issues and workarounds.
- [Architecture](https://metalbear.com/mirrord/docs/reference/architecture.md): mirrord's architecture
- [Targets](https://metalbear.com/mirrord/docs/reference/targets.md): Possible targets for mirrord and how to set them
- [Network Traffic](https://metalbear.com/mirrord/docs/reference/traffic.md): Reference to working with network traffic with mirrord
- [Environment Variables](https://metalbear.com/mirrord/docs/reference/env.md): Reference to including remote environment variables
- [File Operations](https://metalbear.com/mirrord/docs/reference/fileops.md): Reference to mirrord's file operations
- [Feature Release Status](https://metalbear.com/mirrord/docs/release-stages.md): Understand mirrord's release stages — how complete each feature is and what stability to expect before relying on it in your workflow.
- [Feature Support Matrix](https://metalbear.com/mirrord/docs/release-stages/feature-matrix.md): See which platforms and infrastructure support mirrord's advanced features — DB Branching, Queue Splitting, Preview Environments, and Multi-cluster.
- [Third-party](https://metalbear.com/mirrord/docs/third-party.md): A list of third-party guides and videos about mirrord.
- [Contributing](https://metalbear.com/mirrord/docs/contributing.md): How to contribute to mirrord

## Configuration

- [Getting Started](https://metalbear.com/mirrord/docs/config/readme.md): Getting started with mirrord configuration.
- [Options](https://metalbear.com/mirrord/docs/config/options.md): Detailed documentation of all configuration options available for mirrord, including usage, defaults, and examples.

## Changelog

- [Operator](https://metalbear.com/mirrord/docs/changelog/operator.md): The release changelog for the mirrord operator.

## Guides

- [Guides](https://metalbear.com/mirrord/docs/guides/readme.md): Step-by-step guides for debugging microservices, testing AI-generated code, and running AI agents in Kubernetes with mirrord
- [How to Debug a Java Microservice](https://metalbear.com/mirrord/docs/guides/language-guides/how-to-debug-a-java-microservice.md)
- [How to Debug a Go Microservice](https://metalbear.com/mirrord/docs/guides/language-guides/how-to-debug-a-go-microservice.md)
- [How to Debug a Node.js Microservice](https://metalbear.com/mirrord/docs/guides/language-guides/how-to-debug-a-nodejs-microservice.md)
- [How to Debug a Kotlin Microservice](https://metalbear.com/mirrord/docs/guides/language-guides/how-to-debug-a-kotlin-microservice.md)
- [How to Debug a Ruby Microservice](https://metalbear.com/mirrord/docs/guides/language-guides/how-to-debug-a-ruby-microservice.md)
- [How to Debug a PHP Microservice](https://metalbear.com/mirrord/docs/guides/language-guides/how-to-debug-a-php-microservice.md)
- [How to Debug a Python Microservice](https://metalbear.com/mirrord/docs/guides/language-guides/how-to-debug-a-python-microservice.md)
- [How to Debug a .NET Microservice](https://metalbear.com/mirrord/docs/guides/language-guides/how-to-debug-a-dotnet-microservice.md)
- [How to Debug Kafka Consumers](https://metalbear.com/mirrord/docs/guides/queue-guides/how-to-debug-kafka-consumers.md)
- [How to Debug SQS Consumers](https://metalbear.com/mirrord/docs/guides/queue-guides/how-to-debug-sqs-consumers.md)
- [Test AI-Generated Code](https://metalbear.com/mirrord/docs/guides/ai-guides/testing-ai-generated-code.md)
- [Autonomous AI Workflows](https://metalbear.com/mirrord/docs/guides/ai-guides/running-ai-agents-with-mirrord.md)
- [Configure Agents to Use mirrord](https://metalbear.com/mirrord/docs/guides/ai-guides/setting-up-mirrord-for-ai-tools.md)


---

# 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, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on a page URL with the `ask` query parameter:
```
GET https://metalbear.com/mirrord/docs/welcome.md?ask=<question>
```
The question should be specific, self-contained, and written in natural language.
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.