Update from code changes: runpodctl agent-friendly output - #756
Open
mintlify[bot] wants to merge 1 commit into
Open
Update from code changes: runpodctl agent-friendly output#756mintlify[bot] wants to merge 1 commit into
mintlify[bot] wants to merge 1 commit into
Conversation
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
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.
Summary
Document the new agent-friendly output introduced in runpodctl v2: GPU pricing plus per-data-center availability on
gpu list, ready-to-call invoke URLs onserverless create/get/list, and the CLI-wide JSON error contract with stablecodevalues.Changes
runpodctl/reference/runpodctl-gpu.mdx: Updated thegpu listexample to includesecurePricePerHrandcommunityPricePerHr(nullable when a cloud type does not offer the GPU) and the newdataCenterAvailabilityarray. Added an output-fields section explainingstockStatus(best overall),available, and the "offered here, out of stock" vs. "not offered here" distinction.runpodctl/reference/runpodctl-serverless.mdx: Added an "Invoke URLs in command output" section showing the newurlsobject (run,runsync,health) emitted byserverless create/get/list, noting the URLs are computed client-side and thatRUNPOD_INVOKE_URLtargets a non-production invoke host.runpodctl/overview.mdx: Added a new "Output format" section covering the JSON-by-default contract, the[]empty-result behavior fortemplate searchandhub search, the flat JSON error shape on stderr with the stablecodevocabulary (usage_error,not_found,no_credentials,network_error,cli_error, and REST/GraphQL-derived codes), the exit-code behavior change formodel,update,send, andreceive, and an environment variables table including the newRUNPOD_INVOKE_URL.Context
Follows the upstream runpodctl PR that introduced the agent-friendly output shape (CON-683, CON-684, CON-685).