CLI Reference
The public release exposes a Python CLI named culsma.
Install
bash
python -m pip install "culsma @ git+https://github.com/culsma/culsma.git@v1.0.0"From a source checkout:
bash
python -m pip install -e ".[dev]"culsma run
Run one or more .culs source files through the pipeline.
bash
culsma run --input examples/minimal/public_minimal.culs --artifacts-dir tmp/runEquivalent module form:
bash
python -m culsma.cli run \
--input examples/minimal/public_minimal.culs \
--artifacts-dir tmp/runIf you only want the primary user-facing result JSON, use --output instead:
bash
culsma run --input examples/minimal/public_minimal.culs --output tmp/result.jsonOptions:
| Option | Meaning |
|---|---|
--input | Path to a .culs source file. Repeatable for multi-file merge. |
--output | Optional path for the primary result JSON. |
--artifacts-dir | Output directory for debug and intermediate JSON artifacts. |
--fail-op | Stub driver failure injection by operation name. Repeatable. |
--material-state-json | Optional initial material state JSON payload. |
--inventory-check | Enable strict inventory validation and material checks. |
--library-root | Optional directory containing importable library .culs modules. Repeatable. |
culsma replay
Replay runtime state from a saved run artifact.
bash
culsma replay --run-json tmp/run/run.json --out tmp/replayed_state.jsonOptions:
| Option | Meaning |
|---|---|
--run-json | Path to run.json. |
--out | Output JSON path for reconstructed state. |
Run Tests
From a source checkout:
bash
python -m pytest -q