@angel-vlqz/reportflow-cli
v0.1.3
Published
CLI for rendering enterprise PDF reports from declarative ReportFlow templates.
Maintainers
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
