ARTICLE DETAIL

资讯详情

深耕郑州网站建设与运营推广的一线实战洞察。

PR-Agent help 工具完全指南:用 `/help` 命令与勾选框交互式触发全部 PR 工具

PR-Agent help 工具完全指南:用 `/help` 命令与勾选框交互式触发全部 PR 工具 人工智能AI Agent代码智能体代码评审AI 应用【免费下载链接】pr-agent PR Agent: The Original Open-Source PR Reviewer. This project is not the Qodo free tier.项目地址https://gitcode.com/gh_mirrors/pr/pr-agent点击查看免费下载导读help是 PR-Agent 内置的向导型工具在任何 PR 评论中发送一条/help它会立刻返回一张「工具清单」——列出项目支持的全部命令、各自的用途说明以及在支持 GFM Markdown 与勾选框命令的平台上可直接勾选的交互式触发入口。本文基于help工具的官方文档与仓库源码完整介绍/help的两种使用形态无参数向导模式与带问题问答模式、其输出内容随代码平台能力的分级渲染逻辑以及help_docs等周边工具的配置方式帮助你在 GitHub、GitLab、Bitbucket 等平台上熟练使用这一入口。概述help 工具能做什么按照官方文档 docs/docs/tools/help.md 的定义help工具的核心职责有两点列出全部可用工具及其描述让新加入仓库协作者的人一眼看清 PR-Agent 提供了哪些能力如describe、review、improve等提供交互式触发入口对 PR-Agent 用户而言它允许「通过勾选相关复选框」来触发每个工具省去手动输入完整命令的麻烦。它可以被手动调用——只要在任意 PR 上评论/help实际效果从输入到输出在任意 PR 的评论区输入/help并提交后机器人会回复一份工具总览。下面两张图分别展示了「输入」与「输出」两个环节的实况从输出截图可以看到列表以表格形式呈现包含三列Tool工具名称如 DESCRIBE、REVIEW、IMPROVE、UPDATE CHANGELOG、ADD DOCS、ASK、GENERATE CUSTOM LABELSDescription该工具的功能简介Trigger Interactively勾选框形式的交互触发入口如- [ ] Run !-- /review --。输出末尾还会附带两条脚注说明每个工具既可以在新 PR 打开时自动触发也可以手动评论调用带[*]标记的工具需要额外参数例如调用/ask需要写成/ask question content。工具清单与命令对照/help输出的工具列表来自 pr_agent/tools/pr_help_message.py 中PRHelpMessage.run()的组装逻辑。其命令、描述与交互勾选框一一对应Tool命令描述源码DESCRIBE/describeGenerate a PR title, type, summary, code walkthrough and labels.生成 PR 标题、类型、摘要、代码走读与标签REVIEW/reviewGenerate a PR review with feedback on possible issues, security concerns, tests and review effort.生成 PR 评审可能的问题、安全隐患、测试与评审工作量IMPROVE/improveGenerate actionable code suggestions for improving the PR.生成可执行的代码改进建议UPDATE CHANGELOG/update_changelogAutomatically updates the changelog自动更新变更日志ADD DOCS/add_docsGenerates documentation to methods/functions/classes that changed in the PR为 PR 中变更的方法/函数/类生成文档ASK/askAnswering free-text questions about the PR回答关于 PR 的自由文本问题GENERATE CUSTOM LABELS/generate_labelsGenerates custom labels for the PR, based on specific guidelines defined by the user基于用户定义的准则为 PR 生成自定义标签前三个工具的描述统一取自 pr_agent/command_descriptions.py 中的COMMAND_DESCRIPTIONS字典其余描述由PRHelpMessage.run()内联维护。这也解释了为什么/help输出能始终与真实命令保持一致——它们是同一份数据源。按平台能力分级的输出渲染PRHelpMessage.run()并非对所有代码平台输出相同内容而是根据当前 git provider 声明的能力做分级渲染相关回归测试见 tests/unittest/test_pr_help_message_rendering.pyGFM Markdown 勾选框命令如 GitHub App输出带「Trigger Interactively」列的 HTML 表格提供- [ ] Run !-- /tool --形式的勾选框用户勾选即可触发对应工具。勾选框受配置项config.disable_checkboxes控制置为true时即使平台支持也会退化为纯表格configuration.toml 中disable_checkboxes默认不开启。仅支持 GFM Markdown如 GitLab输出三列纯文本表格Tool / Command / Description不提供勾选框。不支持 GFM Markdown、但支持管道表格如 Bitbucket Server退化为最基础的| Tool | Description |两列表格且只列出前四个工具由generate_bbdc_table()辅助函数生成。两者都不支持直接发布提示信息 TheHelptool requires gfm markdown, which is not supported by your code platform.平台的能力声明位于各 git provider 实现中例如GithubProvider的supports_checkbox_commands()返回TrueGitLabProvider、BitbucketProvider返回False测试test_providers_declare_the_capabilities_the_tool_reads逐一验证了这些声明。进阶用法/help question文档问答模式除了输出工具清单help还支持问答形态。在/help后附带问题文本即可进入该模式例如/help How do I enable automatic reviews?此时PRHelpMessage会加载项目打包的 Markdown 文档语料_load_help_docs_prompt()默认从pr_agent/_help_docs资源或源码树docs/docs读取见_get_help_docs_root()将文档内容按file name/file content的格式拼入用户提示词交由模型pr_help_prompts.toml 中的DocHelper结构约束输出 YAML从模型响应中解析出response与relevant_sections发布评论。评论包含### Question: 用户问题 ### Answer: 文档驱动的答案 #### Relevant Sources: - https://docs.pr-agent.ai/tools/review/#automatic-review其中「相关来源」链接由format_docs_url()依据文档路径与章节标题规范化生成并且只链接确实被完整加载进提示词的文档——被截断的文档不会生成引用验证逻辑见_get_fitted_docs_files()行为由 tests/unittest/test_pr_help_message_fallback.py 中的test_fallback_only_publishes_sources_from_complete_fitted_documents覆盖。提示词预算与文档截断问答模式下文档语料可能超过模型输入上限。PRHelpMessage通过_get_prompt_budget()计算可用提示词预算扣除输出 token 预留默认预留HELP_OUTPUT_TOKEN_RESERVE 2000再用_fit_prompts()对文档进行「先全文、后截断」的适配能放下全文就用全文放不下则按比例裁剪并追加...(truncated)标记保证每个模型含 fallback 模型收到的提示词都在自己的预算内。相关单测覆盖了主模型失败自动切换 fallback 模型、输出 token 配置解析config.max_output_tokens等多种边界情况。触发方式与相关配置手动触发评论/help查看工具总览向导模式评论/help question获得基于官方文档的问答式解答。自动触发在pr_commands配置中加入/help即可让机器人自动发布帮助信息。典型配置configuration_options 有完整说明[config] pr_commands [ /describe, /review, /help ]相关配置项与help及其文档问答能力直接相关的配置位于 configuration.toml[pr_help_docs] repo_url # 为空时使用评论上下文所在仓库 repo_default_branch main docs_path docs # 文档目录 exclude_root_readme false supported_doc_exts [.md, .mdx, .rst] enable_help_text false这些配置作用于help_docs工具pr_help_docs.py当文档语料总长度超过模型输入上限时该工具会先让模型仅依据文件名章节标题排序相关文档再按排序结果选取最相关的文档重新组装提示词_rank_docs_and_return_them_as_prompt()并在读取前对路径做越界防护确保符号链接不会把克隆目录之外的文件读进提示词_filter_doc_files_under_clone()测试见 tests/unittest/test_pr_help_docs_path_containment.py。通用帮助入口与各工具使用指南help的输出信息源还包括 pr_agent/servers/help.py 中的HelpMessage类。它集中维护了get_general_bot_help_text()/get_general_commands_text()通用的命令速查/review、/describe、/improve [--extended]、/ask QUESTION、/update_changelog、/add_docs、/generate_labels并提示/config可查看配置参数各工具的详细使用指南get_review_usage_guide()、get_describe_usage_guide()、get_improve_usage_guide()、get_ask_usage_guide()、get_help_docs_usage_guide()涵盖配置覆盖写法与自动化开关示例。这些指南会在help_docs输出末尾以可折叠details的形式追加受pr_help_docs.enable_help_text控制也常常被 PR 评审等工具的结果引用enable_help_text在pr_reviewer、pr_description等段落中默认关闭可自行开启。小结/help是理解和使用 PR-Agent 的第一入口无参数时输出完整工具清单与交互式勾选框让团队成员尤其是新成员无需记忆命令即可触发工具带问题时则化身文档问答助手基于官方文档给出带来源链接的答案。其行为随代码平台能力自适应降级且所有输出、预算与安全行为都有对应源码与测试保障具体实现可继续阅读 pr_help_message.py、help.py 及 tests/unittest/test_pr_help_message_rendering.py。赞分享人工智能AI Agent代码智能体代码评审AI 应用【免费下载链接】pr-agent PR Agent: The Original Open-Source PR Reviewer. This project is not the Qodo free tier.项目地址https://gitcode.com/gh_mirrors/pr/pr-agent点击查看免费下载相关推荐winget help 命令完全指南用 --help 与 -? 快速掌握 WinGet 全部命令与参数winget help 命令完全指南用 help 与 ? 快速掌握 WinGet 全部命令与参数 导读 本文围绕 WinGetWindows Package包管理器CLIPR-Agent /improve 工具完全指南从触发方式到源码级配置PR Agent /improve 工具完全指南从触发方式到源码级配置 PR Agent 的 /improve 工具源码位于 pr_agent/tools/人工智能AI Agent代码智能体代码评审AI 应用PR-Agent /review 工具深度指南从触发方式到配置项与超大 PR 分块合并原理PR Agent /review 工具深度指南从触发方式到配置项与超大 PR 分块合并原理 review 是 PR Agent 的核心工具之一它在 Pull人工智能AI Agent代码智能体代码评审AI 应用创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考
返回列表