Command-Line Interface

XBridge provides a command-line interface for quick conversions and validation without writing code.

Usage

xbridge INPUT_FILE [OPTIONS]
xbridge validate INPUT_FILE [OPTIONS]

Positional Arguments:

Optional Arguments:

--output-path PATH: Output directory path. If not specified, the output will be saved in the same directory as the input file.
--headers-as-datapoints: Treat headers as datapoints in the output. Default is False.
--strict-validation: Raise errors on validation failures. This is the default behavior.
--no-strict-validation: Emit warnings instead of errors for validation failures. Use this to continue processing despite orphaned facts.
--validate: Run validation before and after conversion. Pre-conversion errors stop the pipeline; post-conversion errors are reported after the output file has been written. Default is False.
--eba: Enable EBA-specific validation rules (entity format, decimal precision, currency checks, etc.). Only applies when --validate is also set. Default is False.
-h, --help: Show help message and exit.

Basic conversion (output to same directory as input):

xbridge instance.xbrl

Specify output directory:

xbridge instance.xbrl --output-path ./converted

Continue with warnings instead of errors:

xbridge instance.xbrl --no-strict-validation

Include headers as datapoints:

xbridge instance.xbrl --headers-as-datapoints

Combine multiple options:

xbridge instance.xbrl \
    --output-path ./output \
    --headers-as-datapoints \
    --no-strict-validation

Validate before and after conversion:

xbridge instance.xbrl --validate

Validate with EBA-specific rules:

xbridge instance.xbrl --validate --eba

Batch processing with shell:

# Convert all XBRL files in a directory
for file in instances/*.xbrl; do
    xbridge "$file" --output-path converted/
done

The validate subcommand checks XBRL instance files against structural and regulatory rules without performing conversion.

xbridge validate INPUT_FILE [OPTIONS]

Positional Arguments:

Optional Arguments:

--eba: Enable EBA-specific validation rules (entity format, decimal precision, currency checks, etc.). Default is False.
--post-conversion: Skip structural checks guaranteed by xbridge’s converter. Only meaningful for .zip (CSV) files. Default is False.
--json: Output findings as JSON instead of human-readable text. Useful for integration with other tools.
-h, --help: Show help message and exit.

Basic validation:

xbridge validate instance.xbrl

Enable EBA-specific rules:

xbridge validate instance.xbrl --eba

Validate an XBRL-CSV package:

xbridge validate report.zip --eba

Validate converter output (skip structural checks):

xbridge validate output.zip --eba --post-conversion

Get JSON output for tooling integration:

xbridge validate instance.xbrl --eba --json

The validate command exits with code 0 when no errors are found, and 1 when at least one ERROR-level finding is present.