Documentation
mbx adds a shared compiler cache and automatic storage management to Cargo. Start with a local build, then add the integrations your workflow needs.
Start here
Get started takes you from installation to your first cached build. For platform-specific downloads, see Installation. For automatic Cargo wrapping and rust-analyzer, see Cargo and editor setup.
Work locally
| Task | Guide |
|---|---|
| Use editors, watch loops, or a debugger | Local development |
| Understand what is stored or deleted | Managed target directories |
| Run tests and Clippy at the same time | Parallel builds |
| Tune repeated source edits | Incremental builds |
| Select a linker by profile and target | Managed linkers |
| Watch compiler and cache activity | Watching builds |
| Cache make or CMake compiler calls | Standalone C and C++ |
Set up CI and sharing
| Task | Guide |
|---|---|
| Add caching to a GitHub Actions job | GitHub Action |
| Replace an existing caching step | Migrate from rust-cache or sccache |
| Support pull requests from forks | CI with fork pull requests |
| Connect a server or S3-compatible bucket | Remote cache |
| Operate the reference server | Cache server |
Understand a result
| Task | Guide |
|---|---|
| Diagnose an unexpected build | Troubleshooting |
| Rank where a rebuild's uncached compiler time went | Analyzing a build |
| Interpret the cache counters | Cache results |
| See lifetime totals and workspace sharing | Savings and statistics |
| Explore live activity and per-build insights | Watching builds |
| Learn the architecture | How it works |
| See which invocations mbx bypasses | Caching limits |
| Read common questions and the story behind the name | FAQ |
About mbx
Benchmarks includes measured results and the method behind them. How mbx compares explains the tradeoffs with other caches and Cargo's incremental compilation.
Look something up
- Configuration: file locations, precedence, and every setting
- CLI reference: command syntax, flags, and arguments
- Stability: upgrade behavior and supported output formats
- Protocol compatibility: local, remote, and Rust API contracts
To improve these docs or contribute code, read Contributing. The acknowledgements recognize the projects mbx builds on.