sgpt

SGPT 项目介绍

项目背景

SGPT (即 shell-gpt) 是一个强大的命令行界面工具，专为直接通过终端与 OpenAI 模型无缝交互而设计。通过简单的命令，用户可以轻松执行查询、生成 shell 命令或代码、根据文本创建图像等等。这个工具不仅功能强大，而且用户友好，旨在简化工作流程，提高生产力。

功能介绍

• 即时答案： 在终端中直接获取简洁且准确的答案，有效简化工作流程。
• GPT-4o 集成： 连接 GPT-4o API，生成详细的回答。
• GPT-4 视觉 API： 利用 GPT-4 视觉 API，从图像中分析并生成见解。
• 生成 Shell 命令： 轻松生成并执行 shell 命令，简化复杂任务，提高效率。
• 代码生成： 生成多种编程语言的代码片段，帮助学习新语言或解决编程问题。
• ChatGPT 集成： 利用 ChatGPT 的交互式聊天功能，精确优化提示以获得更精确的结果。
• Bash 函数和别名： 将 SGPT 响应无缝集成到自定义的 Bash 函数和别名中，优化工作流程，提高日常任务的效率。

通过这些功能，SGPT 成为了一种强大的工具，能够提升总体生产力，简化工作，轻松解决复杂任务。

安装指南

SGPT 可以在多种操作系统上安装，以下是安装步骤：

Linux

SGPT 在 Ubuntu LTS 版本上经过测试，可兼容 Debian、Arch Linux、Fedora 等发行版。需要通过特定的软件包管理器安装最新版本。

macOS

使用 Homebrew 的用户可以直接在终端中运行以下命令进行安装：

brew install tbckr/tap/sgpt

Windows

使用 Scoop 的用户可以在 PowerShell 中执行以下命令：

scoop bucket add tbckr https://github.com/tbckr/scoop-bucket.git
scoop install tbckr/sgpt

使用 Go

使用 Go 安装 SGPT，需要基于 git 标记运行以下命令：

go install github.com/tbckr/sgpt/v2/cmd/sgpt@latest

Docker

SGPT 也可以通过 Docker 运行，使用以下命令获取最新镜像：

docker pull ghcr.io/tbckr/sgpt:latest

Ansible 和其他平台

使用 Ansible 可根据提供的 playbook 安装，并可根据需要适配。其他平台的用户可直接访问 GitHub 页面下载适合系统的版本。

使用指南

SGPT 的使用非常多样化，以下为一些基本操作指引：

获取 OpenAI API Key

使用 OpenAI API 前需先获得 API Key，用户需注册账户并生成新的 API Key，然后在相应的系统文件中设置环境变量以保存该 Key。

查询 OpenAI 模型

用户可以用 SGPT 提出问题并获得有用的回答，比如：

$ sgpt "mass of sun"

支持的 API 和聊天功能

SGPT 支持 GPT-4o 和 GPT-4 Vision API，允许分析和生成图像见解。也提供交互式会话功能，方便用户进行连续对话以获取精准的结果。

生成和执行 Shell 命令

SGPT 可以生成基于输入的 shell 命令，并可以直接执行生成的 shell 命令，优化命令行效率。

代码生成能力

SGPT 能高效生成指定需求的代码片段，便于解决编程问题。

提升工作流的 Bash 别名和函数

用户还可以进一步将 SGPT 集成到工作流中，通过配置 Bash 别名和函数来自动化常见任务，比如自动生成 git 提交信息。

致谢

SGPT 受到了 shell-gpt 项目的启发，许多功能和想法来源于此项目。