Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tbckr/sgpt
SGPT is a command-line tool that provides a convenient way to interact with OpenAI models, enabling users to run queries, generate shell commands and produce code directly from the terminal.
https://github.com/tbckr/sgpt
bash cli go gpt-3 gpt-4 gpt-4-vision gpt-4-vision-preview gpt-4o openai shell
Last synced: 4 days ago
JSON representation
SGPT is a command-line tool that provides a convenient way to interact with OpenAI models, enabling users to run queries, generate shell commands and produce code directly from the terminal.
- Host: GitHub
- URL: https://github.com/tbckr/sgpt
- Owner: tbckr
- License: mit
- Created: 2023-02-25T19:21:49.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-05-22T13:46:30.000Z (6 months ago)
- Last Synced: 2024-05-22T22:09:07.324Z (6 months ago)
- Topics: bash, cli, go, gpt-3, gpt-4, gpt-4-vision, gpt-4-vision-preview, gpt-4o, openai, shell
- Language: Go
- Homepage:
- Size: 1.17 MB
- Stars: 181
- Watchers: 4
- Forks: 21
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
README
# SGPT
[](https://github.com/tbckr/sgpt/releases/latest)
[](/LICENSE.md)
[](https://codecov.io/gh/tbckr/sgpt)
[](https://goreportcard.com/report/github.com/tbckr/sgpt/v2)
[](http://godoc.org/github.com/tbckr/sgpt)
[](https://github.com/goreleaser)
[](https://sgpt.readthedocs.io/)
[](https://conventionalcommits.org)
[](https://github.com/gitleaks/gitleaks-action)
SGPT (*aka shell-gpt*) is a powerful command-line interface (CLI) tool designed for seamless interaction with OpenAI
models directly from your terminal. Effortlessly run queries, generate shell commands or code, create images from text,
and more, using simple commands. Streamline your workflow and enhance productivity with this powerful and user-friendly
CLI tool.
Developed with the help of [SGPT](https://github.com/tbckr/sgpt).
This is a Go implementation. For the original Python implementation,
visit [shell-gpt](https://github.com/TheR1D/shell_gpt). Please keep this in mind when reporting issues.
- [Features](#features)
- [Installation](#installation)
- [Linux](#linux)
- [macOS](#macos)
- [Windows](#windows)
- [Using Go](#using-go)
- [Docker](#docker)
- [Ansible](#ansible)
- [Other platforms](#other-platforms)
- [Usage Guide](#usage-guide)
- [Getting started: Obtaining an OpenAI API Key](#getting-started-obtaining-an-openai-api-key)
- [Querying OpenAI Models](#querying-openai-models)
- [GPT-4o and GPT-4 Vision API Support](#gpt-4o-and-gpt-4-vision-api-support)
- [Chat Capabilities](#chat-capabilities)
- [Generating and Executing Shell Commands](#generating-and-executing-shell-commands)
- [Interactive Shell Sessions](#interactive-shell-sessions)
- [Code Generation Capabilities](#code-generation-capabilities)
- [Enhancing Your Workflow with Bash Aliases and Functions](#enhancing-your-workflow-with-bash-aliases-and-functions)
- [Acknowledgements](#acknowledgements)
## Features
- **Instant Answers:** Obtain quick and accurate responses to simple questions directly in your shell, streamlining your
workflow.
- **GPT-4o Integration:** Access the capabilities of the [GPT-4o API](https://platform.openai.com/docs/models/gpt-4o)
to generate detailed and informative responses.
- **GPT-4 Vision API:** Leverage the capabilities of
the [GPT-4 Vision API](https://platform.openai.com/docs/guides/vision) to analyze and generate insights from images.
- **Shell Commands Generation:** Effortlessly generate and execute shell commands, simplifying complex tasks and
enhancing
productivity.
- **Code Production:** Generate code snippets in various programming languages, making it easier to learn new languages
or
find solutions to coding problems.
- **ChatGPT Integration:** Utilize ChatGPT's interactive chat capabilities to refine your prompts and achieve more
precise
results, benefiting from the powerful language model.
- **Bash Functions and Aliases:** Seamlessly integrate SGPT responses into custom bash functions and aliases, optimizing
your workflows and making your daily tasks more efficient.
By offering these versatile features, SGPT serves as a powerful tool to enhance your overall productivity, streamline
your workflow, and simplify complex tasks.
## Installation
### Linux
SGPT has been tested on Ubuntu LTS releases and is expected to be compatible with the following Linux
distributions:
- Debian
- Ubuntu
- Arch Linux
- Fedora
To install, download the latest release from the [release page](https://github.com/tbckr/sgpt/releases) and use the
package manager specific to your distribution.
### macOS
For users with Homebrew as their package manager, run the following command in the terminal:
```shell
brew install tbckr/tap/sgpt
```
### Windows
For users with Scoop as their package manager, execute these commands in PowerShell:
```shell
scoop bucket add tbckr https://github.com/tbckr/scoop-bucket.git
scoop install tbckr/sgpt
```
### Using Go
To install SGPT with Go, based on the git tag, use this command:
```shell
go install github.com/tbckr/sgpt/v2/cmd/sgpt@latest
```
### Docker
To run SGPT with Docker, use the following command to pull the latest image:
```shell
docker pull ghcr.io/tbckr/sgpt:latest
```
Examples on how to use SGPT with Docker can be found [here](https://sgpt.readthedocs.io/en/latest/usage/docker/).
### Ansible
To install SGPT with Ansible, you can use the following ansible playbook as your base and adapt accordingly:
```yaml
---
- hosts: all
tasks:
- name: Get latest sgpt release
uri:
url: "https://api.github.com/repos/tbckr/sgpt/releases/latest"
return_content: yes
register: sgpt_release
- name: Set latest version of sgpt
set_fact:
sgpt_latest_version: "{{ sgpt_release.json.tag_name }}"
- name: Install sgpt for debian based, amd64 systems
ansible.builtin.apt:
deb: https://github.com/tbckr/sgpt/releases/download/{{ sgpt_latest_version }}/sgpt_{{ sgpt_latest_version[1:] }}_amd64.deb
allow_unauthenticated: true
```
The playbook can be run with the following command:
```shell
ansible-playbook -i .yml
```
The latest version of the playbook can be found [here](https://github.com/tbckr/sgpt/blob/main/playbook.yml).
### Other platforms
For other platforms, visit the GitHub [release page](https://github.com/tbckr/sgpt/releases) and download the latest
release suitable for your system.
## Usage Guide
See the [documentation](https://sgpt.readthedocs.io/en/stable/) for detailed usage instructions.
### Getting started: Obtaining an OpenAI API Key
To use the OpenAI API, you must first obtain an API key.
1. Visit [https://platform.openai.com/overview](https://platform.openai.com/overview) and sign up for an account.
2. Navigate to [https://platform.openai.com/account/api-keys](https://platform.openai.com/account/api-keys) and generate
a new API key.
3. On Linux or macOS: Update your `.bashrc` or `.zshrc` file to include the following export statement adding your API
key as the value:
```shell
export OPENAI_API_KEY="sk-..."
```
1. On Windows: [Update your environment variables](https://geekflare.com/system-environment-variables-in-windows/) to
include the `OPENAI_API_KEY` variable with your API key as the value.
After completing these steps, you'll have an OpenAI API key that can be used to interact with the OpenAI models through
the SGPT tool.
**Note:** Your API key is sensitive information. Do not share it with anyone.
### Querying OpenAI Models
SGPT allows you to ask simple questions and receive informative answers. For example:
```shell
$ sgpt "mass of sun"
The mass of the sun is approximately 1.989 x 10^30 kilograms.
```
You can also pass prompts to SGPT using pipes:
```shell
$ echo -n "mass of sun" | sgpt
The mass of the sun is approximately 1.989 x 10^30 kilograms.
```
You can also add another prompt to the piped data by specifying the `stdin` modifier and then specifying the prompt:
```shell
$ echo "Say: Hello World!" | sgpt stdin 'Replace every "World" word with "ChatGPT"'
Hello ChatGPT!
```
If you want to stream the completion to the command line, you can add the `--stream` flag. This will stream the output
to the command line as it is generated.
### GPT-4o and GPT-4 Vision API Support
SGPT additionally facilitates the utilization of the GPT-4o and GPT-4 Vision API. Include input images using the `-i`
or `--input` flag, supporting both URLs and local images.
```shell
$ sgpt -m "gpt-4o" -i pkg/fs/testdata/marvin.jpg "what can you see on the picture?"
The picture shows a robot with a large, round head and an expressive, downward-slanting triangular eye. The body of the robot is designed with a sleek, somewhat shiny, metallic structure and it is pointing with its right hand. The design appears to be humanoid with distinct arms, legs, and a segmented torso.
$ sgpt -m "gpt-4-vision-preview" -i "https://upload.wikimedia.org/wikipedia/en/c/cb/Marvin_%28HHGG%29.jpg" "what can you see on the picture?"
The image shows a figure resembling a robot with a humanoid form. It has a
```
It is also possible to combine URLs and local images:
```shell
$ sgpt -m "gpt-4o" -i "https://upload.wikimedia.org/wikipedia/en/c/cb/Marvin_%28HHGG%29.jpg" -i pkg/fs/testdata/marvin.jpg "what is the difference between those two pictures"
The two pictures you provided appear to be identical. There are no visible differences between them. Both show the same character in the same pose with the same lighting and background.
```
You can also set the default model to GPT-4o or GPT-4 Vision by setting it in
the [configuration file](https://sgpt.readthedocs.io/en/stable/configuration/).
**Important:** The GPT-4o and GPT-4-vision API integration is currently in beta and may change in the future.
### Chat Capabilities
SGPT provides chat functionality that enables interactive conversations with OpenAI models. You can use the `--chat`
flag to initiate and reference chat sessions.
The chat capabilities allow you to interact with OpenAI models in a more dynamic and engaging way, making it
easier to obtain relevant responses, code, or shell commands through continuous conversations.
The example below demonstrates how to fine-tune the model's responses for more targeted outcomes.
1. The first command initiates a chat session named `ls-files` and asks the model to "list all files directory":
```shell
$ sgpt sh --chat ls-files "list all files directory"
ls
```
1. The second command continues the conversation within the `ls-files` chat session and requests to "sort by name":
```shell
$ sgpt sh --chat ls-files "sort by name"
ls | sort
```
The model provides the appropriate shell command `ls | sort`, which lists all files in a directory and sorts them by
name.
### Generating and Executing Shell Commands
SGPT can generate shell commands based on your input:
```shell
$ sgpt sh "make all files in current directory read only"
chmod -R 444 *
```
You can also generate a shell command and execute it directly:
```shell
$ sgpt sh --execute "make all files in current directory read only"
chmod -R 444 *
Do you want to execute this command? (Y/n) y
```
The `sh` command is a default persona to generate shell commands. For more information on personas, see
the [docs](https://sgpt.readthedocs.io/en/latest/usage/personas/).
### Interactive Shell Sessions
Currently, SGPT does not support interactive shell sessions. However, `rlwrap` can be used to enable
interactive-like shell sessions ([source](https://github.com/tbckr/sgpt/issues/111#issuecomment-1869814041)):
```text
$ rlwrap bash -c 'echo ▶; while read in; do [[ -n "$in" ]] && echo ■ && sgpt --chat chat_name "$in" && echo ▶; done'
▶
mass of sun
■
The mass of the Sun is approximately 1.989 x 10^30 kilograms, or about 330,000 times the mass of Earth. It contains about 99.86% of the total mass of the Solar System and is by far the most dominant object in it. The Sun's mass is composed mostly of hydrogen (~74%) and helium (~24%), with the remaining 2% consisting of heavier elements.
▶
convert to earth masses
■
To convert the mass of the Sun to Earth masses, you can simply divide the Sun's mass by the mass of the Earth. Given that:
A. The Sun's mass is approximately 1.989 x 10^30 kilograms.
B. The Earth's mass is approximately 5.972 x 10^24 kilograms.
Using these values, you can calculate how many Earth masses the Sun is:
(1.989 x 10^30 kg) / (5.972 x 10^24 kg/Earth) = approximately 333,000 Earth masses
So the Sun is about 333,000 times more massive than the Earth.
▶
```
A script with automated session name generation and notification support could look like this:
```shell
#!/usr/bin/env bash
shopt -s -o errexit
shopt -s -o pipefail
shopt -s -o nounset
shopt -s inherit_errexit
export CHAT="$(date '+%Y%m%d%H%M%S%3N')_$(tr -dc 'A-Za-z' "`.
This function is meant to automate the commit process and increase productivity in daily work.
Additionally, updated the README.md file to include information about the new bash function and added a section to
showcase useful bash aliases and functions found in `.bash_aliases`.
Do you want to commit your changes with this commit message? [y/N] y
[main d6db80a] feat: Add bash function to generate git commit messages
2 files changed, 48 insertions(+)
create mode 100644 .bash_aliases
```
A compilation of beneficial bash aliases and functions, including an updated gsum function, is available
in [.bashrc](.bashrc).
## Acknowledgements
Inspired by [shell-gpt](https://github.com/TheR1D/shell_gpt).