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:

display-vlan-info: Deprecated alias for flync info vlans. (DEPRECATED)
display-service-info: Deprecated alias for ``flync info… (DEPRECATED)
display-repo-structure: Deprecated alias for flync filetree. (DEPRECATED)
debug: Deprecated alias for ``flync validate… (DEPRECATED)
validate: Validate a FLYNC Model or parts of a Model.
info: Display FLYNC workspace information in a…
filetree: Export the expected filetree of a FLYNC…
schema: Export the FLYNC model as JSON Schema…
generate-system-uml: Generate a UML representation of a given…
config: Manage the FLYNC CLI session configuration…
errors: Inspect and maintain the FLYNC error catalog.

`flync display-vlan-info`¶

Deprecated alias for flync info vlans.

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 the FLYNC config directory. Defaults to the path stored with flync config set.

Options:

-e, --ecu-name <str>: Optional: filter info for a specific ECU name.
--help: Show this message and exit.

`flync display-service-info`¶

Deprecated alias for flync info instances.

Usage:

$ flync display-service-info [OPTIONS] {service} [path]

Arguments:

service: Service for which the information needs to be displayed [required]
path: Path to the FLYNC config directory. Defaults to the path stored with flync config set.

Options:

--help: Show this message and exit.

`flync display-repo-structure`¶

Deprecated alias for flync filetree.

Usage:

$ flync display-repo-structure [OPTIONS]

Options:

--class <str>
--help: Show this message and exit.

`flync debug`¶

Deprecated alias for flync validate --verbose.

Usage:

$ flync debug [OPTIONS] [dir_path]

Arguments:

dir_path: Path to the FLYNC config directory. Defaults to the path stored with flync config set.

Options:

--help: Show this message and exit.

`flync validate`¶

Validate a FLYNC Model or parts of a Model.

Usage:

$ flync validate [OPTIONS] [path]

Arguments:

path: Path to the FLYNC config directory. Defaults to the path stored with flync config set.

Options:

-n, --node <str>: Node type name to validate via validate_external_node. Omit to validate the full workspace.
-c, --config-name, --config <str>: Name of configuration. [default: flync_config]
-v, --verbose: Run the layered debug checks (folder structure, YAML syntax, schema, field values, system-wide) instead of the summary tables. Only applies when validating the full workspace (no –node).
--help: Show this message and exit.

`flync info`¶

Display FLYNC workspace information in a structured, user-friendly format.

Usage:

$ flync info [OPTIONS] COMMAND [ARGS]...

Options:

--help: Show this message and exit.

Commands:

ecus: List every ECU in the workspace.
controllers: List the controllers of every ECU, or of…
switches: List the switches of every ECU, or of one…
ports: List the ports of every ECU, grouped by…
ip: List IP addresses across every ECU, with…
sockets: Show socket endpoints grouped by ECU and…
services: List every SOME/IP service, its…
instances: Show the consumer/provider deployments of…
vlans: Show VLAN membership grouped by VLAN,…
list-ecus: Deprecated alias for flync info ecus. (DEPRECATED)
list-controllers: Deprecated alias for ``flync info… (DEPRECATED)
list-switches: Deprecated alias for flync info switches. (DEPRECATED)
list-ports: Deprecated alias for flync info ports. (DEPRECATED)
list-ips: Deprecated alias for flync info ip. (DEPRECATED)
list-sockets: Deprecated alias for flync info sockets. (DEPRECATED)
list-services: Deprecated alias for flync info services. (DEPRECATED)

`flync info ecus`¶

List every ECU in the workspace.

Usage:

$ flync info ecus [OPTIONS] [path]

Arguments:

path: Path to the FLYNC config directory. Defaults to the path stored with flync config set.

Options:

--help: Show this message and exit.

`flync info controllers`¶

List the controllers of every ECU, or of one ECU with –ecu-name.

Usage:

$ flync info controllers [OPTIONS] [path]

Arguments:

path: Path to the FLYNC config directory. Defaults to the path stored with flync config set.

Options:

-e, --ecu-name <str>: Optional: filter info for a specific ECU name.
--help: Show this message and exit.

`flync info switches`¶

List the switches of every ECU, or of one ECU with –ecu-name.

Usage:

$ flync info switches [OPTIONS] [path]

Arguments:

path: Path to the FLYNC config directory. Defaults to the path stored with flync config set.

Options:

-e, --ecu-name <str>: Optional: filter info for a specific ECU name.
--help: Show this message and exit.

`flync info ports`¶

List the ports of every ECU, grouped by ECU, or of one ECU with –ecu-name.

Usage:

$ flync info ports [OPTIONS] [path]

Arguments:

path: Path to the FLYNC config directory. Defaults to the path stored with flync config set.

Options:

