Skip to content

docs: rewrite the cli docs for difyctl in dify 1.18.0 - #1126

Merged
RiskeyL merged 5 commits into
release/1.18.0from
docs/ce1180-cli-v2
Oct 23, 2026
Merged

RiskeyL merged 5 commits into
release/1.18.0from
docs/ce1180-cli-v2

Conversation

@RiskeyL

@RiskeyL RiskeyL commented Oct 23, 2026

Copy link
Copy Markdown
Contributor

Rewrites the Dify CLI docs (en/cli/, with zh and ja) for difyctl in Dify 1.18.0, where the CLI reads its commands from the server's catalog.

  • Start: Overview, Get Started, and Find and Run Commands.
  • Work with Apps: Build Apps, Run Apps, Create and Update Apps from DSL Files, and Use difyctl in CI and Automation.
  • Manage difyctl: Manage Your Sign-In, Update or Uninstall difyctl, and Upgrade Across Dify 1.18.0.
  • Reference: Command Index; Results, Errors, and Exit Codes; and Configuration.
  • Retired pages redirect to their replacements.
  • The Cloud navigation keeps a frozen copy of the 1.17.1 CLI docs under {en,zh,ja}/cloud/cli/ until Dify Cloud runs 1.18.0.
  • environments.mdx: the OpenAPI paragraph links Get Started.

Verified against dify 1fefc52723; the 1.18.0 release-prep commit 229c3f1165 makes no line false.

Closes DC-367

- Add the CE pages for the difyctl command set that ships with Dify
  1.18.0, grouped in the nav as Work with Apps, Manage difyctl, and
  Reference, with Get Started covering install, sign-in, and agent setup.
- Move the pre-1.18.0 pages to en/cloud/cli for Dify Cloud readers.
- Point the environment variable reference at the new Get Started page.
- docs.json: navigation for all three languages and redirects from the
  retired pages. The zh and ja pages follow in a separate commit, so the
  zh and ja navigation points at pages that are not in this commit.
- Indent the "mode" lines in the DSL page's app list example to match
  the lines around them.
- Open Build Apps with the recommendation to let the coding agent build
  the app, since the page covers no hand-built path.
- Bring the zh and ja CE CLI pages in line with the English rewrite,
  including the new pages, the Work with Apps, Manage difyctl, and
  Reference nav groups, and the moved Find and Run Commands and Build
  Apps pages.
- Move the pre-1.18.0 zh and ja pages to the Cloud tree.
- Point the zh and ja environment variable references at Get Started.
- Translate natural-language example values in code blocks, per the
  zh and ja formatting guides.
Removes the pending-link markers now that Key Concepts and Export and Import Apps are on the release branch, and points the zh and ja DSL links at #dify-dsl.
@RiskeyL
RiskeyL merged commit 983df7d into release/1.18.0 Oct 23, 2026
2 of 3 checks passed
@RiskeyL
RiskeyL deleted the docs/ce1180-cli-v2 branch October 23, 2026 05:55

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🔵 Needs a closer look

No blocking defect was confirmed, but the broad version-specific rewrite across three languages warrants final human validation.

No open issues 🎉

What changed in this PR

Updates the CLI documentation for Dify 1.18.0’s server-provided command catalog, while keeping separate 1.17.1 instructions for Dify Cloud.

Changes:

  • Rewrites CLI guidance for command discovery, app building, sign-in, configuration, and maintenance in English, Chinese, and Japanese.
  • Preserves Cloud documentation with Cloud-local links and installation commands pinned to 1.17.1.
  • Points deployment configuration references to the new Get Started page.
