How the Raycast API Documentation Is Organized

Updated

The Raycast developer documentation at developers.raycast.com is organized into six top-level sections: Basics, Teams, Examples, Information, API Reference, and Utilities. Where you start depends on what you're trying to do — building your first extension, sharing one with a team, or looking up a specific API detail. The docs cover guides, examples, and references for building extensions with React, Node.js, and TypeScript, and for publishing them to the Raycast Store.

Section-by-section breakdown

Section What it's for Go here when
Basics Step-by-step guides for building extensions You're new and want a guided path from zero to a working extension
Teams Building and sharing extensions with teammates You want to speed up common workflows inside your team rather than publish publicly
Examples Open-source starting points You learn better by reading and modifying working code
Information Background knowledge about the platform You want to understand how the platform works before or while building
API Reference Detailed reference with code snippets You know what you want to build and need exact signatures and usage
Utilities Utilities that streamline common patterns and operations You're repeating a common pattern and want the supported shortcut

How the platform itself is split

The docs describe the Raycast Platform as two parts, which is worth keeping in mind because it explains why some sections exist:

  • API — lets you build extensions with React, Node.js, and TypeScript.
  • Store — lets you share your extensions with all Raycast users. Publishing is covered in the docs.

So "building" and "distributing" are separate concerns, and the section list reflects that.

What makes the ecosystem distinctive

The introduction highlights a few points that shape how you'll work:

  • Familiar tooling — extensions use TypeScript, React, and Node, so you can pull from the npm ecosystem.
  • Built-in UI components — you handle logic, the platform handles pixels, and your extension stays visually consistent with others.
  • Strongly typed API with hot-reloading — the developer experience is treated as a first-class concern.
  • Flexible scope — you can start with a simple script, add a static UI, or go further with React.

Practical entry points

  • For the complete documentation index, the docs point to llms.txt.
  • Individual pages are also available as Markdown, which is useful if you want to pull content into your own tooling or notes.
  • If you're deciding between reading and building, the Examples section is the fastest way to see a real extension structure before committing to the Basics guides.

The docs were last updated 2 years ago, so treat version-specific details in the API Reference as the authoritative source over any prose description.