-e, --ecu-name <str>: Optional: filter info for a specific ECU name.
--help: Show this message and exit.

`flync info ip`¶

List IP addresses across every ECU, with their VLAN and subnet.

Usage:

$ flync info ip [OPTIONS] [path]

Arguments:

path: Path to the FLYNC config directory. Defaults to the path stored with flync config set.

Options:

-e, --ecu-name <str>: Optional: filter info for a specific ECU name.
--help: Show this message and exit.

`flync info sockets`¶

Show socket endpoints grouped by ECU and VLAN, or of one ECU with –ecu-name.

Usage:

$ flync info sockets [OPTIONS] [path]

Arguments:

path: Path to the FLYNC config directory. Defaults to the path stored with flync config set.

Options:

-e, --ecu-name <str>: Optional: filter info for a specific ECU name.
--help: Show this message and exit.

`flync info services`¶

List every SOME/IP service, its ID/version, and its providing/consuming ECUs.

Usage:

$ flync info services [OPTIONS] [path]

Arguments:

path: Path to the FLYNC config directory. Defaults to the path stored with flync config set.

Options:

--help: Show this message and exit.

`flync info instances`¶

Show the consumer/provider deployments of one SOME/IP service instance.

Usage:

$ flync info instances [OPTIONS] {service_id} {major_version} [path]

Arguments:

service_id: Service ID, decimal or hex (e.g. 0x0101). [required]
major_version: Major version of the service interface. [required]
path: Path to the FLYNC config directory. Defaults to the path stored with flync config set.

Options:

--help: Show this message and exit.

`flync info vlans`¶

Show VLAN membership grouped by VLAN, across the workspace or one ECU.

Usage:

$ flync info vlans [OPTIONS] [path]

Arguments:

path: Path to the FLYNC config directory. Defaults to the path stored with flync config set.

Options:

--vlan-id <int>: Optional: show only this VLAN.
-e, --ecu-name <str>: Optional: filter info for a specific ECU name.
--help: Show this message and exit.

`flync info list-ecus`¶

Deprecated alias for flync info ecus.

Usage:

$ flync info list-ecus [OPTIONS] [path]

Arguments:

path: Path to the FLYNC config directory. Defaults to the path stored with flync config set.

Options:

--help: Show this message and exit.

`flync info list-controllers`¶

Deprecated alias for flync info controllers.

Usage:

$ flync info list-controllers [OPTIONS] [path]

Arguments:

path: Path to the FLYNC config directory. Defaults to the path stored with flync config set.

Options:

-e, --ecu-name <str>: Optional: filter info for a specific ECU name.
--help: Show this message and exit.

`flync info list-switches`¶

Deprecated alias for flync info switches.

Usage:

$ flync info list-switches [OPTIONS] [path]

Arguments:

path: Path to the FLYNC config directory. Defaults to the path stored with flync config set.

Options:

-e, --ecu-name <str>: Optional: filter info for a specific ECU name.
--help: Show this message and exit.

`flync info list-ports`¶

Deprecated alias for flync info ports.

Usage:

$ flync info list-ports [OPTIONS] [path]

Arguments:

path: Path to the FLYNC config directory. Defaults to the path stored with flync config set.

Options:

-e, --ecu-name <str>: Optional: filter info for a specific ECU name.
--help: Show this message and exit.

`flync info list-ips`¶

Deprecated alias for flync info ip.

Usage:

$ flync info list-ips [OPTIONS] [path]

Arguments:

path: Path to the FLYNC config directory. Defaults to the path stored with flync config set.

Options:

-e, --ecu-name <str>: Optional: filter info for a specific ECU name.
--help: Show this message and exit.

`flync info list-sockets`¶

Deprecated alias for flync info sockets.

Usage:

$ flync info list-sockets [OPTIONS] [path]

Arguments:

path: Path to the FLYNC config directory. Defaults to the path stored with flync config set.

Options:

-e, --ecu-name <str>: Optional: filter info for a specific ECU name.
--help: Show this message and exit.

`flync info list-services`¶

Deprecated alias for flync info services.

Usage:

$ flync info list-services [OPTIONS] [path]

Arguments:

path: Path to the FLYNC config directory. Defaults to the path stored with flync config set.

Options:

--help: Show this message and exit.

`flync filetree`¶

Export the expected filetree of a FLYNC configuration to a txt file.

Usage:

$ flync filetree [OPTIONS]

Options:

--class <str>: Sub-tree to visualize. 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, compute_node, compute_nodes, virtual_switches, controller_topology, communication, tcp_profiles, someip, sd_config, services, someip_timings, diagnostics, doip, doip_timings, uds, uds_timings, uds_servers, dids, routines, dtcs, channels, pdus, can, lin, ethernet_pdu_containers, topology, system_topology, metadata. Defaults to the full FLYNCModel.
--help: Show this message and exit.

