rf inspect

Synopsis

rf inspect [target] [options]

Description

rf inspect reads a pipeline definition and displays its structure — nodes, edges, execution order, and schemas. You can inspect the full pipeline, a single node, an edge, or results from a previous run.

Targets

Target	Description
(none)	Show the full pipeline overview.
node <slug>	Show details for a specific node.
edge <id>	Show details for a specific edge.
run <id>	Show results from a specific execution run.

Options

Flag	Default	Description
--format <fmt>	table	Output format: table, json, yaml.
--last-run	—	Show results from the most recent execution.

Examples

Inspect the full pipeline

$ rf inspect

Pipeline: lead-scoring
Nodes: 4
Edges: 3

Nodes
-----
  read-leads       source          file.read
  score-leads      deterministic   sql.query
  filter-top       deterministic   sql.query
  write-output     deterministic   file.write

Edges
-----
  read-leads.rows       -> score-leads.rows        Table
  score-leads.scored    -> filter-top.data          Table
  filter-top.qualified  -> write-output.data        Table

Execution Order
---------------
  1. read-leads
  2. score-leads
  3. filter-top
  4. write-output

Schemas
-------
  read-leads.rows (output):
    name       string
    email      string
    score      number

  score-leads.scored (output):
    name       string
    email      string
    score      number
    weighted   number

Inspect a node

$ rf inspect node score-leads

Node: score-leads
Type: deterministic
Op:   sql.query

Params:
  query: "SELECT *, score * 1.5 AS weighted FROM rows"

Inputs:
  rows     Table    from ref(read-leads.rows)
    name       string
    email      string
    score      number

Outputs:
  scored   Table
    name       string
    email      string
    score      number
    weighted   number

Inspect an edge

$ rf inspect edge read-leads.rows:score-leads.rows

Edge: read-leads.rows -> score-leads.rows
Type: Table
Schema:
  name       string
  email      string
  score      number

Inspect the last run

$ rf inspect --last-run

Run: 2024-01-15T10:30:00Z
Status: success
Duration: 0.6s

  read-leads       success   12ms    5 rows
  score-leads      success   8ms     5 rows
  filter-top       success   6ms     3 rows
  write-output     success   4ms     3 rows written

JSON output

Use --format json for machine-readable output in scripts and tooling.

$ rf inspect --format json

{
  "name": "lead-scoring",
  "nodes": [
    {
      "id": "read-leads",
      "type": "source",
      "op": "file.read"
    },
    {
      "id": "score-leads",
      "type": "deterministic",
      "op": "sql.query"
    }
  ],
  "edges": [
    {
      "from": "read-leads.rows",
      "to": "score-leads.rows",
      "type": "Table"
    }
  ]
}

Exit codes

Code	Meaning
0	Inspection completed successfully.
1	Target not found (node, edge, or run ID doesn’t exist).