plumb-render - render a plumbing pipeline as a graph diagram

SYNOPSIS

plumb-render file.plumb [--binding NAME] [--format FORMAT]

DESCRIPTION

plumb-render loads a pipeline specification from file.plumb and renders the specified plumb binding as a graph diagram on standard output.

If --binding is not given, the first plumb binding in the file is rendered.

The output is a graph description in the chosen format, suitable for piping to a graph layout tool or embedding in documentation.

OPTIONS

--binding NAME

Render the named plumb binding instead of the first one found.

--format FORMAT

Output format. One of dot (Graphviz, default), d2, or mermaid.

--version

Print the version string and exit.

--help

Print a usage summary and exit.

EXAMPLES

Render a pipeline as a PNG via Graphviz:

plumb-render my-pipeline.plumb | dot -Tpng -o pipeline.png

Render a specific binding in Mermaid format:

plumb-render my-pipeline.plumb --binding main --format mermaid

Render in D2 format:

plumb-render my-pipeline.plumb --format d2

EXIT STATUS

0

Success.

1

Render error (e.g. binding not found).

2

Configuration error (missing file, bad arguments).

SEE ALSO

plumb(1), plumbing(5)