shell_gpt AI技能包

Installation

pip install shell-gpt

[!TIP] Alternatively, you can run open-source models locally for free. This requires setting up your own LLM backend, such as Ollama. To get ShellGPT working with Ollama, follow this detailed guide ❗️Note that ShellGPT is not optimized for local models and may not work as expected.

-> docker run -d -p 80:80 -v $(pwd)/index.html:/usr/share/nginx/html/index.html nginx

-> It appears that jq is not installed on the system. Let me try to install it using brew.

-> @FunctionCall execute_shell_command(shell_command="brew install jq")

-> jq has been successfully installed. Let me try to parse the file again.

Docker

Run the container using the OPENAI_API_KEY environment variable, and a docker volume to store cache. Consider to set the environment variables OS_NAME and SHELL_NAME according to your preferences.

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"

Example of a conversation, using an alias and the OPENAI_API_KEY environment variable:

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"
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"

You also can use the provided Dockerfile to build your own image:

docker build -t sgpt .

Usage

ShellGPT is designed to quickly analyse and retrieve information. It's useful for straightforward requests ranging from technical configurations to general knowledge. ```shell sgpt "What is the fibonacci sequence"

-> The email value in /tmp/test.json is johndoe@example.

It is also possible to chain multiple function calls in the prompt:

Enforce LiteLLM usage (for local LLMs).

USE_LITELLM=false

Configuration Examples

Default behavior (ellipsis):

MARKDOWN_LIVE_VERTICAL_OVERFLOW=ellipsis

Visible mode (recommended for REPL sessions):

MARKDOWN_LIVE_VERTICAL_OVERFLOW=visible

sgpt --repl

Runtime configuration file

You can setup some parameters in runtime configuration file ~/.config/shell_gpt/.sgptrc: ```text

API key, also it is possible to define OPENAI_API_KEY env.

OPENAI_API_KEY=your_api_key

Shell integration

This is a very handy feature, which allows you to use sgpt shell completions directly in your terminal, without the need to type sgpt with prompt and arguments. Shell integration enables the use of ShellGPT with hotkeys in your terminal, supported by both Bash and ZSH shells. This feature puts sgpt completions directly into terminal buffer (input line), allowing for immediate editing of suggested commands.

https://github.com/TheR1D/shell_gpt/assets/16740832/bead0dab-0dd9-436d-88b7-6abfb2c556c1

To install shell integration, run sgpt --install-integration and restart your terminal to apply changes. This will add few lines to your .bashrc or .zshrc file. After that, you can use Ctrl+l (by default) to invoke ShellGPT. When you press Ctrl+l it will replace you current input line (buffer) with suggested command. You can then edit it and just press Enter to execute.