shell_gpt

环境要求

• Python 环境与 pip（用于 pip install shell-gpt）
• OpenAI API Key（默认走 OpenAI API，需付费）
• 可选：Docker，用于容器化运行
• 可选：本地 LLM 后端（如 Ollama），免费但官方称未做优化

安装与启动步骤

1. 1安装 ShellGPT

   使用 pip 从 PyPI 安装，安装完成后终端会出现 sgpt 命令。

   pip install shell-gpt

   复制

2. 2首次运行填密钥

   首次执行会提示输入 OpenAI API Key，密钥保存在 ~/.config/shell_gpt/.sgptrc。

   sgpt "What is the fibonacci sequence"

   复制

3. 3进入 REPL 模式

   用 --repl 进入交互会话，可持续追问；长输出建议改配置为 visible。

   sgpt --repl

   复制

4. 4Docker 方式运行

   用官方镜像运行，通过环境变量传 Key，挂载 volume 缓存，按需设 OS_NAME/SHELL_NAME。

   docker run --rm \
              --env OPENAI_API_KEY=api_key \
              --env OS_NAME=$(uname -s) \
              --env SHELL_NAME=$(echo $SHELL) \
              --volume gpt-cache:/tmp/shell_gpt \
          ghcr.io/ther1d/shell_gpt -s "update my system"

   复制

5. 5设为别名（可选）

   把 docker 启动命令设为 sgpt 别名并导出 Key，之后像本地命令一样使用。

   alias sgpt="docker run --rm --volume gpt-cache:/tmp/shell_gpt --env OPENAI_API_KEY --env OS_NAME=$(uname -s) --env SHELL_NAME=$(echo $SHELL) ghcr.io/ther1d/shell_gpt"
   export OPENAI_API_KEY="your OPENAI API key"

   复制

6. 6自建镜像（可选）

   README 提供 Dockerfile，可按需自行构建镜像，标签自定。

   docker build -t sgpt .

   复制

关键配置

如何确认成功

执行 sgpt "What is the fibonacci sequence"，能正常返回模型回答即表示安装与密钥配置成功。

常见问题

注意事项

• OpenAI API 不是免费的，使用前请查看 OpenAI 定价说明。
• 本地模型（如 Ollama）方案官方提示 ShellGPT 未针对其优化，效果可能不稳定。
• Docker 自建镜像需在与 Dockerfile 同级目录执行 docker build。
• 配置项写在 ~/.config/shell_gpt/.sgptrc 中，修改后对新会话生效。