项目介绍:GPTerminator
概述
GPTerminator 是一个在终端上与 OpenAI 的聊天完成和图像生成 API 互动的便捷工具。通过这个项目,用户可以在命令行界面中轻松进行聊天对话、保存聊天记录、分析文件和生成图像。
功能特点
- 聊天完成:支持与 GPT 模型进行自然语言对话。
- 保存与载入聊天会话:可将聊天记录保存并在需要时重新载入。
- 文件分析:通过命令行对文件内容进行简要分析。
- 图像生成:使用 DALL·E 模型生成图像。
- 便捷的代码和文本复制:在终端中轻松复制代码和文本。
- 响应再生:可重新生成上一次的对话回复。
入门与安装
安装 GPTerminator
用户可以通过以下方式安装:
git clone https://github.com/AineeJames/ChatGPTerminator
cd ChatGPTerminator
pip install .
或者直接使用 pip 安装:
pip install gpterminator
环境配置
在使用之前,需要设置 OPENAI_API_KEY
环境变量:
export OPENAI_API_KEY=<YOUR_API_KEY>
启动 GPTerminator
在终端中运行以下命令即可启动:
gpterm
# 或者
gpterm <input> # 例如:gpterm write a hello world function in Python
运行后,输入 !help
可以查看所有可用的命令。
使用 Podman 或 Docker (可选)
用户可以选择通过 Podman 或 Docker 来运行 GPTerminator。首先,构建镜像并提供 APIKEY
:
podman build \
--build-arg APIKEY=$(echo $OPENAI_API_KEY) \
-t gpterm .
然后使用以下命令在容器中运行:
podman run -it --rm --name gpterm gpterm
为了方便访问,可以设置一个别名:
echo "alias gpterm='podman run -it --rm --name gpterm gpterm'" >> ~/.bashrc
命令
您可以通过命令提升聊天体验。输入 !help
查看所有可能的命令及其简要说明。
配置
GPTerminator 支持多种配置。可以在 config.ini
文件中设置以下参数:
设置 | 描述 | 默认值 |
---|---|---|
ModelName | 使用的聊天模型 | gpt-3.5-turbo |
Temperature | 模型输出的随机性参数,值介于 0 到 2 之间 | 1 |
PresencePenalty | 影响新主题引入的惩罚 | 0 |
FrequencyPenalty | 影响已有主题重复的惩罚 | 0 |
SystemMessage | 发送给 API 的初始系统消息 | "You are a helpful assistant named GPTerminator" |
CommandInitiator | 命令前缀符,默认是 ! | ! |
SavePath | 加载/保存路径 | (默认保存路径) |
CodeTheme | 代码块的 Pygments 主题 | monokai |
保存配置后,运行 gpterm
,输入 !setconf
选择要使用的配置,也可使用 !pconf
查看当前配置细节。
贡献
欢迎大家为本项目贡献力量。如果发现问题、有功能请求,或想贡献代码,可以发起 Issue 或 Pull Request。
免责声明
本程序使用 OpenAI API 来聊天和生成图像。在使用时,建议在账单上设置使用上限,以防出现意外情况。