mrun, is a utility to quickly set up complex MongoDB test environments
on a local machine, including replica sets and sharded clusters. It was
originally part of the now deprecated mtools collection; however, is now available
as a standalone tool.
For more information, see the mongorun documentation.
mrun is written in Python. The tools are currently tested with Python 3.8, 3.9, 3.10, and 3.11.
mongorun requires pymongo, psutil and packaging dependencies. See the installation instructions for more information.
mongorun is only tested with actively supported (non End-of-Life) versions of the MongoDB server. As of November 2025, that includes MongoDB 7.0 or newer.
After installing mongorun, you can run it from the command line by typing
mrun. For a list of available commands, run:
mrun --helpFor detailed usage instructions, see the mongorun documentation.
See the changelog for a list of changes from previous versions of mlaunch/mongorun.
If you'd like to contribute to mongorun, please read the contributor page for instructions.
This software is not supported by MongoDB, Inc. under any of their commercial support subscriptions or otherwise. Any usage of mongorun is at your own risk. Bug reports, feature requests and questions can be posted in the Issues section on GitHub.