轻松从代码库生成 LLM 提示：code2prompt和vscode2prompt

banq

code2prompt是一个命令行工具（CLI），它将您的代码库转换为具有源树、提示模板和标记计数的单个 LLM 提示。

可以在整个目录上运行此工具，它会生成格式良好的 Markdown 提示，详细说明源树结构和所有代码。然后，您可以将此文档上传到具有更高上下文窗口的 GPT 或 Claude 模型，并要求它：

  • 从任意大小的代码库快速生成 LLM 提示。
  • 使用 Handlebars 模板自定义提示生成。（参见默认模板）
  • 敬備.gitignore。
  • 使用 glob 模式过滤和排除文件。
  • 显示生成的提示的标记计数。（有关更多详细信息，请参阅标记器）
  • 可选择在生成的提示中包含 Git diff 输出（暂存文件）。
  • 自动将生成的提示复制到剪贴板。
  • 将生成的提示保存到输出文件。
  • 按名称或路径排除文件和文件夹。
  • 为源代码块添加行号。

您可以自定义提示模板以实现任何所需的用例。它本质上是遍历代码库并创建一个包含所有源文件的提示。简而言之，它会自动将多个源文件复制粘贴到您的提示中并对其进行格式化，同时让您知道您的代码使用了多少个标记。

它有什么用处？
code2prompt可轻松从代码库生成 LLM 提示。它会遍历目录、构建树结构并收集有关每个文件的信息。您可以使用 Handlebars 模板自定义提示生成。生成的提示会自动复制到剪贴板，也可以保存到输出文件中。code2prompt有助于简化为代码分析、生成和其他任务创建 LLM 提示的过程。


要求：

git clone https://github.com/mufeedvh/code2prompt.git
cd code2prompt/
cargo build --release

从代码库目录生成提示：
code2prompt path/to/codebase

vscode2prompt
vscode2prompt是一个 Visual Studio Code 扩展，可让您将选定的文件或打开的选项卡合并为一个文件。这对于准备用于 ChatGPT 等聊天应用程序的内容特别有用。灵感来自code2prompt

特征

  • 合并选定的文件：从工作区中选择多个文件并将其内容合并为一个虚拟文档。
  • 合并打开的选项卡：将所有打开的文本选项卡的内容合并到一个虚拟文档中。

安装

  1. 克隆存储库或下载扩展包。
  2. 在 Visual Studio Code 中打开项目。
  3. 运行npm install以安装依赖项。
  4. 按下F5即可打开一个已加载扩展的新 VS Code 窗口。

用法

合并选定文件

  1. 打开命令面板（Ctrl+Shift+P或Cmd+Shift+P在 macOS 上）。
  2. 键入Merge Selected Files并选择命令。
  3. 从快速选择列表中选择要合并的文件。
  4. 将打开一个包含合并内容的新标签。
合并打开的标签页
  1. 打开命令面板（Ctrl+Shift+P或Cmd+Shift+P在 macOS 上）。
  2. 键入Merge Open Tabs并选择命令。
  3. 将打开一个新选项卡，其中包含所有打开的文本选项卡的合并内容。