gpterm 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e77a65025792f307da8e9cbc3d152c805ac99693ec166aefb34daf33e03342a1
-  data.tar.gz: a60503f8eccdb64bce12bbc04190b9f56607d3ee55dcbfbfe9ac270162fdf97b
+  metadata.gz: fe8a62780b9a0890cdb4080971d6810c36b160da4bdab39f6a77a7a69c104e07
+  data.tar.gz: d48d93b725e8714a8213513ef30a06a9771b9866da8124a8765b95b3060365c1
 SHA512:
-  metadata.gz: edccfb30f83becb981042ee7c533fc4ad3754fac9fc6a9dd70d2b51fa7055abe1c09ee52fb814612c16dc0926fa72be53cfba563a76c9b00cef3bd202ec986e1
-  data.tar.gz: acde43696b1afc0f762d6b34a5a6a6fdde5e150a849f269e1b9fc8abf68c17dea4f6e6cbbb90146c10240cfa3d95765e31d18830c61c114e6b667624632c90c0
+  metadata.gz: d6cc7c0a7ae13f2f7d826cae3bbbe479cf12bb54f486d4c8eb0dba33896fa462709cd431f2577e351a40a41b4804502e1f4b991183aa3f32b50f7eb073a311a2
+  data.tar.gz: e9cb1e4214ac2c0f2fe8797ec35d821812dc883545b9cb61be0b1bc3ef50e79f3a9875c6a9f8a6a820474de90c9ac2bb38f966af8979ba6004928f60e402335a

data/README.md

@@ -1,7 +1,9 @@
-# gpterm
+# gpterm: a natural language interface for your terminal
 
 **WARNING:** `gpterm` has very few guardrails. If used indiscriminately, it can wipe your entire system or leak information.
 
