Compile, run, format, and lint the Materialize codebase locally.
npx skills add https://github.com/MaterializeInc/materialize --skill mz-run
Please help me install this Agent Skill. Skill: mz-run Source: https://github.com/MaterializeInc/materialize/tree/main/.agents/skills/mz-run Command: npx skills add https://github.com/MaterializeInc/materialize --skill mz-run
Developers working on Materialize need to know the correct commands and pitfalls for compiling, running, formatting, and linting the codebase, including non-obvious issues like shared CockroachDB state and multi-crate constructor updates.
cargo check and bin/environmentd --build-only instead of cargo build or cargo run, and verify mz-sqllogictest compiles when changing mz_environmentd::Config.bin/environmentd --optimized, connect via psql on ports 6875 or 6877, and safely handle --reset against the shared CockroachDB metadata backend.bin/fmt, bin/lint, and cargo clippy --all-targets -- -D warnings to keep the tree clean.mz_environmentd::Config and CI fails mysteriously. The skill explains that cargo check -p mz-environmentd misses the sqllogictest constructor, so you must run cargo check -p mz-sqllogictest --all-targets.Ask the assistant to start Materialize locally and check that my changes compile across all affected crates.
High-intent search queries and answers about installing and using this skill.
Start Materialize with `bin/environmentd --optimized`, then connect using `psql -p 6875 -h localhost -U materialize` for regular access or port 6877 with user mz_system for system access. CockroachDB must be running first, typically via a Docker container.
Use `cargo check` rather than `cargo build` or `cargo run`. To build without running, use `bin/environmentd --build-only`. When changing mz_environmentd::Config, also verify with `cargo check -p mz-sqllogictest --all-targets`.
mz_environmentd::Config is constructed in three places, including the separate mz-sqllogictest crate. `cargo check -p mz-environmentd` does not cover the sqllogictest constructor, so a missing field breaks mz-sqllogictest and cascades into clippy, doc-tests, and mzcompose jobs.
Not always. `--reset` drops schemas in the shared CockroachDB at localhost:26257, which is global across all worktrees and wipes state for any other running instance. Check for other instances with `ss -ltnp | grep 6875` first, or use a different metadata backend via `--postgres`.
Run `bin/fmt` to format Rust, Python, and Protobuf files across the whole tree, `bin/lint` for lint errors, and `cargo clippy --all-targets -- -D warnings` for Rust-specific warnings.
Set the MZ_LOG_FILTER environment variable to a tracing-compatible filter expression. For example, `mz_adapter::catalog::apply=trace,warn` enables trace logging for that module and warn level for everything else.
BlocUnited-LLCSet up a Mozaiks development environment with dependencies and environment variables.
windmill-labsRuns the CI Codex PR review locally against unpushed branch changes before pushing.
d-o-hubDiagnose runtime issues in Rust async code with Tokio, Turso, and redb.
summarybotngAutomates provisioning, configuration, and management of test environments via IaC and containerization.