| name | raycast-extension-docs |
| description | Guidance for building, debugging, and publishing Raycast extensions using the Raycast documentation set. Use when Codex needs to create or modify Raycast extensions (React/TypeScript/Node), consult Raycast API reference or UI components, build AI extensions, handle manifest/lifecycle/preferences, troubleshoot issues, or prepare/publish extensions to the Raycast Store or Teams. |
Raycast Extension Docs
Overview
Use the bundled Raycast documentation under references/ as the source of truth for APIs, patterns, and policies. Route requests to the right section, load only the needed files, and apply the guidance to the user's task.
Quick Routing
- Start with
references/SUMMARY.md to locate the right doc page.
- Use
references/README.md for the general introduction and platform overview.
- Use
references/basics/ for step-by-step guides (getting started, create, debug, publish).
- Use
references/api-reference/ for API details and component usage.
- Use
references/api-reference/user-interface/ for UI components (List, Form, Detail, Action Panel, etc.).
- Use
references/ai/ and references/api-reference/ai.md for AI extension guidance.
- Use
references/examples/ for real-world extension patterns.
- Use
references/information/ for terminology, manifest, lifecycle, file structure, best practices, tools, and security.
- Use
references/utils-reference/ for utility helpers and patterns.
- Use
references/teams/ for private/team extension workflows.
- Use
references/migration/ and references/changelog.md for version changes and breaking updates.
- Use
references/faq.md for quick clarifications.
Working Approach
- Identify the user's goal and map it to the most relevant section in
references/SUMMARY.md.
- Open the specific doc file(s) and extract only the details needed to answer or implement.
- Cross-check API usage against
references/api-reference/ and best practices in references/information/best-practices.md.
- When building UI, verify component props and patterns in
references/api-reference/user-interface/.
- When shipping or collaborating, confirm publish/team steps in
references/basics/ or references/teams/.
Notes
- Keep answers aligned with the docs; call out when guidance is inferred or when the docs are silent.
- If the user asks about behavior changes, consult
references/migration/ and references/changelog.md.