Skip to content

armgit / dify

Public Imported from GitHub
0

Build Agentic workflows, RAG pipelines, with rich AI model and tool support on one collaborative workspace. Deploy on cloud, VPC, or self-hosted, so teams move from prototype to production without rebuilding the stack.

10.3 KB
Raw Blame
#!/bin/sh
# install-cli.sh — one-line difyctl installer. difyctl ships as assets on Dify
# GitHub Releases; this installs the build matching your Dify version.
#
# usage:
#   curl -fsSL https://raw.githubusercontent.com/langgenius/dify/main/cli/scripts/install-cli.sh | sh
#
# env:
#   DIFY_VERSION     Dify release tag to install difyctl from (e.g. 1.14.2). Primary key.
#   DIFYCTL_VERSION  difyctl version pin (used only when DIFY_VERSION is unset).
#   DIFYCTL_PREFIX       install prefix (default $HOME/.local); binary -> $PREFIX/bin/difyctl
#   DIFYCTL_INSTALL_DIR  the bin folder itself (wins over DIFYCTL_PREFIX); binary -> $DIR/difyctl
#   DIFYCTL_REPO     release source repo (default langgenius/dify)
#   GITHUB_TOKEN     GitHub token (or GH_TOKEN) to raise the API rate limit to 5000/hour.
# requires: curl, uname, sort -V, and sha256sum or shasum.
set -eu

REPO="${DIFYCTL_REPO:-langgenius/dify}"
DIFY_VERSION="${DIFY_VERSION:-}"
DIFYCTL_VERSION="${DIFYCTL_VERSION:-}"
GH_AUTH="${GITHUB_TOKEN:-${GH_TOKEN:-}}"
# fetch_json runs in a subshell, so it reports failures via this file, not a variable.
FETCH_ERR_FILE="${TMPDIR:-/tmp}/difyctl-fetcherr.$$"
API="https://api.github.com/repos/${REPO}"
DL="https://github.com/${REPO}/releases/download"

err() { printf '%s\n' "install-cli: $*" >&2; }
die() { err "$*"; rm -f "$FETCH_ERR_FILE"; exit 1; }
need() { command -v "$1" >/dev/null 2>&1 || die "$1 is required"; }
re_escape() { printf '%s' "$1" | sed 's/[][\\.^$*+?(){}|/]/\\&/g'; }
# print_skill_hint BIN: the hint names a v2 command, so a binary without it (any v1 build) gets none.
print_skill_hint() {
  "$1" install skills --help >/dev/null 2>&1 || return 0
  printf '%s\n' 'AI agents: run `difyctl install skills <skills root>` after each install or upgrade; the skill ships inside the binary.'
}

# DIFYCTL_INSTALL_DIR names the bin folder itself; DIFYCTL_PREFIX the folder above it.
bin_dir_for() {
    printf '%s' "${DIFYCTL_INSTALL_DIR:-${DIFYCTL_PREFIX:-${HOME}/.local}/bin}"
}

# install_binary SRC DEST: stage the copy next to DEST, then rename it over DEST, so a
# running difyctl keeps its old file and DEST is never half written.
install_binary() {
    _stage="$(dirname "$2")/.difyctl.install.$$"
    if cp "$1" "$_stage" && chmod 0755 "$_stage" && mv -f "$_stage" "$2"; then
        return 0
    fi
    rm -f "$_stage"
    die "cannot write $2"
}

detect_target() {
    case "$(uname -s)" in
        Linux*)  _os=linux ;;
        Darwin*) _os=darwin ;;
        *)       die "unsupported OS: $(uname -s) (use install.ps1 on Windows)" ;;
    esac
    case "$(uname -m)" in
        x86_64|amd64)  _arch=x64 ;;
        arm64|aarch64) _arch=arm64 ;;
        *)             die "unsupported arch: $(uname -m)" ;;
    esac
    printf '%s-%s' "$_os" "$_arch"
}

# list_asset_names  (reads release JSON on stdin) -> one difyctl asset name per line
list_asset_names() {
    grep -oE '"name"[[:space:]]*:[[:space:]]*"difyctl-v[^"]*"' \
        | sed -E 's#.*"name"[[:space:]]*:[[:space:]]*"([^"]*)".*#\1#'
}

# pick_asset TARGET  (reads release JSON on stdin) -> highest-semver matching asset name
pick_asset() {
    _target=$(re_escape "$1")
    list_asset_names \
        | grep -E -- "-${_target}(\\.exe)?\$" \
        | grep -vE -- '-checksums\.txt$' \
        | sort -V | tail -1
}

