Rayfin

Docs • Website • Templates • Issues • Reddit

Getting Started

npm create @microsoft/rayfin@latest

This CLI scaffolds a new Rayfin project with everything you need: data models, authentication, APIs, and a ready-to-deploy app.

[!TIP] Prefer to build with a coding agent? Hand it the guided setup prompt and describe what you want to build:

copilot -i "$(curl -sSfL https://aka.ms/rayfin/start.md)"

On Windows (PowerShell):

copilot -i (irm https://aka.ms/rayfin/start.md)

This loads the Rayfin starter prompt: it checks your environment, scaffolds the bundled default app template, and helps you customize.

Agent plugin

Install the Rayfin getting-started skill through your agent's native marketplace or extension manager:

Claude Code

/plugin marketplace add microsoft/rayfin
/plugin install rayfin@rayfin-skills

Grok Build automatically reads Claude Code marketplaces.

GitHub Copilot CLI

copilot plugin marketplace add microsoft/rayfin
copilot plugin install rayfin@rayfin-skills

Codex

codex plugin marketplace add microsoft/rayfin

After adding the marketplace, install Rayfin from the Plugins Directory.

Kimi Code

/plugins marketplace https://raw.githubusercontent.com/microsoft/rayfin/main/kimi-marketplace.json

Gemini CLI

gemini extensions install https://github.com/microsoft/rayfin

Alternatively, use the cross-agent plugins CLI:

npx plugins add microsoft/rayfin

The plugin supports Claude Code, Cursor, Codex, GitHub Copilot CLI, Grok Build, Kimi Code, Visual Studio Code agent plugins, and Gemini CLI.

What is Rayfin?

Rayfin is a fully managed Backend-as-a-Service (BaaS) platform that helps teams build and ship applications faster without building or operating backend infrastructure.

With Rayfin, you define your data model using TypeScript decorators, and the platform automatically provides and manages:

• Database
• Authentication
• Data APIs
• Storage
• Hosting

So you can focus on building your application, not backend services.

npm create @microsoft/rayfin@latest    # scaffold a new project
npx rayfin up                          # deploy and run

Why Fabric?

Rayfin is built on Microsoft Fabric, which provides centralized data discovery, access control, and governance capabilities -- helping organizations manage data access, sharing, and compliance consistently across workloads.

This means your Rayfin apps inherit enterprise-grade security and governance out of the box, so you can build fast without compromising on compliance.

👉 Get started with Microsoft Fabric

Local Development (Experimental)

Rayfin supports a pure local development experience — no cloud resources required. This is currently experimental and great for trying out Rayfin or building offline.

👉 See the Todo Local Experimental template to get started.

Packages

Package	Version	Description
@microsoft/create-rayfin		Scaffold a Rayfin project with npm create @microsoft/rayfin@latest
@microsoft/rayfin-cli		CLI for scaffolding, deploying, and managing Rayfin apps
@microsoft/rayfin-core		Entity decorators, schema definitions, and core types
@microsoft/rayfin-client		Main client SDK for Rayfin services
@microsoft/rayfin-data		Type-safe client library for Data API Builder endpoints
@microsoft/rayfin-auth		Authentication utilities for Rayfin SDK
@microsoft/rayfin-auth-provider-fabric		Fabric brokered authentication provider for Rayfin SDK
@microsoft/rayfin-functions		Rayfin functions runtime
@microsoft/rayfin-storage		Type-safe client library for Rayfin storage operations
@microsoft/rayfin-lib		Shared library utilities and HTTP client foundation
@microsoft/rayfin-tools-common		Shared utilities for Rayfin tools packages
@microsoft/rayfin-docs		Rayfin docs indexing and search library
@microsoft/rayfin-guide		Cross-cutting builder guides for the Rayfin platform
@microsoft/rayfin-mcp		Rayfin Model Context Protocol tooling
@microsoft/fabric-embedded-host		PostMessage bridge and embedded mode detection for Fabric iframes

Related Repositories

Community

• 📖 Documentation
• 🏗️ Get started with Microsoft Fabric
• 🐛 Report a Bug
• ⚠️ Known Issues
• 💡 Request a Feature
• 🐟 Reddit
• 🤝 Contributing Guide

Trademarks

This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks or logos must follow the Microsoft Trademark and Brand Guidelines. Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or logos is subject to those third parties' policies.

License

MIT