docs: clarify difyctl reference and agent auth wording (#831) (backport to release/1.15.0)#832
Merged
Merged
Conversation
- reference/apps: drop the inaccurate "per-node" qualifier on metadata.reasoning - reference/auth-and-contexts: rename the "sealed-file" fallback to "protected file" - integrate-agents/auth-for-agent-deployments: point the keychain dead-end to sign-in Option 1 (cherry picked from commit 5ec724e)
dosubot
Bot
added
size:S
Contributor
There was a problem hiding this comment.
Pull request overview
This backport updates Dify CLI (difyctl) documentation wording across English, Chinese, and Japanese to better reflect token storage behavior, agent authentication guidance, and the shape of metadata.reasoning in app run output.
Changes:
- Reworded
metadata.reasoningoutput description to remove the “per-node” qualifier. - Updated token-storage fallback wording (“sealed file” → “protected file”) in auth/context docs.
- Clarified agent deployment auth guidance when OS keychain storage prevents exporting tokens.
Reviewed changes
Copilot reviewed 9 out of 9 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| zh/cli/reference/auth-and-contexts.mdx | Updates wording for the token storage fallback in contexts/auth reference. |
| zh/cli/reference/apps.mdx | Adjusts metadata.reasoning wording in stdout format table. |
| zh/cli/integrate-agents/auth-for-agent-deployments.mdx | Clarifies what to do when tokens.yml is absent due to keychain capture. |
| ja/cli/reference/auth-and-contexts.mdx | Updates wording for the token storage fallback in contexts/auth reference. |
| ja/cli/reference/apps.mdx | Adjusts metadata.reasoning wording in stdout format table. |
| ja/cli/integrate-agents/auth-for-agent-deployments.mdx | Clarifies what to do when tokens.yml is absent due to keychain capture. |
| en/cli/reference/auth-and-contexts.mdx | Updates wording for the token storage fallback in contexts/auth reference. |
| en/cli/reference/apps.mdx | Adjusts metadata.reasoning wording in stdout format table. |
| en/cli/integrate-agents/auth-for-agent-deployments.mdx | Clarifies what to do when tokens.yml is absent due to keychain capture. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| --- | ||
|
|
||
| `difyctl` can hold sign-ins for several Dify hosts and accounts at once. Each host and account pair is a context: its metadata lives in `hosts.yml` in the [config directory](/en/cli/reference/environment-variables), and its bearer token lives in your OS credential store (with a sealed-file fallback). | ||
| `difyctl` can hold sign-ins for several Dify hosts and accounts at once. Each host and account pair is a context: its metadata lives in `hosts.yml` in the [config directory](/en/cli/reference/environment-variables), and its bearer token lives in your OS credential store (with a protected file fallback). |
| > 本文档由 AI 自动翻译。如有任何不准确之处，请参考 [英文原版](/en/cli/reference/auth-and-contexts)。 | ||
|
|
||
| `difyctl` 可同时保持对多个 Dify 主机和账户的登录状态。每一对主机和账户构成一个上下文：其元数据保存在 [配置目录](/zh/cli/reference/environment-variables) 下的 `hosts.yml` 中，其 bearer token 则保存在操作系统的凭据存储中（并以密封文件作为回退方案）。 | ||
| `difyctl` 可同时保持对多个 Dify 主机和账户的登录状态。每一对主机和账户构成一个上下文：其元数据保存在 [配置目录](/zh/cli/reference/environment-variables) 下的 `hosts.yml` 中，其 bearer token 则保存在操作系统的凭据存储中（并以受保护文件作为回退方案）。 |
| > このドキュメントは AI によって自動翻訳されています。不正確な部分がある場合は、[英語版](/en/cli/reference/auth-and-contexts) を参照してください。 | ||
|
|
||
| `difyctl` は、複数の Dify ホストとアカウントへのサインインを同時に保持できます。各ホストとアカウントの組み合わせが 1 つのコンテキストです。そのメタデータは [設定ディレクトリ](/ja/cli/reference/environment-variables) 内の `hosts.yml` に保存され、bearer token は OS の認証情報ストアに保存されます（封印ファイルへのフォールバックあり）。 | ||
| `difyctl` は、複数の Dify ホストとアカウントへのサインインを同時に保持できます。各ホストとアカウントの組み合わせが 1 つのコンテキストです。そのメタデータは [設定ディレクトリ](/ja/cli/reference/environment-variables) 内の `hosts.yml` に保存され、bearer token は OS の認証情報ストアに保存されます（保護されたファイルへのフォールバックあり）。 |
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.
Backport
This will backport the following commits from
maintorelease/1.15.0: