Raycast Manual
Raycast Manual
Build your own Extensions

Build your own Extensions

πŸ‘‰πŸ» πŸ‘€ https://developers.raycast.com/

Overview

Our developer API is designed to let you extend and customize your Raycast experience, turning the launcher into a powerful, personalized productivity hub. Our API provides the tools for to do this by building your own extensions or by contributing to extensions that have been built by others.

A few helpful links to get you started:

  • Test and publish a macOS extension to the Windows store
  • Create Your First Extension | Raycast APICreate Your First Extension | Raycast API
  • Contribute to an Extension | Raycast APIContribute to an Extension | Raycast API
image
image

What is not yet available on Windows

Our extensions API is almost complete . Some features listed in the API docs may not be fully functional yet. The remaining functionality will be released soon. The most notable missing items are:

  • API
    • AI extensions
    • Menu bar commands

Publish macOS extensions to the Windows store

We’ve intentionally chosen to release only extensions that we’ve tested and verified ourselves. That said, many extensions built by our macOS community likely already work on Windows. For these, we’d love your help in testing and publishing the ones that are most useful or interesting to you. This helps us keep quality standards high. Most extensions that aren’t clearly macOS-specific should work on Windows as well, especially those that rely on web APIs. You can find details on all of our extensions on our store page and in our Github extensions repo.

image

How to test an existing extension and publish it to the store

  • You can browse details on all of our extensions on our store page.
  • To test a macOS only extension, the easiest is to use the Forked Extensions extension built by an engineer in our community. Here you can search for the extension that you want to test and fork it.
  • You will then need to open the extension in your terminal and run npm install and then npm run dev
  • This will then appear as a development command in Raycast.
  • Once you have tested the extension, made changes if needed, and verified that it works wells, you can publish it to the Windows store by updating the package.json to ensure it has a platforms field with ["Windows", "macOS"] as its value.
image
image
SlackXInstagram