Skip to main content

Build tool for moose apps

Project description

moose logo

Made by Fiveonefour NPM Version MooseStack Community Docs MIT license

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:

  1. Software engineers integrating analytics & AI into their apps, and leaning into real-time / OLAP infrastructure best practices
  2. 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

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.

Get started with Boreal →

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.

Get started with Boreal →

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

Community

Join us on Slack

Cursor Background Agents

MooseStack works with Cursor's background agents for remote development. The repository includes a pre-configured Docker-in-Docker setup that enables Moose's Docker dependencies to run in the agent environment.

Quick Setup

  1. Enable background agents in Cursor
  2. The environment will automatically build with Docker support
  3. Run moose dev or other Moose commands in the agent

For detailed setup instructions and troubleshooting, see Docker Setup Documentation.

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

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distributions

If you're not sure about the file name format, learn more about wheel file names.

moose_cli-0.6.170-py3-none-manylinux_2_28_x86_64.whl (14.8 MB view details)

Uploaded Python 3manylinux: glibc 2.28+ x86-64

moose_cli-0.6.170-py3-none-manylinux_2_28_aarch64.whl (14.0 MB view details)

Uploaded Python 3manylinux: glibc 2.28+ ARM64

moose_cli-0.6.170-py3-none-macosx_14_0_arm64.whl (13.2 MB view details)

Uploaded Python 3macOS 14.0+ ARM64

moose_cli-0.6.170-py3-none-macosx_13_0_x86_64.whl (13.9 MB view details)

Uploaded Python 3macOS 13.0+ x86-64

File details

Details for the file moose_cli-0.6.170-py3-none-manylinux_2_28_x86_64.whl.

File metadata

File hashes

Hashes for moose_cli-0.6.170-py3-none-manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 ca1b25ca0e53b16a9d72a55d1432ca5db4e77322dd110bee2f05860fa429a0d9
MD5 86809fef62b8dbdf0da2e0f5ea96aaa5
BLAKE2b-256 89412fb42fc4d4d4f1a6f3f64e5e33ac8ca5fda4eac4e741d1ee843d8651823d

See more details on using hashes here.

File details

Details for the file moose_cli-0.6.170-py3-none-manylinux_2_28_aarch64.whl.

File metadata

File hashes

Hashes for moose_cli-0.6.170-py3-none-manylinux_2_28_aarch64.whl
Algorithm Hash digest
SHA256 8795c7719b388fdc57d6422ec73f1a17ce018386f865f6faa296165770a4cd30
MD5 103d6850e722416a0d1750c84be0dfac
BLAKE2b-256 c7f074ca3026190677c41030ca1ce9759ee72d7eca1879cab42df055d7993691

See more details on using hashes here.

File details

Details for the file moose_cli-0.6.170-py3-none-macosx_14_0_arm64.whl.

File metadata

File hashes

Hashes for moose_cli-0.6.170-py3-none-macosx_14_0_arm64.whl
Algorithm Hash digest
SHA256 6bd97a03c3573b4904b3e44ef4ac65e68b4f5194ea8ea4c5bb503a899e659780
MD5 2870c7b46f37d283b3b804689ab9d475
BLAKE2b-256 453608225becef99969203437c802792f0c9f72a447abf66d1065f52c5539912

See more details on using hashes here.

File details

Details for the file moose_cli-0.6.170-py3-none-macosx_13_0_x86_64.whl.

File metadata

File hashes

Hashes for moose_cli-0.6.170-py3-none-macosx_13_0_x86_64.whl
Algorithm Hash digest
SHA256 4e284392b0f5196439452e8b5a8b03013883247f403e02c493626a74b0430ea3
MD5 6200d9541034ecc5462589b1b9ff398e
BLAKE2b-256 89783ceb59bdaa3ca964ecb31a0003f4914e82bcaff8eb8f8bf8503c59af0fee

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page