rml

Find bugs in code. Using rml is as simple as changing a file, and running rml <filename>. rml will analyze your changes for bugs and report them, if it has found any.

Getting Started

Installation

If you just want to use rml you can install it by running:

curl install.recurse.ml | sh

Usage

To run rml you need to be in a git repo

Modify a local file and run:

rml funky/src/file.js

By default rml analyzes unstaged changes (i.e. the ones displayed by git diff without any arguments).

You can also specify the changes to compare against, by specifying --from and/or --to explicitly (they accept arbitrary git refs):

rml funky/src/file.js --from HEAD^

# or between branches
rml funky/src/file.js --to HEAD --head feat/chameleon

Contributing

Contributions are welcome and highly appreciated. This section describes how to set up your local environment for development. If you run into any issues, reach out on Discord, we're here to help🫡.

Installation (dev)

Ensure UV is installed in your system:

curl -LsSf https://astral.sh/uv/install.sh | sh

Then from project root run:

make install-dev

Support

Having trouble? Check out the existing issues on GitHub, or feel free to open a new one.

You can also ask for help on Discord.