shell-gpt-plus 1.1.0__tar.gz

shell_gpt_plus-1.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Farkhod Sadykov
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

shell_gpt_plus-1.1.0/PKG-INFO

@@ -0,0 +1,601 @@
+Metadata-Version: 2.4
+Name: shell-gpt-plus
+Version: 1.1.0
+Summary: A command-line productivity tool powered by large language models (Chinese enhanced, with web search and tool-use).
+Project-URL: homepage, https://github.com/zzzjjj-ss/shell-gpt-plus
+Project-URL: repository, https://github.com/zzzjjj-ss/shell-gpt-plus
+Project-URL: documentation, https://github.com/zzzjjj-ss/shell-gpt-plus/blob/main/README.md
+Author-email: Farkhod Sadykov <farkhod@sadykov.dev>, zzzjjj-ss <15728641935@163.com>
+License-Expression: MIT
+License-File: LICENSE
+Keywords: cheet-sheet,chinese,cli,deepseek,gpt,ollama,openai,productivity,shell
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Information Technology
+Classifier: Intended Audience :: System Administrators
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development
+Requires-Python: >=3.10
+Requires-Dist: beautifulsoup4
+Requires-Dist: distro<2.0.0,>=1.8.0
+Requires-Dist: lxml
+Requires-Dist: openai<3.0.0,>=2.0.0
+Requires-Dist: prompt-toolkit>=3.0.51
+Requires-Dist: pyreadline3<4.0.0,>=3.4.1; sys_platform == 'win32'
+Requires-Dist: requests
+Requires-Dist: rich<14.0.0,>=13.1.0
+Requires-Dist: typer<1.0.0,>=0.7.0
+Provides-Extra: dev
+Requires-Dist: pre-commit<4.0.0,>=3.1.1; extra == 'dev'
+Requires-Dist: ruff==0.0.256; extra == 'dev'
+Provides-Extra: litellm
+Requires-Dist: litellm==1.83.4; extra == 'litellm'
+Provides-Extra: test
+Requires-Dist: black==23.1.0; extra == 'test'
+Requires-Dist: codespell<3.0.0,>=2.2.5; extra == 'test'
+Requires-Dist: isort<6.0.0,>=5.12.0; extra == 'test'
+Requires-Dist: mypy==1.1.1; extra == 'test'
+Requires-Dist: pytest<8.0.0,>=7.2.2; extra == 'test'
+Requires-Dist: requests-mock[fixture]<2.0.0,>=1.10.0; extra == 'test'
+Requires-Dist: types-requests==2.28.11.17; extra == 'test'
+Description-Content-Type: text/markdown
+
+# shell-gpt-plus （中文增强版）
+
+基于 [TheR1D/shell_gpt](https://github.com/TheR1D/shell_gpt) 深度定制的命令行 AI 助手，专为国内用户优化，支持 **DeepSeek** 等兼容 OpenAI 接口的模型，内置联网搜索与文件操作工具，全中文交互，开箱即用。
+
+## ✨ 增强功能
+
+- 🧠 **修复函数调用兼容性** – 解决与 DeepSeek 思维链（`reasoning_content`）的冲突，函数调用稳定可用。
+- 🌐 **内置联网搜索** – 提供 `web_search` 和 `fetch_url` 工具，让 AI 实时查询网页内容。
+- 🔧 **可扩展工具集** – 已包含 `execute_shell_command`、`web_search`、`fetch_url`，可按需自定义。
+- 🧰 **全中文角色** – 所有系统角色（Shell 命令生成、代码生成、命令解释等）均已汉化。
+- 📦 **一键部署** – 安装后首次运行自动部署中文角色和工具，无需手动复制文件。
+- 🚀 **国内 API 直连** – 默认配置指向 DeepSeek（`api.deepseek.com`），也可自行修改。
+
+## 快速开始
+
+### 前置条件
+
+- **Python 3.10 或以上**
+- **Git**（用于 `pip install git+...`）
+- **DeepSeek API Key**（[申请地址](https://platform.deepseek.com/)）或其他兼容 OpenAI 接口的 Key
+
+### 安装
+
+在终端中执行：
+
+```bash
+py -m pip install git+https://github.com/zzzjjj-ss/shell-gpt-plus.git@v1.0.0
+```
+
+### 使用
+
+在终端中执行：
+
+```bash
+py -m sgpt "你好"
+```
+
+
+
+### Windows 平台快速调用（可选）
+
+为方便在任意路径下直接使用 `sgpt` 命令，可创建批处理脚本并添加至系统 PATH。
+
+1. 在项目目录（或固定路径，例如 `C:\Tools\shell-gpt-plus`）新建文件 `sgpt.bat`，写入以下内容：
+
+   ```batch
+   @echo off
+   py -m sgpt %*
+   ```
+
+2. 将 `sgpt.bat` 所在目录的**绝对路径**添加到系统环境变量 `PATH` 中：
+   - 按 `Win + R`，输入 `sysdm.cpl` 并回车。
+   - 点击 **高级** → **环境变量**。
+   - 在 **用户变量** 或 **系统变量** 中找到 `Path`，双击编辑。
+   - 点击 **新建**，粘贴目录路径（如 `C:\Tools\shell-gpt-plus`），依次确定保存。
+
+3. 重新打开任意命令行窗口，输入以下命令验证：
+
+   ```batch
+   sgpt "你好"
+   ```
+
+   正常返回 AI 回复即表示配置成功。
+
+
+
+### 卸载
+
+若需从系统中完全移除 shell-gpt-plus，请按以下步骤操作：
+
+1. **卸载 Python 包**  
+   ```bash
+   py -m pip uninstall shell-gpt-plus
+   ```
+
+2. **移除 Windows 快速调用配置（如已配置）**  
+   - 删除之前创建的 `sgpt.bat` 文件。  
+   - 从系统环境变量 `PATH` 中删除该文件所在目录（参考上方第2步进入环境变量设置）。
+
+3. **删除配置文件与缓存（可选）**  
+   - **Linux / macOS**：`rm ~/.config/shell_gpt`  
+   - **Windows**：手动删除 `C:\Users\你的用户名\.config\shell_gpt` 文件夹。
+
+
+
+###注意
+本项目AI没有上下文/记忆
+
+
+
+* * *
+
+# 以下为原版 README
+
+# ShellGPT
+A command-line productivity tool powered by AI large language models (LLM). This command-line tool offers streamlined generation of **shell commands, code snippets, documentation**, eliminating the need for external resources (like Google search). Supports Linux, macOS, Windows and compatible with all major Shells like PowerShell, CMD, Bash, Zsh, etc.
+
+https://github.com/TheR1D/shell_gpt/assets/16740832/721ddb19-97e7-428f-a0ee-107d027ddd59
+
+## Installation
+```shell
+pip install shell-gpt
+```
+By default, ShellGPT uses OpenAI's API and GPT-4 model. You'll need an API key, you can generate one [here](https://platform.openai.com/api-keys). You will be prompted for your key which will then be stored in `~/.config/shell_gpt/.sgptrc`. OpenAI API is not free of charge, please refer to the [OpenAI pricing](https://openai.com/pricing) for more information.
+
+> [!TIP]
+> Alternatively, you can run open-source models locally for free. This requires setting up your own LLM backend, such as [Ollama](https://github.com/ollama/ollama). To get ShellGPT working with Ollama, follow this detailed [guide](https://github.com/TheR1D/shell_gpt/wiki/Ollama)
+>
+> **❗️Note that ShellGPT is not optimized for local models and may not work as expected.**
+
+## 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 Fibonacci sequence is a series of numbers where each number ...
+```
+
+ShellGPT accepts prompt from both stdin and command line argument. Whether you prefer piping input through the terminal or specifying it directly as arguments, `sgpt` got you covered. For example, you can easily generate a git commit message based on a diff:
+```shell
+git diff | sgpt "Generate git commit message, for my changes"
+# -> Added main feature details into README.md
+```
+
+You can analyze logs from various sources by passing them using stdin, along with a prompt. For instance, we can use it to quickly analyze logs, identify errors and get suggestions for possible solutions:
+```shell
+docker logs -n 20 my_app | sgpt "check logs, find errors, provide possible solutions"
+```
+```text
+Error Detected: Connection timeout at line 7.
+Possible Solution: Check network connectivity and firewall settings.
+Error Detected: Memory allocation failed at line 12.
+Possible Solution: Consider increasing memory allocation or optimizing application memory usage.
+```
+
+You can also use all kind of redirection operators to pass input:
+```shell
+sgpt "summarise" < document.txt
+# -> The document discusses the impact...
+sgpt << EOF
+What is the best way to lear Golang?
+Provide simple hello world example.
+EOF
+# -> The best way to learn Golang...
+sgpt <<< "What is the best way to learn shell redirects?"
+# -> The best way to learn shell redirects is through...
+```
+
+
+### Shell commands
+Have you ever found yourself forgetting common shell commands, such as `find`, and needing to look up the syntax online? With `--shell` or shortcut `-s` option, you can quickly generate and execute the commands you need right in the terminal.
+```shell
+sgpt --shell "find all json files in current folder"
+# -> find . -type f -name "*.json"
+# -> [E]xecute, [D]escribe, [A]bort: e
+```
+
+Shell GPT is aware of OS and `$SHELL` you are using, it will provide shell command for specific system you have. For instance, if you ask `sgpt` to update your system, it will return a command based on your OS. Here's an example using macOS:
+```shell
+sgpt -s "update my system"
+# -> sudo softwareupdate -i -a
+# -> [E]xecute, [D]escribe, [A]bort: e
+```
+
+The same prompt, when used on Ubuntu, will generate a different suggestion:
+```shell
+sgpt -s "update my system"
+# -> sudo apt update && sudo apt upgrade -y
+# -> [E]xecute, [D]escribe, [A]bort: e
+```
+
+Let's try it with Docker:
+```shell
+sgpt -s "start nginx container, mount ./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
+```
+
+We can still use pipes to pass input to `sgpt` and generate shell commands:
+```shell
+sgpt -s "POST localhost with" < data.json
+# -> curl -X POST -H "Content-Type: application/json" -d '{"a": 1, "b": 2}' http://localhost
+# -> [E]xecute, [D]escribe, [A]bort: e
+```
+
+Applying additional shell magic in our prompt, in this example passing file names to `ffmpeg`:
+```shell
+ls
+# -> 1.mp4 2.mp4 3.mp4
+sgpt -s "ffmpeg combine $(ls -m) into one video file without audio."
+# -> 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
+```
+
+If you would like to pass generated shell command using pipe, you can use `--no-interaction` option. This will disable interactive mode and will print generated command to stdout. In this example we are using `pbcopy` to copy generated command to clipboard:
+```shell
+sgpt -s "find all json files in current folder" --no-interaction | pbcopy
+```
+
+
+### 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.
+
+### Generating code
+By using the `--code` or `-c` parameter, you can specifically request pure code output, for instance:
+```shell
+sgpt --code "solve fizz buzz problem using python"
+```
+
+```python
+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)
+```
+Since it is valid python code, we can redirect the output to a file:  
+```shell
+sgpt --code "solve classic fizz buzz problem using Python" > fizz_buzz.py
+python fizz_buzz.py
+# 1
+# 2
+# Fizz
+# 4
+# Buzz
+# ...
+```
+
+We can also use pipes to pass input:
+```shell
+cat fizz_buzz.py | sgpt --code "Generate comments for each line of my code"
+```
+```python
+# Loop through numbers 1 to 100
+for i in range(1, 101):
+    # Check if number is divisible by both 3 and 5
+    if i % 3 == 0 and i % 5 == 0:
+        # Print "FizzBuzz" if number is divisible by both 3 and 5
+        print("FizzBuzz")
+    # Check if number is divisible by 3
+    elif i % 3 == 0:
+        # Print "Fizz" if number is divisible by 3
+        print("Fizz")
+    # Check if number is divisible by 5
+    elif i % 5 == 0:
+        # Print "Buzz" if number is divisible by 5
+        print("Buzz")
+    # If number is not divisible by 3 or 5, print the number itself
+    else:
+        print(i)
+```
+
+### Chat Mode 
+Often it is important to preserve and recall a conversation. `sgpt` creates conversational dialogue with each LLM completion requested. The dialogue can develop one-by-one (chat mode) or interactively, in a REPL loop (REPL mode). Both ways rely on the same underlying object, called a chat session. The session is located at the [configurable](#runtime-configuration-file) `CHAT_CACHE_PATH`.
+
+To start a conversation, use the `--chat` option followed by a unique session name and a prompt.
+```shell
+sgpt --chat conversation_1 "please remember my favorite number: 4"
+# -> I will remember that your favorite number is 4.
+sgpt --chat conversation_1 "what would be my favorite number + 4?"
+# -> Your favorite number is 4, so if we add 4 to it, the result would be 8.
+```
+
+You can use chat sessions to iteratively improve GPT suggestions by providing additional details.  It is possible to use `--code` or `--shell` options to initiate `--chat`:
+```shell
+sgpt --chat conversation_2 --code "make a request to localhost using python"
+```
+```python
+import requests
+
+response = requests.get('http://localhost')
+print(response.text)
+```
+
+Let's ask LLM to add caching to our request:
+```shell
+sgpt --chat conversation_2 --code "add caching"
+```
+```python
+import requests
+from cachecontrol import CacheControl
+
+sess = requests.session()
+cached_sess = CacheControl(sess)
+
+response = cached_sess.get('http://localhost')
+print(response.text)
+```
+
+Same applies for shell commands:
+```shell
+sgpt --chat conversation_3 --shell "what is in current folder"
+# -> ls
+sgpt --chat conversation_3 "Sort by name"
+# -> ls | sort
+sgpt --chat conversation_3 "Concatenate them using FFMPEG"
+# -> ffmpeg -i "concat:$(ls | sort | tr '\n' '|')" -codec copy output.mp4
+sgpt --chat conversation_3 "Convert the resulting file into an MP3"
+# -> ffmpeg -i output.mp4 -vn -acodec libmp3lame -ac 2 -ab 160k -ar 48000 final_output.mp3
+```
+
+To list all the sessions from either conversational mode, use the `--list-chats` or `-lc` option:  
+```shell
+sgpt --list-chats
+# .../shell_gpt/chat_cache/conversation_1  
+# .../shell_gpt/chat_cache/conversation_2
+```
+
+To show all the messages related to a specific conversation, use the `--show-chat` option followed by the session name:
+```shell
+sgpt --show-chat conversation_1
+# user: please remember my favorite number: 4
+# assistant: I will remember that your favorite number is 4.
+# user: what would be my favorite number + 4?
+# assistant: Your favorite number is 4, so if we add 4 to it, the result would be 8.
+```
+
+### REPL Mode  
+There is very handy REPL (read–eval–print loop) mode, which allows you to interactively chat with GPT models. To start a chat session in REPL mode, use the `--repl` option followed by a unique session name. You can also use "temp" as a session name to start a temporary REPL session. Note that `--chat` and `--repl` are using same underlying object, so you can use `--chat` to start a chat session and then pick it up with `--repl` to continue the conversation in REPL mode.
+
+<p align="center">
+  <img src="https://s10.gifyu.com/images/repl-demo.gif" alt="gif">
+</p>
+
+```text
+sgpt --repl temp
+Entering REPL mode, press Ctrl+C to exit.
+>>> What is REPL?
+REPL stands for Read-Eval-Print Loop. It is a programming environment ...
+>>> How can I use Python with REPL?
+To use Python with REPL, you can simply open a terminal or command prompt ...
+```
+
+REPL mode can work with `--shell` and `--code` options, which makes it very handy for interactive shell commands and code generation:
+```text
+sgpt --repl temp --shell
+Entering shell REPL mode, type [e] to execute commands or press Ctrl+C to exit.
+>>> What is in current folder?
+ls
+>>> Show file sizes
+ls -lh
+>>> Sort them by file sizes
+ls -lhS
+>>> e (enter just e to execute commands, or d to describe them)
+```
+
+To provide multiline prompt use triple quotes `"""`:
+```text
+sgpt --repl temp
+Entering REPL mode, press Ctrl+C to exit.
+>>> """
+... Explain following code:
+... import random
+... print(random.randint(1, 10))
+... """
+It is a Python script that uses the random module to generate and print a random integer.
+```
+
+You can also enter REPL mode with initial prompt by passing it as an argument or stdin or even both:
+```shell
+sgpt --repl temp < my_app.py
+```
+```text
+Entering REPL mode, press Ctrl+C to exit.
+──────────────────────────────────── Input ────────────────────────────────────
+name = input("What is your name?")
+print(f"Hello {name}")
+───────────────────────────────────────────────────────────────────────────────
+>>> What is this code about?
+The snippet of code you've provided is written in Python. It prompts the user...
+>>> Follow up questions...
+```
+
+### Function calling  
+[Function calls](https://platform.openai.com/docs/guides/function-calling) is a powerful feature OpenAI provides. It allows LLM to execute functions in your system, which can be used to accomplish a variety of tasks. To install [default functions](https://github.com/TheR1D/shell_gpt/tree/main/sgpt/llm_functions/) run:
+```shell
+sgpt --install-functions
+```
+
+ShellGPT has a convenient way to define functions and use them. In order to create your custom function, navigate to `~/.config/shell_gpt/functions` and create a new .py file with the function name. Inside this file, you can define your function using this [example](https://github.com/TheR1D/shell_gpt/blob/main/sgpt/llm_functions/common/execute_shell.py).
+
+The docstring comment inside the class will be passed to OpenAI API as a description for the function, along with the `title` attribute and parameters descriptions. The `execute` function will be called if LLM decides to use your function. In this case we are allowing LLM to execute any Shell commands in our system. Since we are returning the output of the command, LLM will be able to analyze it and decide if it is a good fit for the prompt. Here is an example how the function might be executed by LLM:
+```shell
+sgpt "What are the files in /tmp folder?"
+# -> @FunctionCall execute_shell_command(shell_command="ls /tmp")
+# -> The /tmp folder contains the following files and directories:
+# -> test.txt
+# -> test.json
+```
+
+Note that if for some reason the function (execute_shell_command) will return an error, LLM might try to accomplish the task based on the output. Let's say we don't have installed `jq` in our system, and we ask LLM to parse JSON file:
+```shell
+sgpt "parse /tmp/test.json file using jq and return only email value"
+# -> @FunctionCall execute_shell_command(shell_command="jq -r '.email' /tmp/test.json")
+# -> 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.
+# -> @FunctionCall execute_shell_command(shell_command="jq -r '.email' /tmp/test.json")
+# -> The email value in /tmp/test.json is johndoe@example.
+```
+
+It is also possible to chain multiple function calls in the prompt:
+```shell
+sgpt "Play music and open hacker news"
+# -> @FunctionCall play_music()
+# -> @FunctionCall open_url(url="https://news.ycombinator.com")
+# -> Music is now playing, and Hacker News has been opened in your browser. Enjoy!
+```
+
+This is just a simple example of how you can use function calls. It is truly a powerful feature that can be used to accomplish a variety of complex tasks. We have dedicated [category](https://github.com/TheR1D/shell_gpt/discussions/categories/functions) in GitHub Discussions for sharing and discussing functions. 
+LLM might execute destructive commands, so please use it at your own risk❗️
+
+### Roles
+ShellGPT allows you to create custom roles, which can be utilized to generate code, shell commands, or to fulfill your specific needs. To create a new role, use the `--create-role` option followed by the role name. You will be prompted to provide a description for the role, along with other details. This will create a JSON file in `~/.config/shell_gpt/roles` with the role name. Inside this directory, you can also edit default `sgpt` roles, such as **shell**, **code**, and **default**. Use the `--list-roles` option to list all available roles, and the `--show-role` option to display the details of a specific role. Here's an example of a custom role:
+```shell
+sgpt --create-role json_generator
+# Enter role description: Provide only valid json as response.
+sgpt --role json_generator "random: user, password, email, address"
+```
+```json
+{
+  "user": "JohnDoe",
+  "password": "p@ssw0rd",
+  "email": "johndoe@example.com",
+  "address": {
+    "street": "123 Main St",
+    "city": "Anytown",
+    "state": "CA",
+    "zip": "12345"
+  }
+}
+```
+
+If the description of the role contains the words "APPLY MARKDOWN" (case sensitive), then chats will be displayed using markdown formatting unless it is explicitly turned off with `--no-md`.
+
+### Request cache
+Control cache using `--cache` (default) and `--no-cache` options. This caching applies for all `sgpt` requests to OpenAI API:
+```shell
+sgpt "what are the colors of a rainbow"
+# -> The colors of a rainbow are red, orange, yellow, green, blue, indigo, and violet.
+```
+Next time, same exact query will get results from local cache instantly. Note that `sgpt "what are the colors of a rainbow" --temperature 0.5` will make a new request, since we didn't provide `--temperature` (same applies to `--top-probability`) on previous request.
+
+This is just some examples of what we can do using OpenAI GPT models, I'm sure you will find it useful for your specific use cases.
+
+### 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
+# Base URL of the backend server. If "default" URL will be resolved based on --model.
+API_BASE_URL=default
+# Max amount of cached message per chat session.
+CHAT_CACHE_LENGTH=100
+# Chat cache folder.
+CHAT_CACHE_PATH=/tmp/shell_gpt/chat_cache
+# Request cache length (amount).
+CACHE_LENGTH=100
+# Request cache folder.
+CACHE_PATH=/tmp/shell_gpt/cache
+# Request timeout in seconds.
+REQUEST_TIMEOUT=60
+# Default OpenAI model to use.
+DEFAULT_MODEL=gpt-5.4-mini
+# Default color for shell and code completions.
+DEFAULT_COLOR=magenta
+# When in --shell mode, default to "Y" for no input.
+DEFAULT_EXECUTE_SHELL_CMD=false
+# Disable streaming of responses
+DISABLE_STREAMING=false
+# The pygment theme to view markdown (default/describe role).
+CODE_THEME=default
+# Path to a directory with functions.
+OPENAI_FUNCTIONS_PATH=/Users/user/.config/shell_gpt/functions
+# Print output of functions when LLM uses them.
+SHOW_FUNCTIONS_OUTPUT=false
+# Allows LLM to use functions.
+OPENAI_USE_FUNCTIONS=true
+# Enforce LiteLLM usage (for local LLMs).
+USE_LITELLM=false
+```
+Possible options for `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.
+Possible options for `CODE_THEME`: https://pygments.org/styles/
+
+### Full list of arguments
+```text
+╭─ Arguments ──────────────────────────────────────────────────────────────────────────────────────────────╮
+│   prompt      [PROMPT]  The prompt to generate completions for.                                          │
+╰──────────────────────────────────────────────────────────────────────────────────────────────────────────╯
+╭─ Options ────────────────────────────────────────────────────────────────────────────────────────────────╮
+│ --model            TEXT                       Large language model to use. [default: gpt-5.4-mini]       │
+│ --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.                                                                │
+╰──────────────────────────────────────────────────────────────────────────────────────────────────────────╯
+```
+
+## 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.
+```shell
+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:
+```shell
+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:
+```shell
+docker build -t sgpt .
+```
+
+## Additional documentation
+* [Azure integration](https://github.com/TheR1D/shell_gpt/wiki/Azure)
+* [Ollama integration](https://github.com/TheR1D/shell_gpt/wiki/Ollama)