Skip to content

Murakumo documentation

Murakumo is model-first data engineering. You design the logical model (the entities, how they relate, and where each column comes from) on a canvas or in YAML files, choose your stack, and Murakumo writes everything downstream: the DDL, a dbt project, PySpark or Polars jobs, streaming jobs, tests, data contracts, audit tables, orchestration, CI and Terraform.

Everything it writes is ordinary code in your repository, and the replication guide says how to build all of it by hand, so you can stop using Murakumo at any time and lose nothing.

pip install "murakumo[canvas,verify,duckdb]"
murakumo init my_platform
murakumo canvas my_platform

Start here

  • Install and set up: installing, murakumo init, and what each machine needs.
  • The end-to-end test: every feature, step by step, from an empty folder to a running platform. The quickest way to see it all.

Design the model

  • Model files: the YAML that holds the model, and every rule it is checked against.
  • Getting metadata in: from databases, data dictionaries, files, APIs, protobuf, an existing dbt project, or a data contract.
  • The canvas: the visual editor, served by murakumo canvas.
  • Modelling patterns: SCD types, Data Vault, CDC, masking and row access, the semantic layer.

Build the platform

Run it

Without Murakumo