Docs
Getting Started

Installation

dxflow is a cross-platform tool, which means it can run on any operating system, such as Linux, macOS, and Windows. It is designed to be easy to install and use, with a simple command-line interface (CLI) and a web-based user interface (UI).

System Requirements

Before installing dxflow, ensure your system meets these requirements:

dxflow is lightweight and runs on minimal resources, making it suitable for everything from IoT devices to high-performance clusters.

Minimum Requirements:

  • OS: Linux, macOS, or Windows
  • Architecture: x86_64 (AMD64) or ARM64
  • Memory: 512MB RAM
  • Storage: 100MB disk space
  • Network: Internet connection for installation

Download

Install the dxflow engine by downloading the latest release from the GitHub releases page.

Platform Downloads

Choose your platform and architecture:

x86

Linux

macOS

Windows

ARM64

Linux

macOS

Windows

Installation Steps

Step 1

Unzip the downloaded file to /usr/local/bin or any directory in your PATH. For example, on Linux, you can use the following command:

tar -xvf dxflow_1.0.3_linux_amd64.tar.gz -C /usr/local/bin

Step 2

Grant execute permissions with:

chmod +x /usr/local/bin/dxflow

Quick Install Script

For Linux and macOS users, use our automated installation script:

This script requires sudo privileges to install dxflow to /usr/local/bin. Review the install script before running.
wget -qO- https://raw.githubusercontent.com/diphyx/dxflow/main/assets/install.sh | sudo bash

What this script does:

  1. Detects your OS and architecture
  2. Downloads the appropriate dxflow binary
  3. Installs it to /usr/local/bin
  4. Sets proper file permissions

Verify Installation

After installation, verify that dxflow is working correctly:

# Check version
dxflow --version

# View available commands
dxflow --help

# Test engine connectivity
dxflow ping
If you see version information and help text, congratulations! dxflow is ready to use.

Next Steps

Now that dxflow is installed:

  1. Quick Start Guide - Get your first engine running
  2. CLI Reference - Explore all available commands
  3. API Documentation - Integrate with your applications

Troubleshooting

Common Issues

Command not found after installation:

  • Ensure /usr/local/bin is in your PATH
  • Try restarting your terminal
  • On macOS, you may need to approve the binary in System Preferences

Permission denied errors:

  • Ensure the binary has execute permissions: chmod +x /usr/local/bin/dxflow
  • On macOS, go to System Preferences → Security & Privacy → General

Download failures:

  • Check your internet connection
  • Verify the GitHub releases page is accessible
  • Try downloading manually and extracting to your PATH

Getting Started

Your comprehensive guide to setting up and using dxflow for distributed computing and workflow orchestration

Quick Start

Get up and running with dxflow in minutes with this comprehensive step-by-step guide