Repository navigation
docs(runpodctl): bring the CLI reference up to runpodctl v3.1.1 - #971
Open
lukepiette wants to merge 1 commit into
Open
lukepiette wants to merge 1 commit into
lukepiette wants to merge 1 commit into
Conversation
Compared every reference page against the command tree and flags of a runpodctl v3.1.1 build. - serverless: add run, status, health, logs, env and model-status; replace the update flags the CLI no longer accepts (--scaler-type, --scaler-value, --flash-boot, --execution-timeout) with --scale-by, --scale-threshold, --model-reference and --clear-models; add --wait and --wait-timeout to create - pod: add logs; add --wait, --wait-for and --wait-timeout to create - network-volume: add upload and download - ssh: add forget - doctor: add --api-key and the stdin form - update: add --check - config: mark as deprecated Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Automations to automatically generate PRs for you. |
lukepiette
marked this pull request as ready for review
November 14, 2026 20:42
lavanya-gunreddi
approved these changes
Nov 15, 2026
This branch was successfully deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
The CLI reference is behind the shipped CLI. I built runpodctl v3.1.1 (the latest release) from source, dumped its full command tree and flags from
--help, and compared it with every page underrunpodctl/reference/.Commands that had no documentation
serverless runserverless statusserverless healthserverless logsserverless envserverless model-statuspod logsnetwork-volume upload,downloadssh forgetFlags that were wrong or missing
serverless update: the page listed--scaler-type,--scaler-value,--flash-boot, and--execution-timeout. v3.1.1 rejects all four as unknown flags. It accepts--scale-by,--scale-threshold,--model-reference, and--clear-models, which are now documented.serverless create: added--waitand--wait-timeout.pod create: added--wait,--wait-for, and--wait-timeout.doctor: added--api-keyand the stdin form for CI.update: added--check.config: the CLI lists it as deprecated, so the page now says so and points todoctorandRUNPOD_API_KEY.How it was tested
serverless update --scaler-typeand--flash-bootreturnunknown flag.serverless runrejects non-JSON and non-object payloads, requires--inputor--input-file, and refuses--no-waitwith--wait.serverless statusrequires both an endpoint ID and a job ID.pod logsvalidates--tail(0 to 5000),--source, and--since.pod create --wait-foraccepts onlysshorrunning.network-volume uploadvalidates--concurrency(1 to 64).update --checkreports versions without installing.doctor --api-keywith a bad key exits non-zero and doesn't save it.Not tested
No API key was available in this environment, so nothing ran against a real account. The output shapes (the JSON lines from
logs, thehealthpayload, job payloads fromrun) and exit codes on real jobs are written from the CLI's own help text, not observed.Not in this PR
runpodctl model(the Model Repository commands) has no reference page at all.model addalone has 17 flags, so it deserves its own page.network-volume uploadanddownload(v3.1.0) are marked, from the changelog.🤖 Generated with Claude Code