How to use the command sgpt (with examples)

The sgpt command is a command-line productivity tool powered by OpenAI’s GPT models. It allows users to perform various tasks such as searching the web, executing shell commands, generating code, starting chat sessions, and more.

Use case 1: Use it as a search engine, asking for the mass of the sun

Code:

sgpt "mass of the sun"

Motivation: Sometimes, it can be time-consuming to search for information on the web manually. By using the sgpt command as a search engine, you can quickly get the answer to your query without leaving the command line interface.

Explanation: In this use case, the sgpt command is used with the search query “mass of the sun”. The command sends the query to the OpenAI GPT model, which generates a response based on the input.

Example output:

The mass of the Sun is approximately 1.989 x 10^30 kilograms.

Use case 2: Execute Shell commands and apply chmod 444 to all files in the current directory

Code:

sgpt --shell "make all files in current directory read only"

Motivation: Changing file permissions manually can be a tedious task, especially when dealing with a large number of files. The sgpt command can automate this process by executing shell commands.

Explanation: In this use case, the sgpt command is used with the --shell argument and the shell command “make all files in current directory read only”. The command runs the specified shell command, chmod 444, on all the files in the current directory. This makes the files read-only for all users.

Example output:

All files in the current directory have been made read-only.

Use case 3: Generate code, solving the classic fizz buzz problem

Code:

sgpt --code "solve fizz buzz problem using Python"

Motivation: The fizz buzz problem is a common programming problem that can be used to gauge a person’s understanding of basic programming concepts. By using the sgpt command to generate the code, you can quickly get a solution without having to write it from scratch.

Explanation: In this use case, the sgpt command is used with the --code argument and the code generation prompt “solve fizz buzz problem using Python”. The command leverages the power of OpenAI’s GPT model to generate Python code that solves the fizz buzz problem.

Example output:

# Python code to solve the fizz buzz problem

for num in range(1, 101):
    if num % 15 == 0:
        print("FizzBuzz")
    elif num % 3 == 0:
        print("Fizz")
    elif num % 5 == 0:
        print("Buzz")
    else:
        print(num)

Use case 4: Start a chat session with a unique session name

Code:

sgpt --chat session_name "please remember my favorite number: 4"

Motivation: Chatbots powered by AI models can be useful for having interactive conversations and retrieving specific information. By using the sgpt command to start a chat session, you can have a conversation with the model and store information uniquely for that session.

Explanation: In this use case, the sgpt command is used with the --chat argument, the desired session name “session_name”, and the chat prompt “please remember my favorite number: 4”. The command starts a chat session with the specified name and interacts with the model using the chat prompt.

Example output:

Model: Hello! How can I assist you today?
User: please remember my favorite number: 4
Model: Noted. Your favorite number is 4.

Use case 5: Start a REPL (Read-Eval-Print Loop) session

Code:

sgpt --repl command

Motivation: REPL sessions are useful for interactive programming and quick prototyping. By using the sgpt command to start a REPL session, you can experiment with code, test snippets, and get immediate results.

Explanation: In this use case, the sgpt command is used with the --repl argument and the desired command. The command starts a REPL session where you can enter code snippets or commands, and the corresponding outputs or results will be displayed.

Example output:

>>> x = 5
>>> y = 10
>>> x + y
15

Use case 6: Display help

Code:

sgpt --help

Motivation: When using a command-line tool, it is essential to have access to the documentation and information about the available options and arguments. By using the sgpt command with the --help argument, you can quickly get the help information for the command.

Explanation: In this use case, the sgpt command is used with the --help argument. The command displays the help information, which provides details about the command, its usage, available options, and examples.

Example output:

Usage: sgpt [OPTIONS] [PROMPT]

Options:
  --shell                   Execute a Shell command
  --code                    Generate code
  --chat SESSION_NAME       Start a chat session with the specified name
  --repl COMMAND            Start a Read–eval–print loop session
  --help                    Show this message and exit.

More information: <https://github.com/TheR1D/shell_gpt#readme>.

Conclusion:

The sgpt command is a powerful tool that combines the capabilities of OpenAI’s GPT models with command-line productivity. It allows users to perform a variety of tasks such as searching the web, executing shell commands, generating code, starting chat sessions, and more. By leveraging the command’s functionality, users can enhance their productivity, automate tasks, and access AI-powered capabilities right from the command line interface.