Getting Started

This guide covers the prerequisites you need to start building extensions.

System Requirements

Before you can create your first extension, make sure you have the following prerequisites.
  • You have Raycast 1.26.0 or higher installed.
  • You have Node.js 16.10 or higher installed. We recommend nvm to install Node.
  • You have npm 7.x or 8.x
  • You are familiar with React and TypeScript. Don't worry, you don't need to be an expert. If you need some help with the basics, check out TypeScript's Handbook and React's Getting Started guide.

Sign In

Opening the "Store" command in Raycast
You need to be signed in to use the following extension development commands.
  • Store: Search and install all published extensions
  • Create Extension: Create new extensions from templates
  • Import Extension: Import extensions from source code
  • Manage Extensions: List and edit your published extensions

Editor/IDE Extensions

You can enhance your extension development experience by installing extensions for common editors.
    • Intellisense for image assets
    • A treeview for easier navigation (commands and preferences)
    • VSCode commands for creating new commands and preferences
    • The possibility to attach a node.js debugger
    • VSCode command for command ray operations like build, dev, lintor fix-lint