dify可通过github repository reader工具自动读取仓库目录并生成规范readme。需配置github_token、正确填写https格式仓库url,设计结构化提示词提取元信息、筛选核心目录、生成启动命令,最后串联工作流执行。
☞☞☞AI 智能聊天, 问答助手, AI 智能搜索, 多模态理解力帮你轻松跨越从0到1的创作门槛☜☜☜

你需要让Dify自动读取GitHub或本地代码仓库的目录结构,并生成符合项目规范的README文件,而不是手动复制粘贴路径或逐行编写文档。
准备代码仓库与获取访问权限
将目标仓库克隆到本地,或确保你拥有该仓库的HTTPS/SSH访问权限。私有仓库必须配置Personal Access Token(PAT)并赋予repo权限,否则Dify无法调用GitHub API读取目录树。
打开GitHub → Settings → Developer settings → Personal access tokens → Generate new token → 勾选repo → 创建后复制保存。这一步漏掉会导致后续所有API请求返回403错误。
把Token存为环境变量:GITHUB_TOKEN=ghp_xxx,Dify工作流会自动读取它。
在Dify中创建新应用并启用代码仓库工具
登录Dify控制台 → 新建应用 → 选择“Agent”模式 → 命名“RepoReadme助手”。
进入“功能设置” → 开启“工具调用” → 点击“添加工具” → 搜索并启用GitHub Repository Reader工具。该工具支持递归获取/tree/main路径下的全部文件路径和元数据。
【必须填写仓库URL格式为https://github.com/{owner}/{repo},不能带.git后缀,也不能是SSH地址】
设计提示词:让模型理解目录结构与README规范
在“提示词编排”区域,清空默认内容,粘贴以下结构化指令:
你是一个资深开源项目维护者。用户会提供一个代码仓库的目录树(含文件路径、类型、层级),请按以下规则生成README:
- 第一部分写项目简介:从
package.json或pyproject.toml提取name/description字段;无则写“未检测到项目元信息” - 第二部分列核心目录:只保留
src/、lib/、tests/、examples/四类,忽略.git/、node_modules/、__pycache__/ - 第三部分写快速启动:若存在
README.md原文件,跳过本节;否则根据package.json#scripts或Makefile生成命令行示例 - 最后加一行“Generated by Dify on {current_date}”
注意:输出纯Markdown,不加任何解释性文字,不包裹在代码块里,不使用```md```标记。
Dify 3.9.2更新重点增强系统安全性,引入 Chainguard 安全基础镜像并同步社区版 CVE 修复,同时优化 OpenSearch 向量存储兼容性、插件参数传输机制及 Helm 部署配置。新增工作流模型节点缓存能力,可减少重复凭证查询,显著提升复杂工作流初始化速度,为企业级 AI 应用提供更稳定、高效的运行体验。
配置工作流:串联目录读取与提示词执行
进入“工作流编排” → 添加节点:
第一步:添加“GitHub Repository Reader”工具节点 → 设置参数:
Repository URL = 用户输入的仓库地址
Branch = main(或用户指定分支)
Max depth = 3(避免遍历过深导致超时)
第二步:添加“LLM”节点 → 连接上一节点输出 → 在“输入模板”中填入:
“这是仓库目录结构:{{github_reader.output}}” → 后接上面设计好的完整提示词
第三步:添加“Response”节点 → 连接LLM节点 → 输出类型设为“Text” → 勾选“流式响应”
保存工作流后点击“发布”,此时应用已具备端到端生成能力。
测试与调试:验证生成结果准确性
在“调试”面板中输入真实仓库URL,例如:https://github.com/mui/material-ui → 点击运行。
观察日志:若出现“Failed to fetch tree”错误,检查GITHUB_TOKEN是否生效、仓库是否公开、URL是否拼写错误。
若生成内容缺失核心目录,说明GitHub Reader返回的目录树被截断——此时需回到工具节点,将“Max depth”从3调至4,重新发布。
成功运行后,复制输出的Markdown内容,粘贴到VS Code中预览渲染效果。确认标题层级、代码块缩进、链接格式均符合预期即可交付使用。










