Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/emilamaj/good-gpt
AI command line assistant. Describe what you want to do and a command is generated
https://github.com/emilamaj/good-gpt
ai assistant chatgpt command-line-tool openai
Last synced: 16 days ago
JSON representation
AI command line assistant. Describe what you want to do and a command is generated
- Host: GitHub
- URL: https://github.com/emilamaj/good-gpt
- Owner: emilamaj
- Created: 2024-03-06T23:16:32.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-04-19T20:08:54.000Z (9 months ago)
- Last Synced: 2024-12-11T07:37:44.333Z (about 1 month ago)
- Topics: ai, assistant, chatgpt, command-line-tool, openai
- Language: Python
- Homepage:
- Size: 12.7 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# gg good-gpt
AI Baked into your command-line terminal: describe what you want to do and the assistant will execute the corresponding command for you.
```bash
user@ubuntu:~$ gg list current processes by RAM usage
Do you want to execute this suggested command for linux? [y/n]
--> ps aux --sort=-rss
USER PID %CPU %MEM VSZ RSS TTY STAT START TIME COMMAND
user0 2942 1.0 0.2 38204 21308 tty3 S 11:57 0:00 /usr/bin/python3 /home/user0/.local/bin/gg list current processes by RAM usage
root 2831 0.0 0.0 19884 5396 pts/2 S 11:13 0:00 ssh RemoteHost
root 2728 49.3 0.0 19888 5088 ? R 09:20 78:02 ssh RemoteHost
...
```
## Installation
This tool is built using python. It has been tested on python 3.10 on both windows and linux.
To install Python, visit [python.org](https://www.python.org/downloads/)
After installing python, you can install the `good-gpt` package using pip
```bash
pip install good-gpt
```
or if you have multiple python installations:
```bash
pip3 install good-gpt
```
This will install the package, but you may not yet have the `gg` command available in your terminal at this point.
For that, you need to add the installation location to your PATH environment variable.
The installation location by default is `%APPDATA%\Python\Python3XX\Scripts\Lib\site-packages\good_gpt` on Windows and `$HOME/.local/lib/python3.XX/site-packages/good_gpt/` on linux.
If PATH is not correctly set, you need to run the `post_install.py` script to add the installation location to your PATH.
For that, find the location of the `post_install.py` script using the following command:
```bash
pip show good-gpt
```
and then navigate to the folder pointed by the `Location` field, and then navigate to the `good_gpt` folder, where you will find the `post_install.py` script.
Then run the script using the following command:
```bash
python post_install.py
```
or if you have multiple python installations:
```bash
python3 post_install.py
```
With the directory added to your PATH, you now simply need to restart your terminal to use the `gg` command. You can also run the following command to refresh the PATH environment variable, depending on your terminal:
```bash
source ~/.bashrc
```
or
```bash
source ~/.zshrc
```
Windows does not require a refresh, but you may need to close and reopen the terminal.
## Usage
On the first run, you will be asked to provide your OpenAI API key. You can get the API key by signing up at [openai.com](https://beta.openai.com/signup/) and generating an API key at [openai.com/account/api-keys](https://platform.openai.com/account/api-keys).
Simply paste the API key when prompted and press enter. The API key will be stored in openai_api_key.env in the same folder as the gg command.
Here is an example on Windows 10:
```bash
C:\Users\user> gg current external ip address, only ipv4
Do you want to execute this suggested command for win32? [y/n]
--> curl ifconfig.me/ip -4
72.88.25.127
```
Here is an example on Ubuntu 20.04:
```bash
user@ubuntu:~$ gg current external ip address, only ipv4
Do you want to execute this suggested command for linux? [y/n]
--> dig +short myip.opendns.com @resolver1.opendns.com -4
yes
72.88.25.127
```