diff --git a/README.md b/README.md index c20f32c..09c71d4 100644 --- a/README.md +++ b/README.md @@ -37,7 +37,9 @@ Use GPT-Runner to manage your AI presets, engage in AI-powered conversations wit - [Quick Start](#quick-start) - [The first way: CLI](#the-first-way-cli) - [The second way: VSCode Extension](#the-second-way--vscode-extension) -- [GPT-Runner File](#gpt-runner-file) +- [Documentation](#documentation) + - [GPT-Runner Configs And AI Preset Files](#gpt-runner-configs-and-ai-preset-files) + - [GPT-Runner Ui Usage](#gpt-runner-ui-usage) - [Road map](#road-map) - [What's New](#whats-new) - [FAQ](#faq) @@ -56,7 +58,7 @@ Use GPT-Runner to manage your AI presets, engage in AI-powered conversations wit 2. **Manage the Project's AI Presets:** - 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. - - After using GPT-Runner: Each [xxx.gpt.md](https://github.com/nicepkg/gpt-runner/tree/main/docs/example.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. + - 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. ## Features @@ -94,11 +96,17 @@ You can see the web interface in your browser at [http://localhost:3003](http:// Install the [GPT-Runner VSCode Extension](https://marketplace.visualstudio.com/items?itemName=nicepkg.gpt-runner) from the VSCode Marketplace. -## GPT-Runner File +## Documentation -For a detailed introduction about `.gpt-runner` directory, `*.gpt.md` files, and `gptr.config.json` files, please see here: +### GPT-Runner Configs And AI Preset Files -[Introduction to GPT-Runner Files](https://github.com/nicepkg/gpt-runner/blob/main/docs/gpt-config-en.gpt.md) +For details about `gptr.config.json` configuration file, `xxx.gpt.md` AI preset file, `.gpt-runner` special directory, please refer to here: + +[Introduction to GPT-Runner Configs And AI Preset Files](https://github.com/nicepkg/gpt-runner/blob/main/docs/gpt-config.en.md) + +### GPT-Runner Ui Usage + +[Introduction to GPT-Runner Ui Usage](https://github.com/nicepkg/gpt-runner/blob/main/docs/ui-usage.en.md) ## Road map @@ -114,7 +122,7 @@ For a detailed introduction about `.gpt-runner` directory, `*.gpt.md` files, and ## FAQ -[English > FAQ](https://github.com/nicepkg/gpt-runner/tree/main/docs/faq-en.md) +[English > FAQ](https://github.com/nicepkg/gpt-runner/tree/main/docs/faq.en.md) ## Sponsor diff --git a/README_CN.md b/README_CN.md index ac517ad..17de14d 100644 --- a/README_CN.md +++ b/README_CN.md @@ -33,7 +33,9 @@ - [快速开始](#快速开始) - [方式一:CLI](#方式一cli) - [方式二:VSCode 扩展](#方式二vscode-扩展) -- [GPT-Runner 文件](#gpt-runner-文件) +- [文档](#文档) + - [GPT-Runner 配置和 AI 预设文件](#gpt-runner-配置和-ai-预设文件) + - [GPT-Runner Ui 用法](#gpt-runner-ui-用法) - [开发计划](#开发计划) - [最新动态](#最新动态) - [常见问题](#常见问题) @@ -52,7 +54,7 @@ 2. **管理项目的AI预设:** - 使用 GPT-Runner 前:保存在备忘录中的项目提示需要复制粘贴给 ChatGPT 才能提问,难以进行 git 版本管理。 - - 使用 GPT-Runner 后:[xxx.gpt.md](https://github.com/nicepkg/gpt-runner/tree/main/docs/example-cn.gpt.md) 文件代表一个AI角色预设,它易于阅读、修改并可进行版本控制。团队成员可以分享和优化 AI 预设,使其生成的代码更接近 100% 的可用性。 + - 使用 GPT-Runner 后:[xxx.gpt.md](https://github.com/nicepkg/gpt-runner/tree/main/docs/examples/example-cn.gpt.md) 文件代表一个AI角色预设,它易于阅读、修改并可进行版本控制。团队成员可以分享和优化 AI 预设,使其生成的代码更接近 100% 的可用性。 ## 主要功能 @@ -89,11 +91,17 @@ npx gptr 从 VSCode Marketplace 安装 [GPT-Runner VSCode 扩展](https://marketplace.visualstudio.com/items?itemName=nicepkg.gpt-runner)。 -## GPT-Runner 文件 +## 文档 -关于 `.gpt-runner` 目录和 `*.gpt.md` 文件和 `gptr.config.json` 文件详细介绍请看这里: +### GPT-Runner 配置和 AI 预设文件 - [GPT-Runner 文件介绍](https://github.com/nicepkg/gpt-runner/blob/main/docs/gpt-config-cn.gpt.md) +关于 `gptr.config.json` 配置文件、`xxx.gpt.md` AI 预设文件、`.gpt-runner` 特殊目录的详细介绍请参见这里: + +[GPT-Runner 配置和 AI 预设文件](https://github.com/nicepkg/gpt-runner/blob/main/docs/gpt-config.cn.md) + +### GPT-Runner Ui 用法 + +[GPT-Runner Ui使用介绍](https://github.com/nicepkg/gpt-runner/blob/main/docs/ui-usage.cn.md) ## 开发计划 @@ -109,7 +117,7 @@ npx gptr ## 常见问题 -[简体中文 > 常见问题](https://github.com/nicepkg/gpt-runner/tree/main/docs/faq-cn.md) +[简体中文 > 常见问题](https://github.com/nicepkg/gpt-runner/tree/main/docs/faq.cn.md) ## 赞助者 diff --git a/docs/example-cn.gpt.md b/docs/examples/example-cn.gpt.md similarity index 100% rename from docs/example-cn.gpt.md rename to docs/examples/example-cn.gpt.md diff --git a/docs/example.gpt.md b/docs/examples/example-en.gpt.md similarity index 100% rename from docs/example.gpt.md rename to docs/examples/example-en.gpt.md diff --git a/docs/gptr.config.json b/docs/examples/gptr.config.json similarity index 100% rename from docs/gptr.config.json rename to docs/examples/gptr.config.json diff --git a/docs/faq-cn.md b/docs/faq.cn.md similarity index 100% rename from docs/faq-cn.md rename to docs/faq.cn.md diff --git a/docs/faq-en.md b/docs/faq.en.md similarity index 100% rename from docs/faq-en.md rename to docs/faq.en.md diff --git a/docs/gpt-config-cn.gpt.md b/docs/gpt-config.cn.md similarity index 98% rename from docs/gpt-config-cn.gpt.md rename to docs/gpt-config.cn.md index 6f0f6cf..b59b2db 100644 --- a/docs/gpt-config-cn.gpt.md +++ b/docs/gpt-config.cn.md @@ -1,9 +1,9 @@ -# GPT-Runner 文件 +# GPT-Runner 配置和 AI 预设文件
目录
-- [GPT-Runner 文件](#gpt-runner-文件) +- [GPT-Runner 配置和 AI 预设文件](#gpt-runner-配置和-ai-预设文件) - [介绍](#介绍) - [.gpt-runner 目录](#gpt-runner-目录) - [gptr.config.ts/js/json 配置文件](#gptrconfigtsjsjson-配置文件) diff --git a/docs/gpt-config-en.gpt.md b/docs/gpt-config.en.md similarity index 98% rename from docs/gpt-config-en.gpt.md rename to docs/gpt-config.en.md index 11135de..0e7dff1 100644 --- a/docs/gpt-config-en.gpt.md +++ b/docs/gpt-config.en.md @@ -1,9 +1,9 @@ -# GPT-Runner Files +# GPT-Runner Configs And AI Preset Files
Table of Contents
-- [GPT-Runner Files](#gpt-runner-files) +- [GPT-Runner Configs And AI Preset Files](#gpt-runner-configs-and-ai-preset-files) - [Introduction](#introduction) - [.gpt-runner Directory](#gpt-runner-directory) - [gptr.config.ts/js/json Configuration Files](#gptrconfigtsjsjson-configuration-files) diff --git a/docs/ui-usage.cn.md b/docs/ui-usage.cn.md new file mode 100644 index 0000000..7b89a9c --- /dev/null +++ b/docs/ui-usage.cn.md @@ -0,0 +1 @@ +# GPT-Runner UI 使用说明 diff --git a/docs/ui-usage.en.md b/docs/ui-usage.en.md new file mode 100644 index 0000000..883b522 --- /dev/null +++ b/docs/ui-usage.en.md @@ -0,0 +1 @@ +# GPT-Runner UI Usage diff --git a/packages/gpt-runner-cli/README.md b/packages/gpt-runner-cli/README.md index 93abdf6..7c69564 100644 --- a/packages/gpt-runner-cli/README.md +++ b/packages/gpt-runner-cli/README.md @@ -23,7 +23,9 @@ GPT-Runner CLI 是一款功能强大的命令行工具,可帮助您管理 AI - [Installation](#installation) - [Quick Start](#quick-start) - [CLI Commands](#cli-commands) -- [GPT-Runner File](#gpt-runner-file) +- [Documentation](#documentation) + - [GPT-Runner Configs And AI Preset Files](#gpt-runner-configs-and-ai-preset-files) + - [GPT-Runner Ui Usage](#gpt-runner-ui-usage) - [FAQ](#faq) - [Sponsor](#sponsor) - [Contributor](#contributor) @@ -81,7 +83,7 @@ gptr ./src # npx gptr ./src ``` -When you run gptr, it will retrieve the global config file [gptr.config.json](https://github.com/nicepkg/gpt-runner/tree/main/docs/gptr.config.json) and [*.gpt.md](https://github.com/nicepkg/gpt-runner/tree/main/docs/example-cn.gpt.md) AI preset files in your current directory and the entire project valid files, and then open a web AI chat window in the browser. +When you run gptr, it will retrieve the global config file [gptr.config.json](https://github.com/nicepkg/gpt-runner/tree/main/docs/examples/gptr.config.json) and [*.gpt.md](https://github.com/nicepkg/gpt-runner/tree/main/docs/examples/example-en.gpt.md) AI preset files in your current directory and the entire project valid files, and then open a web AI chat window in the browser. You can now see the GPT-Runner's web in your browser at [http://localhost:3003](http://localhost:3003). @@ -91,7 +93,7 @@ You can utilize the following options with GPT-Runner CLI: - `-p, --port [port number]`: This option allows you to specify the port number for the server to listen on. By default, the value is `3003`. If you wish to modify this, simply append this option followed by the desired port number to your command. For example: `--port 8080`. -- `-c, --config [filepath]`: This option allows you to specify the global configuration file path for GPT-Runner. If your configuration file is not in the default location, or if you have multiple configuration files, you can use this option to tell GPT-Runner which file to use. For example, if you have a configuration called [gptr.config.json](https://github.com/nicepkg/gpt-runner/tree/main/docs/gptr.config.json) in the root of your project file, you can use this option as follows: `--config ./gptr.config.json`. Of course, we will detect [gptr.config.json](https://github.com/nicepkg/gpt-runner/tree/main/docs/gptr.config.json) in the gptr running directory by default. +- `-c, --config [filepath]`: This option allows you to specify the global configuration file path for GPT-Runner. If your configuration file is not in the default location, or if you have multiple configuration files, you can use this option to tell GPT-Runner which file to use. For example, if you have a configuration called [gptr.config.json](https://github.com/nicepkg/gpt-runner/tree/main/docs/examples/gptr.config.json) in the root of your project file, you can use this option as follows: `--config ./gptr.config.json`. Of course, we will detect [gptr.config.json](https://github.com/nicepkg/gpt-runner/tree/main/docs/examples/gptr.config.json) in the gptr running directory by default. - `--share`: This flag shares the link to the running server through a temporal link. It doesn't require a value, you can simple add it to enable the sharing feature. For example: `gptr --share`. Some dependencies need to be downloaded when sharing for the first time, so it will be slower. @@ -105,18 +107,25 @@ Here is an example of using all options: gptr --port 8080 --config ./gptr.config.json --share --no-open --debug ``` -In this example, the GPT-Runner CLI will start a server available at port 8080, use the [gptr.config.json](https://github.com/nicepkg/gpt-runner/tree/main/docs/gptr.config.json) configuration file, share the server link, not automatically open in the browser, and run in debug mode. +In this example, the GPT-Runner CLI will start a server available at port 8080, use the [gptr.config.json](https://github.com/nicepkg/gpt-runner/tree/main/docs/examples/gptr.config.json) configuration file, share the server link, not automatically open in the browser, and run in debug mode. -## GPT-Runner File +## Documentation -For a detailed introduction about `.gpt-runner` directory, `*.gpt.md` files, and `gptr.config.json` files, please see here: +### GPT-Runner Configs And AI Preset Files + +For details about `gptr.config.json` configuration file, `xxx.gpt.md` AI preset file, `.gpt-runner` special directory, please refer to here: + +[Introduction to GPT-Runner Configs And AI Preset Files](https://github.com/nicepkg/gpt-runner/blob/main/docs/gpt-config.en.md) + +### GPT-Runner Ui Usage + +[Introduction to GPT-Runner Ui Usage](https://github.com/nicepkg/gpt-runner/blob/main/docs/ui-usage.en.md) -[Introduction to GPT-Runner Files](https://github.com/nicepkg/gpt-runner/blob/main/docs/gpt-config-en.gpt.md) ## FAQ -[English > FAQ](https://github.com/nicepkg/gpt-runner/tree/main/docs/faq-en.md) +[English > FAQ](https://github.com/nicepkg/gpt-runner/tree/main/docs/faq.en.md) ## Sponsor diff --git a/packages/gpt-runner-cli/README_CN.md b/packages/gpt-runner-cli/README_CN.md index 49a93b1..c32329f 100644 --- a/packages/gpt-runner-cli/README_CN.md +++ b/packages/gpt-runner-cli/README_CN.md @@ -21,7 +21,9 @@ GPT-Runner CLI 是一款功能强大的命令行工具,可帮助您管理 AI - [安装](#安装) - [快速开始](#快速开始) - [CLI 命令](#cli-命令) -- [GPT-Runner 文件](#gpt-runner-文件) +- [文档](#文档) + - [GPT-Runner 配置和 AI 预设文件](#gpt-runner-配置和-ai-预设文件) + - [GPT-Runner Ui 用法](#gpt-runner-ui-用法) - [常见问题](#常见问题) - [赞助](#赞助) - [贡献者](#贡献者) @@ -79,7 +81,7 @@ gptr ./src # npx gptr ./src ``` -当你运行 gptr 时,它将检索当前目录和整个项目有效文件中的全局配置文件 [gptr.config.json](https://github.com/nicepkg/gpt-runner/tree/main/docs/gptr.config.json) 和 [*.gpt.md](https://github.com/nicepkg/gpt-runner/tree/main/docs/example-cn.gpt.md) AI 预设文件,然后在浏览器中打开一个 Web AI 聊天窗口。 +当你运行 gptr 时,它将检索当前目录和整个项目有效文件中的全局配置文件 [gptr.config.json](https://github.com/nicepkg/gpt-runner/tree/main/docs/examples/gptr.config.json) 和 [*.gpt.md](https://github.com/nicepkg/gpt-runner/tree/main/docs/examples/example-cn.gpt.md) AI 预设文件,然后在浏览器中打开一个 Web AI 聊天窗口。 现在,你可以在浏览器的 [http://localhost:3003](http://localhost:3003) 上看到 GPT-Runner 的 Web 界面。 @@ -89,7 +91,7 @@ gptr ./src - `-p,--port [端口号]`:此选项允许您指定服务器监听的端口号。默认值为 `3003` 。如果您希望修改这个值,只需在您的命令后面添加此选项,然后跟上您想要的端口号。例如:`--port 8080` 。 -- `-c,--config [文件路径]`:此选项允许您指定 GPT-Runner 的全局配置文件路径。如果您的配置文件不在默认位置,或者您有多个配置文件,您可以使用此选项告诉 GPT-Runner 使用哪个文件。例如,如果您在项目的根目录中有一个名为 [gptr.config.json](https://github.com/nicepkg/gpt-runner/tree/main/docs/gptr.config.json) 的配置文件,您可以如下使用此选项:`--config ./gptr.config.json`。当然我们会默认检测 gptr 运行目录下的 [gptr.config.json](https://github.com/nicepkg/gpt-runner/tree/main/docs/gptr.config.json)。 +- `-c,--config [文件路径]`:此选项允许您指定 GPT-Runner 的全局配置文件路径。如果您的配置文件不在默认位置,或者您有多个配置文件,您可以使用此选项告诉 GPT-Runner 使用哪个文件。例如,如果您在项目的根目录中有一个名为 [gptr.config.json](https://github.com/nicepkg/gpt-runner/tree/main/docs/examples/gptr.config.json) 的配置文件,您可以如下使用此选项:`--config ./gptr.config.json`。当然我们会默认检测 gptr 运行目录下的 [gptr.config.json](https://github.com/nicepkg/gpt-runner/tree/main/docs/examples/gptr.config.json)。 - `--share`:此标志通过一个临时链接分享正在运行的服务器。它不需要一个值,你可以简单地添加它来启用分享功能。例如:`gptr --share` 。首次分享时需要下载一些依赖,所以会比较慢。 @@ -103,17 +105,23 @@ gptr ./src gptr --port 8080 --config ./gptr.config.json --share --no-open --debug ``` -在这个例子中,GPT-Runner CLI 将在端口 8080 上启动一个服务器,使用 [gptr.config.json](https://github.com/nicepkg/gpt-runner/tree/main/docs/gptr.config.json) 的配置文件,分享服务器链接,不自动在浏览器中打开,并以调试模式运行。 +在这个例子中,GPT-Runner CLI 将在端口 8080 上启动一个服务器,使用 [gptr.config.json](https://github.com/nicepkg/gpt-runner/tree/main/docs/examples/gptr.config.json) 的配置文件,分享服务器链接,不自动在浏览器中打开,并以调试模式运行。 -## GPT-Runner 文件 +## 文档 -关于 `.gpt-runner` 目录和 `*.gpt.md` 文件和 `gptr.config.json` 文件详细介绍请看这里: +### GPT-Runner 配置和 AI 预设文件 -[GPT-Runner 文件介绍](https://github.com/nicepkg/gpt-runner/blob/main/docs/gpt-config-cn.gpt.md) +关于 `gptr.config.json` 配置文件、`xxx.gpt.md` AI 预设文件、`.gpt-runner` 特殊目录的详细介绍请参见这里: + +[GPT-Runner 配置和 AI 预设文件](https://github.com/nicepkg/gpt-runner/blob/main/docs/gpt-config.cn.md) + +### GPT-Runner Ui 用法 + +[GPT-Runner Ui使用介绍](https://github.com/nicepkg/gpt-runner/blob/main/docs/ui-usage.cn.md) ## 常见问题 -[简体中文 > 常见问题](https://github.com/nicepkg/gpt-runner/tree/main/docs/faq-cn.md) +[简体中文 > 常见问题](https://github.com/nicepkg/gpt-runner/tree/main/docs/faq.cn.md) ## 赞助 diff --git a/packages/gpt-runner-vscode/README.md b/packages/gpt-runner-vscode/README.md index dcf9e61..ecae7d2 100644 --- a/packages/gpt-runner-vscode/README.md +++ b/packages/gpt-runner-vscode/README.md @@ -20,7 +20,9 @@ This extension helps you manage AI presets and drive conversations with code usi - [Features](#features) - [Installation](#installation) - [Quick Start](#quick-start) -- [GPT-Runner File](#gpt-runner-file) +- [Documentation](#documentation) + - [GPT-Runner Configs And AI Preset Files](#gpt-runner-configs-and-ai-preset-files) + - [GPT-Runner Ui Usage](#gpt-runner-ui-usage) - [Common Questions](#common-questions) - [Sponsor](#sponsor) - [Contributors](#contributors) @@ -61,15 +63,22 @@ Or, click here to install [GPT-Runner VSCode Extension](https://marketplace.visu > 1. Note the chat icon in the top right corner, which is also clickable > 2. Note the status bar at the bottom, `🚀 GPT-Runner` is also clickable -## GPT-Runner File +## Documentation -For a detailed introduction about `.gpt-runner` directory, `*.gpt.md` files, and `gptr.config.json` files, please see here: +### GPT-Runner Configs And AI Preset Files + +For details about `gptr.config.json` configuration file, `xxx.gpt.md` AI preset file, `.gpt-runner` special directory, please refer to here: + +[Introduction to GPT-Runner Configs And AI Preset Files](https://github.com/nicepkg/gpt-runner/blob/main/docs/gpt-config.en.md) + +### GPT-Runner Ui Usage + +[Introduction to GPT-Runner Ui Usage](https://github.com/nicepkg/gpt-runner/blob/main/docs/ui-usage.en.md) - [Introduction to GPT-Runner Files](https://github.com/nicepkg/gpt-runner/blob/main/docs/gpt-config-en.gpt.md) ## Common Questions -[English > Common Questions](https://github.com/nicepkg/gpt-runner/tree/main/docs/faq-en.md) +[English > Common Questions](https://github.com/nicepkg/gpt-runner/tree/main/docs/faq.en.md) ## Sponsor diff --git a/packages/gpt-runner-vscode/README_CN.md b/packages/gpt-runner-vscode/README_CN.md index d803cc8..2d33550 100644 --- a/packages/gpt-runner-vscode/README_CN.md +++ b/packages/gpt-runner-vscode/README_CN.md @@ -21,7 +21,9 @@ GPT-Runner VSCode 扩展是 GPT-Runner 跟 VSCode 深度结合的结果。 - [特性](#特性) - [安装](#安装) - [快速开始](#快速开始) -- [GPT-Runner 文件](#gpt-runner-文件) +- [文档](#文档) + - [GPT-Runner 配置和 AI 预设文件](#gpt-runner-配置和-ai-预设文件) + - [GPT-Runner Ui 用法](#gpt-runner-ui-用法) - [常见问题](#常见问题) - [赞助](#赞助) - [贡献者](#贡献者) @@ -63,15 +65,21 @@ GPT-Runner VSCode 扩展是 GPT-Runner 跟 VSCode 深度结合的结果。 > 1. 注意你的右上角有个聊天 icon,那个也能点击 > 2. 注意你的底部状态栏,有个 `🚀 GPT-Runner` 也能点击 -## GPT-Runner 文件 +## 文档 -关于 `.gpt-runner` 目录和 `*.gpt.md` 文件和 `gptr.config.json` 文件详细介绍请看这里: +### GPT-Runner 配置和 AI 预设文件 - [GPT-Runner 文件介绍](https://github.com/nicepkg/gpt-runner/blob/main/docs/gpt-config-cn.gpt.md) +关于 `gptr.config.json` 配置文件、`xxx.gpt.md` AI 预设文件、`.gpt-runner` 特殊目录的详细介绍请参见这里: + +[GPT-Runner 配置和 AI 预设文件](https://github.com/nicepkg/gpt-runner/blob/main/docs/gpt-config.cn.md) + +### GPT-Runner Ui 用法 + +[GPT-Runner Ui使用介绍](https://github.com/nicepkg/gpt-runner/blob/main/docs/ui-usage.cn.md) ## 常见问题 -[简体中文 > 常见问题](https://github.com/nicepkg/gpt-runner/tree/main/docs/faq-cn.md) +[简体中文 > 常见问题](https://github.com/nicepkg/gpt-runner/tree/main/docs/faq.cn.md) ## 赞助