本文档由 AI 自动翻译。如有任何不准确之处,请参考 英文原版。
difyctl 的帮助系统涵盖四个层面:顶层概览、单个命令或命令组的帮助、指南主题,以及上述所有内容的 机器可读形式。所有帮助内容均输出到 stdout,并以退出码 0 结束。
获取帮助
以下四种调用方式都会显示相同的顶层概览:查看单个命令或命令组的帮助
在任意命令后追加--help,或在命令前加上 help:
unknown help topic: <name> 报错,给出建议并返回退出码 1。
指南主题
长篇主题随 CLI 一同分发,通过difyctl help <topic> 阅读:
这些主题已内置于 CLI 中。要了解
difyctl 实际读取哪些变量,参见 环境变量。
机器可读帮助
每个帮助层面都接受-o json 和 -o yaml。顶层形式会在一份文档中输出完整的命令全貌:
bin、contract:退出码、输出格式、错误输出的结构以及跨命令规则commands:每个命令一个描述符topics:按名称列出的可用指南主题,每个主题的正文通过difyctl help <topic>读取
effect 标签(read、write 或 destructive),以及在有的情况下提供的 agentGuide 字符串。编码 Agent 正是通过这种方式发现 difyctl。
退出码
完整方案参见 输出格式与退出码。