See the contributing guide for review expectations and repository conventions.
git submodule update --init --recursive
mise install
mise run buildbuild prepares the embedded web UI before compiling Rust. Use
mise run build-dev when you also want to restart your local supervisor.
Run mise run ci-dev before committing and inspect the generated changes.
mise run docs # Local VitePress server
mise run build:docs # Production build and documentation checksEdit prose in docs/, navigation in docs/.vitepress/config.mts, and styling in
docs/.vitepress/theme/. For generated CLI help and settings, edit src/cli/
or src/settings.rs and run mise run render; do not hand-edit docs/cli/.
The render task stages the docs directory and generated usage spec. Build the
docs again after rendering and review staged changes before committing.
mise wraps cargo with mbx, so compiled work is
shared across checkouts. mise run tasks and mise exec -- cargo … use the
wrapper; plain cargo does too once mise is activated in your
shell. Builds that set
MBX_DISABLE=1, including CI, skip the cache.