Skip to content
Merged
Show file tree
Hide file tree
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
4 changes: 4 additions & 0 deletions runpodctl/overview.mdx

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

(Line 44)

PR #303 added SHA-256 checksum verification to install.sh before extraction; its calculate_sha256 helper uses sha256sum or shasum and fails closed with "No SHA-256 checksum tool found" when neither is present, and the new header requirement notes sha256sum on Linux or shasum on macOS. This note documents that new prerequisite.

Source: runpod/runpodctl#303

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 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 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 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 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 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 All @@ -45,6 +45,10 @@

The script installs the latest version to `/usr/local/bin` when run as root, or to `~/.local/bin` for non-root users. If you don't have root access, the script displays instructions for adding `runpodctl` to your PATH.

<Note>
The install script verifies the downloaded release against its SHA-256 checksum before installing, so it needs a checksum tool to be present: `sha256sum` on Linux or `shasum` on macOS. These are preinstalled in most environments, but on minimal images without one the install aborts.
</Note>

</Tab>

<Tab title="macOS">
Expand Down Expand Up @@ -145,7 +149,7 @@
runpodctl doctor
```

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

Check warning on line 152 in runpodctl/overview.mdx

View check run for this annotation

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

runpodctl/overview.mdx#L152

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 +162,7 @@
saved apiKey into config file: /Users/runpod/.runpod/config.toml
```

### Step 3: Verify installation

Check warning on line 165 in runpodctl/overview.mdx

View check run for this annotation

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

runpodctl/overview.mdx#L165

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

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

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

You should see which version is installed:

Check warning on line 173 in runpodctl/overview.mdx

View check run for this annotation

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

runpodctl/overview.mdx#L173

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

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

## Command groups

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

Check warning on line 181 in runpodctl/overview.mdx

View check run for this annotation

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

runpodctl/overview.mdx#L181

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

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

Check warning on line 185 in runpodctl/overview.mdx

View check run for this annotation

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

runpodctl/overview.mdx#L185

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 +196,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 199 in runpodctl/overview.mdx

View check run for this annotation

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

runpodctl/overview.mdx#L199

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

Check warning on line 199 in runpodctl/overview.mdx

View check run for this annotation

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

runpodctl/overview.mdx#L199

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

```bash
runpodctl help
Expand All @@ -211,6 +215,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 218 in runpodctl/overview.mdx

View check run for this annotation

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

runpodctl/overview.mdx#L218

Use parentheses judiciously.

Restart your shell or source the configuration file for changes to take effect.
2 changes: 1 addition & 1 deletion runpodctl/reference/runpodctl-update.mdx
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---

Check warning on line 1 in runpodctl/reference/runpodctl-update.mdx

View check run for this annotation

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

runpodctl/reference/runpodctl-update.mdx#L1

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

Check warning on line 1 in runpodctl/reference/runpodctl-update.mdx

View check run for this annotation

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

runpodctl/reference/runpodctl-update.mdx#L1

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

Check warning on line 1 in runpodctl/reference/runpodctl-update.mdx

View check run for this annotation

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

runpodctl/reference/runpodctl-update.mdx#L1

Try to keep the SMOG grade (10.86) below 10.

Check warning on line 1 in runpodctl/reference/runpodctl-update.mdx

View check run for this annotation

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

runpodctl/reference/runpodctl-update.mdx#L1

Try to keep the Coleman–Liau Index grade (11.29) below 9.
title: "update"
sidebarTitle: "update"
---

Update `runpodctl` to the latest version to access new features and bug fixes.

Check warning on line 6 in runpodctl/reference/runpodctl-update.mdx

View check run for this annotation

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

runpodctl/reference/runpodctl-update.mdx#L6

Avoid time-based words like 'latest' in product documentation.

<RequestExample>
```bash Command
Expand All @@ -13,7 +13,7 @@

## Description

The `update` command downloads and installs the latest version of `runpodctl`. After updating, verify the installation with [`runpodctl version`](/runpodctl/reference/runpodctl-version).
The `update` command downloads the latest version of `runpodctl` and verifies it against its SHA-256 checksum before replacing the installed binary. Verification always runs. If it fails, the update aborts and leaves your existing binary in place. After updating, verify the installation with [`runpodctl version`](/runpodctl/reference/runpodctl-version).

Check warning on line 16 in runpodctl/reference/runpodctl-update.mdx

View check run for this annotation

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

runpodctl/reference/runpodctl-update.mdx#L16

Avoid time-based words like 'latest' in product documentation.

Check warning on line 16 in runpodctl/reference/runpodctl-update.mdx

View check run for this annotation

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

runpodctl/reference/runpodctl-update.mdx#L16

Spell out 'SHA', if it's unfamiliar to the audience.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

PR #303 added self-update checksum verification in cmd/update.go: the update command downloads the release archive and its checksums_<version>_sha256.txt asset (via DownloadBytes/findAsset), then calls verifyArchiveChecksum (verifyFileChecksum, using stdlib crypto/sha256) before extracting/installing the new binary. Verification always runs (no flag or env var to skip it); on failure (missing checksum asset, malformed digest, or mismatch) the update returns an error before the existing binary is replaced.

Source: https://github.com/runpod/runpodctl/blob/c05a2bb71b5cf736b0477e0531f66027dc88cfc6/cmd/update.go#L289


## Related commands

Expand Down
Loading