`flync schema`¶

Export the FLYNC model as JSON Schema files, one per Pydantic model class, linked with $ref.

Usage:

$ flync schema [OPTIONS] [output_dir]

Arguments:

output_dir: Directory the schema files are written to. [default: schemas]

Options:

--mode <validation|serialization>: Describe the input accepted by validation or the output produced by serialization. [default: validation]
--base-uri <str>: URI the schema files are published under. Sets an absolute $id on every file.
--suffix <str>: File name suffix of every schema file. [default: .schema.json]
--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 the FLYNC config directory. Defaults to the path stored with flync config set.

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 config`¶

Manage the FLYNC CLI session configuration (the default workspace path).

Usage:

$ flync config [OPTIONS] COMMAND [ARGS]...

Options:

--help: Show this message and exit.

Commands:

set: Store a FLYNC workspace path to use when a…
show: Print the stored workspace path.
clear: Forget the stored workspace path.

`flync config set`¶

Store a FLYNC workspace path to use when a command omits its path argument.

Usage:

$ flync config set [OPTIONS] {path}

Arguments:

path: Path to a FLYNC config directory. [required]

Options:

--help: Show this message and exit.

`flync config show`¶

Print the stored workspace path.

Usage:

$ flync config show [OPTIONS]

Options:

--help: Show this message and exit.

`flync config clear`¶

Forget the stored workspace path.

Usage:

$ flync config clear [OPTIONS]

Options:

--help: Show this message and exit.

`flync errors`¶

Inspect and maintain the FLYNC error catalog.

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-catalog: Check that the catalog matches the code…
generate-catalog: (Re)generate docs/source/error_catalog.rst…
fix-numbers: Renumber duplicated error numbers, keeping…
sync: Fix duplicate numbers and (re)generate the…

`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-catalog`¶

Check that the catalog matches the code (source of truth).

Usage:

$ flync errors validate-catalog [OPTIONS]

Options:

--help: Show this message and exit.

`flync errors generate-catalog`¶

(Re)generate docs/source/error_catalog.rst from the code.

Usage:

$ flync errors generate-catalog [OPTIONS]

Options:

--help: Show this message and exit.

`flync errors fix-numbers`¶

Renumber duplicated error numbers, keeping the one already on the base branch.

Usage:

$ flync errors fix-numbers [OPTIONS]

Options:

--base <str>: Base branch to diff against when deciding which duplicate keeps its number.
--dry-run: Report what would change without writing anything.
--help: Show this message and exit.

`flync errors sync`¶

Fix duplicate numbers and (re)generate the catalog

Usage:

$ flync errors sync [OPTIONS]

Options:

--base <str>: Base branch to diff against when deciding which duplicate keeps its number.
--check: Write nothing; exit 1 if anything would change.
--fix-duplicates / --no-fix-duplicates: Renumber duplicates before generating. [default: fix-duplicates]
--help: Show this message and exit.

Usage¶

flync display-vlan-info¶

flync display-service-info¶

flync display-repo-structure¶

flync debug¶

flync validate¶

flync info¶

flync info ecus¶

flync info controllers¶

flync info switches¶

flync info ports¶

flync info ip¶

flync info sockets¶

flync info services¶

flync info instances¶

flync info vlans¶

flync info list-ecus¶

flync info list-controllers¶

flync info list-switches¶

flync info list-ports¶

flync info list-ips¶

flync info list-sockets¶

flync info list-services¶

flync filetree¶

flync schema¶

flync generate-system-uml¶

flync config¶

flync config set¶

flync config show¶

flync config clear¶

flync errors¶

flync errors get-next-number¶

flync errors validate-catalog¶

flync errors generate-catalog¶

flync errors fix-numbers¶

flync errors sync¶

`flync display-vlan-info`¶

`flync display-service-info`¶

`flync display-repo-structure`¶

`flync debug`¶

`flync validate`¶

`flync info`¶

`flync info ecus`¶

`flync info controllers`¶

`flync info switches`¶

`flync info ports`¶

`flync info ip`¶

`flync info sockets`¶

`flync info services`¶

`flync info instances`¶

`flync info vlans`¶

`flync info list-ecus`¶

`flync info list-controllers`¶

`flync info list-switches`¶

`flync info list-ports`¶

`flync info list-ips`¶

`flync info list-sockets`¶

`flync info list-services`¶

`flync filetree`¶

`flync schema`¶

`flync generate-system-uml`¶

`flync config`¶

`flync config set`¶

`flync config show`¶

`flync config clear`¶

`flync errors`¶

`flync errors get-next-number`¶

`flync errors validate-catalog`¶

`flync errors generate-catalog`¶

`flync errors fix-numbers`¶

`flync errors sync`¶