# asset_version ASSET_NAME TARGET -> difyctl version embedded in the name
asset_version() {
    _target=$(re_escape "$2")
    printf '%s' "$1" | sed -E "s#^difyctl-v(.*)-${_target}(\\.exe)?\$#\\1#"
}

# list_release_tags  (reads /releases array JSON on stdin) -> tag per line, newest first
list_release_tags() {
    grep -oE '"tag_name"[[:space:]]*:[[:space:]]*"[^"]*"' \
        | sed -E 's#.*:[[:space:]]*"([^"]*)".*#\1#'
}

# fetch_json URL -> body on stdout, 0 on success. On failure writes the cause to
# FETCH_ERR_FILE (ratelimit:<epoch> | http:<code> | network) and returns nonzero.
# Inspects the status and rate-limit headers, so it must not use curl -f.
fetch_json() {
    rm -f "$FETCH_ERR_FILE"
    _hdr=$(mktemp) || return 1
    _body=$(mktemp) || { rm -f "$_hdr"; return 1; }
    if [ -n "$GH_AUTH" ]; then
        _code=$(curl -sSL -D "$_hdr" -o "$_body" -w '%{http_code}' \
            -H "Accept: application/vnd.github+json" \
            -H "Authorization: Bearer ${GH_AUTH}" \
            "$1" 2>/dev/null) || _code=000
    else
        _code=$(curl -sSL -D "$_hdr" -o "$_body" -w '%{http_code}' \
            -H "Accept: application/vnd.github+json" \
            "$1" 2>/dev/null) || _code=000
    fi
    case "$_code" in
        2*) cat "$_body"; rm -f "$_hdr" "$_body"; return 0 ;;
        403|429)
            _rem=$(awk 'tolower($1)=="x-ratelimit-remaining:"{gsub(/\r/,"",$2);v=$2} END{print v}' "$_hdr")
            if [ "$_code" = "429" ] || [ "${_rem:-}" = "0" ]; then
                _rst=$(awk 'tolower($1)=="x-ratelimit-reset:"{gsub(/\r/,"",$2);v=$2} END{print v}' "$_hdr")
                printf 'ratelimit:%s' "$_rst" > "$FETCH_ERR_FILE"
            else
                printf 'http:%s' "$_code" > "$FETCH_ERR_FILE"
            fi ;;
        000) printf 'network' > "$FETCH_ERR_FILE" ;;
        *)   printf 'http:%s' "$_code" > "$FETCH_ERR_FILE" ;;
    esac
    rm -f "$_hdr" "$_body"
    return 1
}

# rate_limit_hint [RESET_EPOCH] -> explain the GitHub API limit and how to proceed.
rate_limit_hint() {
    err "GitHub API rate limit exceeded (unauthenticated requests are capped at 60/hour per IP)."
    case "${1:-}" in
        '' | *[!0-9]*) ;;
        *)
            _now=$(date +%s 2>/dev/null) || _now=""
            if [ -n "$_now" ]; then
                _mins=$(( ($1 - _now + 59) / 60 ))
                if [ "$_mins" -gt 0 ]; then
                    err "The limit resets in ~${_mins} min."
                fi
            fi ;;
    esac
    err "To proceed now, authenticate to raise the limit to 5000/hour:"
    err "  curl -fsSL <install-url> | GITHUB_TOKEN=<token> sh"
    err "Tip: pinning DIFY_VERSION makes a single API call (DIFYCTL_VERSION scans many)."
}

# True if the last fetch_json hit a rate limit — lets a subshell bail without printing.
fetch_hit_ratelimit() {
    [ -f "$FETCH_ERR_FILE" ] || return 1
    case "$(cat "$FETCH_ERR_FILE" 2>/dev/null || true)" in
        ratelimit:*) return 0 ;;
    esac
    return 1
}

# Explain and exit if the last fetch_json hit a rate limit; else return. Main shell only.
maybe_ratelimit_exit() {
    fetch_hit_ratelimit || return 0
    _reset=$(cat "$FETCH_ERR_FILE" 2>/dev/null || true)
    rm -f "$FETCH_ERR_FILE"
    rate_limit_hint "${_reset#ratelimit:}"
    exit 1
}

