FacturXDotNet.CLI 0.5.7-alpha

Prefix Reserved
This is a prerelease version of FacturXDotNet.CLI.
There is a newer prerelease version of this package available.
See the version list below for details.
dotnet tool install --global FacturXDotNet.CLI --version 0.5.7-alpha
                    
This package contains a .NET tool you can call from the shell/command line.
dotnet new tool-manifest
                    
if you are setting up this repo
dotnet tool install --local FacturXDotNet.CLI --version 0.5.7-alpha
                    
This package contains a .NET tool you can call from the shell/command line.
#tool dotnet:?package=FacturXDotNet.CLI&version=0.5.7-alpha&prerelease
                    
nuke :add-package FacturXDotNet.CLI --version 0.5.7-alpha
                    

Getting started

Using NuGet

dotnet tool install --global FacturXDotNet.CLI --framework net8.0

Using binaries

Download the binaries for your platform in the latest release.

Documentation

FacturX.NET CLI v0.2.1-alpha+790b140996d1c1bef17d6f725e0d7fd776df34b1
Copyright © 2025 Ismail Bennani

Usage:
  facturx [command] [options]

Options:
  --version       Show version information
  -?, -h, --help  Show help and usage information

Commands:
  extract <path>   Extracts the content of a Factur-X PDF.
  validate <path>  Validates the content of a Factur-X PDF.

Generate

FacturX.NET CLI v0.2.1-alpha+790b140996d1c1bef17d6f725e0d7fd776df34b1
Copyright © 2025 Ismail Bennani

Usage:
  facturx generate [options]

Options:
  --pdf <path> (REQUIRED)                                                  The path to the PDF that will be used as base.
  --cii <path> (REQUIRED)                                                  The path to the CII file to use as structured data.
  --cii-name <name>                                                        The name of the CII attachment in the result. [default: factur-x.xml]
  --attach <path>                                                          Additional files to attach to the result.
  --author <name>                                                          The name of the author of the document. This will be added to the metadata of the output file.
  -o, --output-path <path>                                                 The path to the output file.
  --skip-validation                                                        Do not validate the generated Factur-X PDF. [default: False]
  --warnings-as-errors                                                     Treat warnings as errors. [default: False]
  -p, --profile <Basic|BasicWl|En16931|Extended|Minimum|None>              The profile to use for validation. If set, the profile will override the one specified in the Factur-X file.
  -s, --skip-rule                                                          The business rules that should be skipped. Example: --skip-rule "BR-01" --skip-rule "BR-02"
  -v, --verbosity <d|detailed|diag|diagnostic|m|minimal|n|normal|q|quiet>  Set the verbosity level. [default: Normal]
  -?, -h, --help                                                           Show help and usage information

Example

facturx generate --pdf "0.MINIMUM\Facture_F20220023-LE_FOURNISSEUR-POUR-LE_CLIENT_MINIMUM.pdf" --cii "0.MINIMUM\Facture_F20220023-LE_FOURNISSEUR-POUR-LE_CLIENT_MINIMUM.xml" 

Result

╭─Options──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ Basd PDF         D:\source\repos\FacturXDotNet\Specification 1.0.07.2\5. FACTUR-X 1.07.2 - Examples\0.MINIMUM\Facture_F20220023-LE_FOURNISSEUR-POUR-LE_CLIENT_MINIMUM.pdf │
│ CII XML          D:\source\repos\FacturXDotNet\Specification 1.0.07.2\5. FACTUR-X 1.07.2 - Examples\0.MINIMUM\Facture_F20220023-LE_FOURNISSEUR-POUR-LE_CLIENT_MINIMUM.xml │
│ Validate result  True                                                                                                                                                        │
╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯

✔ The input files have been read in 1 millisecond.
✔ The document has been generated in 70 milliseconds.
✔ The document has been checked in 70 milliseconds.

✔ The document is valid.
✔ Document profile: Minimum.
✔ Detected profile: Extended.

✔ The document has been exported to D:\source\repos\FacturXDotNet\Specification 1.0.07.2\5. FACTUR-X 1.07.2 - Examples\0.MINIMUM\Facture_F20220023-LE_FOURNISSEUR-POUR-LE_CLIENT_MINIMUM-facturx.pdf in 3 milliseconds.

Validate

FacturX.NET CLI v0.2.1-alpha+790b140996d1c1bef17d6f725e0d7fd776df34b1
Copyright © 2025 Ismail Bennani

