Download and installation

System requirements

OrgFlow CLI requires:

• An operating system supported by .NET 8.0. Please refer to Microsoft's documentation on supported releases for each OS.
• Git version 2.39 or later.

When running OrgFlow CLI from our Docker images, all requirements are already provided by the images.

macOS

Format	Architecture	Runtime ID	Download
Installer (.pkg)	Universal	osx-universal
	x64 (Intel)	osx-x64
	arm64 (Apple Silicon)	osx-arm64
ZIP archive	Universal	osx-universal
	x64 (Intel)	osx-x64
	arm64 (Apple Silicon)	osx-arm64

The universal build runs on both Intel and Apple Silicon processors and is recommended unless download size is your primary concern. Please note that the x64 (Intel) version will not run reliably on Apple Silicon processors.

To use the installer, run the downloaded .pkg file to install OrgFlow CLI on your computer. If you prefer to use the ZIP archive, OrgFlow CLI can be run using the orgflow executable file from the extracted directory.

Both the installer and the OrgFlow CLI binaries are signed and notarized by Apple.

Windows

Format	Architecture	Runtime ID	Download
Installer (.msi)	x64 (64-bit)	win-x64
	x86 (32-bit)	win-x86
ZIP archive	x64 (64-bit)	win-x64
	x86 (32-bit)	win-x86

To use the installer, run the downloaded .msi file to install OrgFlow CLI on your computer. If you prefer to use the ZIP archive, OrgFlow CLI can be run using the orgflow.exe executable file from the extracted directory.

OrgFlow CLI for Windows is not yet signed

When running the .msi installer, you may see warnings about running an unrecognized app or installing software from an unknown publisher. We plan to start signing our binaries and installer with a publisher certificate in the future.

Linux

Format	Architecture	Runtime ID	Download
ZIP archive	x64	linux-x64
	arm64	linux-arm64

OrgFlow CLI can be run using the orgflow executable file from the extracted directory. For more convenience, consider adding the directory to the PATH variable of your shell, or create a symlink to the orgflow executable in a default location such as /usr/local/bin.

Docker

Docker images for OrgFlow CLI can be found on Docker Hub: https://hub.docker.com/r/orgflow/cli

Image tags correspond to the version of the OrgFlow CLI that they contain. To use the most recent version, use the :latest tag. To use to a specific version, use the tag that matches the full version number (e.g. :3.2.2). You can also use :3.2.x or :3.x to pin to a specific minor or major version, respectively.

To run the OrgFlow CLI in a Docker container interactively:

$ docker run --interactive --tty --rm orgflow/cli
$ orgflow --help

Windows compatibility

We currently publish Docker images for linux/amd64 and linux/arm64 platforms only. To run OrgFlow in a Docker container on Windows, your system must be configured to use Linux containers.

While the image contains the OrgFlow CLI and all of its dependencies, you'll need to make sure that any required configuration values are set. These include the access token that you intend to use, the encryption key for your stack, as well as any required Git configuration and authentication. See the initial setup topic for details.

GitHub Actions

OrgFlow for GitHub Actions can be found here: https://github.com/marketplace/actions/orgflow-salesforce-devops-for-github

Our setup action downloads, installs and configures OrgFlow CLI in your GitHub Actions workflow using a single step:

jobs:
  orgflow_job:
    runs-on: ubuntu-latest
    steps:
      # Download and install latest version
      - uses: orgflow-actions/setup@v2
        with:
          access-token: ${{ secrets.ORGFLOW_ACCESSTOKEN }}
        env:
          ORGFLOW__ACCEPTEULA: "true"
      # Run any OrgFlow command
      - run: orgflow stack:list

See our demo template repository for complete sample workflows and a guided tutorial.

TIP

You are not required to use our actions in order to use OrgFlow CLI in your GitHub Actions workflows, but they do a lot of heavy lifting for you and ensure OrgFlow CLI is configured and invoked in a way that ensures an optimal experience in GitHub Actions.

Script or other CI/CD platform

If you are looking to download and install the OrgFlow CLI in a scripting environment other than GitHub Actions, you will need to add steps to your script or pipeline to download the OrgFlow CLI in ZIP format, unzip it, and add the target directory to the PATH variable.

The download URL pattern is https://prod.orgflow.app/download/v2/cli/<runtimeId>/latest/zip. Substitute <runtimeId> with the runtime for the agent or host you're installing on. The following runtime IDs are available:

• osx-universal
• osx-arm64
• osx-x64
• win-x64
• win-x86
• linux-arm64
• linux-x64

You can also substitute latest with a version specifier if you'd like to pin your script or pipeline to a specific version or version range. To use to a specific version, use the full version number (e.g. :3.2.2). You can also use :3.2.x or :3.x to pin to a specific minor or major version, respectively.

Once the OrgFlow CLI has been downloaded and installed, you'll need to make sure that any required configuration values are set. These include the access token that you intend to use, the encryption key for your stack, as well as any required Git configuration and authentication. See the initial setup topic for details.

FAQ

Why do I see warnings about running an unrecognized app or installing software from an unknown publisher?

Our installer packages and binaries for Windows are not yet digitally signed or notarized. On Windows, when running the .msi installer package you may see warnings about running an unrecognized app or installing software from an unknown publisher.

We plan to start signing and notarizing our binaries and installer packages for Windows with a publisher certificate in the future.

Can I download and install OrgFlow CLI through Homebrew on macOS?

Not currently. However, installation through Homebrew is on our backlog and we plan to provide this in the future.

Can I download and install OrgFlow CLI through Chocolatey on Windows?

Not currently. However, installation through Windows package managers such as Chocolatey or winget may be provided in the future. If this feature is important to you, please reach out to us at support@orgflow.io.

Can I download and install OrgFlow CLI through my Linux distro package manager?

Not currently. However, installation through Linux distro package managers may be provided in the future. If this feature is important to you, please reach out to us at support@orgflow.io.