format-info Command

The format-info command displays detailed information about a specific format handler, including parameters, capabilities, and supported domain types.

Synopsis

MauroImportExport.Cli format-info FORMAT [--importer-only] [--exporter-only] 
                         [--log-file FILE] [--log-level LEVEL]

Description

The format-info command provides comprehensive details about a specific format handler. It displays:

  • Format identifier and version
  • Implementation type name
  • Supported domain types
  • Capabilities (for exporters: multi-file, ZIP support)
  • Parameter definitions with types, defaults, and descriptions

If both an importer and exporter exist for the format, information for both is displayed unless filtered by options.

Arguments

FORMAT
The format identifier to query (e.g., json, skos, dita). Case-insensitive.

Options

--importer-only
Display information only for the importer (if available)
--exporter-only
Display information only for the exporter (if available)
--log-file FILE
Path to log file for recording operation details
--log-level LEVEL
Minimum logging level (Trace, Debug, Information, Warning, Error, Critical, None)

Exit Status

Code Description
0 Success - format information displayed
1 Format not found or conflicting options
130 Operation cancelled

Show Information for JSON Format

MauroImportExport.Cli format-info json

Show Only Exporter Information

MauroImportExport.Cli format-info dita --exporter-only

Query SKOS Importer Details

MauroImportExport.Cli format-info skos --importer-only

Parameter Information

For each parameter defined by the format handler, the following information is displayed in a table:

  • Key: The parameter name used with --param
  • Type: Boolean, String, Choice, or Integer
  • Required: Whether the parameter is mandatory
  • Default: Default value if not specified
  • Choices: Valid values for Choice type parameters
  • Description: Explanation of the parameter's purpose

Notes

Important:

The --importer-only and --exporter-only options are mutually exclusive.

Tip:

Use this command to discover available parameters before performing import or export operations.