Namespace xeoconvert

xeokit Multi-Format File Converter


CLI tool for converting 3D models between various formats.


xeoconvert is a Node.js command-line utility that converts 3D model or data files between various formats. It uses predefined pipelines that describe how to process input files into output files.

The tool is designed for users who want a simple, scriptable way to transform models, inspect the results, and optionally generate reports.

Installation

Install the xeokit SDK by running:

npm install @xeokit/sdk

Usage

node xeoconvert.js --pipeline <pipelineName> --<inputId> <inputFile> --<outputId> <outputFile> [options]
  • --pipeline <name> - Specifies the conversion pipeline to use. Each pipeline defines the required input and output formats.
  • --<inputId> <inputFile> - Supplies an input file for the pipeline. The input ID depends on the pipeline and is mandatory.
  • --<outputId> <outputFile> - Specifies the output file where the converted result will be saved. The output ID depends on the pipeline and is mandatory.
  • --log - Enables verbose logging for debugging and progress monitoring.
  • --<reporterId> <reportPath> - Generates a conversion report in the specified file. Reporter IDs vary depending on available report types.

References

createManifestReport → modelconverter.createManifestReport
createStatsReport → modelconverter.createStatsReport
ModelConverterManifestReport → modelconverter.ModelConverterManifestReport
ModelConverterManifestReportFile → modelconverter.ModelConverterManifestReportFile
ModelConverterStatsReport → modelconverter.ModelConverterStatsReport
ModelConverterStatsReportInput → modelconverter.ModelConverterStatsReportInput
ModelConverterStatsReportOutput → modelconverter.ModelConverterStatsReportOutput