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.128-py3-none-manylinux_2_28_x86_64.whl (14.5 MB view details)

Uploaded Python 3manylinux: glibc 2.28+ x86-64

moose_cli-0.6.128-py3-none-manylinux_2_28_aarch64.whl (13.8 MB view details)

Uploaded Python 3manylinux: glibc 2.28+ ARM64

moose_cli-0.6.128-py3-none-macosx_14_0_arm64.whl (13.0 MB view details)

Uploaded Python 3macOS 14.0+ ARM64

moose_cli-0.6.128-py3-none-macosx_13_0_x86_64.whl (13.7 MB view details)

Uploaded Python 3macOS 13.0+ x86-64

File details

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

File metadata

File hashes

Hashes for moose_cli-0.6.128-py3-none-manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 1df91ebc3c59076ab7d441773d4d390dfafca8018b3f2529cecd14c93a22c64e
MD5 22a698f38cb39d6dfd67922b594567a5
BLAKE2b-256 0e76af803e555db0f0960c1a37f2dae389c5a07a19943276e0d79d0f2e33776d

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for moose_cli-0.6.128-py3-none-manylinux_2_28_aarch64.whl
Algorithm Hash digest
SHA256 6a84dff09ad52b850203521a002278343dfbe0121b8ea30794141d60659d0c2e
MD5 4efd832e0adcc326e47ae4b4ee2903bc
BLAKE2b-256 e7caaa9e741095ccab089cf848b3fa12116d6079cb8ac925bf356b7c8dcd0f67

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for moose_cli-0.6.128-py3-none-macosx_14_0_arm64.whl
Algorithm Hash digest
SHA256 27cabe0ee4fe83c64bd6d1ad2351ccec3ab06a029bda4006bc373aef3fa38fc6
MD5 78bc9261a96afd5337a130a42727994f
BLAKE2b-256 4c492e551c215e918ec2adbaaaf5fd20c87ee7c5fd9244e1c5c3c42be61e56f8

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for moose_cli-0.6.128-py3-none-macosx_13_0_x86_64.whl
Algorithm Hash digest
SHA256 5933d76b8a0b3c88f68f1dd56b36f9f871dfa972aee308bc6cee46b97d6fedc0
MD5 bee63b015554b962391c4130a41869f1
BLAKE2b-256 2c650d89301f6a2538d10f70ce60b7b66184429dce9807a5d0cb56f2c15887fb

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