gpt-runner

GPT Runner 项目介绍

GPT Runner 是一个创新性的工具，旨在帮助开发者有效管理 AI 预设，并通过与代码进行实时交互，大幅提升个人及团队的开发效率。不论是通过终端工具、网页版还是 VSCode 扩展，GPT Runner 都提供了简便的集成方式，让用户可以轻松地与 AI 进行互动。

为什么选择 GPT Runner？

GPT Runner 彻底改变了开发者与 AI 互动的方式：

1. 与代码文件对话：

   • 在使用 GPT Runner 之前，开发者需要手动复制多个文件代码到 ChatGPT 窗口中，以向 AI 提出功能要求或修复 bug。
   • 有了 GPT Runner，用户只需从项目文件树中选择文件，AI 即可基于最新内容进行响应，无需繁琐的复制粘贴。

2. 管理项目的 AI 预设：

   • 过去，项目的提示信息通常被存于便签中，难以通过 git 进行版本控制。
   • GPT Runner 为每个 xxx.gpt.md 文件提供 AI 角色预设，并且这些预设易于阅读和修改，支持版本控制。团队成员可以共享并提升 AI 预设，提高代码的实用性。

功能特点

• 与代码文件的对话能力： 选择文件或文件夹，与 AI 进行实时对话。
• 强大的 CLI 和 IDE 集成： 在多种 IDE 中实现高效的 AI 工作流。
• AI 预设管理器： 类似于本地的 AI 预设 Storybook，方便管理。
• 自定义 AI 参数： 灵活控制 AI 模型的配置。
• 第三方 LLM 支持： 高兼容性和适应性。
• 隐私优先： 本地数据存储保护用户隐私。
• 多语言支持： 提供多语言支持，适合全球用户。

快速开始

在开始使用 GPT Runner 前，确保你拥有 OpenAI 或 Anthropic 的 API Key。

方法一：命令行工具 (CLI)

1. 确保 NodeJS 版本不低于 16.15.0。使用 node -v 检查当前 NodeJS 版本。如需安装或更新，请访问 NodeJS 官网。

2. 在项目文件夹中运行以下命令：

   cd <your project folder>
   npx gptr
   

   命令运行后，可以在浏览器中访问 http://localhost:3003 查看 Web 界面。

方法二：VSCode 扩展

1. 确保 VSCode 版本不低于 1.78.0。
2. 从 VSCode Marketplace 安装 GPT-Runner VSCode Extension。

文档和支持

• GPT-Runner 配置和 AI 预设文件： 有关 gptr.config.json 配置文件、xxx.gpt.md AI 预设文件、.gpt-runner 目录的详细信息，请查看 介绍文档。
• GPT-Runner 界面使用： 查看 UI 使用指南。

未来计划

• Jetbrains 插件开发
• 聊天记录导出和导入功能
• AI 预设商店，供社区共享和使用
• 模板插值支持
• Electron 客户端开发，拓展用户群至非开发者

支持与贡献

GPT Runner 项目得以成立，离不开诸多贡献者。欢迎查看我们的 贡献指南。如有疑问或需要支持，开发者可通过 2214962083@qq.com 联系我们。