Commands

Table of contents

  1. Validate Config
  2. Validate Query
  3. Validate Mermaid
  4. Merge Config
  5. Execute Query
  6. Generate Mermaid

YAMLtecture supports a number of commands for various operations. These commands are used to interact with the YAMLtecture configuration, query the configuration, and render the configuration as a mermaid diagram.

Validate Config

The validate config command, --validateConfig, takes in a configuration file and runs the validation checks on the configuration.

The inputs are used in the following order of precedence:

  1. The --configIn=<filePath> flag
  2. The --in=<filePath> flag
  3. The STDIN

This command outputs validation errors and warnings to the console via standard output.

Validate Query

The validate query command, --validateQuery, takes in a query file and runs the validation checks on the query.

The inputs are used in the following order of precedence:

  1. The --queryIn=<filePath> flag
  2. The --in=<filePath> flag
  3. The STDIN

This command outputs validation errors and warnings to the console via standard output.

Validate Mermaid

The validate mermaid command, --validateMermaid, takes in a Mermaid file and runs validation checks on it.

The inputs are used in the following order of precedence:

  1. The --mermaidIn=<filePath> flag
  2. The --in=<filePath> flag
  3. The STDIN

This command outputs validation errors and warnings to the console via standard output.

Merge Config

The merge config command, --mergeConfig, takes in a folder path and merges all of the configuration files into a single output configuration file.

The only input for this command is the --in=<folderPath> flag, which is used to specify a folder path that contains the configuration files-unlike other commands.

The output of this command is the resulting config YAML, which is written to STDOUT. If --out=<filePath> is specified, the output is written to the specified file instead.

Execute Query

The execute query command, --executeQuery, takes in both a configuration file and a query file. The validate config and validate query checks are always performed, but the details as for the failure of these checks are not displayed.

Since this command accepts multiple inputs, the configuration file can be specified in the following order of precedence:

  1. The --configIn=<filePath> flag
  2. The STDIN

The query file can be specified in the following order of precedence:

  1. The --queryIn=<filePath> flag

Note that the --in=<filePath> flag is not applicable to this command, as it requires both a configuration and a query file.

The output of this command is the resulting config YAML, which is written to STDOUT. If --out=<filePath> is specified, the output is written to the specified file instead.

Generate Mermaid

The generate mermaid command, --generateMermaid, takes in a configuration file and renders the configuration as a mermaid flowchart.

Since this command accepts multiple inputs, the configuration file can be specified in the following order of precedence:

  1. The --configIn=<filePath> flag
  2. The STDIN

Mermaid settings can be specified in the following order of precedence:

  1. The --mermaidIn=<settings> flag
  2. A default set of settings is used

The output of this command will be a Mermaid flowchart that is output to STDOUT or if --out=<filePath> is specified then the output will be written to the specified file.