CLI reference

Generated from src/pipetree/cli.py (pipetree 0.1.1).

Usage: pipetree [OPTIONS] COMMAND [ARGS]...

  pipetree - metadata-driven pipeline orchestration.

Options:
  --version  Show the version and exit.
  --help     Show this message and exit.

Commands:
  graph     Print the dependency tree derived from --config.
  run       Run the pipeline described by --config.
  validate  Validate --config without running anything.

pipetree --version prints the version.

pipetree graph

Print the dependency tree derived from –config.

With –select, –tag or –exclude-tag, the tables a run with the same options would not touch are marked as not selected.

pipetree graph [OPTIONS]

Option	Default	Description
--config FILE	required	Path to the pipeline YAML config.
--format text|mermaid|html	text	html: one self-contained page (inline CSS + SVG) with the tree laid out in waves - redirect it to a file and open it in a browser.
--select TEXT	-	Comma-separated table names to run (fqn or unambiguous bare name). Everything else is left alone.
--tag TEXT	-	Run only tables carrying this tag. Repeat for several: a table needs at least one. Intersects with –select; –with-dependents and –with-ancestors extend the result.
--exclude-tag TEXT	-	Never run tables carrying this tag, even when –with-dependents or –with-ancestors pulls them in. Repeatable.
--with-dependents	off	Extend the selection to every table downstream of it (the CI/CD subtree mode).
--with-ancestors	off	Extend the selection to every table upstream of it (what it transitively reads).

pipetree run

Run the pipeline described by –config.

pipetree run [OPTIONS]

Option	Default	Description
--config FILE	required	Path to the pipeline YAML config.
--max-workers INTEGER	4	Maximum number of tables running at the same time.
--select TEXT	-	Comma-separated table names to run (fqn or unambiguous bare name). Everything else is left alone.
--tag TEXT	-	Run only tables carrying this tag. Repeat for several: a table needs at least one. Intersects with –select; –with-dependents and –with-ancestors extend the result.
--exclude-tag TEXT	-	Never run tables carrying this tag, even when –with-dependents or –with-ancestors pulls them in. Repeatable.
--with-dependents	off	Extend the selection to every table downstream of it (the CI/CD subtree mode).
--with-ancestors	off	Extend the selection to every table upstream of it (what it transitively reads).
--init	off	Full reload: treat every run table as if seeding fresh.
--live-html FILE	-	Keep an HTML picture of the dependency tree at this path, rewritten as tables run and finish. Open it in a browser: it refreshes itself until the run ends.

pipetree validate

Validate –config without running anything.

pipetree validate [OPTIONS]

Option	Default	Description
--config FILE	required	Path to the pipeline YAML config.
--list-tags	off	Print every tag with the number of tables carrying it, instead of the OK line.