CLI overview
The Rime CLI works against a pipeline.dag.yaml file. Relative source paths,
script paths, and outputs resolve from the directory that contains that DAG.
Command Map
Section titled “Command Map”| Command | Use it for |
|---|---|
rime validate | Parse the DAG, validate node schemas, resolve graph references, and check source bindings without executing nodes. |
rime check | Do everything validate does, plus validate an optional report.yaml against the DAG. |
rime run | Execute nodes and persist outputs under outputs/. |
rime build | Run the DAG and render an HTML report. |
rime verify | Check whether cached artifacts still match the current DAG, source files, params, and output digests. |
rime introspect | Generate a starter node block from a Python, R, JavaScript, or SQL script. |
Common Flow
Section titled “Common Flow”rime validate pipeline.dag.yamlrime check pipeline.dag.yamlrime run pipeline.dag.yamlrime build pipeline.dag.yamlrime verify pipeline.dag.yamlUse --source node_id=path/to/file to override a source file for a single
command. Use --param name=value on run-like commands to override top-level
DAG params.
Exit Codes
Section titled “Exit Codes”| Code | Meaning |
|---|---|
0 | Command completed successfully. |
1 | Validation, execution, report, or cache verification failed. |
2 | Invocation error such as a missing command or malformed flag. |