Installation
dxflow ships as a single binary for Linux, macOS, and Windows on x86_64 and ARM64. Install it with the script, or download the archive and place the binary on your PATH.
System requirements
| Requirement | Minimum |
|---|---|
| OS | Linux, macOS, or Windows |
| Architecture | x86_64 (AMD64) or ARM64 |
| Memory | 512MB RAM |
| Storage | 100MB disk space |
| Network | Internet connection for installation |
| Runtime | Docker, Podman, Singularity, or Apptainer — needed to run workflows |
A runtime is needed only to run workflows. The engine itself, its CLI, its API, shells, and artifacts all work without one.
Install with the script
The fastest route on Linux and macOS. The script detects your OS and architecture, downloads the matching release, installs it to /usr/local/bin, and sets the execute bit.
/usr/local/bin and requires root. Review the install script before running it.curl -fsSL https://dxflow.ai/install.sh | sudo bash
wget -qO- https://dxflow.ai/install.sh | sudo bash
Jump to verify installation once it finishes.
Install manually
Download
Pick your platform and architecture from the GitHub releases page, or use a direct link:
x86_64
ARM64
Every release ships a dxflow_checksums.txt. Verify your download against it before extracting:
wget https://github.com/dxflow-ai/community/releases/latest/download/dxflow_checksums.txt
sha256sum --check --ignore-missing dxflow_checksums.txt # Linux
shasum -a 256 --check --ignore-missing dxflow_checksums.txt # macOS
Extract
Every archive is a .tar.gz holding one dxflow binary (dxflow.exe on Windows).
Extract to a directory on your PATH
sudo tar -xzf dxflow_linux_amd64.tar.gz -C /usr/local/bin
Grant execute permission
sudo chmod +x /usr/local/bin/dxflow
Extract to a directory on your PATH
sudo tar -xzf dxflow_darwin_arm64.tar.gz -C /usr/local/bin
Grant execute permission
sudo chmod +x /usr/local/bin/dxflow
Approve the binary
The release binaries are unsigned, so Gatekeeper blocks the first run. Run dxflow --version once, then open System Settings → Privacy & Security, click Open Anyway in the Security section, and confirm with Open. Later runs start without a prompt.
Extract the archive
Extract dxflow_windows_amd64.tar.gz to C:\Program Files\dxflow. Windows 10 and later include tar:
mkdir "C:\Program Files\dxflow"
tar -xzf dxflow_windows_amd64.tar.gz -C "C:\Program Files\dxflow"
Add it to your PATH
- Press
Win + X, select System, then Advanced system settings. - Click Environment Variables.
- Select
Pathunder System variables and click Edit. - Click New, add
C:\Program Files\dxflow, and click OK. - Open a new terminal so the change takes effect.
Verify installation
Open a new terminal and check the binary:
dxflow --version
dxflow --help
Then confirm the engine runs on this machine and see what it detected:
dxflow engine info
This command spawns a temporary engine when none is running, so it works right after install:
● Engine
Identity a1b2c3d4e5f60718293a4b5c6d7e8f90
Directory ~/.dxflow
Profile default
Version 2.4.0
● System
OS Ubuntu 24.04 (amd64)
CPU AMD EPYC 7763 (16 CORE)
GPU none
Memory 64 GB
Runtime docker 27.3.1
Runtime row lists the container runtimes dxflow found. none means workflows have nothing to run on yet — install Docker, Podman, Singularity, or Apptainer.Next steps
Troubleshooting
| Problem | Fix |
|---|---|
dxflow: command not found | Confirm the install directory is on your PATH, then open a new terminal. |
permission denied running dxflow | sudo chmod +x /usr/local/bin/dxflow |
| macOS blocks the binary | Approve it in System Settings → Privacy & Security → Open Anyway. |
| Download fails | Check connectivity and that the releases page is reachable, then download and extract manually. |
| Checksum mismatch | Download again — the archive is incomplete or corrupted. |
For more, see the FAQ and Troubleshooting.