命令索引 - Dify Docs

本文档由 AI 自动翻译。如有任何不准确之处，请参考英文原版。

要查看某条命令的标志，运行 difyctl help <command>。命令中的 <mode> 表示应用类型，例如 workflow 或 advanced_chat。每条命令支持哪些类型，可用 help 查看。每个类型对应哪种应用，参见查找应用。

登录和账户

命令	作用	使用条件
`login`	通过浏览器登录
`logout`	退出登录，并结束本机在服务器上的会话
`describe account`	显示当前登录的账户
`get account session`	列出你的登录会话
`delete account session`	结束你的某个会话
`delete account current_session`	结束运行这条命令所用的会话

工作空间和成员

命令	作用	使用条件
`get workspace`	显示你的工作空间及其 ID
`describe workspace`	显示工作空间的详细信息
`get workspace member`	列出工作空间的成员
`invite workspace member`	通过邮箱邀请成员	管理员及以上角色
`set workspace member_role`	修改成员的角色	管理员及以上角色
`delete workspace member`	移除成员	管理员及以上角色

查找和查看应用

命令	作用	使用条件
`get console_app`	列出已开启服务 API 访问的应用，可按名称或类型筛选
`describe console_app`	显示应用的详细信息和输入变量	已开启服务 API 访问
`describe app_info <mode>`	显示应用的名称、描述和图标

运行应用

命令	作用	使用条件
`run console_app <mode>`	运行应用并获取结果	已开启服务 API 访问
`upload console_app file`	上传文件，供之后的运行使用	已开启服务 API 访问
`stop run`	停止仍在进行的运行	已开启服务 API 访问
`get run event`	跟踪工作流运行的事件	已开启服务 API 访问
`describe run form`	显示运行暂停处的人工介入表单	已开启服务 API 访问
`submit run form`	填写人工介入表单	已开启服务 API 访问
`get run`	列出应用的运行记录，最新的排在最前	已开启服务 API 访问，仅限 Workflow 和 Chatflow 应用
`describe run`	显示某次运行的输入、输出、错误和耗时	已开启服务 API 访问，仅限 Workflow 和 Chatflow 应用
`get run node`	显示运行中每个节点的执行情况，以找出失败的节点	已开启服务 API 访问，仅限 Workflow 和 Chatflow 应用

构建和修改应用

命令	作用	使用条件
`create console_app <mode>`	创建空白 Workflow 应用，或带初始草稿的 Chatflow 应用	编辑及以上角色
`set app_info <mode>`	修改应用的名称、描述或图标	编辑及以上角色
`import console_app dsl`	通过 DSL 文件创建或更新应用	编辑及以上角色
`check console_app dsl`	检查 DSL 文件中的问题，不导入	编辑及以上角色
`confirm console_app dsl_import`	完成等待你确认的导入，例如导入来自较新 Dify 版本的文件	编辑及以上角色
`export console_app dsl`	导出应用的 DSL	已开启服务 API 访问、编辑及以上角色
`check console_app dependency`	列出应用需要但工作空间缺少的集成	已开启服务 API 访问、编辑及以上角色
`get console_app env`	列出草稿的环境变量，Secret 类型的值以掩码显示	已开启服务 API 访问、编辑及以上角色，仅限 Workflow 和 Chatflow 应用
`set console_app env`	添加或修改环境变量	已开启服务 API 访问、编辑及以上角色，仅限 Workflow 和 Chatflow 应用
`delete console_app env`	删除环境变量	已开启服务 API 访问、编辑及以上角色，仅限 Workflow 和 Chatflow 应用
`test console_app <mode>`	测试运行草稿。运行在人工介入表单处暂停后，无法通过 `difyctl` 继续	已开启服务 API 访问、编辑及以上角色
`test node <mode>`	测试草稿中的单个节点	已开启服务 API 访问、编辑及以上角色
`get node_type`	列出服务器可运行的节点类型
`describe node_type`	显示节点类型的设置项和默认值
`get knowledge_base`	列出可在工作流中使用的知识库

发布和回滚

命令	作用	使用条件
`check console_app release`	检查草稿是否可以发布，并查看改动内容	已开启服务 API 访问、编辑及以上角色，仅限 Workflow 和 Chatflow 应用
`publish console_app`	发布草稿	已开启服务 API 访问、编辑及以上角色，仅限 Workflow 和 Chatflow 应用
`get console_app version`	列出已发布的版本，最新的排在最前	已开启服务 API 访问、编辑及以上角色，仅限 Workflow 和 Chatflow 应用
`restore console_app version`	将某个已发布版本复制到草稿中。发布后才会上线	已开启服务 API 访问、编辑及以上角色，仅限 Workflow 和 Chatflow 应用

Web 应用和服务 API

命令	作用	使用条件
`describe webapp <mode>`	显示 Web 应用是否开启，以及其 URL 和页面设置
`set webapp <mode>`	修改 Web 应用的设置	编辑及以上角色
`reset webapp`	为 Web 应用生成新的 URL。旧 URL 随即失效	管理员及以上角色
`describe service_api`	显示应用是否已开启服务 API 访问，以及它的基础 URL	编辑及以上角色
`set service_api`	开启或关闭应用的服务 API 访问	管理员及以上角色

集成

命令	作用	使用条件
`get marketplace plugin`	在市场中搜索集成
`get plugin`	列出工作空间中已安装的集成
`install plugin`	从市场安装集成。安装在后台完成	拥有在工作空间中安装集成的权限
`describe plugin task`	查看安装进度	拥有在工作空间中安装集成的权限
`delete plugin`	卸载集成	拥有在工作空间中安装集成的权限
`get tool`	列出工作流可用的工具
`describe tool_provider`	显示工具供应商的凭据表单和已保存的凭据
`create tool_provider credential`	为工具供应商保存 API 密钥	管理员及以上角色
`set tool_provider credential`	替换已保存的工具供应商凭据	管理员及以上角色
`get model`	列出模型，以及各模型当前是否可用
`describe model_provider`	显示模型供应商的凭据表单和已保存的凭据
`create model_provider credential`	为模型供应商保存凭据	管理员及以上角色
`set model_provider credential`	替换已保存的模型供应商凭据	管理员及以上角色
`create model credential`	为单个模型保存凭据，例如由 Ollama 提供的模型	管理员及以上角色
`set model credential`	替换单个模型已保存的凭据	管理员及以上角色

本地设置和帮助

命令	作用	使用条件
`help`	查找命令并查看其标志
`version`	显示 `difyctl` 和服务器的版本
`get config`、`set config`、`unset config`	查看、修改或重置 `difyctl` 等待服务器响应的时长
`refresh cache`	重新获取服务器的命令列表，例如在服务器升级之后
`delete cache`	删除缓存的命令列表
`install skills`	将 `difyctl` Skill 安装到编码 Agent 的 Skill 目录中

最后修改于 2026年10月23日