Skip to main content

Documentation Index

Fetch the complete documentation index at: https://runpod-b18f5ded-promptless-github-integration-timeout-clari.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Runpod CLI is an open source command-line interface tool for managing your Runpod resources remotely from your local machine. You can transfer files and data between your local system and Runpod, execute code on remote Pods, and automate Pod deployment workflows.

​
Install Runpod CLI locally

Every Pod you deploy comes preinstalled with the runpodctl command and a Pod-scoped API key. You can also install it on your local machine to manage your Pods remotely from your own system.

​
Step 1: Choose an installation method

Choose the installation method that matches your operating system.
Homebrew:
brew install runpod/runpodctl/runpodctl
ARM (Apple Silicon):
wget --quiet --show-progress https://github.com/runpod/runpodctl/releases/download/v1.14.3/runpodctl-darwin-arm64 -O runpodctl && chmod +x runpodctl && sudo mv runpodctl /usr/local/bin/runpodctl
AMD (Intel):
wget --quiet --show-progress https://github.com/runpod/runpodctl/releases/download/v1.14.3/runpodctl-darwin-amd64 -O runpodctl && chmod +x runpodctl && sudo mv runpodctl /usr/local/bin/runpodctl
This installs runpodctl globally on your system, so you can run commands from any directory.

​
Step 2: Configure your API key

Before you can use runpodctl locally, you must configure it with an API key. Run the following command to add your API key to runpodctl, replacing YOUR_API_KEY with your API key: 
runpodctl config --apiKey YOUR_API_KEY
After running the command, you should see a confirmation message similar to this: 
saved apiKey into config file: /Users/runpod/.runpod/config.toml

​
Step 3: Verify installation

To verify that runpodctl installed successfully, run this command: 
runpodctl version
You should see which version is installed: 
runpodctl v1.14.4

​
Help and reference

Learn how to use Runpod CLI commands by browsing the CLI reference using the sidebar to the left, or by running the help command: 
runpodctl help
Learn more about a particular command by running: 
runpodctl [command] help