如果您曾经为将代码库迁移到新的框架或语言而感到头疼，那么这个项目就是为您准备的。

https://user-images.githubusercontent.com/25165841/250232917-bcc99ce8-99b7-4e3d-a653-f89e163ed825.mp4

迁移是一项成本高昂、繁琐且并不简单的任务。请不要盲目信任当前版本，请谨慎使用。同时请注意，由于 GPT-Migrate 的设计目的是编写（并可能重写）整个代码库，因此费用可能会迅速增加。

然而，在开源社区的集体智慧和当前大语言模型技术的支持下，这一问题也是完全可以解决的。

⚡️ 使用方法

1. 安装 Docker 并确保其正在运行。建议您至少使用 GPT-4，最好是 GPT-4-32k。

📦 使用 Poetry 安装

1. 按照 Poetry 官方网站 的说明安装 Poetry。

2. Poetry 安装完成后，导航到项目目录，并使用以下命令安装项目依赖：

poetry install

这将创建一个虚拟环境，并在该环境中安装所有必要的依赖项。

2. 设置您的 OpenRouter API 密钥（默认）和/或您的 OpenAI API 密钥（以直接使用 OpenAI API……在这种情况下，将 --model 设置为 gpt-4-32k 或您所需的模型），并安装 Python 依赖项：

export OPENROUTER_API_KEY=<your key> export OPENAI_API_KEY=<your key> pip install -r requirements.txt

3. 运行主脚本，指定您想要迁移到的目标语言：

python main.py --targetlang nodejs

4. （可选）如果您希望 GPT-Migrate 在用单元测试测试迁移后的应用之前，先验证它生成的单元测试是否适用于您的现有应用，请确保您的现有应用已对外暴露，并使用 --sourceport 标志。要针对基准测试执行此操作，请打开另一个终端，导航到 benchmarks/language-pair/source 目录，并在安装依赖项后运行 python app.py。它将在端口 5000 上暴露服务。请结合 --sourceport 标志使用。

默认情况下，此脚本将执行 flask-nodejs 基准测试。您可以使用下面的选项指南指定语言、源目录以及其他许多内容。

💡 选项

您可以通过向 main.py 脚本传递以下选项来自定义 GPT-Migrate 的行为：

• --model: 要使用的大型语言模型。默认值为 "gpt-4-32k"。

• --temperature: AI 模型的温度设置。默认值为 0。

• --sourcedir: 包含待迁移代码的源目录。默认值为 "../benchmarks/flask-nodejs/source"。

• --sourcelang: 待迁移代码的源语言或框架。无默认值。

• --sourceentry: 源目录下的入口文件名。例如，对于 Python 应用程序，可能是 app.py 或 main.py 文件。默认值为 "app.py"。

• --targetdir: 迁移后的代码将存放的目录。默认值为 "../benchmarks/flask-nodejs/target"。

• --targetlang: 迁移的目标语言或框架。默认值为 "nodejs"。

• --operating_system: Dockerfile 的操作系统。常见选项有 'linux' 或 'windows'。默认值为 'linux'。

• --testfiles: 需要测试的函数所在的文件列表，以逗号分隔。例如，对于 Python 应用程序，这可能是包含 REST 端点的 app.py 或 main.py 文件。请提供完整的相对路径。默认值为 "app.py"。

• --sourceport: （可选）用于将单元测试文件与原始应用程序进行测试的端口。无默认值。如果未指定，GPT-Migrate 将不会尝试将单元测试与您的原始应用程序进行测试。

• --targetport: 用于将单元测试文件与迁移后的应用程序进行测试的端口。默认值为 8080。

• --guidelines: 您希望在迁移过程中遵循的风格或小功能指南。例如，“使用制表符，而不是空格”。默认值为空字符串。

• --step: 要执行的步骤。选项包括 'setup'、'migrate'、'test'、'all'。默认值为 'all'。

例如，要将 Python 代码库迁移到 Node.js，您可以运行：

python main.py --sourcedir /path/to/my-python-app --sourceentry app.py --targetdir /path/to/my-nodejs-app --targetlang nodejs

这会将 ./my-python-app 中的 Python 代码迁移到 Node.js，并将结果代码写入 ./my-nodejs-app。

GPT 辅助调试

https://user-images.githubusercontent.com/25165841/250233075-eff1a535-f40e-42e4-914c-042c69ba9195.mp4

🤖 工作原理

要将仓库从 --sourcelang 迁移到 --targetlang……

1. GPT-Migrate 首先为 --targetlang 创建一个 Docker 环境，该环境可以由用户指定，也可以由 GPT-Migrate 自动评估。
2. 它递归地评估您现有的代码，以识别第三方 --sourcelang 依赖项，并选择相应的 --targetlang 依赖项。
3. 它从您指定的 --sourceentry 文件开始，递归地根据现有代码重建新的 --targetlang 代码。这一步可以通过 --step migrate 选项启动。
4. 它启动包含新代码的 Docker 环境，在 --targetport 上暴露服务，并根据需要迭代调试。
5. 它使用 Python 的 unittest 框架开发单元测试，并可选地在您的现有应用程序运行且在 --sourceport 上暴露的情况下，将其与现有应用程序进行测试，同样根据需要迭代调试。这一步可以通过 --step test 选项启动。
6. 它使用这些单元测试在 --targetport 上测试新代码。
7. 它会根据日志、错误信息、相关文件以及目录结构等上下文，为您迭代调试代码。它通过选择一项或多项操作（移动、创建或编辑文件）并执行它们来实现这一点。如果它需要执行任何类型的 shell 脚本（例如移动文件），它会先请求许可。最后，如果在任何时候它陷入僵局，或者用户终止了调试循环，它将输出指导用户如何进入迁移的下一步。
8. 新的代码库完成，并存放在 --targetdir 中。

📝 提示词设计

子提示词按照以下方式组织：

• HIERARCHY：定义了偏好概念。共有4个偏好级别，每个级别都比前一级别优先级更高。
• p1：偏好级别1。这些是最通用的提示词，由宽泛的指导原则组成。
• p2：偏好级别2。这些提示词更加具体，包含针对特定类型操作的指导（例如编写代码的最佳实践和理念）。
• p3：偏好级别3。这些提示词更为具体，提供针对特定操作的指示（例如创建某个文件、调试、编写测试）。
• p4：偏好级别4。这些是最高级别的具体提示词，用于指定输出格式。

提示词是由多个子提示词组合而成的。这种标签化和可组合性的概念还可以扩展到其他属性上，从而使提示词更加健壮。这是我们非常感兴趣并积极探索的一个领域。

在本仓库中，prompt_constructor() 函数接收一个或多个子提示词，并生成一个可以使用变量进行格式化的字符串，例如将 GUIDELINES 定义为 p1，WRITE_CODE 定义为 p2 等：

prompt = prompt_constructor(HIERARCHY, GUIDELINES, WRITE_CODE, DEBUG_TESTFILE, SINGLEFILE).format(targetlang=targetlang,buggyfile=buggyfile)

📈 性能

GPT-Migrate 目前仍处于开发 Alpha 阶段，尚未准备好投入生产环境使用。例如，在相对简单的基准测试中，它大约 50% 的时间能够顺利迁移 Python 或 JavaScript 等“简单”语言，而对于 C++ 或 Rust 等更复杂的语言，则需要一定的人工协助才能完成迁移。

✅ 基准测试

我们正在积极构建一个强大的基准测试库。如果您有一个希望贡献的代码库，请提交 Pull Request！目前的基准测试是从零开始构建的：包含几个端点和依赖文件的 REST API 应用程序。

🧗 路线图

以下是待办事项清单中的改进内容。如果您希望完成其中任何一项或其他任务，请提交 PR :)

高紧急程度

• 根据模型输入窗口大小，添加限制输入长度的逻辑。详见问题 #2。

中等紧急程度

• 为整个项目添加单元测试，以提高可靠性和 CI/CD 流程。
• 增加更多基准测试示例，尤其是大型代码库。
• 添加功能，使 LLM 在调试时能够请求访问其他文件中的依赖函数。
• 增加对其他 LLM 的支持。

低紧急程度

• 在模型调试过程中启用互联网搜索功能。
• 识别并整理特定语言的问题，并提出解决方案。

