Skip to content

docs(runpodctl): bring the CLI reference up to runpodctl v3.1.1 - #971

Open
lukepiette wants to merge 1 commit into
mainfrom
docs/runpodctl-reference-v3-1
Open

lukepiette wants to merge 1 commit into
mainfrom
docs/runpodctl-reference-v3-1

Conversation

@lukepiette

Copy link
Copy Markdown
Contributor

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 under runpodctl/reference/.

Commands that had no documentation

Command What it does
serverless run Send a request and wait for the job
serverless status Check a submitted job
serverless health Worker and job counts
serverless logs Read worker logs
serverless env Show env overrides set on the endpoint
serverless model-status Diagnose a cached model that won't load
pod logs Read container and system logs
network-volume upload, download Resumable file transfer over the S3-compatible API (v3.1.0+)
ssh forget Drop a Pod's recorded host key

Flags 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 --wait and --wait-timeout.
  • pod create: added --wait, --wait-for, and --wait-timeout.
  • doctor: added --api-key and the stdin form for CI.
  • update: added --check.
  • config: the CLI lists it as deprecated, so the page now says so and points to doctor and RUNPOD_API_KEY.

How it was tested

  • A script compares each documented subcommand's flags with the v3.1.1 binary. After this change it reports no real differences.
  • I ran the binary to confirm the behavior the new text describes, without credentials:
    • serverless update --scaler-type and --flash-boot return unknown flag.
    • serverless run rejects non-JSON and non-object payloads, requires --input or --input-file, and refuses --no-wait with --wait.
    • serverless status requires both an endpoint ID and a job ID.
    • pod logs validates --tail (0 to 5000), --source, and --since.
    • pod create --wait-for accepts only ssh or running.
    • network-volume upload validates --concurrency (1 to 64).
    • update --check reports versions without installing.
    • doctor --api-key with 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, the health payload, job payloads from run) 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 add alone has 17 flags, so it deserves its own page.
  • Version floors for the older commands. Only network-volume upload and download (v3.1.0) are marked, from the changelog.

🤖 Generated with Claude Code

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>
@mintlify

mintlify Bot commented Nov 14, 2026 •

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated
runpod-docs 🟢 Ready View Preview Nov 14, 2026, 8:08 PM

💡 Tip: Enable Automations to automatically generate PRs for you.

This branch was successfully deployed

1 active deployment
staging — 88906317 Deployed Nov 14, 2026 by mintlify[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants