@transitrix/cli
v2.0.0
Published
Transitrix CLI — compile, validate, and report on Transitrix diagrams (BPMN, Goals, DGCA, …) from any shell or CI pipeline.
Maintainers
Readme
@transitrix/cli
The Transitrix CLI — compile, validate, and report on Transitrix diagrams (BPMN, Goals, FGCA, Capability Map, Process Blueprint, and the rest of the Transitrix notation family) from any shell or CI pipeline.
This is the install-from-npm distribution of the same CLI shipped inside the Transitrix Studio VS Code extension. Use it when you want the resolver outside an editor — scripts, CI checks, downstream tools.
Install
npm install -g @transitrix/cli
transitrix --helpOr run without installing:
npx @transitrix/cli --helpQuick reference
transitrix compile <input>.yaml <output>.bpmn # YAML → BPMN 2.0 XML
transitrix validate <input>.yaml # per-file validation
transitrix validate --scope=repo # whole-repo canon checks
transitrix metrics <input>.yaml [--json] # layout-quality metrics
transitrix export-compliance [--format md|pdf] # compliance report
transitrix serve [--port 8765] # local web UIPDF compliance export requires WeasyPrint on PATH
(pipx install weasyprint).
What's included
dist/cli.js— bundled CLI entry point. Runtime npm dependencies (ajv,ajv-formats,bpmn-moddle,elkjs,js-yaml,xmlbuilder2) are declared independenciesand resolved by npm at install time.dist/repo-validate.jsanddist/export-compliance.js— lazy-loaded handlers for thevalidate --scope=repoandexport-compliancesubcommands. The Transitrix diagrams library is bundled into these.schemas/bpmn-dsl.schema.json— the YAML DSL JSON Schema used by the validator and parser. Located next todist/so the runtime pathdist/../schemas/bpmn-dsl.schema.jsonresolves.
Versioning
@transitrix/cli ships on its own version line, independent of the
Transitrix Studio extension and @transitrix/diagrams. The first published
release is 1.0.0.
Naming
The package is born in the 2.0 era of the methodology. The legacy cervin
bin alias is not shipped — only transitrix is on PATH.
License
MIT — see LICENSE.
Links
- Monorepo: https://github.com/transitrix/transitrix-studio
- Issues: https://github.com/transitrix/transitrix-studio/issues
- Methodology spec: https://github.com/transitrix/methodology
