{"id":13588475,"url":"https://github.com/nicepkg/gpt-runner","last_synced_at":"2025-10-23T22:15:33.993Z","repository":{"id":181200047,"uuid":"640476297","full_name":"nicepkg/gpt-runner","owner":"nicepkg","description":"Conversations with your files! Manage and run your AI presets!","archived":false,"fork":false,"pushed_at":"2023-09-11T13:14:48.000Z","size":55859,"stargazers_count":364,"open_issues_count":10,"forks_count":45,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-03-27T07:52:02.728Z","etag":null,"topics":["ai","anthropic","chatgpt","langchain","llm","openai","prompt","promptengineering"],"latest_commit_sha":null,"homepage":"https://github.com/nicepkg/gpt-runner","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/nicepkg.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":"CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null},"funding":{"github":["nicepkg",2214962083],"open_collective":"nicepkg"}},"created_at":"2023-05-14T08:06:03.000Z","updated_at":"2025-03-23T04:40:42.000Z","dependencies_parsed_at":null,"dependency_job_id":"4528867d-5a8a-43d8-b936-8eb5b21aec93","html_url":"https://github.com/nicepkg/gpt-runner","commit_stats":null,"previous_names":["nicepkg/gpt-runner"],"tags_count":57,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nicepkg%2Fgpt-runner","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nicepkg%2Fgpt-runner/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nicepkg%2Fgpt-runner/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nicepkg%2Fgpt-runner/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nicepkg","download_url":"https://codeload.github.com/nicepkg/gpt-runner/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247226210,"owners_count":20904465,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ai","anthropic","chatgpt","langchain","llm","openai","prompt","promptengineering"],"created_at":"2024-08-01T15:06:44.271Z","updated_at":"2025-10-23T22:15:28.933Z","avatar_url":"https://github.com/nicepkg.png","language":"TypeScript","readme":"\u003cdiv align=\"center\"\u003e\n\u003cimg src=\"https://github.com/2214962083/2214962083/assets/34775414/a48b745f-c803-4884-95a8-26c63f7f5b53\" alt=\"icon\"/\u003e\n\n\u003ch1 align=\"center\"\u003eGPT Runner\u003c/h1\u003e\n\n\nEnglish / [简体中文 🌏](https://github.com/nicepkg/gpt-runner/tree/main/README_CN.md)\n\nUse GPT-Runner to manage your AI presets, engage in AI-powered conversations with your code, and significantly boost the development efficiency of both you and your team!\n\n用 GPT-Runner 管理您的 AI 预设，通过 AI 与您的代码文件聊天，极大提升您和团队的开发效率！\n\n[![CLI][cli-image]][cli-url]\n[![Web][web-image]][web-url]\n[![VSCode][vscode-image]][vscode-url]\n[![License](https://img.shields.io/github/license/nicepkg/gpt-runner)][gpt-runner-license]\n[![GitHub stars](https://img.shields.io/github/stars/nicepkg/gpt-runner?style=social)][gpt-runner-url]\n\n\n[CLI](https://github.com/nicepkg/gpt-runner/tree/main/packages/gpt-runner-cli/) / [Web Page](https://github.com/nicepkg/gpt-runner/tree/main/packages/gpt-runner-web/) / [VSCode Extension](https://github.com/nicepkg/gpt-runner/tree/main/packages/gpt-runner-vscode/) / [Issues](https://github.com/nicepkg/gpt-runner/issues) / [Buy Me a Coffee](https://bmc.link/jinmingyang)\n\n[终端工具](https://github.com/nicepkg/gpt-runner/blob/main/packages/gpt-runner-cli/README_CN.md) / [网页版](https://github.com/nicepkg/gpt-runner/tree/main/packages/gpt-runner-web/) / [VSCode 扩展](https://github.com/nicepkg/gpt-runner/blob/main/packages/gpt-runner-vscode/README_CN.md) / [反馈](https://github.com/nicepkg/gpt-runner/issues) / [打赏开发者](https://user-images.githubusercontent.com/35005637/255805279-da299e44-ab7a-4038-b945-86d33128a775.jpg)\n\n[cli-url]: https://github.com/nicepkg/gpt-runner/tree/main/packages/gpt-runner-cli/\n[cli-image]: https://img.shields.io/badge/CLI-Node.js-green?logo=node.js\n[gpt-runner-license]: https://github.com/nicepkg/gpt-runner/tree/main/LICENSE\n[gpt-runner-url]: https://github.com/nicepkg/gpt-runner\n[web-url]: https://github.com/nicepkg/gpt-runner/tree/main/packages/gpt-runner-web/\n[web-image]: https://img.shields.io/badge/Web-React-blue?logo=react\n[vscode-url]: https://github.com/nicepkg/gpt-runner/tree/main/packages/gpt-runner-vscode/\n[vscode-image]: https://img.shields.io/badge/VSCode-Extension-blue?logo=visualstudiocode\n\n\u003c/div\u003e\n\nhttps://user-images.githubusercontent.com/35005637/252378643-f0d053ac-88db-4b92-966a-75a411a1ce6c.mp4\n\n\u003cdetails\u003e\n\u003csummary\u003e📚 Table of Contents\u003c/summary\u003e\u003cbr\u003e\n\n- [🤷‍♂️ Why GPT-Runner?](#️-why-gpt-runner)\n- [⚙️ Features](#️-features)\n- [🚀 Quick Start](#-quick-start)\n  - [The first way: CLI](#the-first-way-cli)\n  - [The second way:  VSCode Extension](#the-second-way--vscode-extension)\n- [📖 Documentation](#-documentation)\n  - [GPT-Runner Configs And AI Preset Files](#gpt-runner-configs-and-ai-preset-files)\n  - [GPT-Runner Ui Usage](#gpt-runner-ui-usage)\n- [🗒️ Road map](#️-road-map)\n- [🆕 What's New](#-whats-new)\n- [❓ FAQ](#-faq)\n- [💖 Sponsor](#-sponsor)\n- [🤝 Contributor](#-contributor)\n- [🙏 Acknowledgement](#-acknowledgement)\n- [📜 LICENSE](#-license)\n\n\u003cbr\u003e\u003c/details\u003e\n\n## 🤷‍♂️ Why GPT-Runner?\n\n1. **🔍 Conversations with Code Files:** \n    - Before using GPT-Runner: Manual copy and paste of multiple file codes into the ChatGPT window were required to propose features or fix bugs to AI.🙁\n    - After using GPT-Runner: Simply select your project files from the file tree. The AI will provide responses based on the most recent contents of those files.🤩\n\n2. **📑 Manage the Project's AI Presets:** \n    - Before using GPT-Runner: Project prompts saved in memos needed to be copied and pasted to ChatGPT for inquiries, making it difficult to put them under git version control.🤪\n    - After using GPT-Runner: Each [xxx.gpt.md](https://github.com/nicepkg/gpt-runner/tree/main/docs/examples/example-en.gpt.md) file represents an AI role preset. They are easy to read, modify, and can be version-controlled. Team members can share and enhance AI presets, making the code they produce closer to 100% usability.🥰\n\n\n## ⚙️ Features\n\n- **🔍 Conversations with Code Files**: Select files or folders and engage in real-time conversations with AI.\n- **🛠️ Powerful CLI and IDE integration:** Implement efficient AI workflows in various IDEs.\n- **🔖 AI Preset Manager:** Manage your AI presets, Just like a locally Storybook for AI presets.\n- **🤖 Customize AI parameters:** Flexibly control the configuration of AI models.\n- **🔌 Support for third-party LLMs:** High compatibility and adaptability.\n- **🔒 Privacy-first:** Local data storage protects your privacy.\n- **🌎 Locale support:** Support for multiple languages.\n\n## 🚀 Quick Start\n\n\u003e Make sure you have an Open AI Key or a Anthropic Key. You can get it from [Open AI](https://platform.openai.com/account/api-keys) or [Anthropic](https://www.anthropic.com/).\n\n\n### The first way: CLI\n\n\u003e 1. Requirements NodeJS \u003e= 16.15.0\n\u003e     - To check your NodeJS version, run `node -v` in your terminal. If you need to install or update NodeJS, visit [the official NodeJS website](https://nodejs.org/) for download and installation instructions.\n\u003e 2. First run the following command to download this package, which will take a long time, which is normal.\n\n\n```bash\ncd \u003cyour project folder\u003e\nnpx gptr\n```\n\nYou can see the web interface in your browser at [http://localhost:3003](http://localhost:3003).\n\n### The second way:  VSCode Extension\n\n\u003e Requirements VSCode \u003e= 1.78.0\n\nInstall the [GPT-Runner VSCode Extension](https://marketplace.visualstudio.com/items?itemName=nicepkg.gpt-runner) from the VSCode Marketplace.\n\n## 📖 Documentation\n\n### GPT-Runner Configs And AI Preset Files\n\nFor details about `gptr.config.json` configuration file, `xxx.gpt.md` AI preset file, `.gpt-runner` special directory, please refer to here:\n\n[Introduction to GPT-Runner Configs And AI Preset Files](https://github.com/nicepkg/gpt-runner/blob/main/docs/gpt-config.en.md)\n\n### GPT-Runner Ui Usage\n\n[Introduction to GPT-Runner Ui Usage](https://github.com/nicepkg/gpt-runner/blob/main/docs/ui-usage.en.md)\n\n## 🗒️ Road map\n\n- [ ] Jetbrains Plugin: Add Jetbrains IDE Plugin\n- [ ] Export And Import Chat History: Add dialogue import and export function\n- [ ] AI Preset Store: Add AI Preset Store for community sharing AI Preset File\n- [ ] Template Interpolation: Add template interpolation support\n- [ ] Electron: Add an Electron client to expand the target audience to non-developers\n\n## 🆕 What's New\n\n- 🚀 v1.0.0: First Release\n\n## ❓ FAQ\n\n\u003e You can contact me via [2214962083@qq.com](mailto:2214962083@qq.com)\n\u003e \n\u003e 对 AI 提升开发效率感兴趣的，可以加我 wechat: qq2214962083 入群交流\n\u003e \n\u003e 要求：会科学上网，使用过 chatgpt\n\n\n[English \u003e FAQ](https://github.com/nicepkg/gpt-runner/tree/main/docs/faq.en.md)\n\n## 💖 Sponsor\n\nWaiting for you...\n\n## 🤝 Contributor\n\nYou can check out our [Contribution Guidelines](https://github.com/nicepkg/gpt-runner/tree/main/CONTRIBUTING.md)\n\nThis project exists thanks to all the people who contribute:\n\n\u003ca href=\"https://github.com/nicepkg/gpt-runner/graphs/contributors\"\u003e\n  \u003cimg src=\"https://contrib.rocks/image?repo=nicepkg/gpt-runner\" /\u003e\n\u003c/a\u003e\n\n## 🙏 Acknowledgement\n\nGPT-Runner is made possible thanks to the inspirations from the following projects:\n\n\u003e in alphabet order\n\n- [Docusaurus](https://github.com/facebook/docusaurus)\n- [Gradio](https://github.com/gradio-app/gradio)\n- [LangchainJs](https://github.com/hwchase17/langchainjs)\n- [Monaco-React](https://github.com/suren-atoyan/monaco-react)\n- [UnoCss](https://github.com/unocss/unocss)\n- [VSCode-Material-Icon-Theme](https://github.com/PKief/vscode-material-icon-theme)\n- [VSCode-Webview-Ui-Toolkit](https://github.com/microsoft/vscode-webview-ui-toolkit)\n\n## 📜 LICENSE\n\n[MIT](https://github.com/nicepkg/gpt-runner/tree/main/LICENSE) License \u0026copy; 2023-PRESENT [Jinming Yang](https://github.com/2214962083)\n","funding_links":["https://github.com/sponsors/nicepkg","https://github.com/sponsors/2214962083","https://opencollective.com/nicepkg"],"categories":["[GPT Runner](https://github.com/nicepkg/gpt-runner)","TypeScript","Prompts","AI Assistants","UIs"],"sub_categories":["Links","Emacs","Command-line(shell) interface"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnicepkg%2Fgpt-runner","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnicepkg%2Fgpt-runner","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnicepkg%2Fgpt-runner/lists"}