一个由 AI 大型语言模型（LLM）驱动的命令行生产力工具。该命令行工具提供了对 shell 命令、代码片段、文档 的简化生成，消除了对外部资源（如 Google 搜索）的需求。支持 Linux、macOS、Windows，并与 PowerShell、CMD、Bash、Zsh 等主要 Shell 兼容。
ShellGPT.mp4
pip install shell-gpt默认情况下，ShellGPT 使用 OpenAI 的 API 和 GPT-4 模型。您需要一个 API 密钥，您可以在这里 生成一个。您将被要求输入您的密钥，然后它将被存储在~/.config/shell_gpt/.sgptrc中。OpenAI API 并非免费，有关更多信息，请参阅OpenAI 定价。
Tip
或者，您可以使用本地托管的开源模型，这些模型可免费使用。要使用本地模型，您需要运行自己的 LLM 后端服务器，例如Ollama。要使用 Ollama 设置 ShellGPT，请按照这个详细的指南 进行操作。
❗️请注意，ShellGPT 并未针对本地模型进行优化，可能无法按预期工作。
ShellGPT 旨在快速分析和检索信息。它对于从技术配置到一般知识的简单请求非常有用。
sgpt "什么是斐波那契数列"
# -> 斐波那契数列是一系列数字，其中每个数字 ...ShellGPT 可以接受来自标准输入和命令行参数的提示。无论您是喜欢通过终端进行输入管道，还是直接指定参数，sgpt都可以满足您的需求。例如，您可以根据差异轻松生成一个 git 提交消息：
git diff | sgpt "为我的更改生成 git 提交消息"
# -> 将主要功能详细信息添加到 README.md 中您可以通过使用 tdin 传递来自各种来源的日志，以及一个提示来分析日志。例如，我们可以使用它快速分析日志，识别错误并获得可能的解决方案建议：
docker logs -n 20 my_app | sgpt "检查日志，查找错误，提供可能的解决方案"检测到错误：第 7 行连接超时。
可能的解决方案：检查网络连接和防火墙设置。
检测到错误：第 12 行内存分配失败。
可能的解决方案：考虑增加内存分配或优化应用程序内存使用。
您还可以使用各种重定向运算符传递输入：
sgpt "总结" < document.txt
# -> 该文档讨论了影响...
sgpt << EOF
什么是学习 Golang 的最佳方法？
提供一个简单的 hello world 示例。
EOF
# -> 学习 Golang 的最佳方法是...
sgpt <<< "什么是学习 shell 重定向的最佳方式？"
# -> 学习 shell 重定向的最佳方式是通过...当然！使用 Shell GPT，您可以快速生成常见的 shell 命令。只需使用--shell或-s选项，即可在终端中生成和执行所需的命令。
sgpt --shell "在当前文件夹中查找所有 json 文件"
# -> find . -type f -name "*.json"
# -> [E]xecute, [D]escribe, [A]bort: eShell GPT 会根据您使用的操作系统和$SHELL环境变量提供特定系统的 shell 命令。例如，如果您要求sgpt更新您的系统，它将返回基于您的操作系统的命令。下面是在 macOS 上的示例：
sgpt -s "更新我的系统"
# -> sudo softwareupdate -i -a
# -> [E]xecute, [D]escribe, [A]bort: e同样的提示，在 Ubuntu 上使用时，将生成不同的建议：
sgpt -s "更新我的系统"
# -> sudo apt update && sudo apt upgrade -y
# -> [E]xecute, [D]escribe, [A]bort: e让我们尝试一下 Docker：
sgpt -s "启动 nginx 容器，挂载./index.html"
# -> docker run -d -p 80:80 -v $(pwd)/index.html:/usr/share/nginx/html/index.html nginx
# -> [E]xecute, [D]escribe, [A]bort: e我们仍然可以使用管道将输入传递给sgpt并生成 shell 命令：
sgpt -s "使用以下数据在 localhost 上进行 POST 请求" < data.json
# -> curl -X POST -H "Content-Type: application/json" -d '{"a": 1, "b": 2}' http://localhost
# -> [E]xecute, [D]escribe, [A]bort: e在提示中应用额外的 shell 技巧，例如将文件名传递给ffmpeg：
ls
# -> 1.mp4 2.mp4 3.mp4
sgpt -s "使用 $(ls -m) 将多个视频文件合并为一个没有音频的视频文件。"
# -> ffmpeg -i 1.mp4 -i 2.mp4 -i 3.mp4 -filter_complex "[0:v] [1:v] [2:v] concat=n=3:v=1 [v]" -map "[v]" out.mp4
# -> [E]xecute, [D]escribe, [A]bort: e如果您想使用管道传递生成的 shell 命令，可以使用--no-interaction选项。这将禁用交互模式，并将生成的命令打印到 tdout。在此示例中，我们使用pbcopy将生成的命令复制到剪贴板：
sgpt -s "在当前文件夹中查找所有 json 文件" --no-interaction | pbcopy这是一个非常方便的功能，它允许您在终端中直接使用 sgpt 的命令补全，无需输入 sgpt 的提示符和参数。Shell 集成功能支持使用热键在终端中使用 ShellGPT，支持 Bash 和 ZSH 两种 shell。该功能将 sgpt 的命令补全直接放入终端缓冲区（输入行），可以立即编辑建议的命令。
Shell_GPT_Integration.mp4
要安装 Shell 集成，运行 sgpt --install-integration 并重新启动终端以应用更改。这将在您的 .bashrc 或 .zshrc 文件中添加几行代码。之后，您可以使用 Ctrl+l（默认情况下）来调用 ShellGPT。按下 Ctrl+l 后，它将用建议的命令替换当前的输入行（缓冲区）。您可以编辑它，然后按下 Enter 来执行命令。
通过使用 --code 或 -c 参数，您可以明确请求纯代码输出，例如：
sgpt --code "使用 Python 解决 Fizz Buzz 问题"for i in range(1, 101):
if i % 3 == 0 and i % 5 == 0:
print("FizzBuzz")
elif i % 3 == 0:
print("Fizz")
elif i % 5 == 0:
print("Buzz")
else:
print(i)由于这是有效的 Python 代码，我们可以将其重定向到一个文件中：
sgpt --code "使用 Python 解决经典 Fizz Buzz 问题" > fizz_buzz.py
python fizz_buzz.py
# 1
# 2
# Fizz
# 4
# Buzz
# ...我们还可以使用管道传递输入：
cat fizz_buzz.py | sgpt --code "为我的代码的每一行生成注释"# 循环遍历从 1 到 100 的数字
for i in range(1, 101):
# 检查数字是否既能被 3 整除又能被 5 整除
if i % 3 == 0 and i % 5 == 0:
# 如果数字能被 3 和 5 同时整除，打印"FizzBuzz"
print("FizzBuzz")
# 检查数字是否能被 3 整除
elif i % 3 == 0:
# 如果数字能被 3 整除，打印"Fizz"
print("Fizz")
# 检查数字是否能被 5 整除
elif i % 5 == 0:
# 如果数字能被 5 整除，打印"Buzz"
print("Buzz")
# 如果数字既不能被 3 整除也不能被 5 整除，打印数字本身
else:
print(i)经常需要保留和回顾对话。sgpt会在每次请求 LLM 完成时创建对话式对话。对话可以逐步发展（聊天模式）或以 REPL 循环的方式进行交互（REPL 模式）。两种方式都依赖于同一个称为对话会话的基础对象，该会话位于可配置 的CHAT_CACHE_PATH位置。
要开始对话，请使用--chat选项，后面跟着一个唯一的会话名称和一个提示。
sgpt --chat conversation_1 "请记住我的最喜欢的数字：4"
# -> 我将记住你最喜欢的数字是 4。
sgpt --chat conversation_1 "我的最喜欢的数字加上 4 会是多少？"
# -> 你最喜欢的数字是 4，所以如果我们加上 4，结果将是 8。您可以使用聊天会话逐步改进 GPT 的建议，提供额外的细节。可以使用--code或--shell选项来启动--chat：
sgpt --chat conversation_2 --code "使用 Python 向 localhost 发送请求"import requests
response = requests.get('http://localhost')
print(response.text)让我们请求 LLM 为我们的请求添加缓存：
sgpt --chat conversation_2 --code "添加缓存"import requests
from cachecontrol import CacheControl
sess = requests.session()
cached_sess = CacheControl(sess)
response = cached_sess.get('http://localhost')
print(response.text)对于 shell 命令也适用：
sgpt --chat conversation_3 --shell "当前文件夹中的内容是什么"
# -> ls
sgpt --chat conversation_3 "按名称排序"
# -> ls | sort
sgpt --chat conversation_3 "使用 FFMPEG 将它们连接起来"
# -> ffmpeg -i "concat:$(ls | sort | tr '\n' '|')" -codec copy output.mp4
sgpt --chat conversation_3 "将生成的文件转换为 MP3 格式"
# -> ffmpeg -i output.mp4 -vn -acodec libmp3lame -ac 2 -ab 160k -ar 48000 final_output.mp3要列出任一对话模式中的所有会话，请使用--list-chats或-lc选项：
sgpt --list-chats
# .../shell_gpt/chat_cache/conversation_1
# .../shell_gpt/chat_cache/conversation_2要显示与特定对话相关的所有消息，请使用--show-chat选项，后面跟着会话名称：
sgpt --show-chat conversation_1
# user: 请记住我的最喜欢的数字：4
# assistant: 我将记住你最喜欢的数字是 4。
# user: 我的最喜欢的数字加上 4 会是多少？
# assistant: 你最喜欢的数字是 4，所以如果我们加上 4，结果将是 8。有一个非常方便的 REPL（读取 - 求值 - 打印循环）模式，它允许您与 GPT 模型进行交互式聊天。要在 REPL 模式下开始一个聊天会话，请使用 --repl 选项后面跟一个唯一的会话名称。您还可以使用 "temp" 作为会话名称来启动临时 REPL 会话。请注意，--chat 和 --repl 使用相同的底层对象，因此您可以使用 --chat 来启动一个聊天会话，然后使用 --repl 来继续在 REPL 模式下进行对话。
sgpt --repl temp
进入 REPL 模式，按 Ctrl+C 退出。
>>> 什么是 REPL？
REPL 代表读取 - 求值 - 打印循环。它是一个编程环境...
>>> 如何在 REPL 中使用 Python？
要在 REPL 中使用 Python，您可以简单地打开终端或命令提示符...
REPL 模式可以与 --shell 和 --code 选项一起使用，非常方便进行交互式的 shell 命令和代码生成：
sgpt --repl temp --shell
进入 shell REPL 模式，输入 [e] 执行命令，或按 Ctrl+C 退出。
>>> 当前文件夹中有什么？
ls
>>> 显示文件大小
ls -lh
>>> 按文件大小排序它们
ls -lhS
>>> e（仅输入 e 执行命令，或输入 d 进行描述）
要提供多行提示，请使用三个引号 """：
sgpt --repl temp
进入 REPL 模式，按 Ctrl+C 退出。
>>> """
... 解释以下代码：
... import random
... print(random.randint(1, 10))
... """
这是一个使用 random 模块生成和打印随机整数的 Python 脚本。
您还可以通过将其作为参数或标准输入甚至两者同时传递来使用初始提示进入 REPL 模式：
sgpt --repl temp < my_app.py进入 REPL 模式，按 Ctrl+C 退出。
─────────────────────────────────────── 输入 ────────────────────────────────────
name = input("What is your name?")
print(f"Hello {name}")
───────────────────────────────────────────────────────────────────────────────
>>> 这段代码是关于什么的？
您提供的代码片段是用 Python 编写的。它提示用户...
>>> 后续问题...
函数调用 是 OpenAI 提供的一个强大功能。它允许 LLM 在您的系统中执行函数，用于完成各种任务。要安装默认函数，请运行:
sgpt --install-functionsShellGPT 提供了一种方便的方法来定义和使用函数。为了创建您的自定义函数，请转到~/.config/shell_gpt/functions并创建一个新的.py 文件，文件名为函数名。在这个文件中，您可以使用以下语法来定义您的函数:
# execute_shell_command.py
import subprocess
from pydantic import Field
from instructor import OpenAISchema
class Function(OpenAISchema):
"""
执行一个 shell 命令并返回输出（结果）。
"""
shell_command: str = Field(..., example="ls -la", descriptions="要执行的 shell 命令。")
class Config:
title = "execute_shell_command"
@classmethod
def execute(cls, shell_command: str) -> str:
result = subprocess.run(shell_command.split(), capture_output=True, text=True)
return f"退出码: {result.returncode}, 输出:\n{result.stdout}"类内的文档字符串注释将作为函数的描述传递给 OpenAI API，还有title属性和参数描述。如果 LLM 决定使用您的函数，将调用execute函数。在这种情况下，我们允许 LLM 在我们的系统中执行任何 Shell 命令。由于我们返回了命令的输出，LLM 将能够分析它并决定是否适合提示。以下是 LLM 可能执行该函数的示例:
sgpt "查看 /tmp 文件夹中的文件有哪些?"
# -> @FunctionCall execute_shell_command(shell_command="ls /tmp")
# -> /tmp 文件夹包含以下文件和目录:
# -> test.txt
# -> test.json请注意，如果由于某种原因函数（execute_shell_command）返回错误，LLM 可能会根据输出尝试完成任务。假设我们的系统中没有安装jq，我们要求 LLM 解析 JSON 文件:
sgpt "使用 jq 解析 /tmp/test.json 文件并仅返回 email 值"
# -> @FunctionCall execute_shell_command(shell_command="jq -r '.email' /tmp/test.json")
# -> 看起来系统中没有安装 jq。让我试着使用 brew 安装它。
# -> @FunctionCall execute_shell_command(shell_command="brew install jq")
# -> jq 已成功安装。让我再次尝试解析文件。
# -> @FunctionCall execute_shell_command(shell_command="jq -r '.email' /tmp/test.json")
# -> /tmp/test.json 中的 email 值是 johndoe@example。还可以在提示中链接多个函数调用:
sgpt "播放音乐并打开黑客新闻"
# -> @FunctionCall play_music()
# -> @FunctionCall open_url(url="https://news.ycombinator.com")
# -> 音乐正在播放，并且黑客新闻已在您的浏览器中打开。享受吧！这只是一个简单的示例，介绍了如何使用函数调用。它是一个真正强大的功能，可用于完成各种复杂的任务。我们在 GitHub 讨论中专门设有一个类别 用于共享和讨论函数。 LLM 可能执行破坏性命令，请自行承担风险❗️
ShellGPT 允许你创建自定义角色，用于生成代码、shell 命令或满足你的特定需求。要创建新角色，使用--create-role选项后跟角色名称。你将被要求提供角色的描述以及其他细节。这将在~/.config/shell_gpt/roles目录下创建一个以角色名称命名的 JSON 文件。在这个目录中，你还可以编辑默认的sgpt角色，如 shell、code 和 default。使用--list-roles选项列出所有可用角色，使用--show-role选项显示特定角色的详细信息。下面是一个自定义角色的示例：
sgpt --create-role json_generator
# 输入角色描述：只提供有效的 JSON 作为响应。
sgpt --role json_generator "random: user, password, email, address"{
"user": "JohnDoe",
"password": "p@ssw0rd",
"email": "[email protected]",
"address": {
"street": "123 Main St",
"city": "Anytown",
"state": "CA",
"zip": "12345"
}
}如果角色的描述中包含"APPLY MARKDOWN"（区分大小写）一词，则聊天将以 Markdown 格式显示。
使用--cache（默认）和--no-cache选项来控制缓存。这个缓存适用于所有对 OpenAI API 的sgpt请求：
sgpt "what are the colors of a rainbow"
# -> The colors of a rainbow are red, orange, yellow, green, blue, indigo, and violet.下次，相同的查询将从本地缓存中立即获取结果。注意，sgpt "what are the colors of a rainbow" --temperature 0.5将发起一个新的请求，因为我们没有在上次请求中提供--temperature（--top-probability也是如此）。
这只是一些使用 OpenAI GPT 模型的示例，我相信你会发现在你的特定用例中它非常有用。
你可以在运行时配置文件~/.config/shell_gpt/.sgptrc中设置一些参数：
# API 密钥，也可以使用 OPENAI_API_KEY 环境变量定义。
OPENAI_API_KEY=your_api_key
# 后端服务器的基本 URL。如果为"default"，将根据 --model 解析 URL。
API_BASE_URL=default
# 每个聊天会话中缓存的最大消息数量。
CHAT_CACHE_LENGTH=100
# 聊天缓存文件夹。
CHAT_CACHE_PATH=/tmp/shell_gpt/chat_cache
# 请求缓存长度（数量）。
CACHE_LENGTH=100
# 请求缓存文件夹。
CACHE_PATH=/tmp/shell_gpt/cache
# 请求超时时间（秒）。
REQUEST_TIMEOUT=60
# 默认使用的 OpenAI 模型。
DEFAULT_MODEL=gpt-3.5-turbo
# shell 和 code 完成的默认颜色。
DEFAULT_COLOR=magenta
# 当处于 --shell 模式时，默认为不输入。
DEFAULT_EXECUTE_SHELL_CMD=false
# 禁用响应的流式传输
DISABLE_STREAMING=false
# 用于查看 Markdown 的 pygment 主题（默认 / 描述角色）。
CODE_THEME=default
# 包含函数的目录路径。
OPENAI_FUNCTIONS_PATH=/Users/user/.config/shell_gpt/functions
# 使用函数时打印函数的输出。
SHOW_FUNCTIONS_OUTPUT=false
# 允许 LLM 使用函数。
OPENAI_USE_FUNCTIONS=true
# 强制使用 LiteLLM（用于本地 LLM）。
USE_LITELLM=false
DEFAULT_COLOR的可能选项：black、red、green、yellow、blue、magenta、cyan、white、bright_black、bright_red、bright_green、bright_yellow、bright_blue、bright_magenta、bright_cyan、bright_white。
CODE_THEME的可能选项：https://pygments.org/styles/
╭─ Arguments ──────────────────────────────────────────────────────────────────────────────────────────────╮
│ prompt [PROMPT] The prompt to generate completions for. │
╰──────────────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────────────────────────────────╮
│ --model TEXT Large language model to use. [default: gpt-4-1106-preview] │
│ --temperature FLOAT RANGE [0.0<=x<=2.0] Randomness of generated output. [default: 0.0] │
│ --top-p FLOAT RANGE [0.0<=x<=1.0] Limits highest probable tokens (words). [default: 1.0] │
│ --md --no-md Prettify markdown output. [default: md] │
│ --editor Open $EDITOR to provide a prompt. [default: no-editor] │
│ --cache Cache completion results. [default: cache] │
│ --version Show version. │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Assistance Options ─────────────────────────────────────────────────────────────────────────────────────╮
│ --shell -s Generate and execute shell commands. │
│ --interaction --no-interaction Interactive mode for --shell option. [default: interaction] │
│ --describe-shell -d Describe a shell command. │
│ --code -c Generate only code. │
│ --functions --no-functions Allow function calls. [default: functions] │
╰──────────────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Chat Options ───────────────────────────────────────────────────────────────────────────────────────────╮
│ --chat TEXT Follow conversation with id, use "temp" for quick session. [default: None] │
│ --repl TEXT Start a REPL (Read–eval–print loop) session. [default: None] │
│ --show-chat TEXT Show all messages from provided chat id. [default: None] │
│ --list-chats -lc List all existing chat ids. │
╰──────────────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Role Options ───────────────────────────────────────────────────────────────────────────────────────────╮
│ --role TEXT System role for GPT model. [default: None] │
│ --create-role TEXT Create role. [default: None] │
│ --show-role TEXT Show role. [default: None] │
│ --list-roles -lr List roles. │
╰──────────────────────────────────────────────────────────────────────────────────────────────────────────╯
使用 OPENAI_API_KEY 环境变量以及容器卷来运行容器以存储缓存:
docker run --rm \
--env OPENAI_API_KEY="你的 OPENAI API 密钥" \
--volume gpt-cache:/tmp/shell_gpt \
ghcr.io/ther1d/shell_gpt --chat rainbow "what are the colors of a rainbow"使用别名和 OPENAI_API_KEY 环境变量的对话示例:
alias sgpt="docker run --rm --env OPENAI_API_KEY --volume gpt-cache:/tmp/shell_gpt ghcr.io/ther1d/shell_gpt"
export OPENAI_API_KEY="你的 OPENAI API 密钥"
sgpt --chat rainbow "what are the colors of a rainbow"
sgpt --chat rainbow "inverse the list of your last answer"
sgpt --chat rainbow "translate your last answer in french"你还可以使用提供的 Dockerfile 来构建自己的镜像:
docker build -t sgpt .