runpodctl

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

Runpodctl

Manage GPU pods, serverless endpoints, templates, volumes, and models.

Spelling: "Runpod" (capital R). Command is
runpodctl
(lowercase).

管理GPU Pod、Serverless端点、模板、存储卷和模型。

拼写说明： "Runpod"（首字母大写R）。命令为
runpodctl
（全小写）。

Quick start

快速开始

bash

runpodctl doctor                    # First time setup (API key + SSH)
runpodctl gpu list                  # See available GPUs
runpodctl template search pytorch   # Find a template
runpodctl pod create --template-id runpod-torch-v21 --gpu-id "NVIDIA RTX 4090"  # Create from template
runpodctl pod list                  # List your pods

API key: https://runpod.io/console/user/settings

bash

runpodctl doctor                    # 首次设置（API密钥 + SSH）
runpodctl gpu list                  # 查看可用GPU
runpodctl template search pytorch   # 查找模板
runpodctl pod create --template-id runpod-torch-v21 --gpu-id "NVIDIA RTX 4090"  # 通过模板创建
runpodctl pod list                  # 列出你的Pod

API密钥：https://runpod.io/console/user/settings

Commands

命令列表

Pods

Pod管理

bash

runpodctl pod list                                    # List all pods
runpodctl pod get <pod-id>                            # Get pod details (includes SSH info)
runpodctl pod create --template-id runpod-torch-v21 --gpu-id "NVIDIA RTX 4090"  # Create from template
runpodctl pod create --image "runpod/pytorch:2.1.0-py3.10-cuda11.8.0-devel-ubuntu22.04" --gpu-id "NVIDIA RTX 4090"  # Create with image
runpodctl pod create --compute-type cpu --image ubuntu:22.04  # Create CPU pod
runpodctl pod start <pod-id>                          # Start stopped pod
runpodctl pod stop <pod-id>                           # Stop running pod
runpodctl pod restart <pod-id>                        # Restart pod
runpodctl pod reset <pod-id>                          # Reset pod
runpodctl pod update <pod-id> --name "new"            # Update pod
runpodctl pod delete <pod-id>                         # Delete pod

Create flags:

--template-id

