Skip to content

Commit 91ceaf6

Browse files
committed
Combine runpodctl overview & installation guide
1 parent 6f22140 commit 91ceaf6

File tree

3 files changed

+64
-124
lines changed

3 files changed

+64
-124
lines changed

docs.json

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -339,31 +339,24 @@
339339
"tab": "CLI",
340340
"groups": [
341341
{
342-
"group": "Get started",
343-
"pages": ["runpodctl/overview", "runpodctl/install-runpodctl"]
342+
"group": "Runpod CLI",
343+
"pages": ["runpodctl/overview"]
344344
},
345345
{
346346
"group": "Reference",
347347
"pages": [
348-
"runpodctl/reference/runpodctl",
349348
"runpodctl/reference/runpodctl-config",
350-
"runpodctl/reference/runpodctl-create",
351349
"runpodctl/reference/runpodctl-create-pod",
352350
"runpodctl/reference/runpodctl-create-pods",
353-
"runpodctl/reference/runpodctl-get",
354351
"runpodctl/reference/runpodctl-get-cloud",
355352
"runpodctl/reference/runpodctl-get-pod",
356353
"runpodctl/reference/runpodctl-receive",
357-
"runpodctl/reference/runpodctl-remove",
358354
"runpodctl/reference/runpodctl-remove-pod",
359355
"runpodctl/reference/runpodctl-remove-pods",
360356
"runpodctl/reference/runpodctl-send",
361-
"runpodctl/reference/runpodctl-ssh",
362357
"runpodctl/reference/runpodctl-ssh-add-key",
363358
"runpodctl/reference/runpodctl-ssh-list-keys",
364-
"runpodctl/reference/runpodctl-start",
365359
"runpodctl/reference/runpodctl-start-pod",
366-
"runpodctl/reference/runpodctl-stop",
367360
"runpodctl/reference/runpodctl-stop-pod",
368361
"runpodctl/reference/runpodctl-update",
369362
"runpodctl/reference/runpodctl-version"
@@ -478,6 +471,10 @@
478471
},
479472

480473
"redirects": [
474+
{
475+
"source": "/runpodctl/install-runpodctl",
476+
"destination": "/runpodctl/overview"
477+
},
481478
{
482479
"source": "/references/faq",
483480
"destination": "/references/troubleshooting/zero-gpus"

runpodctl/install-runpodctl.mdx

Lines changed: 0 additions & 85 deletions
This file was deleted.

runpodctl/overview.mdx

Lines changed: 58 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,75 +1,103 @@
11
---
2-
title: "Runpod CLI overview"
2+
title: "Overview"
33
sidebarTitle: "Overview"
44
---
55

6-
Runpod CLI is an [open source](https://github.com/runpod/runpodctl) command-line interface tool that simplifies the management of GPU [Pods](/pods/overview) and [Serverless](/serverless/overview) endpoints on the Runpod platform. You can use Runpod CLI to execute code on Pods, deploy endpoints, transfer data, and manage computing resources efficiently.
6+
Runpod CLI is an [open source](https://github.com/runpod/runpodctl) 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.
77

8-
Every Pod you deploy comes preinstalled with the `runpodctl` command. You can also [install it locally](/runpodctl/install-runpodctl) to manage Runpod resources from your own machine.
8+
## Install Runpod CLI locally
99

10-
## Key capabilities
10+
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.
1111

12-
Runpod CLI enables you to:
12+
### Step 1: Choose an installation method
1313

14-
* [Manage Pods](/pods/manage-pods) and Serverless endpoints programmatically.
15-
* [Transfer files](/pods/storage/transfer-files) and data between your local system and Runpod.
16-
17-
## Installation
18-
19-
For more information, see [Install runpodctl](/runpodctl/install-runpodctl).
14+
Choose the installation method that matches your operating system.
2015

2116
<Tabs>
22-
<Tab title="macOS (Homebrew)">
23-
Install using Homebrew:
17+
<Tab title="macOS">
2418

19+
**Homebrew:**
2520
```sh
2621
brew install runpod/runpodctl/runpodctl
2722
```
2823

29-
</Tab>
24+
**ARM (Apple Silicon):**
25+
```sh
26+
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
27+
```
28+
29+
**AMD (Intel):**
30+
```sh
31+
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
32+
```
3033

31-
<Tab title="Linux (WSL)">
32-
Install using `wget`:
34+
</Tab>
3335

36+
<Tab title="Linux">
3437
```sh
35-
wget -qO- cli.runpod.net | sudo bash
38+
wget --quiet --show-progress https://github.com/Run-Pod/runpodctl/releases/download/v1.14.3/runpodctl-linux-amd64 -O runpodctl && chmod +x runpodctl && sudo cp runpodctl /usr/bin/runpodctl
3639
```
3740

3841
</Tab>
3942

40-
<Tab title="Windows (PowerShell)">
41-
Install using PowerShell:
43+
<Tab title="Windows">
44+
```sh
45+
wget https://github.com/runpod/runpodctl/releases/download/v1.14.3/runpodctl-windows-amd64.exe -O runpodctl.exe
46+
```
4247

48+
</Tab>
49+
50+
<Tab title="Google Colab / Jupyter Notebook">
4351
```sh
44-
wget https://github.com/runpod/runpodctl/releases/latest/download/runpodctl-windows-amd64.exe -O runpodctl.exe
52+
!wget --quiet --show-progress https://github.com/Run-Pod/runpodctl/releases/download/v1.14.3/runpodctl-linux-amd -O runpodctl
53+
!chmod +x runpodctl
54+
!cp runpodctl /usr/bin/runpodctl
4555
```
4656

4757
</Tab>
4858

4959
</Tabs>
5060

51-
## Configure your API key
61+
This installs `runpodctl` globally on your system, so you can run commands from any directory.
62+
63+
### Step 2: Configure your API key
5264

53-
Before you can use Runpod CLI to manage resources from your local machine, you'll need to configure your [API key](/get-started/api-keys). You can create and manage API keys on the [Runpod account settings page](https://www.console.runpod.io/user/settings).
65+
Before you can use `runpodctl` locally, you must configure it with an [API key](/get-started/api-keys).
5466

55-
After installing `runpodctl` on your local system, run this command to configure it with your API key:
67+
Run the following command to add your API key to `runpodctl`, replacing `YOUR_API_KEY` with your API key:
5668

5769
```sh
58-
runpodctl config --apiKey [API_KEY]
70+
runpodctl config --apiKey YOUR_API_KEY
5971
```
6072

61-
## Help command
73+
After running the command, you should see a confirmation message similar to this:
74+
```text
75+
saved apiKey into config file: /Users/runpod/.runpod/config.toml
76+
```
77+
78+
### Step 3: Verify installation
6279

63-
Learn how to use Runpod CLI commands by browsing the [CLI reference](/runpodctl/reference/runpodctl) or by running the `help` command:
80+
To verify that `runpodctl` installed successfully, run this command:
6481

6582
```sh
66-
runpodctl help
83+
runpodctl version
6784
```
6885

69-
Learn more about a particular command by running:
86+
You should see which version is installed:
7087

7188
```sh
72-
runpodctl [command] help
89+
runpodctl v1.14.4
90+
```
91+
92+
## Help and reference
93+
94+
Learn how to use Runpod CLI commands by browsing the CLI reference using the sidebar to the left, or by running the `help` command:
95+
96+
```sh
97+
runpodctl help
7398
```
7499

75-
For a comprehensive list of commands, see the [Runpod CLI reference](/runpodctl/reference/runpodctl).
100+
Learn more about a particular command by running:
101+
```sh
102+
runpodctl [command] help
103+
```

0 commit comments

Comments
 (0)