Skip to content

CLI: check, run, eval, step, describe ​

rein check ​

Check a project directory, or one .rein file, and print diagnostics

Usage: rein check [PATH]

Arguments: ​
  • <PATH> — Project directory or .rein file

    Default value: .

rein run ​

Run a flow as a live process. Writes one step per line, reads one answer per line on stdin

Usage: rein run [OPTIONS] [FLOW]

Arguments: ​
  • <FLOW> — Program to run: a .rein file, or a name (see rein list)
Options: ​
  • --root <ROOT> — Project root. Default: the nearest directory with main.rein
  • --entry <ENTRY> — Function to start from, as its path under the root without .rein. Default: main
  • --json — Speak JSON Lines: one step object out, one {"key","value"} answer in, per line

rein eval ​

Evaluate one function, for debugging. Agents use rein run or rein step

Usage: rein eval [OPTIONS] [FUNCTION]

Arguments: ​
  • <FUNCTION> — Function name, as its path under the root without .rein. Default: main

    Default value: main

Options: ​
  • --root <ROOT> — Project root. Default: the nearest directory with main.rein
  • --set <NAME=VALUE> — Input value as name=value. Repeat for each input
  • --json — Print the result as JSON

rein step ​

Step the whole flow from main. This is the agent-facing interface: answer one key per call

Usage: rein step [OPTIONS] [PROGRAM]

Arguments: ​
  • <PROGRAM> — Program to step: a .rein file (its folder is the project root), or a name (see rein list)
Options: ​
  • --entry <ENTRY> — Function to start from, as its path under the root without .rein. Default: main
  • --root <ROOT> — Project root. Default: the nearest directory with main.rein
  • --flow <FLOW> — Program to step, by name (see rein list). Same as the positional program
  • --answer <KEY=VALUE> — Answer as key=value, such as merge_pr.ci=green. Repeat for each answer
  • --input <NAME=VALUE> — Value of a string parameter of the entry function, as name=value. Repeat for each input
  • --stdin — Read the whole request as JSON from stdin. Output is always JSON
  • --json — Print the response as JSON

rein describe ​

Print a function's schema as JSON

Usage: rein describe [OPTIONS] [FUNCTION]

Arguments: ​
  • <FUNCTION> — Function name. Default: main

    Default value: main

Options: ​
  • --root <ROOT> — Project root. Default: the nearest directory with main.rein