(required if no

--image

--image

(required if no

--template-id

--name

--gpu-id

--gpu-count

--compute-type

--ssh

(default true),

--container-disk-in-gb

--volume-in-gb

--volume-mount-path

--ports

--env

--cloud-type

--data-center-ids

--global-networking

--public-ip

bash

runpodctl pod list                                    # 列出所有Pod
runpodctl pod get <pod-id>                            # 获取Pod详情（包含SSH信息）
runpodctl pod create --template-id runpod-torch-v21 --gpu-id "NVIDIA RTX 4090"  # 通过模板创建
runpodctl pod create --image "runpod/pytorch:2.1.0-py3.10-cuda11.8.0-devel-ubuntu22.04" --gpu-id "NVIDIA RTX 4090"  # 通过镜像创建
runpodctl pod create --compute-type cpu --image ubuntu:22.04  # 创建CPU Pod
runpodctl pod start <pod-id>                          # 启动已停止的Pod
runpodctl pod stop <pod-id>                           # 停止运行中的Pod
runpodctl pod restart <pod-id>                        # 重启Pod
runpodctl pod reset <pod-id>                          # 重置Pod
runpodctl pod update <pod-id> --name "new"            # 更新Pod
runpodctl pod delete <pod-id>                         # 删除Pod

创建参数：

--template-id

（未指定

--image

时为必填项）,

--image

（未指定

--template-id

时为必填项）,

--name

--gpu-id

--gpu-count

--compute-type

--ssh

（默认值true）,

--container-disk-in-gb

--volume-in-gb

--volume-mount-path

--ports

--env

--cloud-type

--data-center-ids

--global-networking

--public-ip

Serverless (alias: sls)

Serverless（别名：sls）

bash

runpodctl serverless list                             # List all endpoints
runpodctl serverless get <endpoint-id>                # Get endpoint details
runpodctl serverless create --name "x" --template-id "tpl_abc"  # Create endpoint
runpodctl serverless update <endpoint-id> --workers-max 5       # Update endpoint
runpodctl serverless delete <endpoint-id>             # Delete endpoint

Create flags:

--name

--template-id

--gpu-id

--gpu-count

--compute-type

--workers-min

--workers-max

--data-center-ids

bash

runpodctl serverless list                             # 列出所有端点
runpodctl serverless get <endpoint-id>                # 获取端点详情
runpodctl serverless create --name "x" --template-id "tpl_abc"  # 创建端点
runpodctl serverless update <endpoint-id> --workers-max 5       # 更新端点
runpodctl serverless delete <endpoint-id>             # 删除端点

创建参数：

--name

--template-id

--gpu-id

--gpu-count

--compute-type

--workers-min

--workers-max

--data-center-ids

Templates (alias: tpl)

模板（别名：tpl）

bash

runpodctl template list                               # Official + community (first 10)
runpodctl template list --type official               # All official templates
runpodctl template list --type community              # Community templates (first 10)
runpodctl template list --type user                   # Your own templates
runpodctl template list --all                         # Everything including user
runpodctl template list --limit 50                    # Show 50 templates
runpodctl template search pytorch                     # Search for "pytorch" templates
runpodctl template search comfyui --limit 5           # Search, limit to 5 results
runpodctl template search vllm --type official        # Search only official
runpodctl template get <template-id>                  # Get template details (includes README, env, ports)
runpodctl template create --name "x" --image "img"    # Create template
runpodctl template create --name "x" --image "img" --serverless  # Create serverless template
runpodctl template update <template-id> --name "new"  # Update template
runpodctl template delete <template-id>               # Delete template

List flags:

--type

(official, community, user),

--limit

--offset

--all

Create flags:

--name

--image

--container-disk-in-gb

--volume-in-gb

--volume-mount-path

--ports

--env

--docker-start-cmd

--docker-entrypoint

--serverless

--readme

bash

runpodctl template list                               # 官方+社区模板（前10个）
runpodctl template list --type official               # 所有官方模板
runpodctl template list --type community              # 社区模板（前10个）
runpodctl template list --type user                   # 你的个人模板
runpodctl template list --all                         # 所有模板（包含个人模板）
runpodctl template list --limit 50                    # 显示50个模板
runpodctl template search pytorch                     # 搜索“pytorch”相关模板
runpodctl template search comfyui --limit 5           # 搜索并限制为5个结果
runpodctl template search vllm --type official        # 仅搜索官方模板
runpodctl template get <template-id>                  # 获取模板详情（包含README、环境变量、端口）
runpodctl template create --name "x" --image "img"    # 创建模板
runpodctl template create --name "x" --image "img" --serverless  # 创建Serverless模板
runpodctl template update <template-id> --name "new"  # 更新模板
runpodctl template delete <template-id>               # 删除模板

列表参数：

--type

（official、community、user）,

--limit

--offset

--all

创建参数：

--name

--image

--container-disk-in-gb

--volume-in-gb

--volume-mount-path

--ports

--env

--docker-start-cmd

--docker-entrypoint

--serverless

--readme

Network Volumes (alias: nv)

网络存储卷（别名：nv）

bash

runpodctl network-volume list                         # List all volumes
runpodctl network-volume get <volume-id>              # Get volume details
runpodctl network-volume create --name "x" --size 100 --data-center-id "US-GA-1"  # Create volume
runpodctl network-volume update <volume-id> --name "new"  # Update volume
runpodctl network-volume delete <volume-id>           # Delete volume

Create flags:

--name

--size

--data-center-id

bash

runpodctl network-volume list                         # 列出所有存储卷
runpodctl network-volume get <volume-id>              # 获取存储卷详情
runpodctl network-volume create --name "x" --size 100 --data-center-id "US-GA-1"  # 创建存储卷
runpodctl network-volume update <volume-id> --name "new"  # 更新存储卷
runpodctl network-volume delete <volume-id>           # 删除存储卷

创建参数：

--name

--size

--data-center-id

Models

模型

bash

runpodctl model list                                  # List your models
runpodctl model list --all                            # List all models
runpodctl model list --name "llama"                   # Filter by name
runpodctl model list --provider "meta"                # Filter by provider
runpodctl model add --name "my-model" --model-path ./model  # Add model
runpodctl model remove --name "my-model"              # Remove model

bash

runpodctl model list                                  # 列出你的模型
runpodctl model list --all                            # 列出所有模型
runpodctl model list --name "llama"                   # 按名称过滤
runpodctl model list --provider "meta"                # 按提供商过滤
runpodctl model add --name "my-model" --model-path ./model  # 添加模型
runpodctl model remove --name "my-model"              # 删除模型

Registry (alias: reg)

镜像仓库（别名：reg）

bash

runpodctl registry list                               # List registry auths
runpodctl registry get <registry-id>                  # Get registry auth
runpodctl registry create --name "x" --username "u" --password "p"  # Create registry auth
runpodctl registry delete <registry-id>               # Delete registry auth

bash

runpodctl registry list                               # 列出仓库认证信息
runpodctl registry get <registry-id>                  # 获取仓库认证详情
runpodctl registry create --name "x" --username "u" --password "p"  # 创建仓库认证
runpodctl registry delete <registry-id>               # 删除仓库认证

Info

信息查询

bash

runpodctl user                                        # Account info and balance (alias: me)
runpodctl gpu list                                    # List available GPUs
runpodctl gpu list --include-unavailable              # Include unavailable GPUs
runpodctl datacenter list                             # List datacenters (alias: dc)
runpodctl billing pods                                # Pod billing history
runpodctl billing serverless                          # Serverless billing history
runpodctl billing network-volume                      # Volume billing history

bash

runpodctl user                                        # 账户信息和余额（别名：me）
runpodctl gpu list                                    # 列出可用GPU
runpodctl gpu list --include-unavailable              # 包含不可用GPU
runpodctl datacenter list                             # 列出数据中心（别名：dc）
runpodctl billing pods                                # Pod账单历史
runpodctl billing serverless                          # Serverless账单历史
runpodctl billing network-volume                      # 存储卷账单历史

SSH

SSH管理

bash

runpodctl ssh info <pod-id>                           # Get SSH info (command + key, does not connect)
runpodctl ssh list-keys                               # List SSH keys
runpodctl ssh add-key                                 # Add SSH key

Agent note:

ssh info

returns connection details, not an interactive session. If interactive SSH is not available, execute commands remotely via

ssh user@host "command"

bash

runpodctl ssh info <pod-id>                           # 获取SSH信息（命令+密钥，不建立连接）
runpodctl ssh list-keys                               # 列出SSH密钥
runpodctl ssh add-key                                 # 添加SSH密钥

代理说明：

ssh info

仅返回连接详情，不提供交互式会话。若无法使用交互式SSH，可通过

ssh user@host "command"

远程执行命令。

File Transfer

文件传输

bash

runpodctl send <path>                                 # Send files (outputs code)
runpodctl receive <code>                              # Receive files using code

bash

runpodctl send <path>                                 # 发送文件（输出传输码）
runpodctl receive <code>                              # 使用传输码接收文件

Utilities

实用工具

bash

runpodctl doctor                                      # Diagnose and fix CLI issues
runpodctl update                                      # Update CLI
runpodctl version                                     # Show version
runpodctl completion bash >> ~/.bashrc                # Install bash completion
runpodctl completion zsh >> ~/.zshrc                  # Install zsh completion

bash

runpodctl doctor                                      # 诊断并修复CLI问题
runpodctl update                                      # 更新CLI
runpodctl version                                     # 显示版本
runpodctl completion bash >> ~/.bashrc                # 安装bash自动补全
runpodctl completion zsh >> ~/.zshrc                  # 安装zsh自动补全

URLs

访问地址

Pod URLs

Pod访问地址

Access exposed ports on your pod:

https://<pod-id>-<port>.proxy.runpod.net

Example:

https://abc123xyz-8888.proxy.runpod.net

访问Pod上暴露的端口：

https://<pod-id>-<port>.proxy.runpod.net

示例：

https://abc123xyz-8888.proxy.runpod.net

Serverless URLs

Serverless访问地址

https://api.runpod.ai/v2/<endpoint-id>/run        # Async request
https://api.runpod.ai/v2/<endpoint-id>/runsync    # Sync request
https://api.runpod.ai/v2/<endpoint-id>/health     # Health check
https://api.runpod.ai/v2/<endpoint-id>/status/<job-id>  # Job status

https://api.runpod.ai/v2/<endpoint-id>/run        # 异步请求
https://api.runpod.ai/v2/<endpoint-id>/runsync    # 同步请求
https://api.runpod.ai/v2/<endpoint-id>/health     # 健康检查
https://api.runpod.ai/v2/<endpoint-id>/status/<job-id>  # 任务状态