+![gpterm-fb-for-dogs](https://github.com/basicallydan/gpterm/assets/516325/7a5bed4f-6f41-4d0a-85d9-79fb071c1aaf)
+
 `gpterm` is a powerful, flexible and dangerous command-line tool designed to help you generate commands for your terminal using OpenAI's Chat Completions. It will not execute commands without your consent, but please do check which commands it is presenting before you let it execute them. Like so:
 
 ```bash

data/lib/client.rb

@@ -1,157 +1,85 @@
 require "openai"
+require 'yaml'
 
 class Client
-  attr_reader :openapi_client
+  attr_reader :openai_client
   attr_reader :config
 
   def initialize(config)
     @config = config
-    @openapi_client = OpenAI::Client.new(access_token: config["openapi_key"])
+    @openai_client = OpenAI::Client.new(access_token: config["openapi_key"])
+    @prompts = YAML.load_file('config/prompts.yml')
   end
 
-  def first_prompt(prompt)
-    system_prompt = <<~PROMPT
-      You are a command-line application being executed inside of a directory in a macOS environment, on the user's terminal command line.
-
-      You are executed by running `gpterm` in the terminal, and you are provided with a prompt to respond to with the -p flag.
-
-      Users can add a preset prompt by running `gpterm -s <name>,<prompt>`.
-
-      The eventual output to the user would be a list of commands that they can run in their terminal to accomplish a task.
-
-      You have the ability to run any command that this system can run, and you can read the output of those commands.
-
-      However, any command which would ordinarily change the directory, such as cd, will not change the location of the directory in which you are running. To execute a command in a different directory, you must chain the cd command with the command you want to run, like so: `cd /path/to/directory && command`.
-
-      The user is trying to accomplish a task using the terminal, but they are not sure how to do it.
-    PROMPT
+  def first_prompt(user_goal_prompt)
+    system_prompt = @prompts["system"]
 
     if @config["send_path"]
       system_prompt += <<~PROMPT
+        # ADDITIONAL CONTEXT:
+
         The user's PATH environment variable is:
         #{ENV["PATH"]}
       PROMPT
     end
 
-    full_prompt = <<~PROMPT
-      Your FIRST response should be a list of commands that will be automatically executed to gather more information about the user's system.
-      - The commands MUST NOT make any changes to the user's system.
-      - The commands MUST NOT make any changes to any files on the user's system.
-      - The commands MUST NOT write to any files using the > or >> operators.
-      - The commands MUST NOT use the touch command.
-      - The commands MUST NOT use echo or any other command to write into files using the > or >> operators.
-      - The commands MUST NOT send any data to any external servers.
-      - The commands MUST NOT contain any placeholders in angle brackets like <this>.
-      - The commands MUST NOT contain any plain language instructions, or backticks indicating where the commands begin or end.
-      - The commands MAY gather information about the user's system, such as the version of a software package, or the contents of a file.
-      - The commands CAN pipe their output into other commands.
-      - The commands SHOULD tend to gather more verbose information INSTEAD OF more concise information.
-      This will help you to provide a more accurate response to the user's goal.
-      Therefore your FIRST response MUST contain ONLY a list of commands and nothing else.
-
-      VALID example response. These commands are examples of commands which CAN be included in your FIRST response:
-
-        for file in *; do cat "$file"; done
-        which ls
-        which git
-        which brew
-        git diff
-        git status
-
-      INVALID example response. These commands are examples of commands which MUST NOT be included in your FIRST response:
-
-        touch file.txt
-        git add .
-        git push
-
-      If you cannot create a VALID response, simply return the string "$$cannot_compute$$" and the user will be asked to provide a new prompt.
-      If you do not need to gather more information, simply return the string "$$no_gathering_needed$$" and the next step will be executed.
-      You probably will need to gather information.
-      If you need to gather information directly from the user, you will be able to do so in the next step.
-
-      The user's goal prompt is:
-      "#{prompt}"
-      Commands to execute to gather more information about the user's system before providing the response which will accomplish the user's goal:
+    user_prompt = @prompts["info_gathering"]
+    user_prompt += <<~PROMPT
+      The user's GOAL PROMPT is:
+
+      "#{user_goal_prompt}"
+
+      Please respond with one or more commands to execute to gather more information about the user's system before providing the response which will accomplish the user's goal.
+
+      COMMANDS:
     PROMPT
 
     @messages = [
-      { role: "system", content: system_prompt },
-      { role: "user", content: full_prompt }
+      { role: "system", content: system_prompt }
     ]
 
-    response = openapi_client.chat(
-      parameters: {
-        model: "gpt-4-turbo-preview",
-        messages: @messages,
-        temperature: 0.6,
-      }
-    )
-    content = response.dig("choices", 0, "message", "content")
-
-    @messages << { role: "assistant", content: content }
-
-    content
+    continue_conversation(user_prompt)
   end
 
-  def offer_information_prompt(prompt)
-    full_prompt = <<~PROMPT
-      This is the output of the command you provided to the user in the previous step.
-
-      #{prompt}
-
-      Before you provide the user with the next command, you have the opportunity to ask the user to provide more information so you can better tailor your response to their needs.
-
-      If you would like to ask the user for more information, please provide a prompt that asks the user for the information you need.
-      - Your prompt MUST ONLY contain one question. You will be able to ask another question in the next step.
-      If you have all the information you need, simply return the string "$$no_more_information_needed$$" and the next step will be executed.
-    PROMPT
+  def offer_information_prompt(previous_output, previous_output_type = :question_response)
+    question_prompt = if previous_output_type == :question_response
+      <<~PROMPT
+        This is the output of the question you asked the user in the previous step.
 
-    @messages << { role: "user", content: full_prompt }
-
-    response = openapi_client.chat(
-      parameters: {
-        model: "gpt-4-turbo-preview",
-        messages: @messages,
-        temperature: 0.6,
-      }
-    )
+        #{previous_output}
+      PROMPT
+    else
+      <<~PROMPT
+        This is the output of the command you provided to the user in the previous step.
 
-    content = response.dig("choices", 0, "message", "content")
+        #{previous_output}
+      PROMPT
+    end
 
-    @messages << { role: "assistant", content: content }
+    question_prompt += @prompts["user_question"]
 
-    content
+    continue_conversation(question_prompt)
   end
 
   def final_prompt(prompt)
-    full_prompt = <<~PROMPT
+    goal_commands_prompt = <<~PROMPT
       This is the output of the command you provided to the user in the previous step.
 
       #{prompt}
 
-      Your NEXT response should be a list of commands that will be automatically executed to fulfill the user's goal.
-      - The commands may make changes to the user's system.
-      - The commands may install new software using package managers like Homebrew
-      - The commands MUST all start with a valid command that you would run in the terminal
-      - The commands MUST NOT contain any placeholders in angle brackets like <this>.
-      - The response MUST NOT contain any plain language instructions, or backticks indicating where the commands begin or end.
-      - THe response MUST NOT start or end with backticks.
-      - The response MUST NOT end with a newline character.
-      Therefore your NEXT response MUST contain ONLY a list of commands and nothing else.
+    PROMPT
 
-      VALID example response. These commands are examples of commands which CAN be included in your FINAL response:
+    goal_commands_prompt += @prompts["goal_commands"]
 
-        ls
-        mkdir new_directory
-        brew install git
-        git commit -m "This is a great commit message"
+    continue_conversation(goal_commands_prompt)
+  end
 
-      If you cannot keep to this restriction, simply return the string "$$cannot_compute$$" and the user will be asked to provide a new prompt.
-    PROMPT
+  private
 
-    @messages << { role: "user", content: full_prompt }
+  def continue_conversation(prompt)
+    @messages << { role: "user", content: prompt }
 
-    response = openapi_client.chat(
+    response = openai_client.chat(
       parameters: {
         model: "gpt-4-turbo-preview",
         messages: @messages,

data/lib/gpterm.rb

@@ -24,36 +24,66 @@ class GPTerm
       name = @options[:preset_prompt][0]
       prompt = @options[:preset_prompt][1]
       AppConfig.add_preset(@config, name, prompt)
-      puts "Preset prompt '#{name}' saved with prompt '#{prompt}'".colorize(:green)
-      exit
+      exit_with_message("Preset prompt '#{name}' saved with prompt '#{prompt}'", :green)
     elsif @options[:prompt]
-      start_prompt(@options[:prompt])
+      start_conversation(@options[:prompt])
     end
   end
 
   private
 
-  def execute_command(command)
+  def execute_shell_command(command)
     stdout, stderr, status = Open3.capture3(command)
     [stdout, stderr, status.exitstatus]
   end
 
-  def start_prompt(prompt)
+  def exit_with_message(message, color)
+    if color
+      puts message.colorize(color)
+    else
+      puts message
+    end
+
+    exit
+  end
+
+  # Ensures the user enters "y" or "n"
+  def get_yes_or_no
+    input = STDIN.gets.chomp.downcase
+    while ['y', 'n'].include?(input) == false
+      puts 'Please enter "y/Y" or "n/N":'.colorize(:yellow)
+      input = STDIN.gets.chomp.downcase
+    end
+    input
+  end
+
+  # Ensures the user enters a non-empty value
+  def get_non_empty_input
+    input = STDIN.gets.chomp.strip
+    while input.length == 0
+      puts 'Please enter a non-empty value:'.colorize(:yellow)
+      input = STDIN.gets.chomp.strip
+    end
+    input
+  end
+
+  def start_conversation(prompt)
     message = @client.first_prompt(prompt)
 
     if message.downcase == '$$cannot_compute$$'
-      puts 'Sorry, a command could not be generated for that prompt. Try another.'.colorize(:red)
-      exit
+      exit_with_message('Sorry, a command could not be generated for that prompt. Try another.', :red)
     end
 
     if message.downcase == '$$no_gathering_needed$$'
       puts 'No information gathering needed'.colorize(:magenta)
       output = "No information gathering was needed."
+    elsif message.downcase == '$$cannot_compute$$'
+      exit_with_message('Sorry, a command could not be generated for that prompt. Try another.', :red)
     else
       puts 'Information gathering command:'.colorize(:magenta)
       puts message.gsub(/^/, "#{"  $".colorize(:blue)} ")
-      puts 'Do you want to execute this command? (Y/n)'.colorize(:yellow)
-      continue = STDIN.gets.chomp
+      puts 'Do you want to execute this command? (Y/n then hit return)'.colorize(:yellow)
+      continue = get_yes_or_no
 
       unless continue.downcase == 'y'
         exit
@@ -68,19 +98,19 @@ class GPTerm
       end
     end
 
-    output = offer_more_information(output)
+    output = @client.offer_information_prompt(output, :shell_output_response)
 
     while output.downcase != '$$no_more_information_needed$$'
       puts "You have been asked to provide more information with this command:".colorize(:magenta)
       puts output.gsub(/^/, "#{"  >".colorize(:blue)} ")
       puts "What is your response? (Type 'skip' to skip this step and force the final command to be generated)".colorize(:yellow)
 
-      response = STDIN.gets.chomp
+      response = get_non_empty_input
 
       if response.downcase == 'skip'
         output = '$$no_more_information_needed$$'
       else
-        output = offer_more_information(response)
+        output = @client.offer_information_prompt(response, :question_response)
       end
     end
 
@@ -88,12 +118,16 @@ class GPTerm
 
     message = @client.final_prompt(output)
 
+    if message.downcase == '$$cannot_compute$$'
+      exit_with_message('Sorry, a command could not be generated for that prompt. Try another.', :red)
+    end
+
     puts 'Generated command to accomplish your goal:'.colorize(:magenta)
     puts message.gsub(/^/, "#{"  $".colorize(:green)} ")
 
-    puts 'Do you want to execute this command? (Y/n)'.colorize(:yellow)
+    puts 'Do you want to execute this command? (Y/n then hit return)'.colorize(:yellow)
 
-    continue = STDIN.gets.chomp
+    continue = get_yes_or_no
 
     unless continue.downcase == 'y'
       exit
@@ -102,12 +136,11 @@ class GPTerm
     commands = message.split("\n")
 
     commands.each do |command|
-      stdout, stderr, exit_status = execute_command(command)
+      stdout, stderr, exit_status = execute_shell_command(command)
       if exit_status != 0
         puts "#{command} failed with the following output:".colorize(:red)
         puts "#{stderr.gsub(/^/, "  ")}".colorize(:red) if stderr.length > 0
-        puts "  Exit status: #{exit_status}".colorize(:red)
-        exit
+        exit_with_message("  Exit status: #{exit_status}", :red)
       end
       puts stdout if stdout.length > 0
       # I'm doing this here because git for some reason always returns the output of a push to stderr,
@@ -123,13 +156,15 @@ class GPTerm
       new_config = {}
       puts "Before we get started, we need to configure the application. All the info you provide will be saved in #{AppConfig::CONFIG_FILE}.".colorize(:magenta)
 
-      puts "Enter your OpenAI API key's \"SECRET KEY\" value: ".colorize(:yellow)
+      puts "Enter your OpenAI API key's \"SECRET KEY\" value then hit return: ".colorize(:yellow)
       new_config['openapi_key'] = STDIN.gets.chomp
 
       puts "Your PATH environment variable is: #{ENV['PATH']}".colorize(:magenta)
-      puts 'Are you happy for your PATH to be sent to OpenAI to help with command generation? (Y/n) '.colorize(:yellow)
+      puts 'Are you happy for your PATH to be sent to OpenAI to help with command generation? (Y/n then hit return) '.colorize(:yellow)
+
+      input = get_yes_or_no
 
-      if STDIN.gets.chomp.downcase == 'y'
+      if input == 'y'
         new_config['send_path'] = true
       else
         new_config['send_path'] = false
@@ -163,14 +198,12 @@ class GPTerm
           opts.banner = "gpterm config [--openapi_key <value>|--send_path <true|false>]"
           opts.on("--openapi_key VALUE", "Set the OpenAI API key") do |v|
             AppConfig.add_openapi_key(@config, v)
-            puts "OpenAI API key saved"
-            exit
+            exit_with_message("OpenAI API key saved")
           end
           opts.on("--send_path", "Send the PATH environment variable to OpenAI") do
             @config['send_path'] = true
             AppConfig.save_config(@config)
-            puts "Your PATH environment variable will be sent to OpenAI to help with command generation"
-            exit
+            exit_with_message("Your PATH environment variable will be sent to OpenAI to help with command generation")
           end
         end
       }
@@ -196,19 +229,14 @@ class GPTerm
       subcommands[command][:option_parser].parse!
       subcommands[command][:argument_parser].call(ARGV) if subcommands[command][:argument_parser]
     elsif command == 'help'
-      puts main
-      exit
+      exit_with_message(main)
     elsif command
       options[:prompt] = command
     else
       puts 'Enter a prompt to generate text from:'.colorize(:yellow)
-      options[:prompt] = STDIN.gets.chomp
+      options[:prompt] = get_non_empty_input
     end
 
     options
   end
-
-  def offer_more_information(output)
-    output = @client.offer_information_prompt(output)
-  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gpterm
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Dan Hough