Package Exports
- @angel-vlqz/reportflow-cli
- @angel-vlqz/reportflow-cli/dist/index.js
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@angel-vlqz/reportflow-cli) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
@angel-vlqz/reportflow-cli
CLI for generating ReportFlow PDFs from template + JSON data.
Install
Requirements:
- Node.js
>=22 - ESM project
Install locally:
pnpm add -D @angel-vlqz/reportflow-cliOr run without installing:
pnpm dlx @angel-vlqz/reportflow-cli --helpCommands
render
One-shot PDF generation.
reportflow render \
--template ./examples/report.tsx \
--data ./examples/data/maintenance.json \
--out ./out/report.pdfdev
Watch mode for template/data files.
reportflow dev \
--template ./examples/report.tsx \
--data ./examples/data/maintenance.json \
--out ./out/report.pdfTemplate Contract
Template file must export a default document factory, normally built with:
createDocument((data) => RFNode, schema?)from@angel-vlqz/reportflow-core
The --data JSON is parsed and validated by the optional schema.
Typical Workflow
- Build template in TypeScript (
.tsx). - Store report data as JSON.
- Run
reportflow renderin CI/CD or local scripts. - Publish generated PDF artifact.
License
MIT