本文へ移動
cccskills
無料GitHub で公開

mirrord-quickstart

Guide users from zero to their first working mirrord session — check system requirements, install mirrord via CLI, VS Code, or IntelliJ, run a first session against a Kubernetes target, and verify the connection. Use when a user is new to mirrord, wants to install it, needs help running their first session, or wants to debug or test a local process against their Kubernetes cluster.

インストール方法を見る

含まれるファイル(2)

  • SKILL.md5.1 KB
  • README.md1.3 KB

SKILL.md(原文)

インストールする前に、エージェントに与えられる指示の中身を確認できます。

Mirrord Quickstart Skill

Purpose

Help new users get mirrord running quickly:

  • Check system requirements
  • Install mirrord (CLI, VS Code, or IntelliJ)
  • Connect to their first Kubernetes target
  • Verify the connection works

Go one step at a time — don't overwhelm a new user with all options at once, and when they first connect, explain what just happened.

Critical First Steps

Step 1: Detect user's environment Ask or detect:

  • Operating system (macOS, Linux, Windows)
  • Preferred workflow (CLI, VS Code, IntelliJ)
  • Do they have kubectl configured?

Step 2: Verify requirements

# Check kubectl access
kubectl cluster-info
kubectl get pods -A | head -5

If kubectl fails, help them configure it first.

Installation Paths

CLI (recommended for getting started)

Do not run remote install scripts that pipe a network download into a shell interpreter. Use only methods your organization approves.

Official guide: Follow mirrord installation documentation for supported options (package managers, pinned release binaries with checksum verification, etc.).

Summary for the agent:

  • macOS / Linux: Point the user to the official docs for Homebrew, apt, or pinned binary install steps — do not invent or paste one-liners that fetch and execute remote scripts.
  • Windows: Point the user to the official docs for supported installers.

Security: Prefer package managers or manually verified binaries from official release artifacts. Never execute installation by piping downloaded content into a shell.

Verify installation:

mirrord --version

VS Code Extension

  1. Open VS Code Extensions (Cmd/Ctrl+Shift+X)
  2. Search "mirrord"
  3. Install "mirrord" by MetalBear
  4. Look for mirrord icon in status bar

IntelliJ Plugin

  1. Open Settings → Plugins → Marketplace
  2. Search "mirrord"
  3. Install and restart IDE
  4. Find mirrord in navigation toolbar

First Session

CLI approach

# List available targets
mirrord ls

# Run a local process with mirrord
mirrord exec --target pod/<pod-name> -- <your-command>

# Example: Node.js app
mirrord exec --target pod/api-server-7c8d9 -- node app.js

# Example: Python app
mirrord exec --target pod/backend-abc123 -- python main.py

If mirrord ls returns no targets, check that the kubeconfig context points at the right cluster (kubectl config current-context) and list pods in the expected namespace (kubectl get pods -n <namespace>).

IDE approach

  1. Enable mirrord (click status bar icon / toolbar button)
  2. Select target pod when prompted
  3. Run/debug your application normally
  4. mirrord intercepts and connects automatically

Verification

After running, verify the connection:

  1. Check logs - mirrord's startup progress (agent started, connected to the target) prints before your app's own output:
mirrord exec --target pod/<pod-name> -- <your-command>
  1. Test environment - Remote env vars should be available locally:
