当前位置：首页 > article >正文

sgpt 终端使用指南

article 2025/3/27 4:48:58

1. 什么是 sgpt？

sgpt 是一个基于 OpenAI API 的命令行工具，允许用户在终端中与 AI 进行交互，支持自然语言对话、代码生成、Shell 命令生成等功能。本文将介绍 sgpt 的安装方法、基本用法、配置文件路径及修改方式，并提供完整的配置示例，特别是如何切换到 DeepSeek API。

1.1 sgpt 的主要用途

直接在终端与 AI 对话。
生成 Shell 命令并执行。
生成代码示例。
进入交互模式，保持持续对话。

2. 如何安装 sgpt？

2.1 在 Linux/macOS 安装

使用 pip 进行安装：

pip install shell-gpt

如果安装了多个大版本的 python，并且 pip 默认是低版本，那么安装的时候大概是会报错，推荐使用下面的命令安装：

pip3 install shell-gpt

pip3 install shell-gpt 命令失败了，错误是 “externally-managed-environment”，这表示 Python 由 macOS 或 Homebrew 管理，不能直接使用 pip 安装全局包。pipx 允许在独立环境中安装 Python 应用，避免影响系统环境：

brew install pipx  # 先安装 pipx
pipx ensurepath    # 确保 pipx 的路径可用
pipx install shell-gpt  # 使用 pipx 安装 shell-gpt

安装完成后，可以使用 sgpt --help 查看命令用法。
在这里插入图片描述

2.2 在 Windows 安装

Windows 用户可以使用 pip 进行安装，推荐在 PowerShell 或 WSL (Windows Subsystem for Linux) 中执行：

pip install shell-gpt

安装成功后，运行以下命令检查是否可用：

sgpt --help

如果 sgpt 命令无法识别，请检查 Python 是否正确安装，并确保 pip 目录已添加到 PATH。

3. 如何在终端使用 sgpt？

3.1 进行 AI 对话

sgpt "你好，今天的天气怎么样？"

3.2 生成 Shell 命令

sgpt -s "列出当前目录的所有文件"

-s 选项让 sgpt 生成 Shell 命令。

3.3 代码生成

sgpt -c "写一个 Python 斐波那契数列函数"

-c 选项让 sgpt 仅返回代码。

3.4 进入交互模式

sgpt --chat temp

--chat temp 让 sgpt 进入临时对话模式，可进行多轮对话。

4. 如何找到 sgpt 的配置文件？

sgpt 需要 API Key 进行访问，配置文件通常存储在 ~/.config/shell_gpt/.sgptrc (Linux/macOS) 或 C:\Users\你的用户名\.config\shell_gpt\.sgptrc (Windows)。

4.1 查找配置文件

echo $HOME/.config/shell_gpt/.sgptrc  # Linux/macOS

echo $env:APPDATA\shell_gpt\.sgptrc  # Windows

4.2 通过源码配置文件

在 sgpt 的 Python 源码中，可以看到默认的 配置文件路径 为：

CONFIG_FOLDER = os.path.expanduser("~/.config")
SHELL_GPT_CONFIG_FOLDER = Path(CONFIG_FOLDER) / "shell_gpt"
SHELL_GPT_CONFIG_PATH = SHELL_GPT_CONFIG_FOLDER / ".sgptrc"

📌 也就是说，配置文件在：~/.config/shell_gpt/.sgptrc

5. 如何修改 API 以使用 DeepSeek？

默认情况下，sgpt 使用 OpenAI 的 API (https://api.openai.com/v1/chat/completions)，如果要使用 DeepSeek，需要修改配置文件。

5.1 修改 `.sgptrc` 配置文件

打开 ~/.config/shell_gpt/.sgptrc (Linux/macOS) 或 C:\Users\你的用户名\.config\shell_gpt\.sgptrc (Windows)，修改以下内容：

API_BASE_URL=https://api.deepseek.com/v1
DEFAULT_MODEL=deepseek-chat
OPENAI_API_KEY=你的密钥

DEFAULT_MODEL 需要与 DeepSeek 支持的模型名称一致。

6. 完整的配置示例（适用于 DeepSeek）

CHAT_CACHE_PATH=/tmp/chat_cache
CACHE_PATH=/tmp/cache
CHAT_CACHE_LENGTH=100
CACHE_LENGTH=100
REQUEST_TIMEOUT=60
DEFAULT_MODEL=deepseek-chat
DEFAULT_COLOR=magenta
ROLE_STORAGE_PATH=$HOME/.config/shell_gpt/roles
DEFAULT_EXECUTE_SHELL_CMD=false
DISABLE_STREAMING=false
CODE_THEME=dracula
OPENAI_FUNCTIONS_PATH=$HOME/.config/shell_gpt/functions
OPENAI_USE_FUNCTIONS=true
SHOW_FUNCTIONS_OUTPUT=false
API_BASE_URL=https://api.deepseek.com/v1
PRETTIFY_MARKDOWN=true
USE_LITELLM=false
SHELL_INTERACTION=true
OS_NAME=auto
SHELL_NAME=auto
OPENAI_API_KEY=your-deepseek-api-key

7. 常见问题及解决方案

7.1 `sgpt` 命令未找到

确保 pip install shell-gpt 已正确执行。
在 Linux/macOS 上，检查 ~/.local/bin 是否在 PATH 中：
```
export PATH=$HOME/.local/bin:$PATH
```
在 Windows 上，检查 Python 目录是否在 PATH 中。