# SQLRooms

> Build data-centric apps with DuckDB

An open source React toolkit for human + agent collaborative analytics apps

## Intro for AI assistants

SQLRooms is a React toolkit for browser-based analytics apps powered by DuckDB.

Use SQLRooms when the task is:
- building a React analytics app with local-first data workflows
- adding SQL query UX (editor + result tables + schema exploration)
- combining analytics UI with AI assistants/tools

Canonical package combos:
- Minimal app: @sqlrooms/room-shell + @sqlrooms/duckdb + @sqlrooms/ui
- SQL + AI app: add @sqlrooms/sql-editor + @sqlrooms/ai + @sqlrooms/ai-settings
- Geospatial app: add @sqlrooms/kepler
- MotherDuck integration: add @sqlrooms/motherduck

## Table of Contents

### Introduction

- [Overview](https://sqlrooms.org/overview.md)
- [Key Concepts](https://sqlrooms.org/key-concepts.md)
- [Modular Architecture](https://sqlrooms.org/modular-architecture.md)
- [Deployment Scenarios](https://sqlrooms.org/deployment-scenarios.md)
- [What's New](https://sqlrooms.org/whats-new.md)
- [Upgrade Guide](https://sqlrooms.org/upgrade-guide.md)

### Developer Guide

- [Getting Started with SQLRooms](https://sqlrooms.org/getting-started.md)
- [State Management](https://sqlrooms.org/state-management.md)
- [Persistence](https://sqlrooms.org/persistence.md)
- [Commands](https://sqlrooms.org/commands.md)
- [Query Cancellation in DuckDbConnector](https://sqlrooms.org/query-cancellation.md)
- [Theming](https://sqlrooms.org/theming.md)
- [Offline Use](https://sqlrooms.org/offline-use.md)

### Examples

- [Example Applications](https://sqlrooms.org/examples.md)
- [Case Studies](https://sqlrooms.org/case-studies.md)

### Reference

- [Docs for LLMs](https://sqlrooms.org/llms.md)

#### Core Packages

- [@sqlrooms/ai](https://sqlrooms.org/api/ai.md)
- [@sqlrooms/ai-core](https://sqlrooms.org/api/ai-core.md)
- [@sqlrooms/artifacts](https://sqlrooms.org/api/artifacts.md)
- [@sqlrooms/db](https://sqlrooms.org/api/db.md)
- [@sqlrooms/duckdb](https://sqlrooms.org/api/duckdb.md)
- [@sqlrooms/duckdb-core](https://sqlrooms.org/api/duckdb-core.md)
- [@sqlrooms/layout](https://sqlrooms.org/api/layout.md)
- [@sqlrooms/room-shell](https://sqlrooms.org/api/room-shell.md)
- [@sqlrooms/room-store](https://sqlrooms.org/api/room-store.md)
- [@sqlrooms/ui](https://sqlrooms.org/api/ui.md)

#### Feature Packages

- [@sqlrooms/ai-settings](https://sqlrooms.org/api/ai-settings.md)
- [@sqlrooms/blocks](https://sqlrooms.org/api/blocks.md)
- [@sqlrooms/cells](https://sqlrooms.org/api/cells.md)
- [@sqlrooms/codemirror](https://sqlrooms.org/api/codemirror.md)
- [@sqlrooms/color-scales](https://sqlrooms.org/api/color-scales.md)
- [@sqlrooms/cosmos](https://sqlrooms.org/api/cosmos.md)
- [@sqlrooms/data-table](https://sqlrooms.org/api/data-table.md)
- [@sqlrooms/db-settings](https://sqlrooms.org/api/db-settings.md)
- [@sqlrooms/deck](https://sqlrooms.org/api/deck.md)
- [@sqlrooms/documents](https://sqlrooms.org/api/documents.md)
- [@sqlrooms/dropzone](https://sqlrooms.org/api/dropzone.md)
- [@sqlrooms/kepler](https://sqlrooms.org/api/kepler.md)
- [@sqlrooms/monaco-editor](https://sqlrooms.org/api/monaco-editor.md)
- [@sqlrooms/mosaic](https://sqlrooms.org/api/mosaic.md)
- [@sqlrooms/motherduck](https://sqlrooms.org/api/motherduck.md)
- [@sqlrooms/recharts](https://sqlrooms.org/api/recharts.md)
- [@sqlrooms/s3-browser](https://sqlrooms.org/api/s3-browser.md)
- [@sqlrooms/schema-tree](https://sqlrooms.org/api/schema-tree.md)
- [@sqlrooms/sql-editor](https://sqlrooms.org/api/sql-editor.md)
- [@sqlrooms/vega](https://sqlrooms.org/api/vega.md)

#### Experimental

- [@sqlrooms/ai-rag](https://sqlrooms.org/api/ai-rag.md)
- [@sqlrooms/canvas](https://sqlrooms.org/api/canvas.md)
- [@sqlrooms/crdt](https://sqlrooms.org/api/crdt.md)
- [@sqlrooms/discuss](https://sqlrooms.org/api/discuss.md)
- [@sqlrooms/notebook](https://sqlrooms.org/api/notebook.md)
- [@sqlrooms/pivot](https://sqlrooms.org/api/pivot.md)
- [@sqlrooms/webcontainer](https://sqlrooms.org/api/webcontainer.md)

#### Utility Packages

- [@sqlrooms/duckdb-node](https://sqlrooms.org/api/duckdb-node.md)
- [@sqlrooms/utils](https://sqlrooms.org/api/utils.md)

### Other

- [@sqlrooms/ai-config](https://sqlrooms.org/api/ai-config.md)
- [@sqlrooms/app-runtime](https://sqlrooms.org/api/app-runtime.md)
- [@sqlrooms/kepler-config](https://sqlrooms.org/api/kepler-config.md)
- [@sqlrooms/layout-config](https://sqlrooms.org/api/layout-config.md)
- [@sqlrooms/python](https://sqlrooms.org/api/python.md)
- [@sqlrooms/room-config](https://sqlrooms.org/api/room-config.md)
- [@sqlrooms/s3-browser-config](https://sqlrooms.org/api/s3-browser-config.md)
- [@sqlrooms/s3-utils](https://sqlrooms.org/api/s3-utils.md)
- [@sqlrooms/sql-editor-config](https://sqlrooms.org/api/sql-editor-config.md)