Skip to content
R2XR2Xr2x-plexos

Configure CLI pipelines

Install the package into the CLI environment first. Plugin references come from the [project.entry-points."r2x_plugin"] table in pyproject.toml.

Terminal window
r2x list r2x-plexos
r2x run plexos-parser --help
r2x run plexos-exporter --help

The generated help reflects the installed package’s configuration schema. Use fully qualified references (r2x-plexos.plexos-parser) when composing plugins from multiple packages.

Share settings

Section titled “Share settings”

Start from the tested round-trip pipeline. Move repeated values to variables and reference them with ${name} in config. Parser and exporter configurations are separate: set each plugin’s input/output fields explicitly. Run from the directory containing your relative data paths.

Terminal window
r2x init pipeline.yaml
r2x run pipeline.yaml --list
r2x run pipeline.yaml round_trip --print
r2x run pipeline.yaml round_trip --dry-run

init creates a starter file. Replace its example pipeline with your own before running it. Compare --print with the configuration source, then execute without preview flags.

For cross-format workflows, insert the appropriate R2X translator between parser and exporter. These packages provide format ingestion and serialization; a parser/exporter round trip alone does not translate component types.