# MooseStack Documentation

This is a table of contents for the MooseStack documentation.
Each link points to the LLM-friendly markdown version of that page.
Append `?lang=typescript` or `?lang=python` to any link for language-specific content.

## MooseStack

- [Overview](/moosestack/index.md) - MooseStack is the OLAP-native agent harness for designing, validating, and shipping analytical systems as code
- [5 Minute Quickstart](/moosestack/getting-started/quickstart.md) - Build your first analytical backend with Moose in 5 minutes
- [Existing ClickHouse](/moosestack/getting-started/from-clickhouse.md) - Use MooseStack with your existing ClickHouse database
- [Next.js](/moosestack/getting-started/existing-app/next-js.md) - Add MooseStack to an existing Next.js app with a sibling `moose/` workspace package for ClickHouse schema + queries (no separate Moose production service).
- [Fastify](/moosestack/getting-started/existing-app/fastify.md) - Add MooseStack to an existing Fastify app with a sibling `moose/` workspace package for ClickHouse schema + queries (no separate Moose production service).
- [Moose Server](/moosestack/server.md) - Understanding how MooseStack runs locally and in production
- [MooseDev MCP](/moosestack/moosedev-mcp.md) - Built-in Model Context Protocol server for AI-assisted development
- [Language Server](/moosestack/language-server.md) - IDE intelligence for ClickHouse SQL in Moose TypeScript projects
- [Data Modeling](/moosestack/data-modeling.md) - Learn how to model data in MooseStack
- [Moose OLAP](/moosestack/olap.md) - Create and manage ClickHouse tables with Moose OLAP, understand when to use it, and where to start with ClickHouse
- [Tables](/moosestack/olap/model-table.md) - Model your database schema in code using native TypeScript/Python typing
- [Views](/moosestack/olap/model-view.md) - Define standard ClickHouse Views for read-time projections
- [Materialized Views](/moosestack/olap/model-materialized-view.md) - Create and configure materialized views for data transformations
- [Dictionaries](/moosestack/olap/olap-dictionary.md) - Define in-memory key-value lookup stores over ClickHouse tables, queries, or external sources
- [Materialized Columns](/moosestack/olap/materialized-columns.md) - Pre-compute and store column values at insert time for faster queries
- [Alias Columns](/moosestack/olap/alias-columns.md) - Define virtual computed columns that are calculated at query time
- [External Tables](/moosestack/olap/external-tables.md) - Connect to externally managed database tables and CDC services
- [Introspecting Tables](/moosestack/olap/db-pull.md) - Refresh your external table models from an existing ClickHouse database
- [Inserting Data](/moosestack/olap/insert-data.md) - Insert data into OLAP tables using various methods
- [Reading Data](/moosestack/olap/read-data.md) - Query OLAP tables using SQL with type safety
- [Schema Optimization](/moosestack/olap/schema-optimization.md) - Best practices for optimizing ClickHouse table schemas for performance and storage
- [Secondary & Data-skipping Indexes](/moosestack/olap/indexes.md) - Specifying indexes with Moose OLAP
- [Projections](/moosestack/olap/projections.md) - Define projections for alternative data ordering within parts
- [TTL (Time-to-Live)](/moosestack/olap/ttl.md) - Configure automatic data expiration with table and column-level TTL
- [Schema Versioning](/moosestack/olap/schema-versioning.md) - Use the `version` field on an `OlapTable` to model breaking ClickHouse schema changes with interactive backfill and old-table retention
- [Moose Streams](/moosestack/streaming.md) - Add continuous ingest and event processing around Moose OLAP with Kafka or Redpanda-backed streams
- [Stream](/moosestack/streaming/create-stream.md) - Define a Stream resource, connect it to destinations, and configure core stream settings
- [Stream.send()](/moosestack/streaming/from-your-code.md) - Publish records from code that can import a `Stream` directly with `Stream.send()`
- [Schema registry](/moosestack/streaming/schema-registry.md) - Publish a `Stream` through Confluent Schema Registry with `schemaConfig` or `schema_config`
- [Consumer functions](/moosestack/streaming/consumer-functions.md) - Attach consumer functions to a stream with `addConsumer`
- [Transform functions](/moosestack/streaming/transform-functions.md) - Attach transform functions to a stream with `addTransform`
- [Stream patterns](/moosestack/streaming/stream-patterns.md) - Reference examples for fan-out, fan-in, and chained stream processing with Moose Streams
- [Sync to table](/moosestack/streaming/sync-to-table.md) - Sync stream records into OLAP tables with the stream `destination` option
- [Dead letter queues](/moosestack/streaming/dead-letter-queues.md) - Capture failed stream records with `DeadLetterQueue`
- [Moose Workflows](/moosestack/workflows.md) - Add scheduled jobs and durable background processing around Moose OLAP
- [Define Workflows](/moosestack/workflows/define-workflow.md) - Create workflow definitions with task sequences and data flow
- [Scheduling](/moosestack/workflows/schedule-workflow.md) - Set up recurring and scheduled workflow execution
- [Triggers](/moosestack/workflows/trigger-workflow.md) - Start workflows from events, APIs, or external triggers
- [Retries and Timeouts](/moosestack/workflows/retries-and-timeouts.md) - Configure error handling, retries, and timeouts for workflows and tasks
- [Cancelling Running Workflows](/moosestack/workflows/cancel-workflow.md) - Stop running workflows and implement cleanup logic
- [Moose APIs & Web Apps](/moosestack/apis.md) - Expose ingestion and analytics endpoints with native APIs, or bring your own web framework.
- [Ingest API](/moosestack/apis/ingest-api.md) - Create HTTP endpoints that validate JSON and route records into destination streams
- [Analytics API](/moosestack/apis/analytics-api.md) - APIs for Moose
- [Admin APIs](/moosestack/apis/admin-api.md) - Admin APIs for managing MooseStack
- [Authentication](/moosestack/apis/auth.md) - Secure your Moose API endpoints with JWT tokens or API keys
- [Overview](/moosestack/app-api-frameworks.md) - Use Express, Koa, Fastify, FastAPI (or raw Node.js) with MooseStack
- [Express](/moosestack/app-api-frameworks/express.md) - Use Express framework with MooseStack
- [Fastify](/moosestack/app-api-frameworks/fastify.md) - Use Fastify framework with MooseStack
- [Koa](/moosestack/app-api-frameworks/koa.md) - Use Koa framework with MooseStack
- [Raw Node.js](/moosestack/app-api-frameworks/raw-nodejs.md) - Use raw Node.js HTTP handlers with MooseStack
- [FastAPI](/moosestack/app-api-frameworks/fastapi.md) - Use FastAPI framework with MooseStack
- [Moose Dev](/moosestack/dev.md) - Local development environment for MooseStack
- [CDC Managed Tables](/moosestack/dev/cdc-managed-tables.md) - Get started with Moose when your ClickHouse database has tables managed by CDC pipelines like ClickPipes, PeerDB, or Debezium
- [Moose Migrate](/moosestack/migrate.md) - Manage schema changes across your MooseStack infrastructure with reviewable migration files
- [Generate migrations](/moosestack/migrate/generate.md) - How Moose generates schema migrations from code changes
- [Apply migrations](/moosestack/migrate/apply.md) - Execute generated migrations against your database
- [Plan Reference](/moosestack/migrate/plan-format.md) - Detailed specification of the migration plan.yaml structure, operations, and types.
- [Fully Managed](/moosestack/migrate/lifecycle-fully-managed.md) - Default lifecycle mode where Moose automatically manages all schema changes, including destructive ones.
- [Deletion Protected](/moosestack/migrate/lifecycle-deletion-protected.md) - Safe lifecycle mode that allows additive changes but prevents destructive operations like drops.
- [Externally Managed](/moosestack/migrate/lifecycle-externally-managed.md) - Configure Moose to interact with existing, externally managed database schemas.
- [Failed Migrations](/moosestack/migrate/failed-migrations.md) - Recover from failed migrations and safely achieve desired type changes
- [Moose Deploy](/moosestack/deploying.md) - Deploy MooseStack to production
- [Packaging Moose for deployment](/moosestack/deploying/packaging-moose-for-deployment.md) - Package MooseStack for deployment
- [Preparing Infrastructure](/moosestack/deploying/preparing-clickhouse-redpanda.md) - Prepare ClickHouse and Redpanda infrastructure
- [Cloud Configuration](/moosestack/deploying/configuring-moose-for-cloud.md) - Configure MooseStack for cloud deployment
- [Kubernetes Deployment](/moosestack/deploying/deploying-on-kubernetes.md) - Deploy MooseStack on Kubernetes
- [AWS ECS Deployment](/moosestack/deploying/deploying-on-ecs.md) - Deploy MooseStack on AWS ECS
- [Offline Deployment](/moosestack/deploying/deploying-on-an-offline-server.md) - Deploy MooseStack on offline servers
- [Docker Compose Deployment](/moosestack/deploying/deploying-with-docker-compose.md) - Deploy MooseStack with Docker Compose
- [API Reference](/moosestack/reference.md) - Complete API reference for MooseStack libraries
- [Query Layer](/moosestack/reference/query-layer.md) - Type-safe semantic query models for ClickHouse with automatic SQL generation, fluent builder API, and MCP tool integration
- [Testing Utilities](/moosestack/reference/testing-utilities.md) - ClickHouse profiling, table diagnostics, and test reporting for MooseStack applications
- [Data Types](/moosestack/data-types.md) - Reference for ClickHouse column types supported in Moose
- [Strings](/moosestack/data-types/strings.md) - String, LowCardinality, and UUID column types in Moose
- [LowCardinality](/moosestack/data-types/low-cardinality.md) - Optimized storage for columns with few unique values in Moose
- [Integers](/moosestack/data-types/integers.md) - Signed and unsigned integer column types in Moose
- [Floats](/moosestack/data-types/floats.md) - Float32 and Float64 column types in Moose
- [Decimals](/moosestack/data-types/decimals.md) - Fixed-point decimal column types for precise numeric values in Moose
- [Booleans](/moosestack/data-types/booleans.md) - Boolean column type in Moose
- [Date & Time](/moosestack/data-types/datetime.md) - Date, DateTime, and DateTime64 column types in Moose
- [Network](/moosestack/data-types/network.md) - IPv4 and IPv6 column types in Moose
- [Arrays](/moosestack/data-types/arrays.md) - Array column types in Moose
- [Maps](/moosestack/data-types/maps.md) - Map column types for key-value pairs in Moose
- [Nested](/moosestack/data-types/nested.md) - Nested object types for embedded structures in Moose
- [Tuples](/moosestack/data-types/tuples.md) - Named tuple column types for structured data in Moose
- [Enums](/moosestack/data-types/enums.md) - Enum column types for categorical values in Moose
- [Geometry](/moosestack/data-types/geometry.md) - Point, Ring, Polygon, and other geometry column types in Moose
- [JSON](/moosestack/data-types/json.md) - Dynamic and typed JSON column types in Moose
- [Nullable](/moosestack/data-types/nullable.md) - Optional and nullable column types in Moose
- [Aggregates](/moosestack/data-types/aggregates.md) - SimpleAggregateFunction for pre-aggregated data in Moose
- [Table Engines](/moosestack/engines.md) - Reference for ClickHouse table engines supported in Moose
- [MergeTree](/moosestack/engines/merge-tree.md) - The default ClickHouse table engine for analytical workloads
- [ReplacingMergeTree](/moosestack/engines/replacing-merge-tree.md) - ClickHouse table engine with automatic deduplication
- [AggregatingMergeTree](/moosestack/engines/aggregating-merge-tree.md) - ClickHouse table engine for pre-aggregated rollups
- [SummingMergeTree](/moosestack/engines/summing-merge-tree.md) - ClickHouse table engine that automatically sums numeric columns
- [Replicated Engines](/moosestack/engines/replicated.md)
- [CLI](/moosestack/moose-cli.md) - Command-line interface for MooseStack
- [Configuration](/moosestack/configuration.md) - Configure your MooseStack project
- [Project Settings](/moosestack/configuration/project-settings.md) - Configure top-level project settings
- [TypeScript](/moosestack/configuration/typescript.md) - Specific settings for TypeScript projects
- [Telemetry](/moosestack/configuration/telemetry.md) - Configure how Moose collects usage data
- [Git](/moosestack/configuration/git.md) - Configure integration with version control
- [Features](/moosestack/configuration/features.md) - Configure feature flags to enable or disable Moose capabilities
- [Migrations](/moosestack/configuration/migrations.md) - Configure database migration and schema change behavior
- [Docker](/moosestack/configuration/docker.md) - Configure custom Dockerfile support for deployment packaging
- [ClickHouse](/moosestack/configuration/clickhouse.md) - Configure the OLAP database connection and behavior
- [Redpanda](/moosestack/configuration/redpanda.md) - Configure the streaming platform
- [Redis](/moosestack/configuration/redis.md) - Configure the caching and state management layer
- [Temporal](/moosestack/configuration/temporal.md) - Configure the workflow orchestration engine
- [HTTP Server](/moosestack/configuration/http-server.md) - Configure the local development server
- [State Storage](/moosestack/configuration/state-storage.md) - Configure where migration state is stored
- [JWT](/moosestack/configuration/jwt.md) - Configure JSON Web Token (JWT) validation for your APIs
- [Row-Level Security](/moosestack/configuration/row-level-security.md) - Filter query results per-request using ClickHouse row policies tied to JWT claims
- [Admin API](/moosestack/configuration/admin-api.md) - Configure authentication settings for the Admin API
- [Dev Environment](/moosestack/configuration/dev-environment.md) - Configure local development scripts, docker extensions, and networking
- [Observability Metrics](/moosestack/metrics.md) - Unified observability for Moose across development and production—metrics console, health checks, Prometheus, OpenTelemetry, logging, and error tracking
- [Help](/moosestack/help.md) - Get help with MooseStack
- [Troubleshooting](/moosestack/help/troubleshooting.md) - Troubleshoot common issues
- [Minimum Requirements](/moosestack/help/minimum-requirements.md) - Minimum system requirements for MooseStack
- [Windows Setup](/moosestack/help/windows-setup.md) - Set up MooseStack on Windows using WSL2
- [Release Notes](/moosestack/release-notes.md) - Moose / Sloan / Fiveonefour Release Notes
- [February 19, 2026](/moosestack/release-notes/2026-02-19.md) - Release notes for February 19, 2026
- [February 12, 2026](/moosestack/release-notes/2026-02-12.md) - Release notes for February 12, 2026
- [February 6, 2026](/moosestack/release-notes/2026-02-06.md) - Release notes for February 6, 2026
- [January 30, 2026](/moosestack/release-notes/2026-01-30.md) - Release notes for January 30, 2026
- [January 23, 2026](/moosestack/release-notes/2026-01-23.md) - Release notes for January 23, 2026
- [January 16, 2026](/moosestack/release-notes/2026-01-16.md) - Release notes for January 16, 2026
- [January 9, 2026](/moosestack/release-notes/2026-01-09.md) - Release notes for January 9, 2026
- [December 22, 2025](/moosestack/release-notes/2025-12-22.md) - Release notes for December 22, 2025
- [December 15, 2025](/moosestack/release-notes/2025-12-15.md) - Release notes for December 15, 2025
- [December 5, 2025](/moosestack/release-notes/2025-12-05.md) - Release notes for December 5, 2025
- [November 22, 2025](/moosestack/release-notes/2025-11-22.md) - Release notes for November 22, 2025
- [November 14, 2025](/moosestack/release-notes/2025-11-14.md) - Release notes for November 14, 2025
- [November 7, 2025](/moosestack/release-notes/2025-11-07.md) - Release notes for November 7, 2025
- [November 1, 2025](/moosestack/release-notes/2025-11-01.md) - Release notes for November 1, 2025
- [October 24, 2025](/moosestack/release-notes/2025-10-24.md) - Release notes for October 24, 2025
- [Documentation](/moosestack/contribution/documentation.md) - How to contribute to the MooseStack documentation
- [Framework](/moosestack/contribution/framework.md) - How to contribute to the MooseStack framework codebase

