table of contents

• runpodctl cli
  • table of contents
  • get started
    • install
      • linux/macos (wsl)
      • macos
      • windows powershell
  • quick start
  • commands
    • pod management
    • serverless endpoints
    • file transfer
  • output format
  • legacy commands
  • acknowledgements

get started

install

linux/macos (wsl)

wget -qO- cli.runpod.net | sudo bash

macos

brew install runpod/runpodctl/runpodctl

windows powershell

wget https://github.com/runpod/runpodctl/releases/latest/download/runpodctl-windows-amd64.exe -O runpodctl.exe

quick start

# configure api key
runpodctl config --apiKey=your_api_key
list all pods
runpodctl pod list
get a specific pod
runpodctl pod get pod_id
create a pod
runpodctl pod create --image=runpod/pytorch:latest --gpu-id=NVIDIA_A100
start/stop/delete a pod
runpodctl pod start pod_id
runpodctl pod stop pod_id
runpodctl pod delete pod_id

commands

commands follow noun-verb pattern: runpodctl <resource> <action>

pod management

runpodctl pod list                    # list all pods
runpodctl pod get <id>                # get pod details
runpodctl pod create --image=<img>    # create a pod
runpodctl pod update <id>             # update a pod
runpodctl pod start <id>              # start a stopped pod
runpodctl pod stop <id>               # stop a running pod
runpodctl pod delete <id>             # delete a pod

serverless endpoints

runpodctl serverless list             # list endpoints (alias: sls)
runpodctl serverless get <id>         # get endpoint details
runpodctl serverless create           # create endpoint
runpodctl serverless update <id>      # update endpoint
runpodctl serverless delete <id>      # delete endpoint

other resources: template (alias: tpl), volume (alias: vol), registry (alias: reg)

file transfer

send and receive files without api key using croc:

# send a file
runpodctl send data.txt
# output: code is: 8338-galileo-collect-fidel
receive on another computer
runpodctl receive 8338-galileo-collect-fidel

output format

default output is json (optimized for agents). use --output flag for alternatives:

runpodctl pod list                    # json (default)
runpodctl pod list --output=table     # human-readable table
runpodctl pod list --output=yaml      # yaml format

legacy commands

legacy commands are still supported but deprecated. please update your scripts:

get pod, create pod, remove pod, start pod, stop pod

acknowledgements

• cobra
• croc
• golang
• viper