File Description
zh/​self-host/​deploy/​configuration/​environments.mdx Links to the new CLI introduction.
zh/​cloud/​cli/​troubleshooting.mdx Retargets troubleshooting links to Cloud docs.
zh/​cloud/​cli/​reference/​workspaces.mdx Retargets workspace reference links.
zh/​cloud/​cli/​reference/​version.mdx Retargets compatibility guidance links.
zh/​cloud/​cli/​reference/​skills.mdx Links to Cloud skill guidance.
zh/​cloud/​cli/​reference/​output-formats-and-exit-codes.mdx Retargets output and error reference links.
zh/​cloud/​cli/​reference/​help.mdx Retargets help reference links.
zh/​cloud/​cli/​reference/​global-flags.mdx Retargets flag reference links.
zh/​cloud/​cli/​reference/​environment-variables.mdx Retargets environment variable links.
zh/​cloud/​cli/​reference/​command-index.mdx Adds the frozen Cloud command index.
zh/​cloud/​cli/​reference/​auth-and-contexts.mdx Retargets authentication reference links.
zh/​cloud/​cli/​reference/​apps.mdx Retargets app operation links.
zh/​cloud/​cli/​quick-start.mdx Keeps onboarding links within Cloud docs.
zh/​cloud/​cli/​overview.mdx Adds the frozen Cloud CLI overview.
zh/​cloud/​cli/​integrate-agents/​overview.mdx Retargets agent integration links.
zh/​cloud/​cli/​integrate-agents/​install-the-difyctl-skill.mdx Retargets skill setup links.
zh/​cloud/​cli/​integrate-agents/​error-handling-and-retries-for-agents.mdx Retargets agent error-handling links.
zh/​cloud/​cli/​integrate-agents/​auth-for-agent-deployments.mdx Retargets agent authentication links.
zh/​cloud/​cli/​install.mdx Pins installation to 1.17.1 and retargets links.
zh/​cloud/​cli/​common-tasks.mdx Retargets everyday command links.
zh/​cloud/​cli/​authenticate.mdx Retargets sign-in and configuration links.
zh/​cli/​update-or-uninstall.mdx Adds update and removal instructions.
zh/​cli/​reference/​configuration.mdx Adds the new configuration reference.
zh/​cli/​overview.mdx Introduces the revised CLI and version routes.
zh/​cli/​manage-sign-in.mdx Documents sign-in and session management.
zh/​cli/​find-and-run-commands.mdx Documents command discovery, inputs, and hints.
zh/​cli/​build-apps.mdx Documents agent-assisted app building.
ja/​self-host/​deploy/​configuration/​environments.mdx Links to the new CLI introduction.
ja/​cloud/​cli/​troubleshooting.mdx Retargets troubleshooting links to Cloud docs.
ja/​cloud/​cli/​reference/​workspaces.mdx Retargets workspace reference links.
ja/​cloud/​cli/​reference/​version.mdx Retargets compatibility guidance links.
ja/​cloud/​cli/​reference/​skills.mdx Links to Cloud skill guidance.
ja/​cloud/​cli/​reference/​output-formats-and-exit-codes.mdx Retargets output and error reference links.
ja/​cloud/​cli/​reference/​help.mdx Retargets help reference links.
ja/​cloud/​cli/​reference/​global-flags.mdx Retargets flag reference links.
ja/​cloud/​cli/​reference/​environment-variables.mdx Retargets environment variable links.
ja/​cloud/​cli/​reference/​command-index.mdx Adds the frozen Cloud command index.
ja/​cloud/​cli/​reference/​auth-and-contexts.mdx Retargets authentication reference links.
ja/​cloud/​cli/​quick-start.mdx Keeps onboarding links within Cloud docs.
ja/​cloud/​cli/​overview.mdx Adds the frozen Cloud CLI overview.
ja/​cloud/​cli/​integrate-agents/​overview.mdx Retargets agent integration links.
ja/​cloud/​cli/​integrate-agents/​error-handling-and-retries-for-agents.mdx Retargets agent error-handling links.
ja/​cloud/​cli/​integrate-agents/​auth-for-agent-deployments.mdx Retargets agent authentication links.
ja/​cloud/​cli/​install.mdx Pins installation to 1.17.1 and retargets links.
ja/​cloud/​cli/​common-tasks.mdx Retargets everyday command links.
ja/​cloud/​cli/​authenticate.mdx Retargets sign-in and configuration links.
ja/​cli/​update-or-uninstall.mdx Adds update and removal instructions.
ja/​cli/​reference/​configuration.mdx Adds the new configuration reference.
ja/​cli/​overview.mdx Introduces the revised CLI and version routes.
ja/​cli/​manage-sign-in.mdx Documents sign-in and session management.
ja/​cli/​find-and-run-commands.mdx Documents command discovery, inputs, and hints.
ja/​cli/​build-apps.mdx Documents agent-assisted app building.
en/​self-host/​deploy/​configuration/​environments.mdx Links to the new CLI introduction.
en/​cloud/​cli/​troubleshooting.mdx Retargets troubleshooting links to Cloud docs.
en/​cloud/​cli/​reference/​workspaces.mdx Retargets workspace reference links.
en/​cloud/​cli/​reference/​version.mdx Retargets compatibility guidance links.
en/​cloud/​cli/​reference/​skills.mdx Links to Cloud skill guidance.
en/​cloud/​cli/​reference/​output-formats-and-exit-codes.mdx Retargets output and error reference links.
en/​cloud/​cli/​reference/​help.mdx Retargets help reference links.
en/​cloud/​cli/​reference/​global-flags.mdx Retargets flag reference links.
en/​cloud/​cli/​reference/​environment-variables.mdx Retargets environment variable links.
en/​cloud/​cli/​reference/​command-index.mdx Adds the frozen Cloud command index.
en/​cloud/​cli/​reference/​auth-and-contexts.mdx Retargets authentication reference links.
en/​cloud/​cli/​reference/​apps.mdx Retargets app operation links.
en/​cloud/​cli/​quick-start.mdx Keeps onboarding links within Cloud docs.
en/​cloud/​cli/​overview.mdx Adds the frozen Cloud CLI overview.
en/​cloud/​cli/​integrate-agents/​overview.mdx Retargets agent integration links.
en/​cloud/​cli/​integrate-agents/​install-the-difyctl-skill.mdx Retargets skill setup links.
en/​cloud/​cli/​integrate-agents/​error-handling-and-retries-for-agents.mdx Retargets agent error-handling links.
en/​cloud/​cli/​integrate-agents/​auth-for-agent-deployments.mdx Retargets agent authentication links.
en/​cloud/​cli/​install.mdx Pins installation to 1.17.1 and retargets links.
en/​cloud/​cli/​common-tasks.mdx Retargets everyday command links.
en/​cloud/​cli/​authenticate.mdx Retargets sign-in and configuration links.
en/​cli/​update-or-uninstall.mdx Adds update and removal instructions.
en/​cli/​reference/​results-errors-and-exit-codes.mdx Documents results, failures, retries, and exit codes.
en/​cli/​reference/​configuration.mdx Adds the new configuration reference.
en/​cli/​overview.mdx Introduces the revised CLI and version routes.
en/​cli/​manage-sign-in.mdx Documents sign-in and session management.
en/​cli/​find-and-run-commands.mdx Documents command discovery, inputs, and hints.
en/​cli/​build-apps.mdx Documents agent-assisted app building.

