# microsoft/rayfin architecture

> Architecture diagram of the GitHub repository microsoft/rayfin, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-18). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/microsoft/rayfin
- Repository: https://github.com/microsoft/rayfin

## Overview

Rayfin is a managed backend platform whose repository includes its CLI, shared tooling, and TypeScript SDKs. The main builder workflow is to scaffold a project, configure its backend, then deploy or run it; SDKs provide application access to services such as data and storage. The README documents platform capabilities, while source excerpts show several CLI implementation details. Links for unsampled subsystems are limited to documented relationships.

Main entry points: [`packages/tools/cli/src/root-command.ts`](https://github.com/microsoft/rayfin/blob/main/packages/tools/cli/src/root-command.ts) (CLI Commands), [`packages/typescript-sdk/client/src/client.ts`](https://github.com/microsoft/rayfin/blob/main/packages/typescript-sdk/client/src/client.ts) (Rayfin Client), [`packages/tools/cli/src/utils/storage-config-generator.ts`](https://github.com/microsoft/rayfin/blob/main/packages/tools/cli/src/utils/storage-config-generator.ts) (Storage Configuration), [`packages/tools/cli/src/utils/scaffold-pipeline.ts`](https://github.com/microsoft/rayfin/blob/main/packages/tools/cli/src/utils/scaffold-pipeline.ts) (Project Scaffolding)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_cli["Builder CLI"]
  node_cli_entry["CLI Commands<br/>[root-command.ts]"]
  node_scaffold["Project Scaffolding"]
  node_deployment["Deploy and Manage"]
  node_localdev["Local Development"]
  node_storage_config["Storage Configuration"]
  node_storage_apply["Storage Apply<br/>[storage-apply.ts]"]
  node_agent_files["Agent Integrations<br/>[manager.ts]"]
end

subgraph group_services["Backend Services"]
  node_connector_discovery["Connector Discovery"]
  node_fabric["Fabric Services"]
  node_managed_backend["Managed Backend"]
  node_database[("Database")]
  node_authentication["Authentication"]
  node_data_api["Data APIs"]
  node_storage_service["Storage Service"]
  node_hosting["Hosting"]
end

subgraph group_sdk["Application SDKs"]
  node_sdk_client["Rayfin Client<br/>[client.ts]"]
  node_sdk_data["Data SDK"]
  node_sdk_storage["Storage SDK"]
  node_storage_schema["Storage Schema"]
  node_sdk_auth["Auth SDK<br/>[Auth.ts]"]
  node_sdk_functions["Functions SDK<br/>[FunctionClient.ts]"]
end

subgraph group_tooling["Shared Tooling"]
  node_templates["Template Engine"]
end

node_builder(("Builder"))

node_builder -->|"runs"| node_cli_entry
node_cli_entry -->|"scaffolds"| node_scaffold
node_scaffold -->|"instantiates"| node_templates
node_builder -->|"deploys with"| node_deployment
node_deployment -->|"provisions"| node_managed_backend
node_builder -->|"develops locally"| node_localdev
node_cli_entry -->|"generates"| node_storage_config
node_cli_entry -->|"applies"| node_storage_apply
node_storage_apply -->|"reads config"| node_storage_config
node_storage_config -.->|"analyzes folders"| node_storage_schema
node_cli_entry -.->|"manages connectors"| node_connector_discovery
node_cli_entry -->|"manages files"| node_agent_files
node_connector_discovery -->|"queries catalog"| node_fabric
node_managed_backend -->|"provides"| node_database
node_managed_backend -->|"provides"| node_authentication
node_managed_backend -->|"provides"| node_data_api
node_managed_backend -->|"provides"| node_storage_service
node_managed_backend -->|"provides"| node_hosting
node_builder -->|"uses"| node_sdk_client
node_sdk_client -.->|"supports data access"| node_sdk_data
node_sdk_client -.->|"supports storage access"| node_sdk_storage
node_sdk_client -.->|"supports authentication"| node_sdk_auth
node_sdk_client -.->|"supports functions"| node_sdk_functions
node_sdk_data -->|"queries"| node_data_api
node_sdk_storage -->|"operates on"| node_storage_service
node_sdk_auth -->|"authenticates"| node_authentication

click node_cli_entry "https://github.com/microsoft/rayfin/blob/main/packages/tools/cli/src/root-command.ts"
click node_scaffold "https://github.com/microsoft/rayfin/blob/main/packages/tools/cli/src/utils/scaffold-pipeline.ts"
click node_templates "https://github.com/microsoft/rayfin/tree/main/packages/tools/common/src/templates"
click node_deployment "https://github.com/microsoft/rayfin/tree/main/packages/tools/cli/src/commands/up"
click node_localdev "https://github.com/microsoft/rayfin/tree/main/packages/tools/common/src/workflows/dev"
click node_storage_config "https://github.com/microsoft/rayfin/blob/main/packages/tools/cli/src/utils/storage-config-generator.ts"
click node_storage_apply "https://github.com/microsoft/rayfin/blob/main/packages/tools/cli/src/utils/storage-apply.ts"
click node_connector_discovery "https://github.com/microsoft/rayfin/tree/main/packages/tools/cli/src/services/connectors/discovery"
click node_agent_files "https://github.com/microsoft/rayfin/blob/main/packages/tools/cli/src/services/agent-files/manager.ts"
click node_fabric "https://github.com/microsoft/rayfin/tree/main/packages/tools/cli/src/services/fabric"
click node_authentication "https://github.com/microsoft/rayfin/tree/main/packages/tools/common/src/services/auth"
click node_data_api "https://github.com/microsoft/rayfin/tree/main/packages/tools/common/src/services/data"
click node_storage_service "https://github.com/microsoft/rayfin/tree/main/packages/tools/common/src/services/storage"
click node_hosting "https://github.com/microsoft/rayfin/tree/main/packages/tools/common/src/services/static-hosting"
click node_sdk_client "https://github.com/microsoft/rayfin/blob/main/packages/typescript-sdk/client/src/client.ts"
click node_sdk_data "https://github.com/microsoft/rayfin/blob/main/packages/typescript-sdk/data/src/graphql/GraphQLQueryBuilder.ts"
click node_sdk_storage "https://github.com/microsoft/rayfin/blob/main/packages/typescript-sdk/storage/src/StorageFolderClient.ts"
click node_storage_schema "https://github.com/microsoft/rayfin/blob/main/packages/typescript-sdk/core/src/analysis/storage-config-generator.ts"
click node_sdk_auth "https://github.com/microsoft/rayfin/blob/main/packages/typescript-sdk/auth/src/Auth.ts"
click node_sdk_functions "https://github.com/microsoft/rayfin/blob/main/packages/typescript-sdk/functions/src/FunctionClient.ts"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_cli_entry,node_scaffold,node_deployment,node_localdev,node_storage_config,node_storage_apply,node_agent_files toneBlue
class node_connector_discovery,node_fabric,node_managed_backend,node_database,node_authentication,node_data_api,node_storage_service,node_hosting toneAmber
class node_sdk_client,node_sdk_data,node_sdk_storage,node_storage_schema,node_sdk_auth,node_sdk_functions toneMint
class node_templates toneRose
class node_builder toneIndigo
```

## Components

### Builder CLI

- [CLI Commands](https://github.com/microsoft/rayfin/blob/main/packages/tools/cli/src/root-command.ts): `packages/tools/cli/src/root-command.ts`
- [Project Scaffolding](https://github.com/microsoft/rayfin/blob/main/packages/tools/cli/src/utils/scaffold-pipeline.ts): `packages/tools/cli/src/utils/scaffold-pipeline.ts`
- [Deploy and Manage](https://github.com/microsoft/rayfin/tree/main/packages/tools/cli/src/commands/up): `packages/tools/cli/src/commands/up`
- [Local Development](https://github.com/microsoft/rayfin/tree/main/packages/tools/common/src/workflows/dev): `packages/tools/common/src/workflows/dev`
- [Storage Configuration](https://github.com/microsoft/rayfin/blob/main/packages/tools/cli/src/utils/storage-config-generator.ts): `packages/tools/cli/src/utils/storage-config-generator.ts`
- [Storage Apply](https://github.com/microsoft/rayfin/blob/main/packages/tools/cli/src/utils/storage-apply.ts): `packages/tools/cli/src/utils/storage-apply.ts`
- [Agent Integrations](https://github.com/microsoft/rayfin/blob/main/packages/tools/cli/src/services/agent-files/manager.ts): `packages/tools/cli/src/services/agent-files/manager.ts`

### Backend Services

- [Connector Discovery](https://github.com/microsoft/rayfin/tree/main/packages/tools/cli/src/services/connectors/discovery): `packages/tools/cli/src/services/connectors/discovery`
- [Fabric Services](https://github.com/microsoft/rayfin/tree/main/packages/tools/cli/src/services/fabric): `packages/tools/cli/src/services/fabric`
- **Managed Backend**
- **Database**
- [Authentication](https://github.com/microsoft/rayfin/tree/main/packages/tools/common/src/services/auth): `packages/tools/common/src/services/auth`
- [Data APIs](https://github.com/microsoft/rayfin/tree/main/packages/tools/common/src/services/data): `packages/tools/common/src/services/data`
- [Storage Service](https://github.com/microsoft/rayfin/tree/main/packages/tools/common/src/services/storage): `packages/tools/common/src/services/storage`
- [Hosting](https://github.com/microsoft/rayfin/tree/main/packages/tools/common/src/services/static-hosting): `packages/tools/common/src/services/static-hosting`

### Application SDKs

- [Rayfin Client](https://github.com/microsoft/rayfin/blob/main/packages/typescript-sdk/client/src/client.ts): `packages/typescript-sdk/client/src/client.ts`
- [Data SDK](https://github.com/microsoft/rayfin/blob/main/packages/typescript-sdk/data/src/graphql/GraphQLQueryBuilder.ts): `packages/typescript-sdk/data/src/graphql/GraphQLQueryBuilder.ts`
- [Storage SDK](https://github.com/microsoft/rayfin/blob/main/packages/typescript-sdk/storage/src/StorageFolderClient.ts): `packages/typescript-sdk/storage/src/StorageFolderClient.ts`
- [Storage Schema](https://github.com/microsoft/rayfin/blob/main/packages/typescript-sdk/core/src/analysis/storage-config-generator.ts): `packages/typescript-sdk/core/src/analysis/storage-config-generator.ts`
- [Auth SDK](https://github.com/microsoft/rayfin/blob/main/packages/typescript-sdk/auth/src/Auth.ts): `packages/typescript-sdk/auth/src/Auth.ts`
- [Functions SDK](https://github.com/microsoft/rayfin/blob/main/packages/typescript-sdk/functions/src/FunctionClient.ts): `packages/typescript-sdk/functions/src/FunctionClient.ts`

### Shared Tooling

- [Template Engine](https://github.com/microsoft/rayfin/tree/main/packages/tools/common/src/templates): `packages/tools/common/src/templates`

### Other components

- **Builder**

## Connections

- Builder → CLI Commands: runs (evidence: `README.md`)
- CLI Commands → Project Scaffolding: scaffolds (evidence: `packages/tools/cli/src/utils/scaffold-pipeline.ts`)
- Project Scaffolding → Template Engine: instantiates (evidence: `packages/tools/cli/src/utils/scaffold-pipeline.ts`)
- Builder → Deploy and Manage: deploys with (evidence: `README.md`)
- Deploy and Manage → Managed Backend: provisions (evidence: `README.md`)
- Builder → Local Development: develops locally (evidence: `README.md`)
- CLI Commands → Storage Configuration: generates
- CLI Commands → Storage Apply: applies
- Storage Apply → Storage Configuration: reads config (evidence: `packages/tools/cli/src/utils/apply-storage-config.ts`)
- Storage Configuration → Storage Schema: analyzes folders
- CLI Commands → Connector Discovery: manages connectors
- CLI Commands → Agent Integrations: manages files (evidence: `packages/tools/cli/src/services/agent-files/manager.ts`)
- Connector Discovery → Fabric Services: queries catalog (evidence: `packages/tools/cli/src/services/connectors/discovery/catalog-search-engine.ts`)
- Managed Backend → Database: provides (evidence: `README.md`)
- Managed Backend → Authentication: provides (evidence: `README.md`)
- Managed Backend → Data APIs: provides (evidence: `README.md`)
- Managed Backend → Storage Service: provides (evidence: `README.md`)
- Managed Backend → Hosting: provides (evidence: `README.md`)
- Builder → Rayfin Client: uses (evidence: `README.md`)
- Rayfin Client → Data SDK: supports data access
- Rayfin Client → Storage SDK: supports storage access
- Rayfin Client → Auth SDK: supports authentication
- Rayfin Client → Functions SDK: supports functions
- Data SDK → Data APIs: queries (evidence: `README.md`)
- Storage SDK → Storage Service: operates on (evidence: `README.md`)
- Auth SDK → Authentication: authenticates (evidence: `README.md`)
