Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions community-solutions/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,14 @@ Explore these community-created tools that can enhance your Runpod workflow:
>
Web-based GUI for easy file browsing, uploading, downloading, and media viewing on Runpod without complex command-line operations.
</Card>

<Card horizontal
title="Runpod Codex Skill"
icon="robot"
href="/community-solutions/runpod-codex-skill"
>
A skill set for AI coding agents like OpenAI Codex, providing structured guidance and tooling so agents can work with Runpod infrastructure using current documentation.
</Card>
</CardGroup>

Browse through our community tools section in the sidebar for detailed documentation on each tool's purpose, installation, and usage.
Expand Down
89 changes: 89 additions & 0 deletions community-solutions/runpod-codex-skill.mdx
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)
Copy link
Copy Markdown
Contributor Author

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


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)
3 changes: 2 additions & 1 deletion docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -377,7 +377,8 @@
"community-solutions/ohmyrunpod/overview",
"community-solutions/ssh-password-migration/overview",
"community-solutions/copyparty-file-manager/overview",
"community-solutions/runpod-network-volume-storage-tool"
"community-solutions/runpod-network-volume-storage-tool",
"community-solutions/runpod-codex-skill"
]
},
{
Expand Down
Loading