Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 26 additions & 3 deletions runpodctl/overview.mdx
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---

Check warning on line 1 in runpodctl/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

runpodctl/overview.mdx#L1

Try to keep the Gunning-Fog index (11.82) below 10.

Check warning on line 1 in runpodctl/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

runpodctl/overview.mdx#L1

Try to keep the Flesch reading ease score (46.11) above 70.

Check warning on line 1 in runpodctl/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

runpodctl/overview.mdx#L1

Try to keep the Flesch–Kincaid grade level (10.54) below 8.

Check warning on line 1 in runpodctl/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

runpodctl/overview.mdx#L1

Try to keep the LIX score (45.05) below 35.

Check warning on line 1 in runpodctl/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

runpodctl/overview.mdx#L1

Try to keep the Coleman–Liau Index grade (13.30) below 9.

Check warning on line 1 in runpodctl/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

runpodctl/overview.mdx#L1

Try to keep the Automated Readability Index (10.94) below 8.

Check warning on line 1 in runpodctl/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

runpodctl/overview.mdx#L1

Try to keep the SMOG grade (12.32) below 10.
title: "Overview"
sidebarTitle: "Overview"
description: "Use Runpod CLI to manage Pods, Serverless endpoints, templates, and more from your local machine. Review commands and usage guidance for the Runpod CLI."

Check warning on line 4 in runpodctl/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

runpodctl/overview.mdx#L4

Use 'command-line tool' instead of 'CLI'.

Check warning on line 4 in runpodctl/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

runpodctl/overview.mdx#L4

Use 'command-line tool' instead of 'CLI'.
---

import { PodsTooltip, PodTooltip } from "/snippets/tooltips.jsx";

