Skip to content

rime build

Terminal window
rime build <pipeline.dag.yaml> [--out out.html] [--report report.yaml]

rime build runs the DAG exactly like rime run, then writes an HTML report. By default, the report is generated from the DAG and each node’s metadata.report value.

Terminal window
# Run + write outputs/run_report.html
rime build pipeline.dag.yaml
# Write to a specific file
rime build pipeline.dag.yaml --out outputs/review.html
# Compatibility path for a hand-authored report spec
rime build pipeline.dag.yaml --report report.yaml

The command streams lifecycle events, prints the same summary table as rime run, then reports the HTML path:

penguins: pending
penguins: cached cache=hit elapsedMs=24
penguins: success cache=hit rowsOut=10
Run summary:
Node Status Cache Rows In Rows Out
----------- ------- ----- ------- --------
penguins SUCCESS hit - 10
adelie_only SUCCESS hit 10 5
by_island SUCCESS hit 5 3
Report written: /path/to/project/outputs/run_report.html

rime build does not render a report over a failed or skipped run. If any node fails, the command exits nonzero.

Reports include nodes by default. Hide raw or noisy nodes with:

metadata:
report: false

See Reports for report layout and output rendering details.

  • rime run - execute without rendering HTML.
  • rime check - validate report wiring without running.