Installing FlowState

FlowState 1.0 is in a controlled release. Packages for every platform are available to early-access users, who receive download instructions with their invitation. To request one, use the early-access form on the home page.

FlowState draws its interface with the GPU (wgpu), so an up-to-date graphics driver gives the best results. Every package contains two programs: the desktop app FlowState and the command-line tool flowstate-cli (see Command line and automation API).

Windows

Microsoft Store

In the Microsoft Store, the app is listed as FlowState Process Studio, because the name “FlowState” alone was already taken in the Store. Once installed, the app calls itself FlowState everywhere. During early access the listing is private: open the direct Store link from your invitation, then click Get or Install.

The Store package:

• appears in the Start menu and registers .flow files;
• includes flowstate-cli, which you can run from any terminal;
• is updated automatically by the Store.

Installer

Run FlowState-1.0.0-windows-x64-setup.exe. The wizard asks whether to install for you only (no administrator rights needed) or for all users, and offers these options:

• Create a desktop shortcut
• Open FlowState process files (.flow) with FlowState: the file association
• Add the flowstate-cli command-line tool to PATH: off by default

The uninstaller (Settings ▸ Apps, or the Start-menu entry) removes everything the installer added. A portable .zip is also available: unzip it anywhere and run FlowState.exe.

macOS

1. Open FlowState-1.0.0-macos-universal.dmg.
2. Drag FlowState to the Applications folder.
3. Start FlowState from Launchpad or Applications.

The app is a universal binary that runs natively on Apple silicon and Intel Macs. It is signed with a Developer ID and notarised by Apple, so Gatekeeper opens it without warnings. The app registers the .flow document type. The command-line tool is inside the bundle; to use it from a terminal, add an alias or a symbolic link:

sudo ln -s /Applications/FlowState.app/Contents/MacOS/flowstate-cli /usr/local/bin/flowstate-cli

Linux

Debian and Ubuntu (.deb)

sudo apt install ./flowstate_1.0.0-1_amd64.deb
flowstate          # desktop app (also in your applications menu)
flowstate-cli --help

The package installs /usr/bin/flowstate and /usr/bin/flowstate-cli, a desktop entry, AppStream metadata, the .flow MIME type and icons. apt pulls in the runtime libraries (X11/Wayland and GL/Vulkan) automatically. Remove it with sudo apt remove flowstate.

Flatpak

flatpak install --user FlowState-1.0.0-x86_64.flatpak
flatpak run uk.yaylali.FlowState

The app id is uk.yaylali.FlowState. The sandbox grants access to Wayland/X11, the GPU, your home folder (for process files) and the network (only used for the optional local automation API).

First start

On first launch FlowState shows the Welcome screen, with buttons to start a New blank process, Open process file… or Browse the examples library…, and a card for each built-in example process. You can reopen it at any time from Help ▸ Welcome screen.

The default theme is dark. Switch with View ▸ ☀ Light theme or the sun/moon button at the right of the toolbar; the choice is remembered.

FlowState keeps a small settings file (theme, recent files, automation options) in %APPDATA%\FlowState\settings.json on Windows and ~/.config/FlowState/settings.json on macOS and Linux. It is never transmitted. See the privacy policy.

Command-line start options

The desktop app accepts a few options, useful for shortcuts and scripts: