Skip to main content
The examples run on the dwelling-fire rater from Write your first rater. To work on a fresh copy, save the example and enter its folder:
With a dwelling/ folder from the tutorial, run cd dwelling alone. The command reference lists every command and every option.

Check a rater

The cost line describes calculation work as the number of scheduled items changes. A failed check prints FAIL and one message for each problem. Each message carries a code, the file position, and a suggested fix. Checks and guarantees describes what a passing check establishes. Review the source interpretation and test independent examples to establish filing fidelity.

Explain a check message

Pass a message’s code to rslc explain:
The entry states what the check asks for, shows a rater that gets the message, and shows the corrected rater. Check messages holds the same entries by topic.

Format the source

Apply the standard layout:
A file that needs a change is rewritten in place, and the command prints FORMATTED rater.rsl. To check formatting while preserving the file:
A formatting difference produces a diff and a failing exit status.

Package a rater

After the rater passes its checks, export a bundle:
Choose a new output filename. Export fails when the destination already exists. Export also writes rater-manifest.json and runtime/rslc_wasm.wasm beside the source. The bundle includes a book schema and an identity prepare function derived from the native rater’s input schema. The book follows the rater’s own inputs. Structural IDs identify submissions and list items; names that collide receive distinct table or column names. Load the bundle with Program.load and inspect program.schema for its tables and columns. The generated prepare passes those values to the native rater. Package a program describes custom preparation and regression examples.
A rater that imports other RSL files or reads enum members from enums/*.csv carries those files too.
Rate submissions with a rater shows how to use the bundle in Python.

Read the reference in your terminal

rslc docs prints the reference for the installed version:
The same text builds the reference pages on this site, such as Sections, types and annotations and Functions. rslc docs round explains one function, and rslc examples lists the example raters.

Use commands in scripts

Each command reports its result in its exit status: Add --json for structured output:
The check returns one JSON object containing ok, diagnostics, cost, and other details. Use --help to inspect a command’s options: