-
Notifications
You must be signed in to change notification settings - Fork 39
docs: Add Runpod Codex Skill to community solutions #642
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
promptless
wants to merge
3
commits into
main
Choose a base branch
from
promptless/add-runpod-codex-skill
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,89 @@ | ||
| --- | ||
| title: Runpod Codex Skill | ||
| sidebar_label: Runpod Codex Skill | ||
| description: A comprehensive Codex skill for AI coding agents working with Runpod infrastructure | ||
| icon: "robot" | ||
| --- | ||
|
|
||
| GitHub repository: [github.com/vavo/runpod-skill](https://github.com/vavo/runpod-skill) | ||
|
|
||
| Runpod Codex Skill is a skill set designed for AI coding agents like OpenAI Codex. It provides structured guidance and tooling so agents can work with Runpod infrastructure without relying on stale documentation or incomplete knowledge. | ||
|
|
||
| The skill covers Serverless workers, Pods, Flash SDK, Public Endpoints, `runpodctl`, MCP, Python SDK, REST, GraphQL, storage, and debugging. It includes a docs helper script that searches and fetches current Runpod documentation directly. | ||
|
|
||
| ## What it covers | ||
|
|
||
| The skill provides comprehensive guidance across the Runpod platform: | ||
|
|
||
| - Serverless workers, handlers, endpoint jobs, local testing, Docker packaging, cold starts, logs, model caching, vLLM, and worker fitness checks. | ||
| - Pods, templates, exposed ports, SSH, persistent storage, network volumes, billing guardrails, and `runpodctl` workflows. | ||
| - Flash SDK and CLI workflows including `runpod_flash`, `Endpoint`, local dev, deployment, app environments, custom containers, and storage. | ||
| - Public Endpoints model APIs for hosted image, video, audio, and text models with model-page lookup. | ||
| - Runpod MCP setup and operation notes for Codex-compatible infrastructure management. | ||
| - Python SDK usage for endpoint requests, worker patterns, and API key handling. | ||
| - REST OpenAPI and GraphQL routing including the GraphQL spec at `https://graphql-spec.runpod.io`. | ||
|
|
||
| ## Why use a Codex skill? | ||
|
|
||
| Most AI agent guidance only covers parts of Runpod: a handler example here, a CLI command there. This skill ties everything together so Codex knows which tool to use, where to look up current docs, and how to avoid stale assumptions when making infrastructure changes. It favors live documentation over hardcoded values that can drift out of date. | ||
|
|
||
| ## Installation | ||
|
|
||
| Copy the skill folder into your Codex skills directory: | ||
|
|
||
| ```bash | ||
| mkdir -p "${CODEX_HOME:-$HOME/.codex}/skills" | ||
| rsync -a runpod/ "${CODEX_HOME:-$HOME/.codex}/skills/runpod/" | ||
| ``` | ||
|
|
||
| ## Usage | ||
|
|
||
| Invoke the skill explicitly in your prompts: | ||
|
|
||
| ```bash | ||
| $runpod deploy and troubleshoot this Serverless worker | ||
| $runpod check this Dockerfile before I push it to Runpod | ||
| $runpod use Public Endpoints to call the current Flux Dev model | ||
| ``` | ||
|
|
||
| ## Docs helper script | ||
|
|
||
| The skill includes a helper script that searches and fetches current Runpod documentation: | ||
|
|
||
| ```bash | ||
| # Search for topics | ||
| python runpod/scripts/runpod_docs.py search serverless handler | ||
| python runpod/scripts/runpod_docs.py search public endpoints models | ||
|
|
||
| # Fetch specific pages | ||
| python runpod/scripts/runpod_docs.py page flash/create-endpoints | ||
|
|
||
| # Get OpenAPI spec | ||
| python runpod/scripts/runpod_docs.py openapi --output /tmp/runpod-openapi.json | ||
| ``` | ||
|
|
||
| ## Repository structure | ||
|
|
||
| ``` | ||
| runpod/ | ||
| ├── SKILL.md | ||
| ├── agents/openai.yaml | ||
| ├── references/ | ||
| │ ├── doc-map.md | ||
| │ ├── flash.md | ||
| │ ├── graphql.md | ||
| │ ├── pods-cli-api.md | ||
| │ ├── public-endpoints.md | ||
| │ ├── runpodctl.md | ||
| │ └── serverless.md | ||
| └── scripts/ | ||
| └── runpod_docs.py | ||
| ``` | ||
|
|
||
| ## Related documentation | ||
|
|
||
| - [Serverless overview](/serverless/overview) | ||
| - [Pods overview](/pods/overview) | ||
| - [Flash overview](/flash/overview) | ||
| - [Public endpoints overview](/public-endpoints/overview) | ||
| - [Python SDK](/serverless/endpoints/sdk/python) | ||
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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
All content sourced from the project's
README.md, including installation commands, usage examples, repository structure, and the docs helper script commands.Source: https://github.com/vavo/runpod-skill