Home / Quickstart
From install to a cached build
rninja is a single binary. Install it, run it where you run ninja, and the cache warms itself. Nothing about your build.ninja or generator changes.
1 · Install
Cargo (crates.io)
cargo install rninja
npm
npm install -g rninja-cli
PyPI
pip install rninja-cli
Homebrew
brew install \ neul-labs/tap/rninja
2 · Run it like ninja
Pass the same flags, or symlink rninja in as ninja so nothing downstream moves.
3 · The flags you already know
-C DIR Change to DIR before building — same as ninja.
-j N Run N jobs in parallel through the async scheduler.
-k N Keep going until N jobs fail, exactly like ninja.
-n Dry run: print what would build without running it.
-t TOOL Subtools: clean, compdb, graph, deps, query — plus rninja’s config and stats.
-d MODE Debug output, including -d explain for why an edge rebuilt.
4 · Share a cache across machines (optional)
Point rninja at an async-nng endpoint to let laptops and CI runners reuse each other's artifacts. Leave it unset and rninja stays local-only.
// see the CI warm-cache use case for a full pipeline.
That's the whole loop.
Curious how the cache decides what is reusable? Read how it works, or see the FAQ.