# kubectl-skill

**Repository Path**: X_P_D_D/kubectl-skill

## Basic Information

- **Project Name**: kubectl-skill
- **Description**: 专为 Claude Code、Cursor 等 AI 助手设计的 kubectl 命令参考技能包。涵盖 Kubernetes / K8s 日常运维、Pod 调试、日志查看、Deployment 部署、端口转发等 100+ 子命令的完整 CLI 参考。让 AI 秒变 Kubernetes 命令行专家，用自然语言生成精确的 kubectl 命令
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-04-27
- **Last Updated**: 2026-04-27

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# kubectl-skill — Kubernetes CLI 与 Kubectl 命令参考

> 专为 [Claude Code](https://github.com/anthropics/claude-code) 等 AI 助手打造的终极 **kubectl 速查表** 与 **Kubernetes 命令行** 参考技能包。涵盖 **k8s CLI** 日常运维、调试、部署、日志及 100+ 子命令。

[![kubectl](https://img.shields.io/badge/kubectl-kubernetes-blue)](https://kubernetes.io/zh-cn/docs/reference/kubectl/)
[![k8s](https://img.shields.io/badge/k8s-cli-reference-green)](https://kubernetes.io/zh-cn/)
[![skill](https://img.shields.io/badge/claude--code-skill-orange)](https://docs.anthropic.com/en/docs/claude-code/skills)

## 这是什么？

**kubectl-skill** 是一个面向 Claude Code、Cursor 及其他大模型编程助手的 **Kubernetes 命令行** 参考技能包。无论你叫它 **kubectl**、**k8s 命令行工具** 还是 **Kubernetes CLI**，本仓库都能为你和 AI 提供完整的命令、参数和用法参考，无需背诵数百个 flags。

加载本 skill 后，AI 可以：

- 用自然语言描述生成精确的 **kubectl** 命令
- 在执行前解释任何 **kubernetes cli** 命令的作用
- 为你的 **k8s** 工作流推荐合适的子命令和参数
- 从 100+ 自动生成的参考文件中查询详细参数说明
- 协助 Pod 调试、日志流查看、端口转发、滚动更新等 **kubectl** 操作

## 适合谁用？

- **DevOps / SRE 工程师** — 借助 AI 加速日常 **kubectl 命令行** 工作流
- **开发者** — 通过对话学习 **k8s cli**，无需翻阅手册页
- **平台工程师** — 减少查询冷门 **kubernetes 命令行** 参数的时间
- **AI 工具开发者** — 为 LLM 提示词和 RAG 管道提供高质量的 **kubectl** 参考数据

## 前置要求

本 skill 假设你已拥有可用的 **Kubernetes** 集群，并已安装 **kubectl CLI**。

1. 安装 **kubectl**（官方 **k8s 命令行工具**）：https://kubernetes.io/zh-cn/docs/tasks/tools/
2. 配置集群访问凭证（通常位于 `~/.kube/config`）
3. 验证 **kubernetes cli** 环境：`kubectl version --client`

> 本 skill 只教 AI 如何「使用」**kubectl 命令行**，不会帮你安装或配置 kubectl。

## 安装方式

### Claude Code

1. 克隆本 **kubectl 参考** 仓库：

   ```bash
   git clone https://github.com/XPDD/kubectl-skill.git
   ```

2. 加载 skill：

   ```bash
   claude skill add /path/to/kubectl-skill
   ```

   或直接将本目录复制到项目的 `.claude/skills/` 文件夹下。

3. 通过自然语言开始使用 **kubernetes cli**。示例提问：
   - "列出 kube-system 命名空间下的所有 Pod"
   - "怎么把 deployment 端口转发到本地 8080？"
   - "把 nginx deployment 扩容到 3 个副本"
   - "导出这个 pod 的 YAML 配置"
   - "调试这个 Pod 为什么 CrashLoopBackOff"
   - "回滚上一次 deployment"

### 其他 AI 助手（Cursor、Copilot 等）

将 `skill.md` 作为系统上下文引入。`generated/` 目录非常适合索引到 RAG 管道中，用于回答 **k8s cli** 相关查询。

## Kubectl 命令速查表

### 资源查询

```bash
# 列出所有 Pod
kubectl get pods

# 列出所有命名空间的 Pod
kubectl get pods --all-namespaces

# 查看 Pod 详情
kubectl describe pod <name>

# 实时监视资源变化
kubectl get pods --watch

# 查看节点（含额外信息）
kubectl get nodes -o wide
```

### 调试与日志

```bash
# 实时查看 Pod 日志
kubectl logs -f <pod-name>

# 进入容器执行命令
kubectl exec -it <pod-name> -- /bin/sh

# 端口转发到本地
kubectl port-forward <pod-name> 8080:80

# 复制文件到/从容器
kubectl cp <pod-name>:/remote/path ./local-path
```

### 生命周期管理

```bash
# 应用资源配置
kubectl apply -f manifest.yaml

# 扩展 Deployment 副本数
kubectl scale deployment/<name> --replicas=5

# 滚动重启
kubectl rollout restart deployment/<name>

# 查看滚动更新状态
kubectl rollout status deployment/<name>
```

## 文件结构 — 完整 Kubectl 参考

| 文件 / 目录 | 说明 |
|------------|------|
| `skill.md` | 核心 **kubectl 速查表** — 常用命令、资源缩写、输出格式、命名空间操作 |
| `generated/` | 每个 **kubernetes cli** 子命令的完整参考文档（100+ 文件） |
| `quick-reference.md` | 日常操作 **kubectl 快速参考** |
| `docker-cli-to-kubectl.md` | 从 Docker CLI 迁移到 **k8s 命令行** 的对照指南 |
| `jsonpath.md` | 用于自定义 **kubectl** 输出的 JSONPath 语法参考 |
| `conventions.md` | **kubectl** 命名与使用约定 |
| `kubectl.md` / `kuberc.md` | **kubernetes cli** 详细概述 |

## 支持的 Kubernetes 命令行工作流

- **资源查询**：`get`、`describe`、`logs`、`top`、`events`
- **生命周期管理**：`apply`、`create`、`delete`、`scale`、`rollout`
- **调试与可观测性**：`exec`、`port-forward`、`debug`、`attach`、`cp`
- **集群运维**：`config`、`cluster-info`、`drain`、`cordon`、`taint`
- **高级功能**：`kustomize`、`auth`、`certificate`、`wait`

## kubectl、k8s CLI 与 Kubernetes 命令行

这三个词指的都是同一个工具 —— 管理 Kubernetes 集群的官方命令行界面。本 skill 同时覆盖 **kubectl**（二进制名称）、**k8s CLI**（常用简称）以及完整的 **Kubernetes 命令行工具**。

## 适用范围

本 skill 仅涵盖 **kubectl CLI 的使用**，不包含集群搭建、RBAC 策略设计或 Kubernetes 架构设计。使用前请确保你已有可用的集群且 **kubernetes cli** 已正确配置。

## 相关资源

- [kubectl 官方文档](https://kubernetes.io/zh-cn/docs/reference/kubectl/)
- [Kubernetes 官方速查表](https://kubernetes.io/zh-cn/docs/reference/kubectl/cheatsheet/)
- [Claude Code Skills 文档](https://docs.anthropic.com/en/docs/claude-code/skills)
- [English README](README.md)

## 许可证

MIT