Package: gigashell
GigaShellОнлайн-инструмент для повышения продуктивности, работающий на основе больших языковых моделей. Как разработчики, мы можем использовать возможности ИИ для генерации команд оболочки, фрагментов кода, комментариев и документации, среди прочего. Забудьте о шпаргалках и заметках, с помощью этого инструмента вы можете получить точные ответы прямо в своем терминале, и вы, вероятно, обнаружите, что сокращаете свои ежедневные поиски в Google, экономя ваше драгоценное время и усилия. GigaShell совместим с несколькими платформами и поддерживает все основные операционные системы, включая Linux, macOS и Windows, а также все основные оболочки, такие как PowerShell, CMD, Bash, Zsh, Fish и многие другие.Является форком библиотекиShellGPT, адаптированым для русского языка и работы с GigaChatInstallationpipinstallgigashellUsagegigahas a variety of use cases, including simple queries, shell queries, and code queries.Simple queriesWe can use it as normal search engine, asking about anything:giga"nginx default config file location"# -> The default configuration file for Nginx is located at /etc/nginx/nginx.conf.giga"mass of sun"# -> = 1.99 × 10^30 kggiga"1 hour and 30 minutes to seconds"# -> 5,400 secondsSummarization and analyzingGigaShell accepts prompt from both stdin and command line argument, you choose the most convenient input method for your preferences. Whether you prefer piping input through the terminal or specifying it directly as arguments,gigagot you covered. This versatile feature is particularly useful when you need to pass file content or pipe output from other commands to the LLM models for summarization or analysis. For example, you can easily generate a git commit message based on a diff:gitdiff|giga"Generate git commit message, for my changes"# -> Commit message: Implement Model enum and get_edited_prompt()You can analyze logs from various sources by passing them using stdin or command line arguments, along with a user-friendly prompt. This enables you to quickly identify errors and get suggestions for possible solutions:dockerlogs-n20container_name|giga"check logs, find errors, provide possible solutions"# ...This powerful feature simplifies the process of managing and understanding data from different sources, making it easier for you to focus on what really matters: improving your projects and applications.Shell commandsHave you ever found yourself forgetting common shell commands, such aschmod, and needing to look up the syntax online? With--shellor shortcut-soption, you can quickly find and execute the commands you need right in the terminal.giga--shell"make all files in current directory read only"# -> chmod 444 *# -> [E]xecute, [D]escribe, [A]bort: e...GigaShell is aware of OS and$SHELLyou are using, it will provide shell command for specific system you have. For instance, if you askgigato update your system, it will return a command based on your OS. Here's an example using macOS:giga-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:giga-s"update my system"# -> sudo apt update && sudo apt upgrade -y# -> [E]xecute, [D]escribe, [A]bort: e...We can ask LLM to describe suggested shell command, it will provide a short description of what the command does:giga-s"show all txt files in current folder"# -> ls *.txt# -> [E]xecute, [D]escribe, [A]bort: d# -> List all files with .txt extension in current directory# -> [E]xecute, [D]escribe, [A]bort: e...Let's try some docker containers:giga-s"start nginx using docker, forward 443 and 80 port, mount current folder with index.html"# -> docker run -d -p 443:443 -p 80:80 -v $(pwd):/usr/share/nginx/html nginx# -> [E]xecute, [D]escribe, [A]bort: e...We can still use pipes to pass input togigaand get shell commands as output:catdata.json|giga-s"curl localhost with provided json"# -> curl -X POST -H "Content-Type: application/json" -d '{"a": 1, "b": 2, "c": 3}' http://localhostWe can apply additional shell magic in our prompt, in this example passing file names to ffmpeg:ls# -> 1.mp4 2.mp4 3.mp4giga-s"using ffmpeg combine multiple videos into one without audio. Video file names:$(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 integrationShell integration allows you to use GigaShell in your terminal with hotkeys. It is currently available for bash and zsh. It will allow you to have giga completions in your shell history, and also edit suggested commands right away.https://github.com/TheR1D/shell_gpt/assets/16740832/bead0dab-0dd9-436d-88b7-6abfb2c556c1To install shell integration, run:giga--install-integration# Restart your terminal to apply changes.This will add few lines to your.bashrcor.zshrcfile. After that, you can useCtrl+l(by default) to invoke GigaShell. When you pressCtrl+lit will replace you current input line (buffer) with suggested command. You can then edit it and pressEnterto execute.Generating codeWith--codeparameters we can query only code as output, for example:giga--code"Solve classic fizz buzz problem using Python"foriinrange(1,101):ifi%3==0andi%5==0:print("FizzBuzz")elifi%3==0:print("Fizz")elifi%5==0:print("Buzz")else:print(i)Since it is valid python code, we can redirect the output to file:giga--code"solve classic fizz buzz problem using Python">fizz_buzz.py
pythonfizz_buzz.py# 1# 2# Fizz# 4# Buzz# Fizz# ...We can also use pipes to pass input togiga:catfizz_buzz.py|giga--code"Generate comments for each line of my code"# Loop through numbers 1 to 100foriinrange(1,101):# Check if number is divisible by both 3 and 5ifi%3==0andi%5==0:# Print "FizzBuzz" if number is divisible by both 3 and 5print("FizzBuzz")# Check if number is divisible by 3elifi%3==0:# Print "Fizz" if number is divisible by 3print("Fizz")# Check if number is divisible by 5elifi%5==0:# Print "Buzz" if number is divisible by 5print("Buzz")# If number is not divisible by 3 or 5, print the number itselfelse:print(i)Conversational Modes - OverviewOften it is important to preserve and recall a conversation and this is kept track of locally.gigacreates 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 theconfigurableCHAT_CACHE_PATH.Listing and Showing Chat SessionsDialogues had in both REPL and chat mode are saved as chat sessions.To list all the sessions from either conversational mode, use the--list-chatsoption:giga--list-chats# .../gigashell/chat_cache/number# .../gigashell/chat_cache/python_requestTo show all the messages related to a specific conversation, use the--show-chatoption followed by the session name:giga--show-chatnumber# 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.Chat ModeTo start a chat session, use the--chatoption followed by a unique session name and a prompt. You can also use "temp" as a session name to start a temporary chat session.giga--chatnumber"please remember my favorite number: 4"# -> I will remember that your favorite number is 4.giga--chatnumber"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 also use chat sessions to iteratively improve LLM suggestions by providing additional clues.giga--chatpython_request--code"make an example request to localhost using Python"importrequestsresponse=requests.get('http://localhost')print(response.text)Asking AI to add a cache to our request.giga--chatpython_request--code"add caching"importrequestsfromcachecontrolimportCacheControlsess=requests.session()cached_sess=CacheControl(sess)response=cached_sess.get('http://localhost')print(response.text)We can use--codeor--shelloptions to initiate--chat, so you can keep refining the results:giga--chatsh--shell"What are the files in this directory?"# -> lsgiga--chatsh"Sort them by name"# -> ls | sortgiga--chatsh"Concatenate them using FFMPEG"# -> ffmpeg -i "concat:$(ls | sort | tr '\n' '|')" -codec copy output.mp4giga--chatsh"Convert the resulting file into an MP3"# -> ffmpeg -i output.mp4 -vn -acodec libmp3lame -ac 2 -ab 160k -ar 48000 final_output.mp3REPL ModeThere is very handy REPL (read–eval–print loop) mode, which allows you to interactively chat with LLM models. To start a chat session in REPL mode, use the--reploption followed by a unique session name. You can also use "temp" as a session name to start a temporary REPL session. Note that--chatand--replare using same chat sessions, so you can use--chatto start a chat session and then use--replto continue the conversation in REPL mode. REPL mode will also show history of your conversation in the beginning.giga --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--shelland--codeoptions, which makes it very handy for interactive shell commands and code generation:giga --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)
...Example of using REPL mode to generate code:giga --repl temp --code
Entering REPL mode, press Ctrl+C to exit.
>>> Using Python request localhost:80
import requests
response = requests.get('http://localhost:80')
print(response.text)
>>> Change port to 443
import requests
response = requests.get('https://localhost:443')
print(response.text)Picking up on a chat mode conversation with REPL modegiga --repl number
───── Chat History──────
user: ###
Role name: default
You are Command Line App GigaShell, a programming and system administration assistant.
You are managing Darwin/MacOS 13.3.1 operating system with zsh shell.
Provide only plain text without Markdown formatting.
Do not show any warnings or information regarding your capabilities.
If you need to store any data, assume it will be stored in the chat.

