Quickstart to FLYNC

This guide helps you get up and running with FLYNC quickly. In just a few steps, you will install the main packages, create your first configuration model, and validate it using the FLYNC SDK.

Warning

If you haven’t set up your environment yet, head over to the Installation Guide first.

Where to Find FLYNC

FLYNC is distributed as an open-source project and can be accessed via its official repository and package distribution channels.

The public project contains:

  • FLYNC configuration models.

  • FLYNC SDK

  • FLYNC CLI

  • FLYNC converters

  • Documentation and reference materials

For more information about the project, refer to the FLYNC Homepage.

Project Namespaces

Namespace

Location

Purpose

Go to

flync

src/flync/

The core library - includes the FLYNC language model, SDK, validation engine, and workspace logic. This is the foundation that everything else builds on.

FLYNC Reference

flync_cli

src/flync_cli/

A Typer-based command-line interface for day-to-day engineering tasks: workspace validation, node information, VLAN inspection, SOME/IP service summaries, and system-level PlantUML diagram generation.

FLYNC CLI

flync_converter

src/flync_converter/

A pluggy-powered converter framework that transforms data between formats (JSON, YAML, FLYNC, and any third-party format added via plugins). Ships with a scriptable CLI, an interactive Textual TUI, and a PySide6 desktop GUI.

FLYNC Converter

Installation

To install FLYNC follow the standard installation procedure for your environment.

Note

For detailed platform-specific instructions, dependency information, and advanced setup options, please refer to the Installation Guide.

Next Steps

Now that you have successfully installed FLYNC, you can explore more advanced topics:

  • Examples — Realistic configuration samples for common SDV scenarios

  • FLYNC Reference — Complete language and model specification. Here you can learn how to author and validate your first FLYNC configuration.

These resources will help you model more complex architectures, services, and communication patterns.

You are now ready to start building Configuration-as-Code workflows with FLYNC!