claw-code/README.md

GPT Runner

English / 简体中文

Manage ai presets. Chat with your code files. Revolutionize Your Team's Collaboration and Efficiency!

管理 ai 预设。 与您的代码文件聊天。 彻底改变您团队的协作和效率！

CLI / Web App / VSCode Extension / Issues / Buy Me a Coffee

终端工具 / 网页版 / VSCode 扩展 / 反馈 / 打赏开发者

Features

• CLI and IDE Extension: GPT-Runner provides a robust command-line interface to launch a web interface and IDE extension that retrieves all xxx.gpt.md files in your project. These files serve as AI-powered robot presets, making the GPT-Runner accessible to virtually any IDE and ensuring an efficient AI workflow.

• AI Robot Preset-based Chats: Developers can create chats based on xxx.gpt.md files, with Git version management support, fostering team collaboration and seamless communication.

• Customizable AI Parameters: The xxx.gpt.md files offer flexibility to specify system prompts, user prompts, model names, temperature, and much more. Empower your team to extract maximum value from a single file with continuous maintenance and improvement.

• LLM Adaptation: GPT-Runner supports both openai's API key method and access token method, and the future is not only openai, because it is built on langchainjs, so it is easy to adapt to third-party LLM !

• Privacy first, all data stored locally in your PC.

• Web Link Share: You can share the GPT-Runner web interface through the LAN ip, or use the Tunnel function provided by the CLI to enable temporary Gradio link sharing.

• Web Theme: GPT-Runner supports light and dark themes. it support VSCode Dark and VSCode Light and Jetbrains Dark and Jetbrains Light. By the way. The theme will auto change with your VSCode current theme style when you use VSCode Extension. BTW, it's Responsive design !

• Web I18n: English, 简体中文, 繁体中文, 日本語, Deutsch

Documentation

Read the documentation for more details.

Roadmap

• Jetbrains Plugin: Add Jetbrains IDE Plugin
• Export Chat History: Add dialogue import and export function, compatible with OpenAI specification
• AI Preset Store: Add AI Preset Store for community sharing AI Preset File
• Template Interpolation: Add template interpolation support
• Electron: Add an Electron client to expand the target audience to non-developers

What's New

• 🚀 v1.0.0: First Release

主要功能

• CLI 和 IDE 扩展：GPT-Runner 提供了强大的命令行界面，用于启动 Web 界面和 IDE 扩展，以检索项目中的所有 xxx.gpt.md 文件。这些文件作为 AI 支持的机器人预设，使得 GPT-Runner 可以适用于几乎任何 IDE，并确保高效的 AI 工作流程。

• 以 AI 机器人预设为基础的聊天：开发人员可以基于 xxx.gpt.md 文件创建聊天，支持 Git 版本管理，促进团队协作和无缝沟通。

• 自定义 AI 参数：xxx.gpt.md 文件可以灵活地指定系统提示、用户提示、模型名称、温度等。通过持续维护和改进，赋予团队从单个文件中提取最大价值的能力。

• LLM 适配：GPT-Runner 支持 openai 的 API key 方式和 access token 方式，未来不仅支持 openai，因为它基于 langchainjs 构建，所以很容易适应第三方 LLM！

• 隐私优先，所有数据存储在您的个人电脑上。

• Web 链接分享：您可以通过 局域网 ip 分享 GPT-Runner Web 界面，或者使用 CLI 提供的 Tunnel 功能启用临时的 Gradio 链接 分享。

• Web 主题：GPT-Runner 支持亮色和暗色主题。支持 VSCode Dark、VSCode Light、Jetbrains Dark 和 Jetbrains Light。顺便说一下，在使用 VSCode 扩展 时，主题会根据您当前的 VSCode 主题样式自动切换。此外, ui 是响应式设计！

• Web 国际化支持：English, 简体中文, 繁体中文, 日本語, Deutsch

文档

阅读 文档 以获取更多详细信息。

开发计划

• Jetbrains 插件：添加 Jetbrains IDE 插件
• 导出聊天记录：添加对话导入导出功能，兼容OpenAI规范
• AI预设商店：添加AI预设商店以供社区共享AI预设文件
• 模板插值：添加模板插值支持
• Electron：添加 Electron 客户端，将目标受众推广到非开发人员

最新动态

• 🚀 v1.0.0: 首次发布

FAQ

English > FAQ

简体中文 > 常见问题

Requirements

NodeJS >= 16.15.0

Local Development

# install nodejs >= 16.15.0
npm i -g pnpm
pnpm i

# run server
cd packages/gpt-runner-web && pnpm dev:server

# open a new terminal and run client
cd packages/gpt-runner-web && pnpm dev:client

Now you can visit http://localhost:3006 to see the result.

Donation

Buy Me a Coffee

Acknowledgement

GPT-Runner is made possible thanks to the inspirations from the following projects:

in alphabet order

• Docusaurus
• LangchainJs
• UnoCss
• VSCode-Webview-Ui-Toolkit

Sponsor

no...

Contributor

Contributors

LICENSE

MIT License © 2023-PRESENT Jinming Yang