Skip to main content

Build tool for moose apps

Project description

moose logo

Made by Fiveonefour NPM Version MooseStack Community Docs MIT license

MooseStack

The ClickHouse-native developer framework and agent harness for building real-time analytical backends in TypeScript and Python — designed for developers and AI coding agents alike.

MooseStack offers a unified, type‑safe, code‑first developer experience layer for ClickHouse (realtime analytical database), Kafka/Redpanda (realtime streaming), and Temporal (workflow orchestration). So you can integrate real time analytical infrastructure into your application stack in native Typescript or Python.

Because your entire analytical stack is captured in code, AI agents can read, write, and refactor it just like any other part of your application. Combined with fast local feedback loops via moose dev and complementary ClickHouse best-practice agent skills, agents can often handle the bulk of your development work — schema design, materialized views, migrations, and query APIs — while you review and steer.

Why MooseStack?

  • AI agent harness: AI-friendly interfaces enable coding agents to iterate quickly and safely on your analytical workloads
  • 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 automated schema 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

MooseStack Modules

  • Moose OLAP: Manage ClickHouse tables, materialized views, and migrations in code.
  • Moose Streaming: Real‑time ingest buffers and streaming transformation functions with Kafka/Redpanda.
  • Moose Workflows: ETL pipelines and tasks with Temporal.
  • Moose APIs and Web apps: Type‑safe ingestion and query endpoints, or bring your own API framework (Nextjs, Express, FastAPI, Fastify, etc)

MooseStack Tooling:

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
npm install  # or: pip install -r requirements.txt
moose dev

MooseStack will start ClickHouse, Redpanda, Temporal, and Redis; the CLI validates each component.

Deploy with Fiveonefour hosting

The fastest way to deploy your MooseStack application is with hosting from Fiveonefour, the creators of MooseStack. Fiveonefour provides automated preview branches, managed schema migrations, deep integration with Github and CI/CD, and an agentic harness for your realtime analytical infrastructure in the cloud.

Get started with Fiveonefour hosting →

Deploy Yourself

MooseStack is open source and can be self-hosted. If you're only using MooseOLAP, you can use the Moose library in your app for schema management, migrations, and typed queries on your ClickHouse database without deploying the Moose runtime. 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)

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

Uploaded Python 3manylinux: glibc 2.28+ x86-64

moose_cli-0.6.417-py3-none-manylinux_2_28_aarch64.whl (15.1 MB view details)

Uploaded Python 3manylinux: glibc 2.28+ ARM64

moose_cli-0.6.417-py3-none-macosx_14_0_arm64.whl (13.9 MB view details)

Uploaded Python 3macOS 14.0+ ARM64

File details

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

File metadata

File hashes

Hashes for moose_cli-0.6.417-py3-none-manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 bc8b15b47147212645a245dc618e227add3b937db1151acd2c93e7de00482e51
MD5 db612fd5e7ecb4dbd3b4c42f93ec49d2
BLAKE2b-256 4dec1dc2cad73cfbd2cc9900a9b1ba140b9d0429914a4eca824a9528fa0f96cd

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for moose_cli-0.6.417-py3-none-manylinux_2_28_aarch64.whl
Algorithm Hash digest
SHA256 ebd9568f415c4e5764176e7c45412ba2b8482fad129fc77ae83263ed7f07a957
MD5 a1a8c069435ee726cc48372a9082ebaf
BLAKE2b-256 77d63650c7eca7397889964c389e2a849f53ff76fcbe29972604b9ad1087ff65

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for moose_cli-0.6.417-py3-none-macosx_14_0_arm64.whl
Algorithm Hash digest
SHA256 77b869b0041a72f28030ade7d4b98ca6b9c365990b6e52e33555861388564061
MD5 5db83e9ad9e9adfa0706bad6980799e2
BLAKE2b-256 9eaede70a0ec52b2cea3cfb61d371357ff81841afee0b5e0762add0bcd156303

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