gpt-web-terminal

项目介绍：GPT Terminal

GPT Terminal 是一个让用户可以在终端中与 GPT 进行自由交流的平台。这款项目的核心目标是为用户提供一个高度自定义的 GPT 终端，用户可以根据自己的需求实现定制化的功能，拥有属于自己的 GPT 交互体验。

项目背景

GPT Terminal 基于 Vue3 和 Express 构建，是针对程序员量身定制的一种前沿应用。它结合命令行工具的特点，通过极客式的方式与 GPT 进行对话，打破了传统的交互模式，为用户提供了全新的体验。

功能特性

• 命令行对话：支持在命令行终端与 GPT 对话，实现程序员专属的极客式沟通。
• API Key和访问令牌配置：可以选择通过 API Key（OpenAI API 方法）或访问令牌（Web API 方法）配置与 GPT 的连接。
• 自定义 GPT 角色：用户可以 DIY GPT 的角色，并保存这些角色，与专属角色进行对话。
• 对话历史记忆：GPT 支持记忆对话历史，并提供查询历史的命令，让对话更加连续和连贯。
• 打字机效果：利用广泛使用的事件流技术，使 GPT 的回复具备打字机效果，为用户提供视觉上的愉悦体验。
• Markdown 渲染：支持将 GPT 的回复渲染为 Markdown 格式，更加清晰易读。
• 基本命令支持：支持查看命令历史、访问帮助手册、清屏等基本终端命令，提高用户的使用效率。

快速开始

用户需要具备基本的 npm 使用知识，即可快速解锁所有功能：

1. 克隆项目到本地：

   git clone https://github.com/ltyzzzxxx/gpt-web-terminal.git

2. 进入项目目录并分别安装前端和后端依赖：

   cd gpt-web-terminal && npm install
   cd service && npm install

3. 在 service/.env 中配置 API Key 或访问令牌，优先使用 API Key：

   OPENAI_API_KEY=
   OPENAI_ACCESS_TOKEN=
   API_REVERSE_PROXY=
   

4. 运行前端：

   npm run dev

5. 运行后端：

   npm run start

6. 使用命令行中的 help 命令查询命令用法：

   help
   gpt -h
   gpt chat -h
   gpt role -h
   gpt history -h

如何设计自己的 GPT 角色

用户可以通过以下命令开始角色 DIY 过程：

gpt diy <-k GPT角色唯一标识符> <-n GPT角色名称> <-d GPT角色描述>

特别鸣谢

该项目受到 YuIndex 的启发，并最终演变为 "GPT Terminal"。感谢以下贡献者：

• @程序员鱼皮
• @MagicCube
• @Overtrue

开源许可证

本项目采用 Apache License 2.0 版本，更多详情请查看 http://www.apache.org/licenses/LICENSE。