Review effort: Balanced

RiskeyL added a commit that referenced this pull request Oct 23, 2026
* chore: sync main into release/1.18.0 (#1096)

* fix: point glossary rows at live i18n keys (#1083)

* fix: point glossary rows at live i18n keys

* fix: give knowledge retrieval labels their own glossary section

Move Query Text, Query Images and Metadata Filtering out of Agent Node Config, and add the metadata filtering modes Disabled, Automatic and Manual. Regenerate the termbase.

* docs: record stored strings for case-styled ui labels

State in the glossary's UI Labels intro that rows record the string stored at the key, even when the UI changes its case on screen.

* feat: set research depth by product change and add pack task analysis (#1094)

* feat: set research depth by product change and add pack task analysis

Research depth now follows what changed for the reader: a new capability runs in full even when it lands as one section of an existing page, a changed behavior runs at targeted depth, and a correction verifies the disputed claim. Filling a gap on an unchanged product gets its own line. Both research depths now gather user reports, searched by the problem a feature solves as well as its name.

Only a single-page correction skips the S4 stop.

The env-var and API rule packs gain the S3 task analysis they lacked: the env pack for variable groups an operator sets up, and the API pack for each changed tag group.

* feat: add a task-analysis step to the cli rule pack

The CLI pack went from S2 straight to S7, as the env-var and API packs did before this PR. It now runs the pipeline's task analysis for each command or concept a change adds or alters, so CLI pages answer the reader's job, not just the command's flags.

* fix: give every env variable a task analysis and walk gaps in delta depth

The env pack exempted a single variable that changes one value of an existing setup, but a single limit or default can still change what the operator gets, and the pipeline gives every behavior change at least a Delta analysis. The exemption is replaced with proportion: a single variable's analysis is usually short.

Delta depth routed documentation gaps but walked only changed steps, which a gap doesn't have. It now walks the steps the docs don't yet cover.

* feat: check and freeze the english before translating

Checking now runs in two passes. The English pass runs the editor test, the reader test, the format and terminology checks, and the pack verifiers, then stops for the owner to freeze the English. Translation and its checks follow. In the old order the reader test and the owner's review came after translation, so any English change they caused sent its sentences back through translation and the translation test.

A single-page correction still skips the stop, and the stage numbers stay as packs and hooks cite them.

* fix: report env-var scope before drafting and re-test reader-test edits

The env pack wrote user-facing descriptions (S5) before its S4 scope report, so descriptions were drafted before the owner approved the scope. The report now comes first, and descriptions are written after approval.

In the English check pass, a unit the reader test changes now goes back through the editor test before the English is frozen, so added prose doesn't skip editorial review.

* fix: load s3 pack steps and align the env summary and api check pass

The S1-S3 read loaded only the packs' S2 procedures, so the S3 steps added to the env-var, API, and CLI packs were never read at that stage; it now loads S2 and S3. The env pack's bold summary now lists the steps in their real order, task analysis included. The two-pass check now says how it applies to the API pack, which edits its three specs in one pass: the owner reviews all three languages together, and the parity check stands in for the second pass.

* fix: fold api translation into s5 and walk any changed part in delta

The API pack said its zh and ja specs are edited at S6, which the English check pass and owner review run before, so the API exception could not run as written. The pack now folds S6 into S5: all three specs are edited together while writing, so the English pass checks and the owner reviews all three, and the parity check replaces the translation pass.

Delta depth applied its prompts only to changed steps, which skips a change that affects only a prerequisite, a limit, or the outcome. It now walks whatever changed.

* fix: align the packs and guides with the english-first check order

* fix: rerun the english checks on corrections found in translation

* chore: sync main into release/1.18.0 (#1125)

* fix: point glossary rows at live i18n keys (#1083)

* fix: point glossary rows at live i18n keys

* fix: give knowledge retrieval labels their own glossary section

Move Query Text, Query Images and Metadata Filtering out of Agent Node Config, and add the metadata filtering modes Disabled, Automatic and Manual. Regenerate the termbase.

* docs: record stored strings for case-styled ui labels

State in the glossary's UI Labels intro that rows record the string stored at the key, even when the UI changes its case on screen.

* feat: set research depth by product change and add pack task analysis (#1094)

* feat: set research depth by product change and add pack task analysis

Research depth now follows what changed for the reader: a new capability runs in full even when it lands as one section of an existing page, a changed behavior runs at targeted depth, and a correction verifies the disputed claim. Filling a gap on an unchanged product gets its own line. Both research depths now gather user reports, searched by the problem a feature solves as well as its name.

Only a single-page correction skips the S4 stop.

The env-var and API rule packs gain the S3 task analysis they lacked: the env pack for variable groups an operator sets up, and the API pack for each changed tag group.

* feat: add a task-analysis step to the cli rule pack

The CLI pack went from S2 straight to S7, as the env-var and API packs did before this PR. It now runs the pipeline's task analysis for each command or concept a change adds or alters, so CLI pages answer the reader's job, not just the command's flags.

* fix: give every env variable a task analysis and walk gaps in delta depth

The env pack exempted a single variable that changes one value of an existing setup, but a single limit or default can still change what the operator gets, and the pipeline gives every behavior change at least a Delta analysis. The exemption is replaced with proportion: a single variable's analysis is usually short.

Delta depth routed documentation gaps but walked only changed steps, which a gap doesn't have. It now walks the steps the docs don't yet cover.

* feat: check and freeze the english before translating

Checking now runs in two passes. The English pass runs the editor test, the reader test, the format and terminology checks, and the pack verifiers, then stops for the owner to freeze the English. Translation and its checks follow. In the old order the reader test and the owner's review came after translation, so any English change they caused sent its sentences back through translation and the translation test.

A single-page correction still skips the stop, and the stage numbers stay as packs and hooks cite them.

* fix: report env-var scope before drafting and re-test reader-test edits

The env pack wrote user-facing descriptions (S5) before its S4 scope report, so descriptions were drafted before the owner approved the scope. The report now comes first, and descriptions are written after approval.

In the English check pass, a unit the reader test changes now goes back through the editor test before the English is frozen, so added prose doesn't skip editorial review.

* fix: load s3 pack steps and align the env summary and api check pass

The S1-S3 read loaded only the packs' S2 procedures, so the S3 steps added to the env-var, API, and CLI packs were never read at that stage; it now loads S2 and S3. The env pack's bold summary now lists the steps in their real order, task analysis included. The two-pass check now says how it applies to the API pack, which edits its three specs in one pass: the owner reviews all three languages together, and the parity check stands in for the second pass.

* fix: fold api translation into s5 and walk any changed part in delta

The API pack said its zh and ja specs are edited at S6, which the English check pass and owner review run before, so the API exception could not run as written. The pack now folds S6 into S5: all three specs are edited together while writing, so the English pass checks and the owner reviews all three, and the parity check replaces the translation pass.

Delta depth applied its prompts only to changed steps, which skips a change that affects only a prerequisite, a limit, or the outcome. It now walks whatever changed.

* fix: align the packs and guides with the english-first check order

* fix: rerun the english checks on corrections found in translation

* fix: update the next.js version in the local source web sample output (#1099)

* fix: correct the audio-to-text 400 error codes (#1101)

* fix: correct integration permission labels and install details (#1102)

* fix: correct integration permission labels and install details

* fix: keep the tool integration type singular

* docs: document deleting archived logs on cloud (#1103)

* fix: correct the knowledge api key path and note key limits (#1104)

* docs: split archived logs into download and delete (#1118)

* fix: point plugin debugging page to the integrations debugging entry (#1123)

The remote debugging page still sent readers to the old Plugins page in the top-right corner, a bug icon next to Install Plugin, and a debug dialog, with two 2024 screenshots of that UI. Since CE 1.15.0 the entry is Debugging at the bottom of the Integrations sidebar.

- Prerequisites: the requirement is now the Who can debug? permission
- Step 1: open Debugging in Integrations; outdated screenshot removed
- Step 4: find the plugin in its type's section in Integrations; outdated screenshot removed; it stays available only while the local process is connected
- Troubleshooting: drop the debug dialog and the nonexistent key regeneration; copy the current key from Debugging instead

en, zh, and ja updated together.

* docs: sync ce 1.18.0 agent, env, api, and skills changes (#1095)

* fix: point glossary rows at live i18n keys (#1083)

* fix: point glossary rows at live i18n keys

* fix: give knowledge retrieval labels their own glossary section

Move Query Text, Query Images and Metadata Filtering out of Agent Node Config, and add the metadata filtering modes Disabled, Automatic and Manual. Regenerate the termbase.

* docs: record stored strings for case-styled ui labels

State in the glossary's UI Labels intro that rows record the string stored at the key, even when the UI changes its case on screen.

* docs: document output routes on the agent node

Adds the Let It Choose a Route section to the New Agent tab: when to use routes instead of IF/ELSE, how to write route descriptions, the always-one-route behavior, and the failure case with a Fail Branch fallback. Verified against dify 2b65f0e893. Also corrects the ja beta note: the node, not its runtime, is on by default.

* docs: document ce 1.18.0 agent and app package environment variables

Covers the agent runtime backends (local, E2B, OpenShell) with setup steps, agent trajectory export, skill package and app package limits, and the new agent backend rows. Verified against dify 2b65f0e893; the OTLP anchors keep their live ids.

* docs: update service api citation fields and metadata errors

Drops the stale 400 on the metadata endpoints, adds the second 404 on PATCH and DELETE, adds doc_metadata, files, and title to retriever resources, and clarifies page and limit handling. Verified against dify 2b65f0e893.

* docs: update skill duplicate and export to use the latest draft

Duplicate and Export both take the latest saved draft, unpublished changes included. Verified against dify 2b65f0e893.

* fix: match ja ui labels for skills, speech models, and knowledge base

Aligns the ja pages and glossary rows with the ja UI strings at dify 2b65f0e893, and regenerates the termbase.

* docs: add output routes and error handling labels to the glossary

Adds Output Routes, Error Handling, and Fail Branch with their zh and ja UI strings at dify 2b65f0e893, confirmed at their render sites, and regenerates the termbase.

* feat: set research depth by product change and add pack task analysis (#1094)

* feat: set research depth by product change and add pack task analysis

Research depth now follows what changed for the reader: a new capability runs in full even when it lands as one section of an existing page, a changed behavior runs at targeted depth, and a correction verifies the disputed claim. Filling a gap on an unchanged product gets its own line. Both research depths now gather user reports, searched by the problem a feature solves as well as its name.

Only a single-page correction skips the S4 stop.

The env-var and API rule packs gain the S3 task analysis they lacked: the env pack for variable groups an operator sets up, and the API pack for each changed tag group.

* feat: add a task-analysis step to the cli rule pack

The CLI pack went from S2 straight to S7, as the env-var and API packs did before this PR. It now runs the pipeline's task analysis for each command or concept a change adds or alters, so CLI pages answer the reader's job, not just the command's flags.

* fix: give every env variable a task analysis and walk gaps in delta depth

The env pack exempted a single variable that changes one value of an existing setup, but a single limit or default can still change what the operator gets, and the pipeline gives every behavior change at least a Delta analysis. The exemption is replaced with proportion: a single variable's analysis is usually short.

Delta depth routed documentation gaps but walked only changed steps, which a gap doesn't have. It now walks the steps the docs don't yet cover.

* feat: check and freeze the english before translating

Checking now runs in two passes. The English pass runs the editor test, the reader test, the format and terminology checks, and the pack verifiers, then stops for the owner to freeze the English. Translation and its checks follow. In the old order the reader test and the owner's review came after translation, so any English change they caused sent its sentences back through translation and the translation test.

A single-page correction still skips the stop, and the stage numbers stay as packs and hooks cite them.

* fix: report env-var scope before drafting and re-test reader-test edits

The env pack wrote user-facing descriptions (S5) before its S4 scope report, so descriptions were drafted before the owner approved the scope. The report now comes first, and descriptions are written after approval.

In the English check pass, a unit the reader test changes now goes back through the editor test before the English is frozen, so added prose doesn't skip editorial review.

* fix: load s3 pack steps and align the env summary and api check pass

The S1-S3 read loaded only the packs' S2 procedures, so the S3 steps added to the env-var, API, and CLI packs were never read at that stage; it now loads S2 and S3. The env pack's bold summary now lists the steps in their real order, task analysis included. The two-pass check now says how it applies to the API pack, which edits its three specs in one pass: the owner reviews all three languages together, and the parity check stands in for the second pass.

* fix: fold api translation into s5 and walk any changed part in delta

The API pack said its zh and ja specs are edited at S6, which the English check pass and owner review run before, so the API exception could not run as written. The pack now folds S6 into S5: all three specs are edited together while writing, so the English pass checks and the owner reviews all three, and the parity check replaces the translation pass.

Delta depth applied its prompts only to changed steps, which skips a change that affects only a prerequisite, a limit, or the outcome. It now walks whatever changed.

* fix: align the packs and guides with the english-first check order

* fix: rerun the english checks on corrections found in translation

* fix: drop the uv_cache_dir row that ce 1.18.0 removes

The variable is gone from the env templates at dify 6af1bb709b, and the compose plugin daemon is still 0.6.10-local. Restore it under Plugin Daemon only if the release ships daemon 0.6.11 or later.

* docs: document client ip and crawler ssrf proxy changes for ce 1.18.0

Adds a FAQ entry for sign-in emails blocked behind Cloudflare, a load balancer, or another proxy, with the Nginx real-ip setup for each proxy type. Moves RESPECT_XFORWARD_HEADERS_ENABLED to its own heading under Nginx Reverse Proxy with its Docker Compose and source defaults, and extends the SSRF allowlist rows for self-hosted Firecrawl and WaterCrawl. Verified against dify 16a2f5abd5 (langgenius/dify#43897, #43898).

* docs: document plugin install default and password pepper for ce 1.18.0

Rewrites the integration permissions on the self-host Integrations page with the product's labels, where to find them, and the options each takes. Adds a PASSWORD_PEPPER heading next to SECRET_KEY on the environment variable page: when to set it, why it belongs in api.env, and how to undo a mistake or let members back in. Verified against dify ba5532ace0.

* fix: say only owners and admins can remove integrations

* docs: add OAUTH_TTL_DAYS and update Landlock sandbox behavior

* fix: correct worker, debug, stop, and default model docs for ce 1.18.0

* fix: require the local sandbox token for ce 1.18.0

* fix: correct webhook errors, node floor, and creator center upload for ce 1.18.0

* fix: rename the zh access point label to 访问入口

* docs: document agent tracing for ce 1.18.0

* docs: document nested workflow tools for ce 1.18.0

* fix: apply review fixes for form_id, forwarded headers, odt, and aop

Adds form_id to the human_input_form_filled and human_input_form_timeout schemas and the resumed-stream examples, and says on human_input_required that clients match these events by form_id because node_id can repeat across forms. Rewrites the RESPECT_XFORWARD_HEADERS_ENABLED warning: containers on the API's Docker networks, such as the code sandbox, can still connect directly, so untrusted workloads need network isolation and a gateway that rewrites X-Forwarded-For. Restores ODT on the document extractor page (parsed locally, or through the Unstructured API when one is configured) and qualifies the Cloudflare tip as zone-level or per-hostname Authenticated Origin Pulls with your own certificate. Verified against dify 229c3f1165 and graphon 4fa2214.

* fix: add cloudflare tunnel as a way to restrict origin access

Takes the reviewer's wording for the Cloudflare tab: zone-level or per-hostname Authenticated Origin Pulls with your own certificate, or Cloudflare Tunnel.

* docs: document app package export and import for ce 1.18.0 (#1097)

* docs: replace app management with an export and import apps page

* docs: point agent, version, and marketplace pages to app packages

* docs: restructure key concepts and rewrite the dsl and env var sections

* docs: restore size tips for oversized creator center uploads

* docs: clarify what an update import keeps and how integrations install

* docs: use the export agent label for agent exports

* docs: list workflow, swagger api, and mcp tools as left behind on export

* docs: list agent file system files as left behind and update export labels in the glossary

Adds persistent files in an Agent's file system to what the export leaves behind, since packages carry only the Files section. Replaces the Export DSL and Import DSL file glossary rows, whose keys #42732 removed, with Export App and Import App, adds Export Agent, Export secret values, and App package, and regenerates the termbase. Fixes the ja wording for packages exported from a Workflow or Chatflow. Verified against dify 229c3f1165.

* docs: rewrite the cli docs for difyctl in dify 1.18.0 (#1126)

* docs: rewrite the english cli docs for difyctl in dify 1.18.0

- Add the CE pages for the difyctl command set that ships with Dify
  1.18.0, grouped in the nav as Work with Apps, Manage difyctl, and
  Reference, with Get Started covering install, sign-in, and agent setup.
- Move the pre-1.18.0 pages to en/cloud/cli for Dify Cloud readers.
- Point the environment variable reference at the new Get Started page.
- docs.json: navigation for all three languages and redirects from the
  retired pages. The zh and ja pages follow in a separate commit, so the
  zh and ja navigation points at pages that are not in this commit.

* fix: correct the dsl example indent and reword the build apps opening

- Indent the "mode" lines in the DSL page's app list example to match
  the lines around them.
- Open Build Apps with the recommendation to let the coding agent build
  the app, since the page covers no hand-built path.

* translate: sync the zh and ja cli docs with the 1.18.0 rewrite

- Bring the zh and ja CE CLI pages in line with the English rewrite,
  including the new pages, the Work with Apps, Manage difyctl, and
  Reference nav groups, and the moved Find and Run Commands and Build
  Apps pages.
- Move the pre-1.18.0 zh and ja pages to the Cloud tree.
- Point the zh and ja environment variable references at Get Started.
- Translate natural-language example values in code blocks, per the
  zh and ja formatting guides.

* fix: link the cli dsl page to the merged app package pages

Removes the pending-link markers now that Key Concepts and Export and Import Apps are on the release branch, and points the zh and ja DSL links at #dify-dsl.

* fix: match the knowledge retrieval field label in workflow 101 lesson 4

The 1.18.0 tag renames the field to Knowledge Base in en; the ja page also gets the node's 知識検索 name and the field's ナレッジベース label.

* fix: scope agent tracing to agents outside workflow tools and clarify retention

Agents inside a workflow tool the app calls aren't traced, and each app also needs Capture Agent internals on. The reconcile task's retention deletes only the trace data Dify stores, not what the tracing provider already received.

This branch was successfully deployed

1 active deployment
staging — 4a5b1320 Deployed Oct 23, 2026 by mintlify[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants