Skip to content

CLI Reference

pipectl run

Run a pipeline against input data.

bash
pipectl run <pipeline.yaml> [flags]

Arguments

ArgumentDescription
pipeline.yamlRequired. Path to the pipeline YAML file.

Flags

FlagShortDescription
--input <path>-iRead pipeline input from a file. Alternative to piping via stdin. Cannot be combined with piped stdin.
--output <path>-oWrite pipeline output to a file instead of stdout. Step logs are always written to stdout regardless of this flag.
--verbose-vEnable verbose logging. Prints per-step debug output — record counts, field operations, sort results — to stdout.
--dry-runValidate the pipeline config and print the ordered step list without executing any steps or reading input.

Examples

Run a pipeline with stdin:

bash
pipectl run pipeline.yaml < input.json

Run a pipeline with an input file:

bash
pipectl run pipeline.yaml --input input.json

Write output to a file:

bash
pipectl run pipeline.yaml -o output.jsonl < input.csv

Enable verbose logging:

bash
pipectl run pipeline.yaml --verbose < input.json

Validate a pipeline without running it:

bash
pipectl run pipeline.yaml --dry-run

Notes

  • run requires exactly one argument: the pipeline file path.
  • Input can be provided via --input <file> or piped through stdin. If neither is provided, the runtime executes but most pipelines will fail when the input format is parsed.
  • --input and piped stdin cannot be used together.
  • Step logs (log, count) are written to stdout. Only the final payload output is affected by -o.

Released under the MIT License.