docs: document difyctl version-compatibility gate for Dify 1.16.0#845
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the Dify CLI docs to reflect the difyctl 0.2.0-alpha / Dify 1.16.0 compatibility model, including the new compatibility verdicts and the version-compatibility gate behavior, and adds documentation for the NEXT_PUBLIC_ENABLE_FEATURE_PREVIEW env var (now defaulting to true in 1.16.0).
Changes:
- Refreshes
difyctl versionsamples to difyctl0.2.0-alpha/ server1.16.0, and expands compatibility verdicts tocompatible/too_old/too_new/unknown. - Adds troubleshooting guidance for
version_skewand updates exit-code6references across CLI docs. - Documents
NEXT_PUBLIC_ENABLE_FEATURE_PREVIEWin environment variable tables and updates internal env-var audit notes.
Reviewed changes
Copilot reviewed 20 out of 20 changed files in this pull request and generated 9 comments.
Show a summary per file
| File | Description |
|---|---|
| en/cli/reference/version.mdx | Updates version output samples and documents compatibility verdicts + gating behavior. |
| en/cli/troubleshooting.mdx | Adds version_skew troubleshooting entry (exit 6). |
| en/cli/reference/output-formats-and-exit-codes.mdx | Expands exit code 6 examples to include version_skew/HTTP 426 direction. |
| en/cli/reference/auth-and-contexts.mdx | Updates auth login exit code 6 description to mention version gate. |
| en/cli/install.mdx | Clarifies supported server floor (1.15.0+) and “builds match server versions”. |
| en/self-host/deploy/configuration/environments.mdx | Documents NEXT_PUBLIC_ENABLE_FEATURE_PREVIEW (default true). |
| zh/cli/reference/version.mdx | Chinese translation of updated version/compatibility docs (incl. new sections). |
| zh/cli/troubleshooting.mdx | Adds Chinese version_skew troubleshooting entry. |
| zh/cli/reference/output-formats-and-exit-codes.mdx | Updates Chinese exit code 6 row with version_skew details. |
| zh/cli/reference/auth-and-contexts.mdx | Updates Chinese auth login exit code 6 description. |
| zh/cli/install.mdx | Updates Chinese install note about version targeting. |
| zh/self-host/deploy/configuration/environments.mdx | Adds Chinese row for NEXT_PUBLIC_ENABLE_FEATURE_PREVIEW. |
| ja/cli/reference/version.mdx | Japanese translation of updated version/compatibility docs (incl. new sections). |
| ja/cli/troubleshooting.mdx | Adds Japanese version_skew troubleshooting entry. |
| ja/cli/reference/output-formats-and-exit-codes.mdx | Updates Japanese exit code 6 row with version_skew details. |
| ja/cli/reference/auth-and-contexts.mdx | Updates Japanese auth login exit code 6 description. |
| ja/cli/install.mdx | Updates Japanese install note about version targeting. |
| ja/self-host/deploy/configuration/environments.mdx | Adds Japanese row for NEXT_PUBLIC_ENABLE_FEATURE_PREVIEW. |
| .claude/skills/dify-docs-env-vars/ignored-vars.md | Removes NEXT_PUBLIC_ENABLE_FEATURE_PREVIEW from “ignored vars” list now that it’s documented. |
| .claude/skills/dify-docs-env-vars/deep-dive.md | Adds internal deep-dive notes for NEXT_PUBLIC_ENABLE_FEATURE_PREVIEW default flip in 1.16.0. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
…login, scope cache claim
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Updates the CLI reference for difyctl 0.2.0-alpha and Dify 1.16.0, and documents the version-compatibility gate introduced upstream in langgenius/dify#38367. It targets
release/1.16.0because it describes behavior that ships with the 1.16.0 release — theversionsamples show the server at1.16.0, which holds once Cloud is on 1.16.0. All changes cover en, zh, and ja.The
/openapi/v1path refactor from that PR is internal to how difyctl calls the server, so it stays out of the docs, which describe commands rather than raw endpoints.Changes
Version and compatibility model (
version.mdx)0.2.0-alpha, server1.16.0, compat range[1.16.0, 1.16.0].compatible/too_old/too_new/unknown), with a Shown as column carrying the exact labels difyctl prints (ok,incompatible (server too old), and so on).The version-compatibility gate (
version.mdx)Adds a "How Commands React to an Incompatible Server" section:
too_oldhard-fails with exit6before the request,too_newruns with a stderr warning, a passing check is cached about an hour per host,auth loginruns the same check, and the symmetric server-side426path is explained.--check-compat(exit64) is documented as a live, uncached probe, suitable for CI gating.Troubleshooting and exit codes
troubleshooting.mdx(version_skew): both failure directions, how to confirm withdifyctl version, and the fix (reinstall / pinDIFY_VERSION).6rows updated inoutput-formats-and-exit-codes.mdxandauth-and-contexts.mdx.Install (
install.mdx)Clarifies that difyctl works with Dify 1.15.0 and later and that each build matches a Dify version. The supported floor stays 1.15.0 (older servers pin
DIFY_VERSION); only the latest build requires 1.16.0. The1.15.0in the examples is intentional, not a stale value.Fix
Translates the
versionpage title in zh/ja (版本/バージョン) — it was the only CLI reference page with an untranslated title.