CLI Reference
pipectl run
Run a pipeline against input data.
bash
pipectl run <pipeline.yaml> [flags]Arguments
| Argument | Description |
|---|---|
pipeline.yaml | Required. Path to the pipeline YAML file. |
Flags
| Flag | Short | Description |
|---|---|---|
--input <path> | -i | Read pipeline input from a file. Alternative to piping via stdin. Cannot be combined with piped stdin. |
--output <path> | -o | Write pipeline output to a file instead of stdout. Step logs are always written to stdout regardless of this flag. |
--verbose | -v | Enable verbose logging. Prints per-step debug output — record counts, field operations, sort results — to stdout. |
--dry-run | Validate 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.jsonRun a pipeline with an input file:
bash
pipectl run pipeline.yaml --input input.jsonWrite output to a file:
bash
pipectl run pipeline.yaml -o output.jsonl < input.csvEnable verbose logging:
bash
pipectl run pipeline.yaml --verbose < input.jsonValidate a pipeline without running it:
bash
pipectl run pipeline.yaml --dry-runNotes
runrequires 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. --inputand piped stdin cannot be used together.- Step logs (
log,count) are written tostdout. Only the final payload output is affected by-o.