patched-codes/patchwork

演示 Demo | 文档 Docs

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 patchflows 所必需的。
• rag: 安装 chromadb（通过 pip install 'patchwork-cli[rag]'），这是 ResolveIssue patchflow 所必需的。
• notifications: 用于发送通知的步骤（如 Slack 消息）。
• all: 安装所有依赖。
• 如果不指定任何依赖组（仅执行 pip install patchwork-cli），将安装核心依赖，足以运行 GenerateDocstring、PRReview 和 GenerateREADME patchflows。

使用 Poetry

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

Patchwork CLI

CLI 用于运行 Patchflows，格式如下：

patchwork  

其中：

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

示例

对于使用 Semgrep 进行漏洞扫描并修复的 AutoFix patchflow：

patchwork AutoFix openai_api_key= github_api_key=

上述命令默认通过运行 Semgrep 来识别漏洞，并对当前目录中的代码进行修复。你可以查看 default.yml 文件以获取可管理 AutoFix patchflow 的配置列表。有关如何在 CLI 中使用 GitHub 个人访问令牌的更多详细信息，请阅读此处。

你可以通过登录 https://app.patched.codes/signin 并在集成（integrations）选项卡中生成 API 密钥，用我们托管服务的密钥替换 OpenAI 密钥。然后，你可以使用该密钥调用 patchflow：

patchwork AutoFix patched_api_key= github_api_key=

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

patchwork-template 仓库包含了所有 patchflows 的默认配置和提示词。你可以克隆该仓库并将其作为 flag 传递给 CLI：

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

使用开源模型

Patchwork 支持任何兼容 OpenAI 的终端节点，允许使用来自 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.yml