mcpField
C
companion-clis

companion-clis

github.com/runpod云与 DevOps4713.7k 次安装2 天前更新
代码仓库

关于 companion-clis

这项技能为 Runpod 常用的四种配套命令行工具提供操作指引：`hf`、`gh`、`docker` 和 `aws`。它按任务选择认证与命令参考，并说明 Runpod 特有的用法和注意事项。

主要功能

  1. 01按任务提供命令行参考
  2. 02下载 Hugging Face 模型
  3. 03管理 GitHub 仓库与发布
  4. 04构建并推送 Docker 镜像
  5. 05访问 Runpod S3 兼容存储

适用场景

  1. 01为镜像缓存 Hugging Face 模型
  2. 02发布 worker 仓库版本
  3. 03构建并推送 Runpod 镜像
  4. 04向网络卷传输数据

安装

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

$npx skills add https://github.com/runpod/runpod-plugins-official --skill companion-clis

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

包含的文件

除 SKILL.md 外，安装时一起下载的参考资料和脚本。

reference/
aws-setup.md
aws.md
docker-setup.md
docker.md
github-setup.md
github.md
huggingface-setup.md
huggingface.md

详细介绍

配套 CLI

要创建或改进有文档说明的模板项目，请从 runpod-build-template 开始；选定 CLI 操作后再返回这里。

Runpod 通常会用到四种 CLI。每种 CLI 在 reference/ 中都有自己的凭据和命令参考，另有一份用于安装的一次性 <cli>-setup.md（仅在尚未安装该 CLI 时打开）。只加载任务所需的 CLI 参考，不要全部加载。

如果请求从导入的 ComfyUI 工作流开始，且其中的模型文件名没有经过验证的 URL 或哈希值，请转到 runpod-templates 中的 ComfyUI 模型修复指南。 如果已知确切的 Hugging Face 仓库和文件，且任务只是下载、缓存或烘焙该资源，则返回这里。

CLI用途完整参考
hf (HuggingFace)从 Hub 下载模型，以便缓存或烘焙到镜像中reference/huggingface.md
gh (GitHub)管理 worker 仓库并发布版本（Hub 会索引发布版本）reference/github.md
docker构建、验证并推送镜像到 Docker Hub，供 Runpod 拉取reference/docker.md
aws (S3)通过 Runpod 的 S3 API 读写网络卷存储reference/aws.md

使用前，每种 CLI 都需要凭据。认证步骤和命令请参阅各自的工具参考；安装另有单独的一次性 <cli>-setup.md。

这些 CLI 通常只是更大任务中的一个步骤。完整任务的已验证示例见 runpod/golden-paths/README.md——烘焙模型还是挂载模型 (25)、构建最小镜像 (22)，或将数据移至网络卷 (07)。

这些是由各自团队独立发布的第三方 CLI，因此标志和子命令以 <cli> --help 为准——此处的参考涵盖 Runpod 特定用法和常见陷阱，而非工具的全部功能。报告某个 CLI 无法执行某项操作之前，请先查看 --help。

Windows：先选择 Shell，再按需设置 WSL2

安装另一份副本之前，请检查是否已有原生、WSL2 或远程工具。本技能中的 Windows hf 和 gh 安装步骤使用 WSL2 及其 Linux 安装程序。如果选择此方案但尚未安装 WSL2，请以管理员身份在 PowerShell 中运行以下命令，然后按提示重启：

wsl --install

之后打开 Ubuntu 应用完成设置，再按照各参考中的 Linux 说明操作。请在所选环境中使用命令、凭据和路径。仅编写文件无需安装这些 CLI。

HuggingFace CLI

在本地下载模型，以便在 Docker 构建或运行时使用缓存。认证和 hf download 操作步骤见：reference/huggingface.md（安装：reference/huggingface-setup.md）。

  • 使用独立的 hf CLI，不要使用 pip install huggingface_hub（它安装的是旧版 huggingface-cli，语法不同）。
  • 使用 hf auth login 进行认证，或设置 export HF_TOKEN=hf_...（环境变量优先于已保存的令牌）。

GitHub CLI

管理 worker 仓库并发布版本。认证和命令见：reference/github.md（安装和 SSH 密钥设置：reference/github-setup.md）。

  • Hub 索引的是发布版本，而非提交——每次更新 Hub 列表都需要新建一次 gh release create。
  • 一个 SSH 密钥（ssh-keygen -t ed25519）可同时注册到 GitHub（gh ssh-key add）和 HuggingFace（在浏览器中粘贴）。

Docker

构建、验证并推送镜像到 Docker Hub。凭据和命令：reference/docker.md（安装：reference/docker-setup.md）。

  • 始终构建 --platform=linux/amd64——Runpod 使用 x86 Linux。
  • 始终使用明确的语义化标签；绝不使用 latest——latest 不会指向最新推送的镜像，因此工作节点可能会悄悄拉取错误的镜像。
  • Docker Hub 身份验证使用个人访问令牌，而非密码。对于私有镜像，请在 Console → Container Registry Settings 中注册一次凭据。

AWS CLI

通过 Runpod 的兼容 S3 API 访问网络卷存储（存储桶名称 = 网络卷 ID）。凭据、区域规则和命令：reference/aws.md（安装：reference/aws-setup.md）。

  • 使用的是 Runpod 的 S3 API，而非 AWS：访问密钥 = Runpod 用户 ID（user_...），密钥 = S3 API 密钥（rps_...）。
  • S3 API 密钥只能在 Console 中创建。 无法通过 runpodctl/REST/GraphQL 创建密钥——如果 ~/.aws/credentials/环境变量中尚无密钥，且需要访问 S3，请停止并让用户生成密钥（Settings > S3 API Keys）。
  • 每条命令都需要 --region DATACENTER --endpoint-url https://s3api-DATACENTER.runpod.io/（datacenter = 卷所在的数据中心，而非 AWS 区域）。
  • 如需可靠地续传大型或多文件传输，请参阅 reference/aws.md → 可选的可续传网络卷传输。

评论

支持 Markdown