companion-clis

コンパニオン CLI

ドキュメント付きのテンプレートプロジェクトを作成または改善する場合は、 まずrunpod-build-templateから始めてください。選択した CLI 操作を行う際は、こちらに戻ってきてください。

Runpod と併せてよく使われる CLI は 4 つあります。それぞれに reference/ 内の認証情報とコマンドのリファレンスがあり、さらにインストール用の一度限りの <cli>-setup.md があります（CLI がインストールされていない場合にのみ開きます）。すべてを読み込まず、タスクに必要なものだけを読み込んでください。

インポートした ComfyUI ワークフローで、モデルのファイル名に検証済みの URL またはハッシュがない状態から依頼が始まる場合は、 runpod-templates の ComfyUI モデル修復ガイドに案内してください。正確な Hugging Face リポジトリとファイルがすでに特定されており、成果物のダウンロード、キャッシュ、またはイメージへの組み込みだけを行うタスクの場合は、こちらに戻ってきてください。

CLI	用途	リファレンス全体
hf（HuggingFace）	Hub からモデルをダウンロードし、イメージにキャッシュまたは組み込みます	reference/huggingface.md
gh（GitHub）	ワーカーのリポジトリを管理し、リリースを作成します（Hub はリリースをインデックス化します）	reference/github.md
docker	Docker Hub にイメージをビルド、検証、プッシュし、Runpod がプルできるようにします	reference/docker.md
aws（S3）	Runpod の S3 API を介してネットワークボリュームストレージを読み書きします	reference/aws.md

いずれも使用前に認証情報が必要です。認証手順とコマンドについては、各ツールのリファレンスを読んでください。インストールについては、別途、一度限りの <cli>-setup.md を参照してください。

これらの CLI は、通常、より大きな作業の一工程として使われます。作業全体の検証済みの例は runpod/golden-paths/README.mdにあります。モデルのイメージへの組み込みとマウントの比較 （25）、最小限のイメージのビルド （22）、またはネットワーク ボリュームへのデータ移動（07）をご覧ください。

これらはそれぞれ独自のリリースサイクルで公開されるサードパーティ製 CLI なので、フラグとサブコマンドについては <cli> --help が正式な情報源です。ここにあるリファレンスでは、Runpod 固有の使い方と注意点を説明しており、ツールの全機能を網羅しているわけではありません。いずれかの CLI で何かができないと報告する前に、--help を確認してください。

Windows：シェルを選び、必要に応じて 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

ワーカーのリポジトリを管理し、リリースを作成します。認証とコマンドについては、reference/github.md（インストールと SSH キーのセットアップ：reference/github-setup.md）をご覧ください。

• Hub がインデックス化するのはコミットではなくリリースです。Hub の一覧を更新するたびに、新しい gh release create が必要です。
• 1 つの 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）。

• AWS ではなく、Runpod の S3 API を使用します。アクセスキー = 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/ が必要です（データセンター = ボリュームの DC であり、AWS のリージョンではありません）。
• 大容量または多数のファイルを確実に再開しながら転送する方法については、reference/aws.md → 再開可能なボリューム転送（オプション） を参照してください。