Quick Start

Installation

flync_converter is included in the main flync package. For installation instructions, see Installation Guide.

CLI (Recommended)

The CLI is the recommended way to use flync_converter. It provides a streamlined interface with built-in help, format auto-detection, and interactive options.

CLI - Single Conversion

The source and destination are always folders, not individual files. By default, the source format is FLYNC and the destination format is FLYNC.

# default: convert from FLYNC workspace to FLYNC workspace
flync-converter convert -s ./flync_source -o ./flync_output

# convert FLYNC to DBC
flync-converter convert -s ./flync_source -o ./dbc_output -of dbc

# convert YAML to FLYNC (optional source format, defaults to FLYNC)
flync-converter convert -s ./yaml_source -o ./flync_output -sf yaml

Additional converter options can be passed using --src-<field> / --dst-<field> flags

flync-converter convert -sf yaml -of flync --help

CLI - Interactive TUI

flync-converter -i
# or equivalently:
flync-converter tui
flync-converter-interactive

The TUI opens a split-panel screen: source on the left, destination on the right. Pick a format from each dropdown, fill in the config fields, and click Convert. Output streams live in a log panel at the bottom.

List available converters

flync-converter list-converters

Note

Built-in converters (flync, yaml, json, dbc) are always available. Additional converters from plugins are automatically discovered if the plugin package is installed via pip install. For plugin development and debugging, see Local Development & Debugging.

Desktop GUI

flync-converter --gui
# or
flync-converter-gui

Opens the PySide6 desktop application with the same split-panel layout as the TUI but as a native window.

Python API

from flync_converter import convert
from flync_converter import registry
import logging

# set your desired logging level
logging.basicConfig(level=logging.DEBUG)

# load plugins to get available converters
registry.load_plugins()


# default: convert from FLYNC
convert(
    source="path/to/flync_source",
    destination="path/to/output",
    destination_type="json",
)

# convert FLYNC to DBC
convert(
    source="path/to/flync_source",
    destination="path/to/dbc_output",
    destination_type="dbc",
)

# convert from YAML to FLYNC
convert(
    source="path/to/yaml_folder",
    destination="path/to/flync_output",
    source_type="yaml",
)

Next Steps

• Usage - deeper usage patterns

• CLI Reference - all commands and options

• Plugin Development Introduction - add your own formats