CLI Reference¶

The esml command is the primary terminal interface. It is installed as a console script entry point from esml.runner:main.

Commands¶

Print the full module surface with descriptions.

esml list-modules

Run a single named analysis module.

esml run-module <module-name> \
  --cpads-csv path/to/cpads.csv \
  --output-dir /tmp/esml-outputs

Run all (or selected) modules in sequence.

esml pipeline --all -y
esml pipeline --modules power-design logistic-models -y
esml pipeline --cpads-csv custom.csv --output-dir ./out

Query the terminal assistant (requires esml[ai] and OPENAI_API_KEY, or runs in local fallback mode).

esml ask "What does the propensity-scores module output?"

--cpads-csv: Path to the CPADS PUMF CSV. Defaults to docs/source/datasets/cpads-2021-2022-pumf2.csv.
--output-dir: Directory for CSV outputs. Defaults to data/manifest/outputs/.
-y / --yes: Skip the interactive confirmation prompt before running modules.

A shell wrapper ./esml at the repository root invokes .venv/bin/python -m esml.runner so the venv does not need to be activated manually:

./esml list-modules
./esml pipeline --all -y