raycast

name	raycast
description	Build, configure, debug, publish, and maintain Raycast extensions with the Raycast API. Use when working with @raycast/api, @raycast/utils, extension manifests, commands, tools, UI components, AI extensions, Raycast Store publishing, or Raycast Teams/private extensions.

Raycast

Raycast extensions are built with TypeScript, React, Node.js, @raycast/api, and optional @raycast/utils helpers.

When working on a Raycast extension, read the relevant local reference first. The files in references/ are a cleaned Markdown mirror of the Raycast developer docs.

Common tasks

• Create a new extension: basics/create-your-first-extension.md
• Understand extension structure and manifest: information/file-structure.md
• Develop/debug/lint/build with the CLI: information/developer-tools/cli.md
• Prepare and publish to the Store: basics/prepare-an-extension-for-store.md
• Build lists, forms, detail views, and actions: api-reference/user-interface.md
• Use AI in extensions: ai/getting-started.md
• Use utilities and React hooks: utilities/getting-started.md
• Find any page: documentation map

Reference sections

Raycast API

• Introduction — Start building your perfect tools with the Raycast API.

Basics

• Getting Started — This guide covers the prerequisites you need to start building extensions.
• Create Your First Extension — Learn how to build your first extension and use it in Raycast.
• Contribute to an Extension — Learn how to import an extension to collaborate with others.
• Prepare an Extension for Store — Learn how to get through review process quickly
• Publish an Extension — Learn how to share your extension with our community.
• Debug an Extension — This guide covers how to find and fix bugs in your extension.
• Install an Extension — Learn how to find and use extensions from the Raycast Store.
• Review an Extension in a Pull Request — Learn how to review a contribution from a Pull Request opened by a contributor.

AI Extensions

• Getting Started — This guide explains how to use AI inside extensions.
• Create an AI Extension — Learn how to turn a regular extension into an AI-powered one.
• Learn Core Concepts of AI Extensions — Get to know the core concepts of AI extensions.
• Write Evals for Your AI Extension — Make your AI Extension more reliable by writing evals.
• Follow Best Practices for AI Extensions — Make the most out of your AI Extension by following best practices.

Teams

• Getting Started — This guide sets you up with Raycast for Teams.
• Publish a Private Extension — Learn how to share an extension in your organization's private extension store
• Collaborate on Private Extensions — This guide explains how to collaborate with your team on extensions.

Examples

• Doppler Share Secrets — This example uses a simple form to collect data.
• Hacker News — This example shows how to show an RSS feed as a List.
• Todo List — This example show how to use lists in combination with forms.
• Spotify Controls — This example shows how to bundle multiple scripts into a single extension.

Information

• Terminology — An explanation of various terms used in this documentation.
• File Structure — Understand the file structure of an extension.
• Manifest
• Lifecycle
• Arguments
• Background Refresh
• Deeplinks
• Best Practices — Tips to guarantee a good user experience for your extensions.
• Developer Tools
• Manage Extensions Command — A Raycast command to manage your extensions, add new commands or attachments, etc.
• CLI — The Raycast CLI allows you to build, develop, and lint your extension.
• ESLint
• Forked Extensions (community tool)
• VS Code (community tool)
• Templates — Learn about the templates provided by Raycast to help kickstart your extension.
• Security
• Versioning

API Reference

• AI
• Browser Extension
• Cache
• Command
• Clipboard
• Environment
• Feedback
• Alert
• HUD
• Toast
• Keyboard
• Menu Bar Commands
• OAuth
• Preferences
• Storage
• System Utilities
• User Interface
• Action Panel
• Actions
• Detail
• Form
• List — The de-facto user interface in Raycast. Ideal to present similar data such as to-dos or files.
• Grid
• Colors
• Icons & Images
• Navigation
• Raycast Window & Search Bar
• Tool
• Window Management

Utilities

• Getting Started
• Functions
• createDeeplink
• executeSQL
• runAppleScript
• runPowerShellScript
• showFailureToast
• withCache
• Icons
• getAvatarIcon
• getFavicon
• getProgressIcon
• OAuth Utils
• OAuthService
• withAccessToken
• getAccessToken
• Getting a Google client ID
• React hooks
• useCachedState
• usePromise
• useCachedPromise
• useFetch
• useForm
• useExec
• useSQL
• useAI
• useFrecencySorting
• useStreamJSON
• useLocalStorage

Misc

• Changelog
• Migration
• v1.28.0
• v1.31.0
• v1.37.0
• v1.42.0
• v1.48.8
• v1.50.0
• v1.51.0
• v1.59.0
• FAQ — Answers to the most frequently asked questions.