# find_release_for_difyctl WANT TARGET -> newest Dify tag whose assets host that difyctl build
find_release_for_difyctl() {
    _want="$1"
    _target="$2"
    _raw=$(fetch_json "${API}/releases?per_page=100") \
        || { fetch_hit_ratelimit && return 1; die "failed to query ${REPO} releases (network error or GitHub API rate limit)"; }
    _tags=$(printf '%s' "$_raw" | list_release_tags)
    for _t in $_tags; do
        _rel=$(fetch_json "${API}/releases/tags/${_t}") \
            || { fetch_hit_ratelimit && return 1; err "fetch failed for ${_t}, skipping"; continue; }
        _name=$(printf '%s' "$_rel" | pick_asset "$_target")
        [ -n "$_name" ] || continue
        if [ "$(asset_version "$_name" "$_target")" = "$_want" ]; then
            printf '%s' "$_t"
            return 0
        fi
    done
    return 1
}

resolve_release() {
    _target="$1"
    if [ -n "$DIFY_VERSION" ]; then
        REL=$(fetch_json "${API}/releases/tags/${DIFY_VERSION}") \
            || { maybe_ratelimit_exit; die "Dify release ${DIFY_VERSION} not found"; }
        DIFY_TAG="$DIFY_VERSION"
    elif [ -n "$DIFYCTL_VERSION" ]; then
        DIFY_TAG=$(find_release_for_difyctl "$DIFYCTL_VERSION" "$_target") \
            || { maybe_ratelimit_exit; die "difyctl ${DIFYCTL_VERSION} not found on any Dify release"; }
        REL=$(fetch_json "${API}/releases/tags/${DIFY_TAG}") \
            || { maybe_ratelimit_exit; die "failed to fetch Dify release ${DIFY_TAG}"; }
    else
        REL=$(fetch_json "${API}/releases/latest") \
            || { maybe_ratelimit_exit; die "failed to query latest Dify release (set DIFY_VERSION to pin one)"; }
        DIFY_TAG=$(printf '%s' "$REL" | list_release_tags | head -1)
        [ -n "$DIFY_TAG" ] || die "could not parse a tag from the latest Dify release"
    fi
}

main() {
    trap 'rm -f "$FETCH_ERR_FILE"' EXIT INT TERM
    need curl
    need uname
    sort -V /dev/null >/dev/null 2>&1 || die "sort with -V support is required (install coreutils)"
    if command -v sha256sum >/dev/null 2>&1; then
        HASH="sha256sum"
    elif command -v shasum >/dev/null 2>&1; then
        HASH="shasum -a 256"
    else
        die "need sha256sum or shasum"
    fi

    target=$(detect_target)
    resolve_release "$target"

    asset=$(printf '%s' "$REL" | pick_asset "$target")
    [ -n "$asset" ] || die "no difyctl published for Dify ${DIFY_TAG} (target ${target}); set DIFY_VERSION to a release that has one"
    version=$(asset_version "$asset" "$target")
    checksums="difyctl-v${version}-checksums.txt"
    base="${DL}/${DIFY_TAG}"

    tmp=$(mktemp -d 2>/dev/null || mktemp -d -t difyctl-install)
    trap 'rm -rf "$tmp"; rm -f "$FETCH_ERR_FILE"' EXIT INT TERM

    printf 'downloading %s (Dify %s)...\n' "$asset" "$DIFY_TAG"
    curl -fsSL "${base}/${asset}" -o "${tmp}/${asset}" \
        || die "download failed: ${base}/${asset}"
    curl -fsSL "${base}/${checksums}" -o "${tmp}/${checksums}" \
        || die "checksum manifest download failed: ${base}/${checksums}"

    _pattern=$(re_escape "$asset")
    _sumline=$(grep -E -- "[[:space:]]${_pattern}\$" "${tmp}/${checksums}") || true
    [ -n "$_sumline" ] || die "no checksum entry for ${asset}"
    (
        cd "$tmp"
        printf '%s\n' "$_sumline" | $HASH -c -
    ) || die "checksum mismatch for ${asset}"

    bin_dir=$(bin_dir_for)
    mkdir -p "$bin_dir"
    target_bin="${bin_dir}/difyctl"
    install_binary "${tmp}/${asset}" "$target_bin"

    printf '\ndifyctl v%s installed (from Dify %s): %s\n' "$version" "$DIFY_TAG" "$target_bin"

    case ":${PATH}:" in
        *":${bin_dir}:"*)
            printf 'verify: run "difyctl version"\n'
            print_skill_hint "$target_bin"
            ;;
        *)
            printf '\n%s is not on your PATH. Add this to your shell profile:\n' "$bin_dir"
            printf '  export PATH="%s:$PATH"\n' "$bin_dir"
            ;;
    esac
}

if [ "${DIFYCTL_INSTALL_LIB:-0}" != "1" ]; then
    main "$@"
fi