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…debug: Run layered validation to debug a FLYNC…display-repo-structure: Display the repo structure of the current…errors: Inspect and maintain the FLYNC error…
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 <str>: Node type name to validate via validate_external_node. Omit to validate the full workspace.-c, --config <str>: 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 <str>: 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 <str>: 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 <str>: Output file path for UML diagram [default: exports/uml/system_uml.puml]--vlan-id <int>: 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 <str>: 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.
flync debug¶
Run layered validation to debug a FLYNC model step by step
Usage:
$ flync debug [OPTIONS] {dir_path}
Arguments:
dir_path: Path to FLYNC config directory [required]
Options:
--help: Show this message and exit.
flync display-repo-structure¶
Display the repo structure of the current FLYNC model
Usage:
$ flync display-repo-structure [OPTIONS]
Options:
--class <str>: Sub-tree to visualise. Choices: flync_model, ecu, ports, switches, ecu_topology, ecu_metadata, mac_multicast_endpoints, controller, controller_metadata, ethernet_interface, interface_config, sockets, can_interfaces, lin_interfaces, virtual_switch, communication, tcp_profiles, someip, sd_config, services, someip_timings, channels, pdus, can, lin, ethernet_pdu_containers, topology, system_topology, metadata. Defaults to the full FLYNCModel.--help: Show this message and exit.
flync errors¶
Inspect and maintain the FLYNC error catalogue.
Usage:
$ flync errors [OPTIONS] COMMAND [ARGS]...
Options:
--help: Show this message and exit.
Commands:
get-next-number: Print the next free globally-unique error…validate-catalogue: Check that the catalogue matches the code…generate-catalogue: (Re)generate…
flync errors get-next-number¶
Print the next free globally-unique error number.
Usage:
$ flync errors get-next-number [OPTIONS]
Options:
--help: Show this message and exit.
flync errors validate-catalogue¶
Check that the catalogue matches the code (source of truth).
Usage:
$ flync errors validate-catalogue [OPTIONS]
Options:
--help: Show this message and exit.
flync errors generate-catalogue¶
(Re)generate docs/source/error_catalogue.rst from the code.
Usage:
$ flync errors generate-catalogue [OPTIONS]
Options:
--help: Show this message and exit.