mcpField
M
mirrord-quickstart

mirrord-quickstart

github.com/metalbear-co云与 DevOps29102 次安装5 天前更新
代码仓库

关于 mirrord-quickstart

面向 mirrord 新用户的入门技能，逐步指导检查环境、安装工具并连接 Kubernetes 目标，适合首次建立和验证会话。

主要功能

  1. 01检查系统与集群要求
  2. 02指导 CLI、VS Code 和 IntelliJ 安装
  3. 03列出并连接 Kubernetes 目标
  4. 04验证会话连接与网络

适用场景

  1. 01首次安装并启动 mirrord
  2. 02排查 kubectl 或目标列表问题

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/metalbear-co/skills --skill mirrord-quickstart

安装后在 Claude Code 中输入/mirrord-quickstart确认已加载。

附带文件README.md

详细介绍

Mirrord 快速入门技能

用途

帮助新用户快速运行 mirrord：

  • 检查系统要求
  • 安装 mirrord（CLI、VS Code 或 IntelliJ）
  • 连接到第一个 Kubernetes 目标
  • 验证连接是否正常

一次只进行一个步骤——不要一开始就用所有选项让新用户不知所措。首次连接时，请说明刚才发生了什么。

关键的第一步

步骤 1：检测用户的环境 询问或检测：

  • 操作系统（macOS、Linux、Windows）
  • 偏好的工作流（CLI、VS Code、IntelliJ）
  • 是否已配置 kubectl？

步骤 2：验证要求

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

如果 kubectl 无法运行，请先帮助用户完成配置。

集群要求： Kubernetes 1.22 或更高版本，节点运行 Linux 内核 5.4+，并使用 containerd、CRI-O 或 Docker 运行时。某些功能需要更新版本的 Kubernetes（例如，将 Agent 用作临时容器需要 1.23）；如果特定功能在较旧的集群上无法运行，请引导用户查看集群要求。

安装方式

CLI（推荐用于快速入门）

不要运行将网络下载内容通过管道传给 Shell 解释器的远程安装脚本。仅使用组织认可的方式。

**官方指南：**按照 mirrord 安装文档了解受支持的选项（包管理器、经过校验和验证的固定版本发布二进制文件等）。

给 Agent 的摘要：

  • **macOS / Linux：**引导用户查看官方文档中的 Homebrew、apt 或固定版本二进制文件安装步骤——不要编造或粘贴会获取并执行远程脚本的单行命令。
  • **Windows：**引导用户查看官方文档中受支持的安装程序。

**安全性：**优先使用包管理器，或使用来自官方发布制品且经过手动验证的二进制文件。切勿通过管道将下载的内容传给 Shell 来执行安装。

验证安装：

mirrord --version
VS Code 扩展
  1. 打开 VS Code 扩展（Cmd/Ctrl+Shift+X）
  2. 搜索 "mirrord"
  3. 安装 MetalBear 出品的 "mirrord"
  4. 在状态栏中找到 mirrord 图标
IntelliJ 插件
  1. 打开 Settings → Plugins → Marketplace
  2. 搜索 "mirrord"
  3. 安装并重启 IDE
  4. 在导航工具栏中找到 mirrord

首次使用

CLI 方式
# 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

如果 mirrord ls 没有返回目标，请检查 kubeconfig 上下文是否指向正确的集群（kubectl config current-context），并在预期的命名空间中列出 Pod（kubectl get pods -n <namespace>）。

IDE 方式
  1. 启用 mirrord（点击状态栏图标 / 工具栏按钮）
  2. 出现提示时选择目标 Pod
  3. 正常运行/调试应用
  4. mirrord 会自动拦截并连接

验证

运行后，验证连接：

  1. 检查日志——mirrord 的启动进度（Agent 已启动、已连接到目标）会在应用自身输出之前显示：
mirrord exec --target pod/<pod-name> -- <your-command>
  1. 测试环境——远程环境变量应可在本地使用：
mirrord exec --target pod/<pod-name> -- env | grep -i database
  1. 测试网络——向远程服务发送请求；请求应到达本地进程（检查本地进程的输出）：
curl http://<remote-service-url>

接下来可以做什么

首次会话运行成功后，可以向用户介绍：

  • mirrord ui — 启动本地仪表板，显示机器上的所有活动会话，并提供实时事件流（HTTP 请求、文件操作、DNS、传出连接）。请参阅本地 UI。
  • mirrord up — 使用一个 mirrord-up.yaml（类似 compose）同时调试多个微服务。请指向 mirrord-up 技能。
  • 浏览器扩展 — 将从 Chrome 发出的请求路由到本地进程，以便从浏览器（而不是 curl）测试经过 HTTP 筛选的会话。请参阅从浏览器调试。
  • mirrord for Teams 功能（数据库分支、队列拆分、预览环境、在同一目标上并发窃取流量）需要 Operator。在没有许可证的集群上，AI Agent 可以向用户提供为期 7 天的 Enterprise 试用，并在用户同意后启动：请指向 mirrord-operator 技能中的“由 Agent 启动的试用”。

首次使用时的常见问题

问题解决方案
"kubectl not found"安装 kubectl 并配置集群访问权限
"No pods found"检查命名空间：kubectl get pods -n <namespace>
"Permission denied"检查 kubectl 上下文的 RBAC 权限
"Agent failed to start"确保集群运行 Kubernetes 1.22+，节点使用 Linux 内核 5.4+，并采用 containerd、CRI-O 或 Docker 运行时

评论

支持 Markdown