Skip to main content

Installation

Zigflow is a single Go binary with prebuilt options.

What you will learn​

  • How to install the Zigflow binary on your platform
  • How to run Zigflow from a Docker image
  • How to install from source

Homebrew​

Install Zigflow using Homebrew:

brew tap zigflow/tap
brew install --cask zigflow

Verify the installation:

zigflow version

Install Script​

For Linux, CI environments and other systems where Homebrew is not available, you can install Zigflow using the official installation script.

curl -fsSL https://get.zigflow.dev | sh

Install a specific version:

curl -fsSL https://get.zigflow.dev | ZIGFLOW_VERSION=0.12.0 sh

Install to a custom directory:

curl -fsSL https://get.zigflow.dev | ZIGFLOW_INSTALL_DIR="$HOME/.local/bin" sh

The installer automatically:

  • Detects your operating system and CPU architecture
  • Downloads the correct Zigflow binary
  • Verifies the release checksum
  • Installs the binary to your chosen location

Binary Releases​

Every release of Zigflow provides binary releases for a variety of OSes. These binary versions can be manually downloaded and installed.

  1. Download your desired version
  2. Make it executable chmod +x ./path/to/binary
  3. (Optional) Move to your $PATH directory

Docker Image​

Every release of Zigflow provides a Docker image. The binary is set as the entrypoint, so you can use the image as a replacement for the binary.

A latest tag is maintained for the most recent tag, or you can use the version as the tag (eg, 0.1.0).

docker run -it --rm \
  -v /path/to/workflow.yaml:/app/workflow.yaml \
  ghcr.io/zigflow/zigflow \
  run

Go Install​

If you already have Go installed, you can use the Go package manager to install the binary. This will be installed under your $GOPATH.

go install github.com/zigflow/zigflow@latest

You can specify a version by changing @latest to the desired version.

From Source​

tip

You will need to install Go

Building from source is useful for testing unreleased versions.

git clone https://github.com/zigflow/zigflow.git
cd zigflow
go build .

This will fetch the dependencies and build the binary. It will compile it to ./zigflow.