📣 行动号召

我们正在寻找优秀的贡献者。无论您对某种特定语言或框架充满热情，还是希望帮助我们构建更健壮的测试套件，亦或是对如何改进该项目有有趣的创意，我们都热烈欢迎您的加入！

🛠 专家协助迁移

由于请求量不断增加，我们决定制定一套标准化流程，以帮助大家完成代码迁移工作。如果您所在的公司需要大规模迁移的支持，或者您是一位愿意提供帮助的专家，请访问以下网站：https://gpt-migrate.com/

欢迎在 Twitter 上参与讨论！

GPT-Migrate 快速上手指南

GPT-Migrate 是一个利用大语言模型（LLM）自动将代码库从一种框架或语言迁移到另一种框架或语言的工具。

环境准备

在开始之前，请确保您的开发环境满足以下要求：

• 操作系统：支持 Linux、macOS 或 Windows（需安装 WSL2 或兼容的 Docker 环境）。
• Docker：必须安装并正在运行。该工具依赖 Docker 来构建目标语言的运行环境。
• Python：建议安装 Python 3.8+。
• Poetry：用于管理 Python 项目依赖。
  • 安装命令：curl -sSL https://install.python-poetry.org | python3 -
• API Key：
  • OpenRouter API Key（推荐默认使用）：访问 OpenRouter 获取。
  • OpenAI API Key（可选）：若直接使用 OpenAI 接口，请访问 OpenAI Platform 获取。
  • 模型建议：强烈建议使用 GPT-4，最好是 GPT-4-32k，以处理较大的代码上下文。

注意：由于涉及大量 Token 调用，迁移整个代码库可能会产生较高的 API 费用，请谨慎使用并监控用量。

安装步骤

1. 克隆项目并进入目录

   git clone https://github.com/0xpayne/gpt-migrate.git
   cd gpt-migrate
   

2. 使用 Poetry 安装依赖 这将创建虚拟环境并安装所需包：

   poetry install
   

3. 配置 API 密钥 根据您的选择导出环境变量（二选一或同时配置）：

   • 使用 OpenRouter（默认）：

     export OPENROUTER_API_KEY=<your_openrouter_key>
     

   • 直接使用 OpenAI（如需指定特定模型如 gpt-4-32k）：

     export OPENAI_API_KEY=<your_openai_key>
     

4. 安装 Python 依赖（备选） 如果不使用 Poetry 激活的环境，可直接通过 pip 安装：

   pip install -r requirements.txt
   

基本使用

以下是最简单的使用示例，将当前目录下的 Python Flask 应用迁移为 Node.js 应用。

1. 执行迁移命令

运行主脚本并指定目标语言（--targetlang）：

python main.py --targetlang nodejs

参数说明：

• 默认情况下，脚本会读取 ../benchmarks/flask-nodejs/source 目录作为源代码。
• 默认会将迁移后的代码输出到 ../benchmarks/flask-nodejs/target 目录。
• 默认使用的模型为 gpt-4-32k。

2. 自定义源目录和目标语言

如果您想迁移自己的项目，可以使用以下命令格式：

python main.py --sourcedir /path/to/my-python-app --sourceentry app.py --targetdir /path/to/my-nodejs-app --targetlang nodejs

• --sourcedir: 源代码所在目录。
• --sourceentry: 入口文件名（如 app.py 或 main.py）。
• --targetdir: 迁移后代码的输出目录。
• --targetlang: 目标语言（如 nodejs, go, rust 等）。

3. 工作流程简述

执行命令后，GPT-Migrate 将自动执行以下步骤：

1. 为目标语言创建 Docker 环境。
2. 分析源代码依赖并映射到目标语言依赖。
3. 递归重写代码。
4. 启动容器并进行迭代调试。
5. 生成单元测试并验证迁移后的应用。
6. 最终在 --targetdir 输出完整的迁移代码。

提示：迁移过程是迭代进行的，如果遇到复杂逻辑，工具可能会请求用户确认文件操作或提供进一步的调试上下文。目前该工具处于 Alpha 阶段，对于复杂语言（如 C++、Rust）可能需要人工辅助。