mirrord exec --target pod/<pod-name> -- env | grep -i database
  1. Test network - Send a request to the remote service; it should reach the local process (check the local process's output):
curl http://<remote-service-url>

What's Next

Once the first session works, point users to:

  • mirrord ui — launches a local dashboard showing every active session on the machine, with a live event stream (HTTP requests, file operations, DNS, outgoing connections). See Local UI.
  • mirrord up — for debugging several microservices together from one mirrord-up.yaml (compose-style). Point to the mirrord-up skill.
  • Browser extension — routes requests made from Chrome to the local process, for testing an HTTP-filtered session from a browser instead of curl. See Debugging from Browser.
  • mirrord for Teams features (DB branching, queue splitting, preview environments, concurrent steal on one target) need the Operator. On a cluster with no license, an AI agent can offer the user a seven-day Enterprise trial and start it once they agree: point to the mirrord-operator skill, "Agent-started trial".

Common First-Timer Issues

IssueSolution
"kubectl not found"Install kubectl and configure cluster access
"No pods found"Check namespace: kubectl get pods -n <namespace>
"Permission denied"Check RBAC permissions for your kubectl context
"Agent failed to start"Ensure cluster runs Linux kernel 4.20+

レビュー

まだレビューはありません。使ってみた感想をお寄せください。

同じリポジトリのスキル

概要と使いどころ

Help users chaos test their app with mirrord: inject artificial latency or connection errors into a mirrord session's outgoing traffic via per-session chaos rules managed with the `mirrord chaos` CLI. Use when a user wants to add latency or delay to outgoing connections or a dependency (e.g. a slow database), simulate connection failures (reset, timed out, refused), test app behavior under degraded network conditions, or wire chaos rules into CI test runs. Always use this skill instead of the deprecated _experimental_.latency mirrord config option.

日本語の概要は準備中です。原文の説明を表示しています。

metalbear-co/mirrord5,3652026年10月13日 更新

Help users set up mirrord in CI pipelines for testing against real Kubernetes environments. Use when users want to run end-to-end tests, integration tests, or automated tests in CI using mirrord to connect to staging/shared clusters.

日本語の概要は準備中です。原文の説明を表示しています。

metalbear-co/mirrord5,3652026年10月13日 更新

Helps users generate, edit, and validate mirrord.json configuration files for mirrord (MetalBear). Use when the user wants to connect their local process to a Kubernetes environment, configure features (env/fs/network), or needs feedback on an existing mirrord.json. Always ensures output JSON is valid and schema-conformant.

日本語の概要は準備中です。原文の説明を表示しています。

metalbear-co/mirrord5,3652026年10月13日 更新

Helps users configure mirrord.json for database branching, enabling isolated database copies for safe development and testing. Use when the user wants to set up MySQL, MariaDB, PostgreSQL, MSSQL, MongoDB, Redis, DynamoDB, ClickHouse, Google Spanner, Amazon S3, turbopuffer, or generic branches, configure copy modes, connection sources, schema migrations, IAM authentication, or manage database branches.

日本語の概要は準備中です。原文の説明を表示しています。

metalbear-co/mirrord5,3652026年10月13日 更新

Makes a codebase propagate W3C baggage (the `baggage` header carrying `mirrord-session=<key>`) end to end, so mirrord HTTP filters, preview environments, and queue splitting can route a whole request chain to one developer's session. Detects existing OpenTelemetry, Datadog, or other tracing that can already propagate baggage and enables it; otherwise adds a small propagation layer. Covers inbound/outbound HTTP and gRPC, publishing to and consuming from Kafka, RabbitMQ, SQS/SNS, GCP Pub/Sub, Azure Service Bus, NATS, Redis Pub/Sub, BullMQ and Temporal, per-message context restore in consumers, and storage hand-offs such as a GCS signed URL upload that triggers Pub/Sub or an S3 presigned upload that triggers SQS. Ends with a report of every flow found and which ones still drop the header. Use when the user asks to propagate headers, baggage, tracestate, the mirrord session key, or trace context across services or queues, or when a mirrord filter matches the first service but not downstream services or queue consumers.

日本語の概要は準備中です。原文の説明を表示しています。

metalbear-co/mirrord5,3652026年10月13日 更新

Helps DevOps engineers configure mirrord Operator's Kafka queue splitting feature end-to-end. Generates the MirrordSplitConfig and MirrordPropertyList Kubernetes CRD YAMLs (the current resources; MirrordKafkaTopicsConsumer + MirrordKafkaClientConfig are deprecated but still supported), the matching mirrord.json split_queues section with message_filter and jq_filter, and Helm value guidance. Use this skill whenever the user mentions Kafka splitting with mirrord, MirrordSplitConfig, MirrordPropertyList, MirrordKafkaClientConfig, MirrordKafkaTopicsConsumer, Kafka queue/topic splitting, configuring mirrord with Kafka, Kafka Streams splitting, MSK IAM auth, or troubleshooting Kafka splitting sessions. Also trigger on split_queues with queue_type Kafka, or connecting mirrord to a Kafka cluster. This is a Team/Enterprise feature of mirrord.

日本語の概要は準備中です。原文の説明を表示しています。

metalbear-co/mirrord5,3652026年10月13日 更新

metalbear-co のスキルをすべて見る

このスキルの問題を報告する