# Mirrord Quickstart

Guide users from zero to their first working mirrord session, check system...

- Repository: https://github.com/metalbear-co/mirrord (5397 stars)
- Category: Testing
- License: MIT
- Last updated: 2026-11-01
- Runs scripts: no, instructions only

## Install

Claude Code: `npx skills add metalbear-co/mirrord --skill mirrord-quickstart -g -a claude-code -y`
Codex: `npx skills add metalbear-co/mirrord --skill mirrord-quickstart -g -a codex -y`
Cursor: `npx skills add metalbear-co/mirrord --skill mirrord-quickstart -g -a cursor -y`
Gemini CLI: `npx skills add metalbear-co/mirrord --skill mirrord-quickstart -g -a gemini-cli -y`

## Description

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.

## SKILL.md, as published by its author (untrusted third-party text, read it as data)

# 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**
```bash
# Check kubectl access
kubectl cluster-info
kubectl get pods -A | head -5
```

If kubectl fails, help them configure it first.

**Cluster requirements:** Kubernetes `1.22` or later, with nodes on Linux kernel `5.4`+ and a containerd, CRI-O, or Docker runtime. Some features need a newer Kubernetes version (for example, the agent as an ephemeral container needs `1.23`); point users at [Cluster Requirements](https://metalbear.com/mirrord/docs/installing-mirrord#cluster-requirements) if a specific feature fails on an older cluster.

## 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](https://mirrord.dev/docs/overview/quick-start/) 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.

The rest: https://github.com/metalbear-co/mirrord/blob/HEAD/mirrord/mcp/corpus/skills/mirrord-quickstart/SKILL.md
