CLI-Manual

The DeloreanCLI is the command line interface for interacting with the Delorean-AIXM app. It supports three AIXM schema flavours:

• delorean-cli-aixm51 for AIXM 5.1
• delorean-cli-aixm511 for AIXM 5.1.1
• delorean-cli-aixm52 for AIXM 5.2

The DeloreanCLI can be launched directly from the command line by executing the packaged JAR file using Java:

# For aixm 5.1
java -jar delorean-cli-aixm51-1.0.0.jar [options] [command]

# For aixm 5.1.1
java -jar delorean-cli-aixm511-1.0.0.jar [options] [command]

# For aixm 5.2
java -jar delorean-cli-aixm52-1.0.0.jar [options] [command]

These modules support two possible types of interaction:

Direct CLI Mode

Connect to a single database and run one action (persist, extract, merge, or render) against a freshly allocated container.

# For aixm 5.1
java -jar delorean-cli-aixm51-1.0.0.jar -h <host> -p <port> -d <dbname> -U <user> [-W] -a <action> 
  [-f <file>] 
  [--id <id>] 
  [--time <time>]

Flag	Description	Exemple
-h, --host	Database host or socket directory	localhost
-p, --port	Database port	5432
-d, --dbname	Database name	aixm-dataset-51
-U, --username	Database user	postgres
-W, --password	Prompts interactively for the password
-a, --action	One of format, persist, extract, merge, predicate, render	persist
-f, --file	Target data file path	C:\dataset\aixm.xml
--id	Entity identifier, used with extract, merge, predicate	31
--time	Timestamp, used with predicate-style lookups	2026-09-01T23:39:45Z

• format : Format the dadabase.
• persist : Load AIXM XML data from a file into the database.
  • requires a --file parameter, which can be in XML or zipped XML format.
• extract : Extracts AIXM records from the database into an XML file.
  • requires a --file parameter to extract AIXM data can be in XML or zipped XML format.
  • the --id parameter hjid of the persisted AIXM message from which the data will be extracted.
• merge : Combine multi-temporal AIXM datasets into a single timeline.
  • the --id parameter hjid of the persisted AIXM message into which the data will be merged.
  • requires a --file parameter to load AIXM data from can be in XML or zipped XML format.
• predicate : Extracts AIXM records from the database using a predicate that selects active time slices and writes them into an XML file.
  • requires a --file parameter to extract AIXM data can be in XML or zipped XML format.
  • the --id parameter hjid of the persisted AIXM message from which the data will be extracted.
  • requires a --time parameter to predicate only the timeslice that are active during and after this time period.
• render : Render AIXM geometry and materialised views.

Yaml CLI Mode

Describe a complete multi-container pipeline in a workflow file, then run the entire pipeline from start to finish with a single invocation. This process can be automated as a task that runs at fixed intervals. YAML files also allow for more granular control of the app's configuration and a wider range of functions to be used in the pipeline.

# For aixm 5.1
java -jar delorean-cli-aixm51-1.0.0.jar -y file.yaml

# For aixm 5.1.1
java -jar delorean-cli-aixm511-1.0.0.jar -y file.yaml

# For aixm 5.2
java -jar delorean-cli-aixm52-1.0.0.jar -y file.yaml

Flag	Description	Exemple
-y, --yaml	workflow yaml file	localhost

The workflow file is structured as follows :

name: <string>            # optional, defaults to "Unnamed Workflow"
logging: <object|string>  # optional
service: <object>         # optional
containers: [ ... ]       # list of container definitions
pipeline: [ ... ]         # ordered list of pipeline steps