docs: Update runpodctl documentation for v2.0#563
docs: Update runpodctl documentation for v2.0#563promptless[bot] wants to merge 9 commits intomainfrom
Conversation
![promptless[bot]](https://avatars.githubusercontent.com/in/979718?s=60&v=4){kind=small}
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
| @@ -0,0 +1,92 @@ | |||
| --- | |||
There was a problem hiding this comment.
Citation: Serverless commands documented from the Serverless (alias: sls) section in the runpodctl v2.0 SKILL.md.
View source
| @@ -0,0 +1,37 @@ | |||
| --- | |||
There was a problem hiding this comment.
Citation: New doctor command for first-time setup documented from the Utilities section in SKILL.md.
View source
| @@ -0,0 +1,58 @@ | |||
| --- | |||
There was a problem hiding this comment.
Citation: GPU listing commands documented from the Info section in SKILL.md.
View source
| ```bash | ||
| runpodctl pod create --template-id runpod-torch-v21 --gpu-id "NVIDIA RTX 4090" | ||
| ``` | ||
|
|
There was a problem hiding this comment.
Citation: New filtering flags (--all, --status, --since, --created-after) and default behavior change (showing only running pods) based on changes in cmd/pod/list.go. Also removed deprecated --include-machine and --include-network-volume flags from internal/api/pods.go.
View source
|
|
||
| </Tab> | ||
|
|
||
| <Tab title="Windows"> |
There was a problem hiding this comment.
Citation: PR #235 adds aarch64/arm64 support for Linux in the install.sh script. The URL pattern runpodctl-linux-arm64 follows the new goreleaser naming convention from this PR.
View source
| ```sh | ||
| ```bash | ||
| brew install runpod/runpodctl/runpodctl | ||
| ``` |
There was a problem hiding this comment.
Citation: Install script improvements from PR #249 (install.sh). The PR updates the script to support non-root installs by using POSIX tools (grep/sed) instead of jq, auto-detects the install directory based on root status, and provides Homebrew priority on macOS.
View source
There was a problem hiding this comment.
(Line 81)
Citation: Non-root installation method from PR #249. The updated install.sh uses tiered path discovery to install to ~/.local/bin, ~/bin, or ~/.bin when running without root access, and displays instructions for adding the directory to PATH.
View source
|
|
||
| ## Description | ||
|
|
||
| The `update` command downloads and installs the latest version of `runpodctl`. After updating, verify the installation with [`runpodctl version`](/runpodctl/reference/runpodctl-version). |
There was a problem hiding this comment.
Citation: PR #254 adds the "already up to date" message in cmd/update.go. When semver.Compare("v"+version, latestVersion) >= 0, the command now prints runpodctl %s is already up to date instead of silently exiting.
View source
|
|
||
| ```sh | ||
| ```bash | ||
| runpodctl version |
There was a problem hiding this comment.
Citation: Added conda/mamba/pixi installation tab based on PR #257 which made runpodctl available on conda-forge. The contributor packaged runpodctl for conda-forge with pre-built binaries for Linux (x86_64, aarch64, ppc64le), macOS (x86_64, arm64), and Windows (x86_64).
View source
| Enable SSH on the Pod. | ||
| </ResponseField> | ||
|
|
||
| ### Start a Pod |
There was a problem hiding this comment.
Citation: Based on the new --network-volume-id flag added in cmd/pod/create.go. The flag is supported for both GPU pods (GraphQL path) and CPU pods (REST path) as verified in the PR's e2e tests.
View source
| Comma-separated list of preferred datacenter IDs. Use [`runpodctl datacenter list`](/runpodctl/reference/runpodctl-datacenter) to see available datacenters. | ||
| </ResponseField> | ||
|
|
||
| ### Update an endpoint |
There was a problem hiding this comment.
Citation: Based on the new --network-volume-id flag added in cmd/serverless/create.go. The flag allows attaching network volumes when creating Serverless endpoints via the REST API path.
View source
| Create a new Pod from a template: | ||
|
|
||
| ```bash | ||
| runpodctl pod create --template-id runpod-torch-v21 --gpu-id "NVIDIA RTX 4090" |
There was a problem hiding this comment.
Citation: Fixed GPU ID from "NVIDIA RTX 4090" to "NVIDIA GeForce RTX 4090" based on PR #260 which corrects the pod create help examples in the CLI. The incorrect ID causes pod creation to fail silently with "no instances available".
View source
1 participant
Open this suggestion in Promptless to view citations and reasoning process
Comprehensive update of the Runpod CLI documentation for version 2.0. Adds new reference pages for all command groups (pod, serverless, template, network-volume, model, registry, gpu, datacenter, billing, user, ssh, doctor), updates the overview with a quick start guide, and adds redirects for backward compatibility with old v1.x URLs.
Trigger Events
Internal discussion about updating runpodctl documentation based on recent changes to the skill file and source code.
Promptless Research (9 files, 2 webpages)
.long_term_context/product_knowledge/product_overview.md.long_term_context/doc_workflow/client_instructions.md.long_term_context/style/client_style_guide.mdrunpodctl/overview.mdxrunpodctl/manage-pods.mdxrunpodctl/transfer-files.mdxrunpodctl/reference/runpodctl-create-pod.mdxrunpodctl/reference/runpodctl-get-pod.mdxdocs.jsonAgent Response
Tip: Attach PDFs in Slack messages to Promptless—it can even extract images from them 📎