# MooseStack Documentation

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

## MooseStack

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

## Hosting

- [Hosting Overview](/hosting.txt) - Operate cloud OLAP workloads through a branch-native CLI harness with automatic preview environments on every push.
- [--help](/hosting/cli.txt) - Root command reference for 514.
- [auth](/hosting/cli/auth.txt) - Authenticate the 514 CLI agent harness and verify control plane session state.
- [login](/hosting/cli/auth/login.txt) - Start browser-based sign-in for the 514 CLI.
- [whoami](/hosting/cli/auth/whoami.txt) - Show the currently authenticated account.
- [logout](/hosting/cli/auth/logout.txt) - Clear local auth session for the current machine.
- [org](/hosting/cli/orgs.txt) - Manage organizations in the 514 hosting control plane.
- [list](/hosting/cli/orgs/list.txt) - List organizations available to the current authenticated user.
- [switch](/hosting/cli/orgs/switch.txt) - Switch the active organization context.
- [project](/hosting/cli/projects.txt) - Manage projects in the 514 hosting control plane.
- [list](/hosting/cli/projects/list.txt) - List projects in an organization.
- [link](/hosting/cli/projects/link.txt) - Link an existing local repository to a cloud project.
- [setup](/hosting/cli/projects/setup.txt) - Bootstrap a local workspace from an existing cloud project.
- [deployment](/hosting/cli/deployment.txt) - Manage deployments in the 514 hosting control plane.
- [list](/hosting/cli/deployment/list.txt) - List deployments for a project.
- [doc](/hosting/cli/doc.txt) - Browse and search documentation from the 514 CLI.
- [list](/hosting/cli/doc/list.txt) - List documentation pages from the CLI.
- [show](/hosting/cli/doc/show.txt) - Show a documentation page by slug.
- [search](/hosting/cli/doc/search.txt) - Search documentation by title or description.
- [browse](/hosting/cli/doc/browse.txt) - Interactively browse and select a documentation page.
- [cli](/hosting/cli/cli.txt) - Manage installed CLI binaries.
- [update](/hosting/cli/cli/update.txt) - Update installed CLI binaries.
- [agent](/hosting/cli/agent.txt) - Agent-focused read-only command surface.
- [api-endpoint](/hosting/cli/api-endpoint.txt) - List API endpoint resources for a deployment.
- [list](/hosting/cli/api-endpoint/list.txt) - List api-endpoint resources for a deployment.
- [stream](/hosting/cli/stream.txt) - List stream resources for a deployment.
- [list](/hosting/cli/stream/list.txt) - List stream resources for a deployment.
- [function](/hosting/cli/function.txt) - List function resources for a deployment.
- [list](/hosting/cli/function/list.txt) - List function resources for a deployment.
- [stream-to-table-sync](/hosting/cli/stream-to-table-sync.txt) - List stream-to-table sync resources for a deployment.
- [list](/hosting/cli/stream-to-table-sync/list.txt) - List stream-to-table-sync resources for a deployment.
- [stream-to-stream-sync](/hosting/cli/stream-to-stream-sync.txt) - List stream-to-stream sync resources for a deployment.
- [list](/hosting/cli/stream-to-stream-sync/list.txt) - List stream-to-stream-sync resources for a deployment.
- [table](/hosting/cli/table.txt) - List table resources for a deployment.
- [list](/hosting/cli/table/list.txt) - List table resources for a deployment.
- [view](/hosting/cli/view.txt) - List view resources for a deployment.
- [list](/hosting/cli/view/list.txt) - List view resources for a deployment.
- [web-app](/hosting/cli/web-app.txt) - List web-app resources for a deployment.
- [list](/hosting/cli/web-app/list.txt) - List web-app resources for a deployment.
- [workflow](/hosting/cli/workflow.txt) - List workflow resources for a deployment.
- [list](/hosting/cli/workflow/list.txt) - List workflow resources for a deployment.
- [sql-resource](/hosting/cli/sql-resource.txt) - List SQL resources for a deployment.
- [list](/hosting/cli/sql-resource/list.txt) - List sql-resource resources for a deployment.
- [materialized-view](/hosting/cli/materialized-view.txt) - List materialized view resources for a deployment.
- [list](/hosting/cli/materialized-view/list.txt) - List materialized-view resources for a deployment.
- [Fiveonefour to Local Setup](/hosting/workflow/fiveonefour-to-local-setup.txt) - Practical workflow from Fiveonefour hosting project access to local development readiness.
- [Setup Failures](/hosting/troubleshooting/setup-failures.txt) - Recovery guide for common blockers in the 514 CLI cloud-to-local harness flow.

## Guides

- [Improving the Performance of Your Dashboards](/guides/performant-dashboards.txt) - Already have a dashboard or report running? Here's how to boost performance with OLAP best practices.
- [Overview](/guides/performant-dashboards/overview.txt) - Why dashboard performance matters and when to migrate to OLAP
- [Tutorial](/guides/performant-dashboards/tutorial.txt) - Step-by-step guide to migrating your dashboard to ClickHouse
- [Chat in your app](/guides/chat-in-your-app.txt) - Build a data-aware chat on top of your ClickHouse database with Next.js and MooseStack.
- [Overview](/guides/chat-in-your-app/overview.txt) - When and why to build data-connected chat
- [Build](/guides/chat-in-your-app/build.txt) - Architecture decisions and implementation choices
- [Tutorial](/guides/chat-in-your-app/tutorial.txt) - Build chat from scratch or add to existing Next.js app