Skip to content

runpod/runpodctl

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

RunPod CLI

runpodctl is the CLI tool to automate / manage GPU pods for runpod.io.

Note: All pods automatically come with runpodctl installed with a pod-scoped API key.

Table of Contents

Get Started

Install

Linux/MacOS (WSL)

# Download and install via wget
wget -qO- cli.runpod.net | sudo bash

MacOS

# Using homebrew
brew install runpod/runpodctl/runpodctl

Windows PowerShell

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

Tutorial

Please checkout this video tutorial for a detailed walkthrough of runpodctl.

Video Chapters:

Transferring Data (file send/receive)

Note: The send and receive commands do not require API keys due to the built-in security of one-time codes.

Run the following on the computer that has the file you want to send

To send a file

runpodctl send data.txt

Example output:

Sending 'data.txt' (5 B)
Code is: 8338-galileo-collect-fidel
On the other computer run

runpodctl receive 8338-galileo-collect-fidel

To receive a file

runpodctl receive 8338-galileo-collect-fidel

Example output:

Receiving 'data.txt' (5 B)

Receiving (<-149.36.0.243:8692)
data.txt 100% |β–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆβ–ˆ| ( 5/ 5B, 0.040 kB/s)

Using Google Drive

You can use the following links for google colab

Send

Receive

Pod Commands

Before using pod commands, configure the API key obtained from your RunPod account.

# configure API key
runpodctl config --apiKey={key}

# Get all pods
runpodctl get pod

# Get a pod
runpodctl get pod {podId}

# Start an ondemand pod.
runpodctl start pod {podId}

# Start a spot pod with bid.
# The bid price you set is the price you will pay if not outbid:
runpodctl start pod {podId} --bid=0.3

# Stop a pod
runpodctl stop pod {podId}

For a comprehensive list of commands, visit RunPod CLI documentation.

Model Repository Commands

Model repository commands let you upload, list, and remove AI models that can later be deployed with pods.

# Upload a model directory to your account's repository
runpodctl create model \
  --provider huggingface \
  --name lodestones/Chroma \
  --credential-reference secret://runpod/model-storage \
  --version 1.0.0 \
  --model-path ./chroma-model

# List models in your repository
runpodctl get models

# Remove a model by owner and name
runpodctl remove model \
  --owner your-org \
  --name lodestones/Chroma

Supplying --model-path archives the directory into a .tar.gz file, starts a multipart upload, transfers the artifact using the pre-signed URLs, and finalizes the upload automatically.

You can still pass --create-upload on its own to inspect the multipart session details without uploading any files.

Acknowledgements