Skip to content

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.

CommandUse it for
rime validateParse the DAG, validate node schemas, resolve graph references, and check source bindings without executing nodes.
rime checkDo everything validate does, plus validate an optional report.yaml against the DAG.
rime runExecute nodes and persist outputs under outputs/.
rime buildRun the DAG and render an HTML report.
rime verifyCheck whether cached artifacts still match the current DAG, source files, params, and output digests.
rime introspectGenerate a starter node block from a Python, R, JavaScript, or SQL script.
Terminal window
rime validate pipeline.dag.yaml
rime check pipeline.dag.yaml
rime run pipeline.dag.yaml
rime build pipeline.dag.yaml
rime verify pipeline.dag.yaml

Use --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.

CodeMeaning
0Command completed successfully.
1Validation, execution, report, or cache verification failed.
2Invocation error such as a missing command or malformed flag.