## Hosting

- [Hosting Overview](/hosting.md) - Operate cloud OLAP workloads through a branch-native CLI harness with automatic preview environments on every push.
- [--help](/hosting/cli.md) - Root command reference for 514.
- [auth](/hosting/cli/auth.md) - Authenticate the 514 CLI agent harness and verify control plane session state.
- [login](/hosting/cli/auth/login.md) - Start browser-based sign-in for the 514 CLI.
- [whoami](/hosting/cli/auth/whoami.md) - Show the currently authenticated account.
- [logout](/hosting/cli/auth/logout.md) - Clear local auth session for the current machine.
- [org](/hosting/cli/orgs.md) - Manage organizations in the 514 hosting control plane.
- [list](/hosting/cli/orgs/list.md) - List organizations available to the current authenticated user.
- [switch](/hosting/cli/orgs/switch.md) - Switch the active organization context.
- [project](/hosting/cli/projects.md) - Manage projects in the 514 hosting control plane.
- [list](/hosting/cli/projects/list.md) - List projects in an organization.
- [link](/hosting/cli/projects/link.md) - Link an existing local repository to a cloud project.
- [setup](/hosting/cli/projects/setup.md) - Bootstrap a local workspace from an existing cloud project.
- [deployment](/hosting/cli/deployment.md) - Manage deployments in the 514 hosting control plane.
- [list](/hosting/cli/deployment/list.md) - List deployments for a project.
- [doc](/hosting/cli/doc.md) - Browse and search documentation from the 514 CLI.
- [list](/hosting/cli/doc/list.md) - List documentation pages from the CLI.
- [show](/hosting/cli/doc/show.md) - Show a documentation page by slug.
- [search](/hosting/cli/doc/search.md) - Search documentation by title or description.
- [browse](/hosting/cli/doc/browse.md) - Interactively browse and select a documentation page.
- [cli](/hosting/cli/cli.md) - Manage installed CLI binaries.
- [update](/hosting/cli/cli/update.md) - Update installed CLI binaries.
- [env](/hosting/cli/env.md) - Manage environment variables for a 514 hosting project.
- [list](/hosting/cli/env/list.md) - List environment variables for a project or branch.
- [get](/hosting/cli/env/get.md) - Get the value of an environment variable.
- [set](/hosting/cli/env/set.md) - Set one or more environment variables.
- [delete](/hosting/cli/env/delete.md) - Delete an environment variable.
- [agent](/hosting/cli/agent.md) - Agent commands for skills installation, MCP configuration, and read-only resource inspection.
- [init](/hosting/cli/agent/init.md) - Install 514 agent skills, MCP servers, LSP, and plugins for supported coding agents.
- [remove](/hosting/cli/agent/remove.md) - Remove installed 514 agent skills and clean up symlinks.
- [clickhouse](/hosting/cli/clickhouse.md) - Run queries and seed data in your project's ClickHouse databases.
- [seed](/hosting/cli/clickhouse/seed.md) - Copy rows from one branch's ClickHouse table into another.
- [api-endpoint](/hosting/cli/api-endpoint.md) - List API endpoint resources for a deployment.
- [list](/hosting/cli/api-endpoint/list.md) - List api-endpoint resources for a deployment.
- [stream](/hosting/cli/stream.md) - List stream resources for a deployment.
- [list](/hosting/cli/stream/list.md) - List stream resources for a deployment.
- [function](/hosting/cli/function.md) - List function resources for a deployment.
- [list](/hosting/cli/function/list.md) - List function resources for a deployment.
- [stream-to-table-sync](/hosting/cli/stream-to-table-sync.md) - List stream-to-table sync resources for a deployment.
- [list](/hosting/cli/stream-to-table-sync/list.md) - List stream-to-table-sync resources for a deployment.
- [stream-to-stream-sync](/hosting/cli/stream-to-stream-sync.md) - List stream-to-stream sync resources for a deployment.
- [list](/hosting/cli/stream-to-stream-sync/list.md) - List stream-to-stream-sync resources for a deployment.
- [table](/hosting/cli/table.md) - List table resources for a deployment.
- [list](/hosting/cli/table/list.md) - List table resources for a deployment.
- [view](/hosting/cli/view.md) - List view resources for a deployment.
- [list](/hosting/cli/view/list.md) - List view resources for a deployment.
- [web-app](/hosting/cli/web-app.md) - List web-app resources for a deployment.
- [list](/hosting/cli/web-app/list.md) - List web-app resources for a deployment.
- [workflow](/hosting/cli/workflow.md) - List workflow resources for a deployment.
- [list](/hosting/cli/workflow/list.md) - List workflow resources for a deployment.
- [sql-resource](/hosting/cli/sql-resource.md) - List SQL resources for a deployment.
- [list](/hosting/cli/sql-resource/list.md) - List sql-resource resources for a deployment.
- [materialized-view](/hosting/cli/materialized-view.md) - List materialized view resources for a deployment.
- [list](/hosting/cli/materialized-view/list.md) - List materialized-view resources for a deployment.
- [Fiveonefour to Local Setup](/hosting/workflow/fiveonefour-to-local-setup.md) - Practical workflow from Fiveonefour hosting project access to local development readiness.
- [Manage Environment Variables](/hosting/workflow/environment-variables.md) - Add, override, and apply environment variables in Fiveonefour Hosting.
- [Branch Data Seeding](/hosting/workflow/branch-data-seeding.md) - Automatically seed preview environment databases with data from the parent branch so you can test with realistic data immediately.
- [Vercel](/hosting/integrations/vercel.md) - Connect a Vercel project to Fiveonefour Hosting so frontend previews and deployments stay coordinated with your Moose application.
- [Setup Failures](/hosting/troubleshooting/setup-failures.md) - Recovery guide for common blockers in the 514 CLI cloud-to-local harness flow.