Request: please remember my favorite number: 4
###
assistant: Sure, I have stored your favorite number as 4.
user: what would be my favorite number raised to the power of 4
assistant: Your favorite number raised to the power of 4 would be 256.
────────────────────────────────────────────────────────
Entering REPL mode, press Ctrl+C to exit.
>>> What is the sum of my favorite number and your previous response?
The sum of your favorite number (4) and my previous response (256) would be 260.RolesGigaShell 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-roleoption 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/gigashell/roleswith the role name. Inside this directory, you can also edit defaultgigaroles, such asshell,code, anddefault. Use the--list-rolesoption to list all available roles, and the--show-roleoption to display the details of a specific role. Here's an example of a custom role:giga--create-rolejson# Enter role description: You are JSON generator, provide only valid json as response.# Enter expecting result, e.g. answer, code, shell command, etc.: jsongiga--rolejson"random: user, password, email, address"{"user":"JohnDoe","password":"p@ssw0rd","email":"johndoe@example.com","address":{"street":"123 Main St","city":"Anytown","state":"CA","zip":"12345"}}Request cacheControl cache using--cache(default) and--no-cacheoptions. This caching applies for allgigarequests to OpenAI API:giga"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 thatgiga "what are the colors of a rainbow" --temperature 0.5will 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 fileYou can setup some parameters in runtime configuration file~/.config/gigashell/.gigarc:# Credentionals to access GigaChat
GIGA_USERNAME=your username
GIGA_PASSWORD=your password
# OpenAI host, useful if you would like to use proxy.
GIGACHAT_API_HOST=https://...
# Max amount of cached message per chat session.
CHAT_CACHE_LENGTH=100
# Chat cache folder.
CHAT_CACHE_PATH=/tmp/gigashell/chat_cache
# Request cache length (amount).
CACHE_LENGTH=100
# Request cache folder.
CACHE_PATH=/tmp/gigashell/cache
# Request timeout in seconds.
REQUEST_TIMEOUT=60
# Default OpenAI model to use.
DEFAULT_MODEL=GigaChat70:latest
# Default color for OpenAI completions.
DEFAULT_COLOR=magenta
# Force use system role messages (not recommended).
SYSTEM_ROLES=false
# When in --shell mode, default to "Y" for no input.
DEFAULT_EXECUTE_SHELL_CMD=false
# Disable streaming of responses
DISABLE_STREAMING=falsePossible options forDEFAULT_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.SwitchSYSTEM_ROLESto force usesystem rolesmessages, this is not recommended, since it doesn't perform well with current LLM models.Full list of arguments╭─ Arguments ─────────────────────────────────────────────────────────────────────────────────────────────────╮
│   prompt      [PROMPT]  The prompt to generate completions for.                                             │
╰─────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Options ───────────────────────────────────────────────────────────────────────────────────────────────────╮
│ --model            TEXT                             GigaChat model to use. [default: GigaChat70:latest]     │
│ --temperature      FLOAT RANGE [0.0<=x<=2.0]        Randomness of generated output. [default: 0.1]          │
│ --top-probability  FLOAT RANGE [0.1<=x<=1.0]        Limits highest probable tokens (words). [default: 1.0]  │
│ --editor                                            Open $EDITOR to provide a prompt. [default: no-editor]  │
│ --cache                                             Cache completion results. [default: cache]              │
│ --help                                              Show this message and exit.                             │
╰─────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Assistance Options ────────────────────────────────────────────────────────────────────────────────────────╮
│ --shell  -s                 Generate and execute shell commands.                                            │
│ --describe-shell  -d        Describe a shell command.                                                       │
│ --code       --no-code      Generate only code. [default: no-code]                                          │
╰─────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ 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        List all existing chat ids. [default: no-list-chats]                                    │
╰─────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Role Options ──────────────────────────────────────────────────────────────────────────────────────────────╮
│ --role         TEXT  System role for LLM model. [default: None]                                             │
│ --create-role  TEXT  Create role. [default: None]                                                           │
│ --show-role    TEXT  Show role. [default: None]                                                             │
│ --list-roles         List roles. [default: no-list-roles]                                                   │
╰─────────────────────────────────────────────────────────────────────────────────────────────────────────────╯