用途:这是 Dify CLI(difyctl)文档集的规则包,不是入口点;由 dify-docs-write 在编写 en/cli/ 页面和 Enterprise develop/cli/ 文档树时加载。
读者定位:面向拥有 Dify 账号、通过浏览器设备流程登录的开发者、DevOps 工程师和技术 PM,默认其熟悉 shell 与 kubectl、gh 等工具,不解释 shell 基础;对 Dify 概念只给一句话并链接主文档,不重复教学。“Integrate Your Agents” 面向把自有 agent 接入 Dify 应用作为工具的工程师,与在 Dify Studio 内构建 agent 区分开。SSO 登录(dfoe_ 令牌)仅限 Enterprise,只在 Enterprise 文档树中记录。
事实来源:所有行为声明须在 langgenius/dify origin/main 的 cli/ 目录按固定 SHA 核验并记录该 SHA,不采用 feat/cli、cli/README.md 或 CLI 自带帮助文本。精确字符串与退出码查 cli/test/e2e/suites/**;标志与参数查 cli/src/commands/<verb>/<resource>/index.ts;错误码查 cli/src/errors/codes.ts;环境变量查 cli/src/env/registry.ts。无法核验的声明应省略或标记 {/* VERIFY: … */}。
三条保护用户的规则:唯一记录的认证方式是浏览器设备流程,不把 DIFY_TOKEN 等非交互令牌写成可用认证;可运行示例不含 <your-app-id>,应用与工作区 ID 为 UUID 形状;en/cli/ 以 CE 优先,仅 Cloud 内容(多工作区、--workspace、-A 等)在标题或列表项加 <Badge color="blue">Cloud</Badge>。主机示例用 dify.example.com,不用 cloud.dify.ai。
写作风格:命令章节先说明何时与为何运行、前置关键限制,并展示真实终端输出。术语上区分 host(连接目标)与 server(后端或版本);JSON 平实描述,不用 “envelope”;应用类型用产品名称(Chatbot、Chatflow、Agent、Workflow、Text Generator);可配置值需明确 flag、env var、config 的优先级;交叉引用以命令为主语;可输入令牌用反引号;正文不写版本号,不设 “See Also”,只写已发布现实。
页面结构:命令参考页一个资源,每个命令一个 H2,标题写成任务。命令内按顺序覆盖 Synopsis、Arguments、Flags 表、Examples、Output、Exit Codes;单事实章节改为句子。多命令页以一行引导和锚点索引开头。
内容归属:跨领域事实各归一处,如运行分发归 Apps “Run an App”,HITL 暂停/恢复归 Apps “When a Workflow Pauses”,工作区解析链归 Workspaces,-o 模式与退出码归 Output Formats and Exit Codes,全局标志归 Global Flags,帮助形式归 help,登录与令牌存储归 Authenticate,环境变量归 Environment Variables,兼容性探测归 version。
检查:运行 python3 tools/check-links.py --internal 须输出 Broken links: 0 与 Broken anchors: 0,并确认被改页面未重复解释已归属事实。