Runpod CLI is an [open source](https://github.com/runpod/runpodctl) command-line tool for managing your Runpod resources from your local machine. You can manage Pods, Serverless endpoints, templates, network volumes, and models, transfer files between your system and Runpod, diagnose issues, and view account information.

Check warning on line 9 in runpodctl/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

runpodctl/overview.mdx#L9

Use 'command-line tool' instead of 'CLI'.

## Quick start

Expand All @@ -20,7 +20,7 @@
runpodctl pod list # List your Pods
```

## Install Runpod CLI locally

Check warning on line 23 in runpodctl/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

runpodctl/overview.mdx#L23

'Install Runpod CLI locally' should use sentence-style capitalization.

Check warning on line 23 in runpodctl/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

runpodctl/overview.mdx#L23

Use 'command-line tool' instead of 'CLI'.

Every <PodTooltip /> you deploy comes preinstalled with `runpodctl` and a Pod-scoped API key. You can also install it on your local machine to manage resources remotely.

Expand Down Expand Up @@ -95,9 +95,32 @@
</Tab>

<Tab title="Windows">
```bash
wget https://github.com/runpod/runpodctl/releases/latest/download/runpodctl-windows-amd64.exe -O runpodctl.exe
```

In PowerShell, `wget` is an alias for `Invoke-WebRequest`, so use `Invoke-WebRequest` directly. This installs runpodctl to `%LOCALAPPDATA%\runpodctl` and adds it to your `PATH`, so you can run `runpodctl` from any terminal.

**AMD64 (x86_64):**
```powershell
$dest = "$env:LOCALAPPDATA\runpodctl"
Invoke-WebRequest -UseBasicParsing -Uri https://github.com/runpod/runpodctl/releases/latest/download/runpodctl-windows-amd64.zip -OutFile "$env:TEMP\runpodctl.zip"
Expand-Archive -Force -Path "$env:TEMP\runpodctl.zip" -DestinationPath $dest
$userPath = [Environment]::GetEnvironmentVariable('Path', 'User')
if ($userPath -notlike "*$dest*") {

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could we compare complete PATH entries rather than using a wildcard substring in both architecture snippets? $userPath -notlike "*$dest*" treats a path such as ...\runpodctl-old as though $dest is already installed, and wildcard characters in the expanded path are interpreted as pattern syntax. A missing User PATH also produces a leading empty entry.

Splitting on ;, dropping empty entries, and using -notcontains $dest avoids these cases:

$userPath = [Environment]::GetEnvironmentVariable('Path', 'User')
$pathEntries = @($userPath -split ';' | Where-Object { $_ })
if ($pathEntries -notcontains $dest) {
  [Environment]::SetEnvironmentVariable(
    'Path',
    (($pathEntries + $dest) -join ';'),
    'User'
  )
}

[Environment]::SetEnvironmentVariable('Path', "$userPath;$dest", 'User')
}
```

**ARM64:**
```powershell
$dest = "$env:LOCALAPPDATA\runpodctl"
Invoke-WebRequest -UseBasicParsing -Uri https://github.com/runpod/runpodctl/releases/latest/download/runpodctl-windows-arm64.zip -OutFile "$env:TEMP\runpodctl.zip"
Expand-Archive -Force -Path "$env:TEMP\runpodctl.zip" -DestinationPath $dest
$userPath = [Environment]::GetEnvironmentVariable('Path', 'User')
if ($userPath -notlike "*$dest*") {
[Environment]::SetEnvironmentVariable('Path', "$userPath;$dest", 'User')
}
```

Open a new terminal so the `PATH` change takes effect, then verify with `runpodctl version`.

</Tab>

Expand Down Expand Up @@ -145,7 +168,7 @@
runpodctl doctor
```

This command guides you through first-time setup, including API key configuration and SSH key setup.

Check warning on line 171 in runpodctl/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

runpodctl/overview.mdx#L171

Use the Oxford comma in ', including API key configuration and SSH key setup.'.

Alternatively, you can manually configure your API key:

Expand All @@ -158,7 +181,7 @@
saved apiKey into config file: /Users/runpod/.runpod/config.toml
```

### Step 3: Verify installation

Check warning on line 184 in runpodctl/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

runpodctl/overview.mdx#L184

'Step 3: Verify installation' should use sentence-style capitalization.

To verify that `runpodctl` installed successfully, run this command:

Expand All @@ -166,7 +189,7 @@
runpodctl version
```

You should see which version is installed:

Check warning on line 192 in runpodctl/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

runpodctl/overview.mdx#L192

In general, use active voice instead of passive voice ('is installed').

```bash
runpodctl v2.0
Expand All @@ -174,11 +197,11 @@

## Command groups

Runpod CLI organizes commands into groups based on the resource type:

Check warning on line 200 in runpodctl/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

runpodctl/overview.mdx#L200

Use 'command-line tool' instead of 'CLI'.

| Command | Alias | Description |
|---------|-------|-------------|
| `runpodctl pod` | | Manage Pods (create, list, start, stop, delete) |

Check warning on line 204 in runpodctl/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

runpodctl/overview.mdx#L204

Use parentheses judiciously.
| `runpodctl serverless` | `sls` | Manage Serverless endpoints |
| `runpodctl template` | `tpl` | List, search, and manage templates |
| `runpodctl hub` | | Browse and deploy from the Runpod Hub |
Expand All @@ -192,7 +215,7 @@

## 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:

Check warning on line 218 in runpodctl/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

runpodctl/overview.mdx#L218

Use 'command-line tool' instead of 'CLI'.

Check warning on line 218 in runpodctl/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

runpodctl/overview.mdx#L218

Use 'command-line tool' instead of 'CLI'.

```bash
runpodctl help
Expand All @@ -211,6 +234,6 @@
runpodctl completion
```

This command auto-detects your shell and adds the appropriate source command to your shell configuration file (`~/.bashrc` or `~/.zshrc`). The command is idempotent—running it again skips installation if completion is already configured.

Check warning on line 237 in runpodctl/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (runpod-b18f5ded) - vale-spellcheck

runpodctl/overview.mdx#L237

Use parentheses judiciously.

Restart your shell or source the configuration file for changes to take effect.
Loading