Home

Welcome to the ShellGPT wiki!

Here, you can find solutions for common problems and get answers to frequently asked questions.

Changing API Key

If you need to change your API key, run:

rm ~/.config/shell_gpt/.sgptrc

Followed by

sgpt "anything"

sgpt will ask you for new API key.

Usage without quotes

If you would like to execute the prompt without having to add quote characters (" ") around the input text, you can add a function to your shell configuration files:

function sgpt () {
    sgpt "$*"
}

HTTPErrors

500+ Server Errors

Please check OpenAI's status page and make sure the API service is operational. If it is down, wait until OpenAI will solve the issue on their side.

429 Too Many Requests

Usually it happens during high traffic and overload on OpenAI servers, more details here. It also might happen because of OpenAI API limitations. You can read more about request limits here You can track your usage in the dashboard Note that limitation applies on both OpenAI's playground and this tools which is using their API.

From OpenAI documentation:

CODE	OVERVIEW
429 - You exceeded your current quota, please check your plan and billing details	Cause: You have hit your maximum monthly spend (hard limit) which you can view in the account billing section. Solution: Apply for a quota increase.
429 - Rate limit reached for requests	Cause: You are sending requests too quickly. Solution: Pace your requests. Read the Rate limit guide.
429 - The engine is currently overloaded, please try again later	Cause: Our servers are experiencing high traffic. Solution: Please retry your requests after a brief wait.

401 Unauthorized

Make sure you have valid API key ~/.config/shell_gpt/.sgptrc.

Socks5 proxy

Edit client.py: ~/.local/lib/python3.x/site-packages/sgpt$ nano client.py

By adding below code:

import socks
import socket

# Define the proxy server URL and port number
proxy_host = '<proxy-server-url>'
proxy_port = <port>
proxy_username = '<username>'
proxy_password = '<password>'

# Set up the SOCKS5 proxy with authentication
socks.set_default_proxy(socks.SOCKS5, proxy_host, proxy_port, username=proxy_username, password=proxy_password)
socket.socket = socks.socksocket

FAQ

Does it know how to exit vim?

Yes it does.