Usage¶
FLYNC CLI tool for validating the model, visually displaying the relevant information and generating system UML diagrams
Usage:
$ flync [OPTIONS] COMMAND [ARGS]...
Options:
--version: Show the installed version of FLYNC.--install-completion: Install completion for the current shell.--show-completion: Show completion for the current shell, to copy it or customize the installation.--help: Show this message and exit.
Commands:
validate: Validate a FLYNC Model or parts of a Model.info: Display model information in a structured…display-vlan-info: Display the controllers, switch ports and…generate-system-uml: Generate a UML representation of a given…display-service-info: Display all details related to a SOME/IP…
flync validate¶
Validate a FLYNC Model or parts of a Model.
Usage:
$ flync validate [OPTIONS] PATH
Arguments:
PATH: Path to FLYNC config directory [required]
Options:
-n, --node TEXT: Node type name to validate via validate_external_node. Omit to validate the full workspace.-c, --config TEXT: Name of configuration. [default: flync_config]-q, --quiet: Only show final result of the validation.--help: Show this message and exit.
flync info¶
Display model information in a structured and user-friendly format.
Usage:
$ flync info [OPTIONS] COMPONENT:{list-ecus|list-controllers|list-switches|list-ports|list-sockets|list-services|list-ips} PATH
Arguments:
COMPONENT:{list-ecus|list-controllers|list-switches|list-ports|list-sockets|list-services|list-ips}: Specify the component type for which you want to display information. [required]PATH: Path to FLYNC config directory. [required]
Options:
-e, --ecu-name TEXT: Optional: filter info for a specific ECU name.--help: Show this message and exit.
flync display-vlan-info¶
Display the controllers, switch ports and IPs that are part of one VLAN for the system or an ECU.
Usage:
$ flync display-vlan-info [OPTIONS] VLAN_ID PATH
Arguments:
VLAN_ID: VLAN ID for which the information needs to be displayed [required]PATH: Path to FLYNC config directory. [required]
Options:
-e, --ecu-name TEXT: Optional: filter info for a specific ECU name.--help: Show this message and exit.
flync generate-system-uml¶
Generate a UML representation of a given system configuration. Java (JRE 11+) must be on your PATH for PlantUML rendering to work.
Usage:
$ flync generate-system-uml [OPTIONS] PATH
Arguments:
PATH: Path to FLYNC config directory containing ecus/ [required]
Options:
-o, --output TEXT: Output file path for UML diagram [default: exports/uml/system_uml.puml]--vlan-id INTEGER: Filter diagram to only include components using this VLAN ID--macsec-info: Show the MACsec annotation if present in the ports--qos-info: Show the QoS annotation if present in the ports--iface-info: Show the Information of the Interface (VLANs, Multicast, IPs)--ptp-info: Show the PTP role if present in the port--target-ecu TEXT: generate the system uml for only the target ECU,default is all--help: Show this message and exit.
flync display-service-info¶
Display all details related to a SOME/IP service deployment
Usage:
$ flync display-service-info [OPTIONS] SERVICE PATH
Arguments:
SERVICE: Service for which the information needs to be displayed [required]PATH: Path to flync config directory. [required]
Options:
--help: Show this message and exit.