Getting Started

dxflow is a workflow engine that gives you one interface — CLI, REST API, and web console — for running containerized workflows across different machines and runtimes. This guide takes you from install to a running workflow in a few minutes.

What is dxflow?

dxflow is a single binary you run on any machine. It turns that machine into a node you can drive through a CLI, a REST API, or a web console, with a modular core that handles containerized workflows, shell sessions, and file storage.

How it works

dxflow runs as a lightweight daemon between your infrastructure and your workloads:

• Your infrastructure — any compute: cloud, on-premise, or laptop (Linux, macOS, Windows; x86_64 or ARM64)
• dxflow engine — the daemon providing the CLI, API, and console
• Container runtimes — Docker, Podman, Singularity, or Apptainer
• Your applications — your workloads, run unchanged

A workflow is a YAML definition made up of one or more steps. Each step runs a container image on a chosen runtime, with its own ports, volumes, environment, and resource limits. Write your own definition, or pull a ready-made one from the dxflow hub by name with hub://<name>.

Next steps

Once you're up and running, see the CLI reference, the API documentation, or the FAQ.