/.gpt-runner/` directory is a special directory. Even if you include it in `.gitignore`, it will be retrieved. This is useful for people who hope GPT-Runner doesn't intrude into the project.
@@ -57,7 +57,7 @@ git config --global core.excludesfile '~/.gitignore_global'
echo '.gpt-runner' >> ~/.gitignore_global
```
-## gptr.config.ts/js/json Configuration Files
+## 📄 gptr.config.ts/js/json Configuration Files
1. gpt.config.ts/js/json is a configuration file, it can override project-level global configurations.
@@ -183,7 +183,7 @@ export default defineConfig({
}
```
-## xxx.gpt.md AI Preset Files
+## 📑 xxx.gpt.md AI Preset Files
1. `xxx.gpt.md` files are AI preset files, each file represents an AI character.
@@ -246,7 +246,7 @@ You can write your remarks here.
You can also override many default parameter values through the `gptr.config.json` at the root directory of the project.
````
-## Chat Model Configuration
+## 🤖 Chat Model Configuration
### OpenAI
@@ -324,7 +324,7 @@ export interface AnthropicModelConfig {
```
-# Other
+# 🔍 Other
1. If you have installed GPT Runner VSCode extension. You can set in `.vscode/settings.json`:
diff --git a/docs/ui-usage.cn.md b/docs/ui-usage.cn.md
index 7b89a9c..db1df44 100644
--- a/docs/ui-usage.cn.md
+++ b/docs/ui-usage.cn.md
@@ -1 +1 @@
-# GPT-Runner UI 使用说明
+# 📖 GPT-Runner UI 使用说明
diff --git a/docs/ui-usage.en.md b/docs/ui-usage.en.md
index 883b522..bd38ce9 100644
--- a/docs/ui-usage.en.md
+++ b/docs/ui-usage.en.md
@@ -1 +1 @@
-# GPT-Runner UI Usage
+# 📖 GPT-Runner UI Usage
diff --git a/packages/gpt-runner-cli/README.md b/packages/gpt-runner-cli/README.md
index 9faffdf..5ba5fbc 100644
--- a/packages/gpt-runner-cli/README.md
+++ b/packages/gpt-runner-cli/README.md
@@ -1,47 +1,47 @@

-
GPT-Runner CLI
+
GPT-Runner CLI 🛠️
-English / [简体中文](https://github.com/nicepkg/gpt-runner/tree/main/packages/gpt-runner-cli/README_CN.md)
+English / [简体中文 🌏](https://github.com/nicepkg/gpt-runner/tree/main/packages/gpt-runner-cli/README_CN.md)
[](https://www.npmjs.com/package/@nicepkg/gpt-runner-cli)
[](https://github.com/nicepkg/gpt-runner/tree/main/packages/gpt-runner-cli/)
[](https://github.com/nicepkg/gpt-runner/blob/main/LICENSE)

-The GPT-Runner CLI is a powerful command-line tool that helps you manage your AI presets and engage in AI-powered conversations with your code to significantly boost your development efficiency.
+The GPT-Runner CLI is a powerful command-line tool that helps you manage your AI presets and engage in AI-powered conversations with your code to significantly boost your development efficiency 💪.
-GPT-Runner CLI 是一款功能强大的命令行工具,可帮助您管理 AI 预设并与代码进行 AI 驱动的对话,从而显着提高您的开发效率。
+GPT-Runner CLI 是一款功能强大的命令行工具,可帮助您管理 AI 预设并与代码进行 AI 驱动的对话,从而显着提高您的开发效率 💪。
-Table of Contents
+ 📚 Table of Contents
-- [Features](#features)
-- [Installation](#installation)
-- [Quick Start](#quick-start)
-- [CLI Commands](#cli-commands)
-- [Documentation](#documentation)
+- [⚙️ Features](#️-features)
+- [📦 Installation](#-installation)
+- [🚀 Quick Start](#-quick-start)
+- [💡 CLI Commands](#-cli-commands)
+- [📖 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)
-- [License](#license)
+- [❓ FAQ](#-faq)
+- [💖 Sponsor](#-sponsor)
+- [🤝 Contributor](#-contributor)
+- [📜 License](#-license)
-## Features
+## ⚙️ Features
-- **Start GPT-Runner Server:** Quickly start a local development server for GPT-Runner with a simple command.
-- **Customizable Server Port:** Specify the server port
-- **Customizable Global Configuration:** Specify the path to the global configuration file of GPT-Runner.
-- **Shareable Server Link:** Share the running server through a temporal link.
-- **Debugging Support:** Run the server in debug mode to facilitate troubleshooting.
+- **⚡ Start GPT-Runner Server:** Quickly start a local development server for GPT-Runner with a simple command.
+- **🔧 Customizable Server Port:** Specify the server port
+- **🌍 Customizable Global Configuration:** Specify the path to the global configuration file of GPT-Runner.
+- **🔄 Shareable Server Link:** Share the running server through a temporal link.
+- **🐞 Debugging Support:** Run the server in debug mode to facilitate troubleshooting.
-## Installation
+## 📦 Installation
> 1. Requirements NodeJS >= 16.15.0
@@ -63,7 +63,7 @@ gptr --version
This command tells npm (Node.js package manager) to install GPT-Runner CLI globally. Among them, the `-g` option means global installation, which means you can run GPT-Runner CLI anywhere.
-## Quick Start
+## 🚀 Quick Start
Go to your project folder and type the following command:
@@ -87,7 +87,7 @@ When you run gptr, it will retrieve the global config file [gptr.config.json](ht
You can now see the GPT-Runner's web in your browser at [http://localhost:3003](http://localhost:3003).
-## CLI Commands
+## 💡 CLI Commands
You can utilize the following options with GPT-Runner CLI:
@@ -110,7 +110,7 @@ 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/examples/gptr.config.json) configuration file, share the server link, not automatically open in the browser, and run in debug mode.
-## Documentation
+## 📖 Documentation
### GPT-Runner Configs And AI Preset Files
@@ -123,15 +123,15 @@ For details about `gptr.config.json` configuration file, `xxx.gpt.md` AI preset
[Introduction to GPT-Runner Ui Usage](https://github.com/nicepkg/gpt-runner/blob/main/docs/ui-usage.en.md)
-## FAQ
+## ❓ FAQ
[English > FAQ](https://github.com/nicepkg/gpt-runner/tree/main/docs/faq.en.md)
-## Sponsor
+## 💖 Sponsor
Waiting for you...
-## Contributor
+## 🤝 Contributor
You can check out our [Contribution Guidelines](https://github.com/nicepkg/gpt-runner/tree/main/CONTRIBUTING.md)
@@ -141,6 +141,6 @@ This project exists thanks to all the people who contribute:
-## License
+## 📜 License
[MIT](https://github.com/nicepkg/gpt-runner/tree/main/LICENSE) License © 2023-PRESENT [Jinming Yang](https://github.com/2214962083)
diff --git a/packages/gpt-runner-cli/README_CN.md b/packages/gpt-runner-cli/README_CN.md
index a109b1f..d0e9427 100644
--- a/packages/gpt-runner-cli/README_CN.md
+++ b/packages/gpt-runner-cli/README_CN.md
@@ -1,45 +1,45 @@

-
GPT-Runner CLI
+
GPT-Runner CLI 🛠️
-[English](https://github.com/nicepkg/gpt-runner/tree/main/packages/gpt-runner-cli/README.md) / 简体中文
+[English 🌏](https://github.com/nicepkg/gpt-runner/tree/main/packages/gpt-runner-cli/README.md) / 简体中文
[](https://www.npmjs.com/package/@nicepkg/gpt-runner-cli)
[](https://github.com/nicepkg/gpt-runner/tree/main/packages/gpt-runner-cli/)
[](https://github.com/nicepkg/gpt-runner/blob/main/LICENSE)

-GPT-Runner CLI 是一款功能强大的命令行工具,可帮助您管理 AI 预设并与代码进行 AI 驱动的对话,从而显着提高您的开发效率。
+GPT-Runner CLI 是一款功能强大的命令行工具,可帮助您管理 AI 预设并与代码进行 AI 驱动的对话,从而显着提高您的开发效率 💪。
-目录
+ 📚 目录
-- [特性](#特性)
-- [安装](#安装)
-- [快速开始](#快速开始)
-- [CLI 命令](#cli-命令)
-- [文档](#文档)
+- [⚙️ 特性](#️-特性)
+- [📦 安装](#-安装)
+- [🚀 快速开始](#-快速开始)
+- [💡 CLI 命令](#-cli-命令)
+- [📖 文档](#-文档)
- [GPT-Runner 配置和 AI 预设文件](#gpt-runner-配置和-ai-预设文件)
- [GPT-Runner Ui 用法](#gpt-runner-ui-用法)
-- [常见问题](#常见问题)
-- [赞助](#赞助)
-- [贡献者](#贡献者)
-- [许可证](#许可证)
+- [❓ 常见问题](#-常见问题)
+- [💖 赞助](#-赞助)
+- [🤝 贡献者](#-贡献者)
+- [📜 许可证](#-许可证)
-## 特性
+## ⚙️ 特性
-- **启动 GPT-Runner 服务器:** 使用一个简单的命令快速启动 GPT-Runner 的本地开发服务器。
-- **可自定义服务器端口:** 指定服务器端口。
-- **自定义全局配置:** 指定 GPT-Runner 的全局配置文件路径。
-- **可共享的服务器链接:** 通过临时链接分享正在运行的服务器。
-- **支持调试:** 在调试模式下运行服务器,方便故障排查。
+- **⚡ 启动 GPT-Runner 服务器:** 使用一个简单的命令快速启动 GPT-Runner 的本地开发服务器。
+- **🔧 可自定义服务器端口:** 指定服务器端口。
+- **🌍 自定义全局配置:** 指定 GPT-Runner 的全局配置文件路径。
+- **🔄 可共享的服务器链接:** 通过临时链接分享正在运行的服务器。
+- **🐞 支持调试:** 在调试模式下运行服务器,方便故障排查。
-## 安装
+## 📦 安装
> 1. 要求 NodeJS >= 16.15.0
> - 要检查您的 NodeJS 版本,在终端运行 `node -v` 。如果需要安装或更新 NodeJS ,请访问[官方 NodeJS 网站](https://nodejs.org/)以获取下载和安装指南。
@@ -61,7 +61,7 @@ gptr --version
此命令告诉 npm ( Node.js 包管理器) 全局安装 GPT-Runner CLI。其中,`-g` 选项表示全局安装,这意味着您可以在任何地方运行 GPT-Runner CLI。
-## 快速开始
+## 🚀 快速开始
转到项目文件夹并输入以下命令:
@@ -85,7 +85,7 @@ gptr ./src
现在,你可以在浏览器的 [http://localhost:3003](http://localhost:3003) 上看到 GPT-Runner 的 Web 界面。
-## CLI 命令
+## 💡 CLI 命令
您可以使用以下选项与 GPT-Runner CLI 一起使用:
@@ -107,7 +107,7 @@ 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/examples/gptr.config.json) 的配置文件,分享服务器链接,不自动在浏览器中打开,并以调试模式运行。
-## 文档
+## 📖 文档
### GPT-Runner 配置和 AI 预设文件
@@ -119,15 +119,15 @@ gptr --port 8080 --config ./gptr.config.json --share --no-open --debug
[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/CONTRIBUTING.md)
@@ -137,6 +137,6 @@ gptr --port 8080 --config ./gptr.config.json --share --no-open --debug
-## 许可证
+## 📜 许可证
[MIT](https://github.com/nicepkg/gpt-runner/tree/main/LICENSE) 许可证 © 2023-PRESENT [Jinming Yang](https://github.com/2214962083)
diff --git a/packages/gpt-runner-vscode/README.md b/packages/gpt-runner-vscode/README.md
index 105fd02..3e48ae2 100644
--- a/packages/gpt-runner-vscode/README.md
+++ b/packages/gpt-runner-vscode/README.md
@@ -1,9 +1,9 @@

-
GPT-Runner VSCode
+
GPT-Runner VSCode 🧑💻
-[简体中文](https://github.com/nicepkg/gpt-runner/tree/main/packages/gpt-runner-vscode/README_CN.md) / English
+[简体中文 🌏](https://github.com/nicepkg/gpt-runner/tree/main/packages/gpt-runner-vscode/README_CN.md) / English
[](https://marketplace.visualstudio.com/items?itemName=nicepkg.gpt-runner) [](https://github.com/nicepkg/gpt-runner/blob/main/LICENSE)

@@ -15,35 +15,35 @@ This extension helps you manage AI presets and drive conversations with code usi
-Contents
+ 📚 Table of Contents
-- [Features](#features)
-- [Installation](#installation)
-- [Quick Start](#quick-start)
-- [Documentation](#documentation)
+- [⚙️ Features](#️-features)
+- [📦 Installation](#-installation)
+- [🚀 Quick Start](#-quick-start)
+- [📖 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)
-- [License](#license)
+- [❓ FAQ](#-faq)
+- [💖 Sponsor](#-sponsor)
+- [🤝 Contributors](#-contributors)
+- [📜 License](#-license)
-## Features
+## ⚙️ Features
-- **Real-time context:** It can observe the files you have edited and the text you have selected to answer your questions.
-- **Multiple chat window instances:** You can not only open a chat in the sidebar, but you can also open a chat page in the editor.
-- **Responsive UI:** It adjusts its layout automatically based on the current window width.
-- **Shareable LAN links:** Click the `🚀 GPT-Runner` at the bottom to open it in the browser.
-- **Conversation with code files:** Select files or folders to chat with AI in real-time.
-- **Manage your AI presets:** Manage your AI presets, it's like the local Storybook for AI presets.
-- **Custom AI Parameters:** Flexible control over the configuration of AI models.
-- **Support for third-party LLMs:** High compatibility and adaptability.
-- **Privacy-First:** Local data storage to protect your privacy.
-- **Localization:** Support for multiple languages.
+- **📁 Real-time context:** It can observe the files you have edited and the text you have selected to answer your questions.
+- **🖥️ Multiple chat window instances:** You can not only open a chat in the sidebar, but you can also open a chat page in the editor.
+- **📱 Responsive UI:** It adjusts its layout automatically based on the current window width.
+- **🔗 Shareable LAN links:** Click the `🚀 GPT-Runner` at the bottom to open it in the browser.
+- **🔍 Conversation with code files:** Select files or folders to chat with AI in real-time.
+- **🔖 Manage your AI presets:** Manage your AI presets, it's like the local Storybook for AI presets.
+- **🤖 Custom AI Parameters:** Flexible control over the configuration of AI models.
+- **🔌 Support for third-party LLMs:** High compatibility and adaptability.
+- **🔒 Privacy-First:** Local data storage to protect your privacy.
+- **🌎 Localization:** Support for multiple languages.
-## Installation
+## 📦 Installation
> 1. Requires VSCode >= 1.72.0
> 2. Make sure you have an Open AI Key or Anthropic Key. If you do not have, please visit [Open AI](https://platform.openai.com/account/api-keys) or [Anthropic](https://www.anthropic.com/product/) to apply.
@@ -52,7 +52,7 @@ You can search `GPT Runner` in the VSCode Extension Marketplace for installation
Or, click here to install [GPT-Runner VSCode Extension](https://marketplace.visualstudio.com/items?itemName=nicepkg.gpt-runner).
-## Quick Start
+## 🚀 Quick Start
1. Open a project and click on the chat icon on the sidebar.
2. Click to confirm the initialization of the `.gpt.md` file.
@@ -63,7 +63,7 @@ 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
-## Documentation
+## 📖 Documentation
### GPT-Runner Configs And AI Preset Files
@@ -76,15 +76,15 @@ For details about `gptr.config.json` configuration file, `xxx.gpt.md` AI preset
[Introduction to GPT-Runner Ui Usage](https://github.com/nicepkg/gpt-runner/blob/main/docs/ui-usage.en.md)
-## Common Questions
+## ❓ FAQ
-[English > Common Questions](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
+## 💖 Sponsor
Waiting for your sponsorship...
-## Contributors
+## 🤝 Contributors
You can check out our [Contribution Guidelines](https://github.com/nicepkg/gpt-runner/tree/main/CONTRIBUTING.md)
@@ -94,6 +94,6 @@ This project exists thanks to all the people who contribute:
-## License
+## 📜 License
[MIT](https://github.com/nicepkg/gpt-runner/tree/main/LICENSE) License © 2023-PRESENT [Jinming Yang](https://github.com/2214962083)
diff --git a/packages/gpt-runner-vscode/README_CN.md b/packages/gpt-runner-vscode/README_CN.md
index b02f3ac..3ac2da0 100644
--- a/packages/gpt-runner-vscode/README_CN.md
+++ b/packages/gpt-runner-vscode/README_CN.md
@@ -1,9 +1,9 @@

-
GPT-Runner VSCode
+
GPT-Runner VSCode 🧑💻
-[English](https://github.com/nicepkg/gpt-runner/tree/main/packages/gpt-runner-vscode/README.md) / 简体中文
+[English 🌏](https://github.com/nicepkg/gpt-runner/tree/main/packages/gpt-runner-vscode/README.md) / 简体中文
[](https://marketplace.visualstudio.com/items?itemName=nicepkg.gpt-runner) [](https://github.com/nicepkg/gpt-runner/blob/main/LICENSE)
@@ -16,35 +16,35 @@ GPT-Runner VSCode 扩展是 GPT-Runner 跟 VSCode 深度结合的结果。
-目录
+ 📚 目录
- [特性](#特性)
-- [安装](#安装)
-- [快速开始](#快速开始)
-- [文档](#文档)
+- [📦 安装](#-安装)
+- [🚀 快速开始](#-快速开始)
+- [📖 文档](#-文档)
- [GPT-Runner 配置和 AI 预设文件](#gpt-runner-配置和-ai-预设文件)
- [GPT-Runner Ui 用法](#gpt-runner-ui-用法)
-- [常见问题](#常见问题)
-- [赞助](#赞助)
-- [贡献者](#贡献者)
-- [许可证](#许可证)
+- [❓ 常见问题](#-常见问题)
+- [💖 赞助](#-赞助)
+- [🤝 贡献者](#-贡献者)
+- [📜 许可证](#-许可证)
## 特性
-- **实时上下文:** 它可以观察你已打开编辑的文件和你选中的文字回答你的问题。
-- **多个聊天窗口实例:** 你不但可以在侧边栏打开聊天,还可以在编辑器里打开聊天页。
-- **响应式 ui:** 它会根据当前窗口宽度自动调整自身布局。
-- **可共享的局域网链接:** 点击底部 `🚀 GPT-Runner` 可以在浏览器打开。
-- **与代码文件对话:** 选择文件或文件夹与 AI 实时对话。
-- **管理你的 AI 预设:** 管理你的 AI 预设,它就像 AI 预设的本地 Storybook。
-- **自定义 AI 参数:** 灵活控制 AI 模型的配置。
-- **支持第三方 LLM:** 具有高度兼容性和适应性。
-- **隐私优先:** 本地数据存储保护您的隐私。
-- **国际化:** 支持多种语言。
+- **📁 实时上下文:** 它可以观察你已打开编辑的文件和你选中的文字回答你的问题。
+- **🖥️ 多个聊天窗口实例:** 你不但可以在侧边栏打开聊天,还可以在编辑器里打开聊天页。
+- **📱 响应式 ui:** 它会根据当前窗口宽度自动调整自身布局。
+- **🔗 可共享的局域网链接:** 点击底部 `🚀 GPT-Runner` 可以在浏览器打开。
+- **🔍 与代码文件对话:** 选择文件或文件夹与 AI 实时对话。
+- **🔖 管理你的 AI 预设:** 管理你的 AI 预设,它就像 AI 预设的本地 Storybook。
+- **🤖 自定义 AI 参数:** 灵活控制 AI 模型的配置。
+- **🔌 支持第三方 LLM:** 具有高度兼容性和适应性。
+- **🔒 隐私优先:** 本地数据存储保护您的隐私。
+- **🌎 国际化:** 支持多种语言。
-## 安装
+## 📦 安装
> 1. 要求 VSCode >= 1.72.0
> 2. 确保你有一个 Open AI Key 或 Anthropic Key,如果没有,请访问 [Open AI](https://platform.openai.com/account/api-keys) 或 [Anthropic](https://www.anthropic.com/product/) 申请。
@@ -54,7 +54,7 @@ GPT-Runner VSCode 扩展是 GPT-Runner 跟 VSCode 深度结合的结果。
或者点击这里安装 [GPT-Runner VSCode 扩展](https://marketplace.visualstudio.com/items?itemName=nicepkg.gpt-runner)。
-## 快速开始
+## 🚀 快速开始
1. 打开一个项目,点击侧边聊天 icon。
2. 点击确认初始化 `.gpt.md` 文件。
@@ -65,7 +65,7 @@ GPT-Runner VSCode 扩展是 GPT-Runner 跟 VSCode 深度结合的结果。
> 1. 注意你的右上角有个聊天 icon,那个也能点击
> 2. 注意你的底部状态栏,有个 `🚀 GPT-Runner` 也能点击
-## 文档
+## 📖 文档
### GPT-Runner 配置和 AI 预设文件
@@ -77,15 +77,15 @@ GPT-Runner VSCode 扩展是 GPT-Runner 跟 VSCode 深度结合的结果。
[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/CONTRIBUTING.md)
@@ -95,6 +95,6 @@ GPT-Runner VSCode 扩展是 GPT-Runner 跟 VSCode 深度结合的结果。
-## 许可证
+## 📜 许可证
[MIT](https://github.com/nicepkg/gpt-runner/tree/main/LICENSE) 许可证 © 2023-PRESENT [Jinming Yang](https://github.com/2214962083)