API for command line tool¶
nyaml supports a single tool for the command line interface (CLI). This page provides documentation for its API.
nyaml2nxdl¶
Main function that distinguishes the input file format and launches the tools.
Usage:
Options:
| Name | Type | Description | Default |
|---|---|---|---|
--output-file |
text | Specify the output file path for the converted file. | Sentinel.UNSET |
--check-consistency |
boolean | Check whether YAML and NXDL can be recursively converted, ensuring version consistency. | False |
--do-not-store-nxdl |
boolean | Prevent the input NXDL file from being stored as a comment at the end of the output YAML file. | False |
--verbose |
boolean | Display keywords and value types in standard output to assist in identifying issues in YAML files. | False |
--help |
boolean | Show this message and exit. | False |