## Guides

- [Improving the Performance of Your Dashboards](/guides/performant-dashboards.md) - Already have a dashboard or report running? Here's how to boost performance with OLAP best practices.
- [Overview](/guides/performant-dashboards/overview.md) - Why dashboard performance matters and when to migrate to OLAP
- [Tutorial](/guides/performant-dashboards/tutorial.md) - Step-by-step guide to migrating your dashboard to ClickHouse
- [Chat in your app](/guides/chat-in-your-app.md) - Build a data-aware chat on top of your ClickHouse database with Next.js and MooseStack.
- [Overview](/guides/chat-in-your-app/overview.md) - When and why to build data-connected chat
- [Tutorial](/guides/chat-in-your-app/tutorial.md) - Build chat from scratch or add to existing Next.js app
- [Custom analytics agents](/guides/production-ready-analytics-agent.md) - Get a multi-tenant, observable, analytics agent running from a production-shaped template.
- [Overview](/guides/production-ready-analytics-agent/overview.md) - Why analytics agents need an analytics agent harness to reach production, and what this approach provides
- [Dev Approach](/guides/production-ready-analytics-agent/dev-approach.md) - How to set your coding agent up for success building a production analytics agent
- [Tutorial](/guides/production-ready-analytics-agent/tutorial.md) - Get a production-shaped analytics agent running and customized for your domain
- [Optimize a Slow ClickHouse Query with Your AI Agent](/guides/optimize-clickhouse-performance.md) - Profile a slow query, benchmark candidate schema changes on preview, and review the winning PR before merge.
- [Overview](/guides/optimize-clickhouse-performance/overview.md) - How preview branches on Fiveonefour let you benchmark ClickHouse optimizations before they touch production
- [Tutorial](/guides/optimize-clickhouse-performance/tutorial.md) - Profile a slow query, compare a frozen baseline against optimization candidates, and review the winning branch before merge.