Skip to main content

Manual Installation

You can manually install FlowSynx by downloading pre-built binaries for your platform from the GitHub Releases page.

FlowSynx supports:

  • ✅ Windows
  • ✅ Linux
  • ✅ macOS

Step 1: Download the Release

  1. Visit the FlowSynx GitHub Releases page.
  2. Select the version you wish to install.
  3. Download the appropriate archive for your operating system and architecture:
PlatformArchitectureFile FormatFilename
Windowsx64.zipflowsynx-windows-x64.zip
Windowsarm64.zipflowsynx-windows-arm64.zip
Linuxx64.tar.gzflowsynx-linux-arm64.tar.gz
Linuxarm64.tar.gzflowsynx-linux-arm.tar.gz
macOSx64.tar.gzflowsynx-osx-x64.tar.gz
macOSarm64.tar.gzflowsynx-osx-arm64.tar.gz

Tip: Always prefer the latest release unless you need a specific version.


Step 2: Extract the Archive

After downloading the archive, extract it to a preferred location.

Windows

Use built-in File Explorer or a tool like 7-Zip:

Right-click > Extract All

Linux/macOS

Use the terminal:

# For .tar.gz archives
tar -xzf flowsynx-<platform>.tar.gz -C /opt/flowsynx

You can replace /opt/flowsynx with your desired directory.

Step 3: Set Executable Permissions (Linux/macOS)

Ensure the binary is executable:

chmod +x /opt/flowsynx/flowsynx

Step 4: Add to PATH (Optional)

To run flowsynx from anywhere in your terminal, add its directory to your system PATH.

Windows

  1. Press Win + R, type sysdm.cpl, press Enter.
  2. Under Advanced tab > Environment Variables.
  3. Add the extracted folder path to the Path variable.

Linux/macOS

Add the following line to your ~/.bashrc, ~/.zshrc, or equivalent:

export PATH="/opt/flowsynx:$PATH"

Then reload your shell:

source ~/.bashrc  # or source ~/.zshrc

Step 5: Verify Installation

Open a terminal or command prompt and run:

flowsynx --version

You should see the installed version of FlowSynx.

Step 6: Running the first command

Once the FlowSynx engine is running (default on port 6262), you can interact with its REST API using tools like curl.

Example: Check System Version

This is a good first API call to confirm that the engine is active and healthy:

curl http://localhost:6262/version

Expected Output:

{
"data": {
"version": "1.1.2"
},
"messages": [],
"succeeded": true,
"generatedAtUtc": "2025-08-02T09:33:28.7058406Z"
}

If you receive a response like the above, your FlowSynx engine is up and ready to receive further API commands.