GPT Terminal

✨ 用程序员的方式，打开GPT！定制专属于你的 GPT 终端 ✨

特别鸣谢

该项目灵感来源于 YuIndex，并最终将其改造为「GPT Terminal」

简介

GPT Terminal 是一个让你在终端上与 GPT 进行自由对话的平台。

在这里，你可以更加轻易地实现更多定制化的功能，拥有专属于你的 GPT 终端！

预览

专栏讲解（持续更新中）

耗时一下午，我实现了 GPT Terminal，真正拥有了专属于我的 GPT 终端！

如何用 GPT 在 5 分钟内 ”调教“ 出一个专属于你的 ”小黑子“？

如何丝滑实现 GPT 打字机流式回复？Server-Sent Events！

功能概览

支持命令行终端与 GPT 进行对话，我们程序员就是要用极客范儿的方式与 GPT 交流！
支持 GPT 记忆历史对话并提供命令查询历史对话，给你的 GPT 长长记性～
支持 GPT 市面使用最广泛的 Event Stream 技术，实现打字机效果～
支持 GPT 回复内容以 Markdown 形式展现
基于 GPT 的中英文翻译助手，地道翻译的最佳选择！
基于 GPT 的命令行翻译助手，当你忘记 linux 命令时，就用它！
基于 GPT 的 SQL-BOY，当你不知道如何写 SQL语句时，就用它！
基本的终端命令，如查看历史命令、帮助手册、清屏等
终端用户登录与注册

快速开始

你只需简单地了解如何使用 npm / MySQL / Redis，即可解锁全部功能！

将项目克隆到本地

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

进入项目目录，并分别安装前端与后端依赖

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

修改后端配置。配置文件位于 server/config/config.js 中
- 你需要将 Redis、MySQL 与 GPT 更改为你自己的配置
运行前端
```
npm run dev
```
运行后端
```
npm run start:dev
```

快速解锁命令用法 - 命令行中使用help命令查询使用方法

# 查询全部命令帮助
help

# 查询具体命令帮助
gpt -h
gpt chat -h
gpt role -h
gpt history -h

项目技术栈

前端	后端
Vue 3	Node.js
Vite2	Express
Ant Design Vue 3 组件库	MySQL
Pinia 2 状态管理	Sequelize
TypeScript 类型控制	Redis
Eslint 代码规范控制
Prettier 美化代码
axios 网络请求
dayjs 时间处理
lodash 工具库
getopts 命令参数解析

GPT 网络与配置问题检测

通过 GPT Demo，检测你能否顺利请求到 Open AI，确保你网络通畅且 API Key 可用

执行如下命令，进入 gpt-test-demo 文件夹，并安装依赖
```
cd gpt-test-demo && npm install
```

在 index.js 文件中配置你的 API Key

const configuration = new Configuration({
  apiKey: "",
});

运行 index.js 文件
```
node index.js
```

若顺利输出内容，则说明 API Key 有效且网络可访问。

如何"调教"属于你的 GPT 角色？

在执行如下步骤之前，请确保已经按照 快速开始 完成项目本地部署。

v1.0.x 版本指南

后续会逐步加入前端界面中自定义角色的功能

进入 server/src/thirdpart/gptApi/template 目录下，新建 markdown 文件。文件名为角色名。
- 参照该目录下的其它模板文件
  - SYSTEM：对 GPT 角色的定义
  - USER - ASSISTANT：示范提示 GPT 在特定情况下该如何回答 - Prompt
进入 src/core/commands/gpt/subCommands/roles.ts 文件中，在数组中添加你之前定义的的角色名（与 markdown 模板文件保持一致）。

版本规划

支持自定义 GPT 角色并与当前用户绑定，真正实现定制专属于你的 GPT 机器人～
支持 GPT 记忆历史对话，给你的 GPT 长长记性～
支持查询最近的 GPT 问答会话，使你与 GPT 的交流真正保存下来～
支持用户在线设置与修改自己的 OpenAI Key
支持 GPT 回复内容以 Markdown 形式展现
前端首页展示艺术字体
支持 GPT 回复内容以打字机方式流式输出
支持前端命令行高亮展示
引入角色市场

各位敬请期待～

开源协议

Apache License Version 2.0 see http://www.apache.org/licenses/LICENSE

CoderLeeMS/gpt-web-terminal