gpt-runner-usage-en.mp4
📚 目录
- ⚡ 启动 GPT-Runner 服务器: 使用一个简单的命令快速启动 GPT-Runner 的本地开发服务器。
- 🔧 可自定义服务器端口: 指定服务器端口。
- 🌍 自定义全局配置: 指定 GPT-Runner 的全局配置文件路径。
- 🔄 可共享的服务器链接: 通过临时链接分享正在运行的服务器。
- 🐞 支持调试: 在调试模式下运行服务器，方便故障排查。
- 要求 NodeJS >= 16.15.0
- 要检查您的 NodeJS 版本，在终端运行
node -v。如果需要安装或更新 NodeJS ，请访问官方 NodeJS 网站以获取下载和安装指南。- 确保你有一个 Open AI Key 或 Anthropic Key，如果没有，请访问 Open AI 或 Anthropic 申请。
- 确保你的命令终端能 ping 通 google.com （如果你在中国大陆，你可能需要科学上网）。
- 安装速度较慢是正常的，因为软件包体积较大。
使用 npm 安装 GPT-Runner CLI :
npm install -g gptr
# 检查版本
gptr --version
# 升级版本
# npm i -g gptr此命令告诉 npm ( Node.js 包管理器) 全局安装 GPT-Runner CLI。其中，-g 选项表示全局安装，这意味着您可以在任何地方运行 GPT-Runner CLI。
转到项目文件夹并输入以下命令:
gptr
# 等价于
# npx gptr或者你可以运行特定的根路径
gptr ./src
# 等价于
# npx gptr ./src当你运行 gptr 时，它将检索当前目录和整个项目有效文件中的全局配置文件 gptr.config.json 和 *.gpt.md AI 预设文件，然后在浏览器中打开一个 Web AI 聊天窗口。
现在，你可以在浏览器的 http://localhost:3003 上看到 GPT-Runner 的 Web 界面。
您可以使用以下选项与 GPT-Runner CLI 一起使用：
-
-p，--port [端口号]：此选项允许您指定服务器监听的端口号。默认值为3003。如果您希望修改这个值，只需在您的命令后面添加此选项，然后跟上您想要的端口号。例如：--port 8080。 -
-c，--config [文件路径]：此选项允许您指定 GPT-Runner 的全局配置文件路径。如果您的配置文件不在默认位置，或者您有多个配置文件，您可以使用此选项告诉 GPT-Runner 使用哪个文件。例如，如果您在项目的根目录中有一个名为 gptr.config.json 的配置文件，您可以如下使用此选项：--config ./gptr.config.json。当然我们会默认检测 gptr 运行目录下的 gptr.config.json。 -
--share：此标志通过一个临时链接分享正在运行的服务器。它不需要一个值，你可以简单地添加它来启用分享功能。例如：gptr --share。首次分享时需要下载一些依赖，所以会比较慢。 -
--no-open：默认情况下，当您启动服务器时，GPT-Runner CLI 会在您的默认网络浏览器中打开用户界面。如果您不希望这样做，使用此选项。例如：gptr --no-open。 -
--debug：此标志以调试模式运行服务器。在调试模式下，CLI 将输出可以帮助进行故障排除的额外信息。要启用调试模式，只需在您的命令后面添加此标志。例如：gptr --debug。
这里有一个使用所有选项的例子：
gptr --port 8080 --config ./gptr.config.json --share --no-open --debug在这个例子中，GPT-Runner CLI 将在端口 8080 上启动一个服务器，使用 gptr.config.json 的配置文件，分享服务器链接，不自动在浏览器中打开，并以调试模式运行。
关于 gptr.config.json 配置文件、xxx.gpt.md AI 预设文件、.gpt-runner 特殊目录的详细介绍请参见这里：
对 AI 提升开发效率感兴趣的，可以加我 wechat: qq2214962083 入群交流
要求：会科学上网，使用过 chatgpt
等待你的赞助...
你可以查看我们的贡献指南
这个项目得以存在，要感谢所有贡献者：
MIT 许可证 © 2023-PRESENT Jinming Yang