Install difyctl

difyctl is a standalone binary with no runtime dependencies. The install script detects your platform, downloads the matching build from Dify’s GitHub Releases, verifies its checksum, and puts the binary in place.

Each difyctl build targets a specific Dify version; install the one that matches your server (see DIFY_VERSION below).

Install

Run the Installer

difyctl ships a build with each Dify release. Dify Enterprise 3.12.x runs Dify 1.16.1, so install that build:

macOS / Linux
Windows
Manual Download

Supported platforms: macOS and Linux, x64 and arm64.

curl -fsSL https://raw.githubusercontent.com/langgenius/dify/main/cli/scripts/install-cli.sh | DIFY_VERSION=1.16.1 sh

The script installs to ~/.local/bin/difyctl and tells you if that directory isn’t on your PATH.

Supported platform: x64.

$env:DIFY_VERSION = "1.16.1"
irm https://raw.githubusercontent.com/langgenius/dify/main/cli/scripts/install.ps1 | iex

The script installs to %LOCALAPPDATA%\difyctl\bin\difyctl.exe and prints the command to add that directory to your PATH if it isn’t already there.

From Dify’s GitHub Releases, pick the release that matches your server’s Dify version and download two assets:
- The binary for your platform (difyctl-v<version>-<os>-<arch>)
- The checksum manifest (difyctl-v<version>-checksums.txt)
Compute the binary’s SHA-256 hash and compare it with the matching entry in the checksums file. If the values differ, the download is corrupted or was tampered with; delete it and download again.
shasum -a 256 difyctl-v<version>-<os>-<arch>
Get-FileHash difyctl-v<version>-windows-x64.exe

Put the binary on your PATH:

chmod +x difyctl-v<version>-<os>-<arch>
mv difyctl-v<version>-<os>-<arch> ~/.local/bin/difyctl

New-Item -ItemType Directory -Force "$env:LOCALAPPDATA\difyctl\bin" | Out-Null
Move-Item difyctl-v<version>-windows-x64.exe "$env:LOCALAPPDATA\difyctl\bin\difyctl.exe"

To customize the install, set any of these environment variables on the install command.

Variable	Description	Example
`DIFY_VERSION`	The Dify release tag to install `difyctl` from, matching a tag on Dify’s Releases. Defaults to the latest release; set it to your server’s release tag when your server isn’t on the latest.	`1.16.1`
`DIFYCTL_VERSION`	Pin a specific `difyctl` build. Used only when `DIFY_VERSION` is unset.	`0.2.0-alpha`
`DIFYCTL_PREFIX`	The install directory (default `~/.local`). The binary lands in `<prefix>/bin`.	`/usr/local`

For example:

curl -fsSL https://raw.githubusercontent.com/langgenius/dify/main/cli/scripts/install-cli.sh | DIFY_VERSION=1.16.1 sh

# PowerShell has no inline form; this applies for the rest of your session
$env:DIFY_VERSION = "1.16.1"
irm https://raw.githubusercontent.com/langgenius/dify/main/cli/scripts/install.ps1 | iex

Verify the Install

difyctl version

You should see a Client: block with the version and platform.If you get command not found instead, the install directory isn’t on your PATH. Add it:

# add to ~/.zshrc or ~/.bashrc; running it inline only lasts until the session ends
export PATH="$HOME/.local/bin:$PATH"

[Environment]::SetEnvironmentVariable('PATH', "$env:LOCALAPPDATA\difyctl\bin;$env:PATH", 'User')

Update

To update difyctl, re-run the install script; it replaces the binary in place. To move to a specific Dify version, set DIFY_VERSION as above.

Uninstall

rm ~/.local/bin/difyctl

Remove-Item -Recurse "$env:LOCALAPPDATA\difyctl"

To sign out before uninstalling, run difyctl auth logout.

Next Steps

With difyctl installed, choose the path that matches how you sign in to dify.example.com:

Account Users

External SSO Users

No Dify account: sign in through external SSO for the specific apps you’re permitted to run.

Get Started

Account Users

External SSO Users

Integrate Your Agents

Command Reference

Troubleshooting

Install

Update

Uninstall

Next Steps

Account Users

External SSO Users

​Install

​Update

​Uninstall

​Next Steps

Account Users

External SSO Users

Install

Update

Uninstall

Next Steps