Usage:
  facturx validate <path> [options]

Arguments:
  <path>  The path to the Factur-X PDF.

Options:
  --cii-attachment <name>                                      The name of the CII attachment. [default: factur-x.xml]
  --warnings-as-errors                                         Treat warnings as errors.
  -p, --profile <Basic|BasicWl|En16931|Extended|Minimum|None>  The profile to use for validation. If set, the profile will override the one specified in the Factur-X file.
  -s, --skip-rule                                              The business rules that should be skipped. Example: --skip-rule "BR-01" --skip-rule "BR-02"
  -?, -h, --help                                               Show help and usage information

Example

facturx validate "0.MINIMUM\Facture_F20220023-LE_FOURNISSEUR-POUR-LE_CLIEN_MINIMUM.pdf"

Result

╭─Options──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ Document             D:\source\repos\FacturXDotNet\Specification 1.0.07.2\5. FACTUR-X 1.07.2 - Examples\0.MINIMUM\Facture_F20220023-LE_FOURNISSEUR-POUR-LE_CLIENT_MINIMUM.pdf │
╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯

✔ The document has been parsed in 122 milliseconds.
✔ The document has been checked in 36 milliseconds.

✔ The document is valid.
✔ Document profile: Minimum.

Extract

FacturX.NET CLI v0.2.1-alpha+790b140996d1c1bef17d6f725e0d7fd776df34b1
Copyright © 2025 Ismail Bennani

Usage:
  facturx extract <path> [options]

Arguments:
  <path>  The path to the Factur-X PDF.

Options:
  --cii <path>             Extracts the content of the CII XML. Optionally specify a path, otherwise the CII XML will be saved next to the PDF with the same name.
  --cii-attachment <name>  The name of the CII attachment. [default: factur-x.xml]
  --xmp <path>             Extracts the content of the XMP metadata. Optionally specify a path, otherwise the XMP metadata will be saved next to the PDF with the same name.
  -?, -h, --help           Show help and usage information

Example:

facturx validate "0.MINIMUM\Facture_F20220023-LE_FOURNISSEUR-POUR-LE_CLIEN_MINIMUM.pdf" --cii --xmp

Result

╭─Options─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ Document    D:\source\repos\FacturXDotNet\Specification 1.0.07.2\5. FACTUR-X 1.07.2 - Examples\0.MINIMUM\Facture_F20220023-LE_FOURNISSEUR-POUR-LE_CLIENT_MINIMUM.pdf │
│ Export CII  True                                                                                                                                                        │
╰─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯

✔ Extracted CII XML to 'D:\source\repos\FacturXDotNet\Specification 1.0.07.2\5. FACTUR-X 1.07.2 - Examples\0.MINIMUM\Facture_F20220023-LE_FOURNISSEUR-POUR-LE_CLIENT_MINIMUM.xml' in 75 milliseconds.
✔ Extracted XMP metadata to 'D:\source\repos\FacturXDotNet\Specification 1.0.07.2\5. FACTUR-X 1.07.2 - Examples\0.MINIMUM\Facture_F20220023-LE_FOURNISSEUR-POUR-LE_CLIENT_MINIMUM.xmp' in 5 milliseconds.

Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 is compatible.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

This package has no dependencies.

Version Downloads Last updated
0.5.9-alpha 113 4/21/2025
0.5.8-alpha 121 4/20/2025
0.5.7-alpha 115 4/20/2025
0.5.6-alpha 118 4/20/2025
0.5.5-alpha 119 4/20/2025
0.5.4-alpha 90 4/18/2025
0.5.3-alpha 150 4/16/2025
0.5.2-alpha 153 4/15/2025
0.5.1-alpha 148 4/15/2025
0.5.0-alpha 149 4/15/2025
0.4.2-alpha 132 4/13/2025
0.4.1-alpha 139 4/13/2025
0.3.7-alpha 118 4/8/2025
0.3.6-alpha 117 4/8/2025
0.3.5-alpha 120 4/8/2025
0.3.4-alpha 120 4/8/2025
0.3.2-alpha 119 4/8/2025
0.3.1-alpha 115 4/6/2025
0.2.1-alpha 99 3/27/2025
0.1.0-alpha 427 3/26/2025
0.0.0-alpha.0.92 235 3/23/2025
0.0.0-alpha.0.73 119 3/23/2025
0.0.0-alpha.0.70 124 3/22/2025