Installing on macOS

Prerequisites

• macOS 13 or later (Actively supported versions of macOS)
• A terminal application (e.g. Terminal or iTerm2)
• Git must be installed and available in your PATH

Installation

To install RML, open your terminal and run the following command:

curl install.recurse.ml | sh

This script will download and install the latest version of RML onto your system.

Once installed, you can verify that RML is available by running:

rml --version

If the command returns 🐞 Running rml version {version}, RML has been installed successfully and is ready to use.

Next Steps

Now that RML is installed, you can:

• Check out the Quickstart guide to run your first analysis
• Learn about configuration options
• Create custom rules for your project

Troubleshooting

If you encounter any issues during installation, please check out the help and support section.