Skip to main content
rslc is one program with a command for each job. Install Relativities to get it. Use the rslc commands shows each command on a rater, and the command reference lists every option.

​
Lay out a project

Keep one program in one folder. The examples on this page use the auto example:
Commit all of them. The bundle that rslc export writes is a build product.

​
Format

RSL has one layout, and rslc fmt writes it. A team that formats on save has diffs that show only real changes.

​
Check and test

The first line of each command starts with PASS or FAIL.

​
Run the three commands in CI

A job that runs these three commands holds a project to its format, its checks and its worked examples:
Each command reports its result in its exit status, so a job stops at the first failure: Install the same release of rslc in CI as on each author’s machine. Versions explains which number is which.

​
Read results from a program

Add --json before the command for one JSON value on standard output:
The object holds ok, the cost, and each diagnostic with its code, message and location.

​
Use the reference from an editor or an agent

The reference ships inside rslc, so it matches the installed compiler and works offline.
  • rslc explain E-CODE prints why a check exists, a program that gets the message, and the fix.
  • rslc docs TOPIC prints the sections, types, functions and annotation keys.
  • rslc examples get NAME --out FOLDER saves a complete program that passes the check.
A coding agent that writes RSL reads these three in place of a web search.