raycast-extensions
Build and maintain Raycast extensions using the Raycast API. Triggers on @raycast/api, List, Grid, Detail, Form, AI.ask, LocalStorage, Cache, showToast, and BrowserExtension. Use this repo's references/api/*.md files as the primary source of truth for component specs and API usage.
How do I install this agent skill?
npx skills add https://github.com/alexi-build/raycast-extensions-skill --skill raycast-extensionsIs this agent skill safe to install?
- Gen Agent Trust Hubpass
This skill provides a comprehensive knowledge base for building Raycast extensions using the Raycast API. While it identifies potential attack surfaces for indirect prompt injection where untrusted data from the clipboard or selected text is processed by AI models, no malicious code, obfuscation, or persistence mechanisms were detected. The documented functionality aligns with the stated purpose of assisting in extension development.
- Socketpass
No alerts
- Snykpass
Risk: LOW · No issues
- Runlayerpass
3/36 files flagged
What does this agent skill do?
Raycast Extensions Skill
Build powerful extensions with React, TypeScript, and the Raycast API.
Repository Conventions
- When updating
CHANGELOG.mdfor the Raycast extensions repository, always use{PR_MERGE_DATE}as the date placeholder. - Never write a literal calendar date in
CHANGELOG.md.
Quick Start (Agent Workflow)
Follow these steps when tasked with implementing or fixing Raycast features:
- Identify the core component: Determine if the UI needs a
List,Grid,Detail, orForm. - Consult Reference: Open and read the corresponding file in
references/api/(e.g.,references/api/list.md). - Use Defaults:
- Feedback: Use
showToastfor Loading/Success/Failure. UseshowHUDonly for quick background completions. - Data: Use
Cachefor frequent/transient data,LocalStoragefor persistent user data. - Access: Always check
environment.canAccess(AI)orenvironment.canAccess(BrowserExtension)before use. - Changelog: When updating
CHANGELOG.mdfor the Raycast extensions repository, always use{PR_MERGE_DATE}as the date placeholder. Never write a literal calendar date.
- Feedback: Use
- Implementation: Provide a concise implementation using
@raycast/apicomponents. - Citing: Link back to the specific
references/api/*.mdfile you used.
Cookbook Patterns
1. List & Grid (Searchable UI)
Use List for text-heavy data and Grid for image-heavy data.
<List isLoading={isLoading} searchBarPlaceholder="Search items..." throttle>
<List.Item
title="Item Title"
subtitle="Subtitle"
accessories={[{ text: "Tag" }]}
actions={
<ActionPanel>
<Action.Push title="View Details" target={<Detail markdown="# Details" />} />
<Action.CopyToClipboard title="Copy" content="value" />
</ActionPanel>
}
/>
</List>
2. Detail (Rich Markdown)
Use for displaying long-form content or item details.
<Detail
isLoading={isLoading}
markdown="# Heading\nContent here."
metadata={
<Detail.Metadata>
<Detail.Metadata.Label title="Status" text="Active" icon={Icon.Checkmark} />
</Detail.Metadata>
}
/>
3. Form (User Input)
Always include a SubmitForm action.
<Form
actions={
<ActionPanel>
<Action.SubmitForm onSubmit={(values) => console.log(values)} />
</ActionPanel>
}
>
<Form.TextField id="title" title="Title" placeholder="Enter title" />
<Form.TextArea id="description" title="Description" />
</Form>
4. Feedback & Interactivity
Prefer showToast for most feedback.
// Success/Failure
await showToast({ style: Toast.Style.Success, title: "Success!" });
// HUD (Overlay)
await showHUD("Done!");
5. Data Persistence
Use Cache for performance, LocalStorage for persistence.
// Cache (Sync/Transient)
const cache = new Cache();
cache.set("key", "value");
// LocalStorage (Async/Persistent)
await LocalStorage.setItem("key", "value");
6. AI & Browser Extension (Restricted APIs)
Always wrap in environment.canAccess checks.
if (environment.canAccess(AI)) {
const result = await AI.ask("Prompt");
}
if (environment.canAccess(BrowserExtension)) {
const tabs = await BrowserExtension.getTabs();
}
Additional Resources
API Reference Tree
- UI Components
- Interactivity
- Utilities & Services
- Data & Configuration
- Advanced
Examples
For end-to-end examples combining multiple components and APIs, see examples.md.
How can the creator link this skill?
Add the canonical catalog link to the repository README so users can inspect current installs and available audits. The publishing guide covers the complete discovery path.
<a href="https://skillzs.dev/skills/alexi-build/raycast-extensions-skill/raycast-extensions">View raycast-extensions on skillZs</a>