Build tool for moose apps
Project description
MooseStack
Developer toolkit for building real-time analytical backends in Typescript and Python — MooseStack brings data engineering best practices and a modern web development DX to any engineer building on data infra.
MooseStack modules offer a type‑safe, code‑first developer experience layer for popular open source analytical infrastructure, including ClickHouse, Kafka, Redpanda, and Temporal.
MooseStack is designed for:
- Software engineers integrating analytics & AI into their apps, and leaning into real-time / OLAP infrastructure best practices
- Data engineers building software & AI applications on their data infra, and leaning into software development best practices
Why MooseStack?
- Git-native development: Version control, collaboration, and governance built-in
- Local-first experience: Full mirror of production environment on your laptop with
moose dev - Schema & migration management: typed schemas in your application code, with transparent migration support
- Code‑first infrastructure: Declare tables, streams, workflows, and APIs in TS/Python -> MooseStack wires it all up.
- Modular design: Only enable the modules you need. Each module is independent and can be adopted incrementally.
- AI copilot friendly: Designed from the ground up for LLM-powered development
MooseStack Modules
- Moose OLAP: Manage ClickHouse tables, materialized views, and migrations in code.
- Moose Streaming: Real‑time pipelines with Kafka/Redpanda and transformation functions.
- Moose Workflows: ETL pipelines and tasks with Temporal.
- Moose APIs: Type‑safe ingestion and query endpoints with auto‑generated OpenAPI docs.
- MooseStack Tooling: Moose Deploy, Moose Migrate, Moose Observability
Quickstart
Also available in the Docs: 5-minute Quickstart
Already running Clickhouse: Getting Started with Existing Clickhouse
Install the CLI
bash -i <(curl -fsSL https://fiveonefour.com/install.sh) moose
Create a project
# typescript
moose init my-project --from-remote <YOUR_CLICKHOUSE_CONNECTION_STRING> --language typescript
# python
moose init my-project --from-remote <YOUR_CLICKHOUSE_CONNECTION_STRING> --language python
Run locally
cd my-project
moose dev
MooseStack will start ClickHouse, Redpanda, Temporal, and Redis; the CLI validates each component.
Deploy with Boreal
The easiest way to deploy your MooseStack Applications is to use Boreal from 514 Labs, the creators of Moose. Boreal provides zero-config deployments, automatic scaling, managed or BYO infrastructure, monitoring and observability integrations.
Deploy Yourself
Moose is open source and can be self-hosted. For detailed self-hosting instructions, see our deployment documentation.
Examples
TypeScript
import { Key, OlapTable, Stream, IngestApi, ConsumptionApi } from "@514labs/moose-lib";
interface DataModel {
primaryKey: Key<string>;
name: string;
}
// Create a ClickHouse table
export const clickhouseTable = new OlapTable<DataModel>("TableName");
// Create a Redpanda streaming topic
export const redpandaTopic = new Stream<DataModel>("TopicName", {
destination: clickhouseTable,
});
// Create an ingest API endpoint
export const ingestApi = new IngestApi<DataModel>("post-api-route", {
destination: redpandaTopic,
});
// Create consumption API endpoint
interface QueryParams {
limit?: number;
}
export const consumptionApi = new ConsumptionApi<QueryParams, DataModel[]>("get-api-route",
async ({limit = 10}: QueryParams, {client, sql}) => {
const result = await client.query.execute(sql`SELECT * FROM ${clickhouseTable} LIMIT ${limit}`);
return await result.json();
}
);
Python
from moose_lib import Key, OlapTable, Stream, StreamConfig, IngestApi, IngestApiConfig, ConsumptionApi
from pydantic import BaseModel
class DataModel(BaseModel):
primary_key: Key[str]
name: str
# Create a ClickHouse table
clickhouse_table = OlapTable[DataModel]("TableName")
# Create a Redpanda streaming topic
redpanda_topic = Stream[DataModel]("TopicName", StreamConfig(
destination=clickhouse_table,
))
# Create an ingest API endpoint
ingest_api = IngestApi[DataModel]("post-api-route", IngestApiConfig(
destination=redpanda_topic,
))
# Create a consumption API endpoint
class QueryParams(BaseModel):
limit: int = 10
def handler(client, params: QueryParams):
return client.query.execute("SELECT * FROM {table: Identifier} LIMIT {limit: Int32}", {
"table": clickhouse_table.name,
"limit": params.limit,
})
consumption_api = ConsumptionApi[RequestParams, DataModel]("get-api-route", query_function=handler)
5 Minute Quickstart
Already running Clickhouse? MooseStack gives you a modern software DX on your existing ClickHouse or ClickHouse Cloud cluster: Getting Started with Existing Clickhouse
Install the CLI
bash -i <(curl -fsSL https://fiveonefour.com/install.sh) moose
Create a project
# typescript
moose init my-project --from-remote <YOUR_CLICKHOUSE_CONNECTION_STRING> --language typescript
# python
moose init my-project --from-remote <YOUR_CLICKHOUSE_CONNECTION_STRING> --language python
Run locally
cd my-project
moose dev
MooseStack will start ClickHouse, Redpanda, Temporal, and Redis; the CLI validates each component.
Deploy with Boreal
The easiest way to deploy to production with MooseStack is to use Boreal from Fiveonefour, the creators of MooseStack. Boreal provides github integration for CI/CD and one click deploys, cloud previews of your dev branches, managed or BYO infrastructure, and security + observability. Boreal works natively with ClickHouse Cloud and RedPanda Cloud.
Deploy Yourself
MooseStack is open source, and apps built with MooseStack can be self-hosted. For detailed self-hosting instructions, see our deployment documentation.
Docs
Built on
- ClickHouse (OLAP storage)
- Redpanda (streaming)
- Temporal (workflow orchestration)
- Redis (internal state)
Community
Contributing
We welcome contributions! See the contribution guidelines.
License
MooseStack is open source software and MIT licensed.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distributions
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file moose_cli-0.6.67-py3-none-manylinux_2_28_x86_64.whl.
File metadata
- Download URL: moose_cli-0.6.67-py3-none-manylinux_2_28_x86_64.whl
- Upload date:
- Size: 13.5 MB
- Tags: Python 3, manylinux: glibc 2.28+ x86-64
- Uploaded using Trusted Publishing? No
- Uploaded via: maturin/1.9.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
0b8eac38b21479c71f24a88224fac5d68f3b9bd3585f7ac4ba0f15fafe1a5bce
|
|
| MD5 |
2ff87a9d9aa8f53ac70d5ac7d5ebe314
|
|
| BLAKE2b-256 |
8c797ae74fb0fe7cea142db7f874722bb882838ca4b1d34d6e02276dfe608295
|
File details
Details for the file moose_cli-0.6.67-py3-none-manylinux_2_28_aarch64.whl.
File metadata
- Download URL: moose_cli-0.6.67-py3-none-manylinux_2_28_aarch64.whl
- Upload date:
- Size: 12.8 MB
- Tags: Python 3, manylinux: glibc 2.28+ ARM64
- Uploaded using Trusted Publishing? No
- Uploaded via: maturin/1.9.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
5d4fdf83d729136d2ea730bd23be4593a2c9fdee1ddbcfd0414f7d46c87ccdf2
|
|
| MD5 |
c71ce826749044542535aef9ec54fa76
|
|
| BLAKE2b-256 |
c5d8a1f71d3b4c9b2171ff3ab5cfeeaf4c9a0aecc32b453fff7dd00cc9c4efe0
|
File details
Details for the file moose_cli-0.6.67-py3-none-macosx_14_0_arm64.whl.
File metadata
- Download URL: moose_cli-0.6.67-py3-none-macosx_14_0_arm64.whl
- Upload date:
- Size: 12.0 MB
- Tags: Python 3, macOS 14.0+ ARM64
- Uploaded using Trusted Publishing? No
- Uploaded via: maturin/1.9.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
22688f69e93640bb5f113869f55b0d34cf5ada99c3441c182a4f863fb9c3061b
|
|
| MD5 |
4081a5136a37f9cc28015de974968536
|
|
| BLAKE2b-256 |
2cc0726c3950d94a6adf47744f935574f16558b2345f0cc39f4914c4e205af10
|
File details
Details for the file moose_cli-0.6.67-py3-none-macosx_13_0_x86_64.whl.
File metadata
- Download URL: moose_cli-0.6.67-py3-none-macosx_13_0_x86_64.whl
- Upload date:
- Size: 12.7 MB
- Tags: Python 3, macOS 13.0+ x86-64
- Uploaded using Trusted Publishing? No
- Uploaded via: maturin/1.9.4
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
713283a6d1c8e56cb23a78be73cec67a521e693102439540919accc6e9cb48ad
|
|
| MD5 |
c2cce095a590f19a9c9f2ec40b2d619c
|
|
| BLAKE2b-256 |
dfc284657d0434426618e93707667d4ab2529bde8e3c6558e113de48f192808c
|