CLI reference

Installing @stafyniaksacha/facturx exposes a facturx command. You can also run it without installing, via your package runner.

Invocation

npx

npx @stafyniaksacha/facturx <command> [options]

pnpm

pnpm dlx @stafyniaksacha/facturx <command> [options]

bun

bunx @stafyniaksacha/facturx <command> [options]

installed

# when the package is a dependency of your project
facturx <command> [options]

Commands

Command	Purpose
generate	Embed an XML into a PDF to produce a Factur-X / Order-X PDF/A-3.
extract	Extract the embedded XML from a PDF/A-3.
check	Validate an XML invoice against the XSD (and optionally Schematron).

Global options

Option	Description
--help, -h	Show help for the CLI or a specific command.
--version	Print the installed version.

npx @stafyniaksacha/facturx --help
npx @stafyniaksacha/facturx generate --help
npx @stafyniaksacha/facturx --version

Common options

Several options are shared across commands and behave identically everywhere:

Option	Alias	Description
--flavor	-f	Schema flavor: facturx, orderx, zugferd. Autodetected from the XML if omitted.
--level	-l	Schema level (e.g. en16931). Autodetected from the XML if omitted.
--output	-o	Output file path.
--check		Run XSD validation (default true; pass --no-check to skip).

See Profiles & flavors for the valid flavor / level combinations.