Awesome
<div align="center">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.
</div>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:
- Installing the latest version of runpodctl
- Uploading large datasets
- File transfers from PC to RunPod
- Downloading folders from RunPod
- Adding runpodctl to your environment path
- Downloading model files
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
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.