patched-codes/patchwork

演示视频 | 文档

Patchwork 使用自托管的 CLI Agent 和您首选的 LLM，实现 PR 审查、Bug 修复、安全补丁等开发繁琐工作的自动化。您可以在此处尝试托管版本。

关键组件

• Steps（步骤）: 可重用的原子化操作，例如创建 PR、提交更改或调用 LLM。
• Prompt Templates（提示词模板）: 针对库更新、代码生成、问题分析或漏洞修复等任务优化的可自定义 LLM 提示词。
• Patchflows（补丁流）: 通过组合步骤和提示词构建的 LLM 辅助自动化流程，例如 PR 审查、代码修复、文档生成等。

Patchflows 可以在您的 CLI 和 IDE 中本地运行，也可以作为 CI/CD 流水线的一部分运行。我们提供了多种现成的 Patchflows，您也可以随时创建自己的补丁流。

演示

安装

使用 Pip

Patchwork 已发布至 PyPI，可以通过 pip 进行安装：

pip install 'patchwork-cli[all]' --upgrade

以下是可选的依赖组：

• security: 安装 semgrep 和 depscan（使用 pip install 'patchwork-cli[security]'），这是 AutoFix 和 DependencyUpgrade 补丁流所必需的。
• rag: 安装 chromadb（使用 pip install 'patchwork-cli[rag]'），这是 ResolveIssue 补丁流所必需的。
• notifications: 用于发送通知的步骤（例如 Slack 消息）。
• all: 安装所有依赖。
• 如果不指定任何依赖组（直接运行 pip install patchwork-cli），将安装核心依赖项，足以运行 GenerateDocstring、PRReview 和 GenerateREADME 补丁流。

使用 Poetry

如果您想使用 poetry 从源码构建，请参考此处的详细文档。

Patchwork CLI

CLI 运行 Patchflows 的方式如下：

patchwork  

其中：

• Arguments（参数）: 允许以 key=value 的格式覆盖 Patchflow 的默认或可选属性。如果 key 没有值，则被视为布尔值 True。

示例

针对基于 Semgrep 扫描结果修复漏洞的 AutoFix 补丁流：

patchwork AutoFix openai_api_key= github_api_key=

上述命令默认通过运行 Semgrep 识别漏洞并修复当前目录下的代码。您可以查看 default.yml 文件以获取可用于管理 AutoFix 补丁流的配置列表。关于如何在 CLI 上使用 GitHub 个人访问令牌（Personal Access Token）的更多详细信息，请阅读此文档。

您可以通过访问 https://app.patched.codes/signin 并从“集成（integrations）”选项卡生成 API 密钥，将 OpenAI 密钥替换为我们托管服务提供的密钥。然后，您可以按如下方式调用补丁流：

patchwork AutoFix patched_api_key= github_api_key=

若要使用 Google 的模型，您可以设置 google_api_key 和 model。这在处理大型上下文时非常有用，因为 gemini-pro-1.5 模型支持 100 万 token 的输入上下文长度。

patchwork-template 仓库包含了所有补丁流的默认配置和提示词。您可以克隆该仓库并将其作为标志（flag）传递给 CLI：

patchwork AutoFix --config /path/to/patchwork-configs/patchflows

使用开源模型

Patchwork 支持任何兼容 OpenAI 的 API 端点，允许使用来自 Groq、Together AI 或 Hugging Face 等各种提供商的任何 LLM。

例如，要使用 Groq.com 的 Llama 3.1 405B，请运行：

patchwork AutoFix client_base_url=https://api.groq.com/openai/v1 openai_api_key=your_groq_key model=llama-3.1-405b-reasoning

您也可以使用配置文件执行相同的操作。要使用 Hugging Face 的 Llama 3.1 405B，请创建一个 config.yml 文件：

openai_api_key: your_hf_token
client_base_url: https://api-inference.huggingface.co/models/meta-llama/Meta-Llama-3.1-405B-Instruct-FP8/v1
model: Meta-Llama-3.1-405B-Instruct-FP8

并执行以下命令：

patchwork AutoFix --config=/path/to/config.