gpterminal 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b11c4f28f70c97e2f7bfa082039d8504e548035cf98b86126d7bafd38098727d
-  data.tar.gz: 4a992292676cb07170d8588a4a5724e94726db3b0e4437099a784f536195c7a4
+  metadata.gz: 02a3cd7d8a3c238a428e6485c53423a5395826671bb8ab6e4f948654960badb5
+  data.tar.gz: a9a00538c4ed4ccce09164c38870a885135b6fb50423cb8366d90a40add7fbf7
 SHA512:
-  metadata.gz: f7126e3f4d2082a72402febcf1728f9f8361c3312f3eb465684f1a4f73e044e939e55d4549606a0e27bdfe70db0851c9451be902c014858cdc04684bb314b2c5
-  data.tar.gz: d3818548a22406e5a1149f9fb275926dcdbbe217f61ba052210bf8cf6637a9dcc0856b6811d96dd1c7963f4e65eeab8f170c6e3238851f77f871bc7d27504b4f
+  metadata.gz: 650b1a3dc9509bf784bfdd9a5dd70b5a62346d26c35983cb051b1b02c7ac57f690718007262147ca05ea62795a0692efd9a2c171e39e0a1a9381c50ee8065141
+  data.tar.gz: 3c3871a02fdf8dce366fb29266ada88fcb5ac3f482062d493d0181e0574e0fd6d86b3397ac9822c552e916f45ef150e3c165c3591690249eddfaebf3b6813db8

data/README.md

@@ -5,7 +5,7 @@
 `gpterminal` 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
-$ ./bin/gpterminal -p "Using git diff to gather info, commit all the latest changes with a descriptive commit message, then push the changes"
+$ gpterminal "Using git diff to gather info, commit all the latest changes with a descriptive commit message, then push the changes"
 $ # It gathers info, asks for consent, and does the thing
 $ [main 94a9292] Update README with gpterminal usage example
 $  1 file changed, 4 insertions(+)
@@ -13,7 +13,9 @@ $  1 file changed, 4 insertions(+)
 
 ## Getting Started
 
-To use gpterminal, ensure you have Ruby installed on your system. Then, follow these steps:
+You can install it from RubyGems using `gem install gpterminal`, or you can clone it and run it straight from the source.
+
+Ensure you have Ruby installed on your system. Then, follow these steps:
 
 - Clone the repository or download the source code.
 - Navigate to the gpterminal directory and run `bundle install` to install dependencies.
@@ -25,13 +27,15 @@ On first run, you'll be prompted to enter your OpenAI API key. This is required
 
 ## Usage
 
-gpterminal can be used with the following options:
+`gpterminal <prompt> [options] [subcommand [options]]`
+
+**Subcommands:**
+
+- `preset` - `gpterminal preset <name> <prompt>`
+- `config` - `gpterminal config [--openapi_key <value>|--send_path <true|false>]`
 
-- `-p`, `--prompt PROMPT`: Set a custom prompt for generating text.
-- `-s`, `--save NAME,PROMPT`: Create a custom preset prompt that can be reused.
-  Without any options, gpterminal will prompt you to enter a text prompt manually.
-- `-k`, `--key KEY`: Set the OpenAI API key
-- `-P`, `--send-path`: Send the PATH environment variable to OpenAI.
+**Options:**
+`-v`, `--verbose` Run verbosely
 
 ## Presets
 

data/lib/client.rb

@@ -79,7 +79,7 @@ class Client
 
     response = openapi_client.chat(
       parameters: {
-        model: "gpt-3.5-turbo",
+        model: "gpt-4-turbo-preview",
         messages: @messages,
         temperature: 0.6,
       }
@@ -108,7 +108,7 @@ class Client
 
     response = openapi_client.chat(
       parameters: {
-        model: "gpt-4",
+        model: "gpt-4-turbo-preview",
         messages: @messages,
         temperature: 0.6,
       }
@@ -151,7 +151,7 @@ class Client
 
     response = openapi_client.chat(
       parameters: {
-        model: "gpt-4",
+        model: "gpt-4-turbo-preview",
         messages: @messages,
         temperature: 0.6,
       }

data/lib/config.rb

@@ -15,9 +15,6 @@ module AppConfig
   end
 
   def self.save_config(config)
-    puts "Saving config to #{CONFIG_FILE}"
-    puts "It will look like:"
-    puts config.to_yaml
     File.write(CONFIG_FILE, config.to_yaml)
   end
 

data/lib/gpterminal.rb

@@ -12,7 +12,22 @@ class GPTerminal
   end
 
   def run
-    prompt = determine_prompt
+    puts "gpterminal has been renamed to gpterm. Please use gpterm instead. Exiting...".colorize(:red)
+    exit
+    if @options[:preset_prompt]
+      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
+    elsif @options[:prompt]
+      start_prompt(@options[:prompt])
+    end
+  end
+
+  private
+
+  def start_prompt(prompt)
     message = @client.first_prompt(prompt)
 
     if message.downcase == '$$cannot_compute$$'
@@ -77,20 +92,18 @@ class GPTerminal
     puts output
   end
 
-  private
-
   def load_config
     unless File.exist?(AppConfig::CONFIG_FILE)
       puts 'Welcome to GPTerminal! It looks like this is your first time using this application.'.colorize(:magenta)
 
       new_config = {}
-      print "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 "Before we get started, we need to configure the application. All the info you provide will be saved in #{AppConfig::CONFIG_FILE}.".colorize(:magenta)
 
-      print "Enter your OpenAI API key's \"SECRET KEY\" value: ".colorize(:yellow)
+      puts "Enter your OpenAI API key's \"SECRET KEY\" value: ".colorize(:yellow)
       new_config['openapi_key'] = STDIN.gets.chomp
 
-      print "Your PATH environment variable is: #{ENV['PATH']}".colorize(:magenta)
-      print 'Are you happy for your PATH to be sent to OpenAI to help with command generation? (Y/n) '.colorize(:yellow)
+      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)
 
       if STDIN.gets.chomp.downcase == 'y'
         new_config['send_path'] = true
@@ -108,66 +121,67 @@ class GPTerminal
 
   def parse_options
     options = {}
-    OptionParser.new do |opts|
-      opts.banner = "Usage: gpterminal [preset] [options]"
-
-      opts.on("-p", "--prompt PROMPT", "Set a custom prompt") do |v|
-        options[:prompt] = v
-      end
-
-      opts.on("-s", "--save NAME,PROMPT", "Create a custom preset prompt") do |list|
-        options[:preset_prompt] = list.split(',', 2)
+    subcommands = {
+      'preset' => {
+        option_parser: OptionParser.new do |opts|
+          opts.banner = "gpterminal preset <name> <prompt>"
+        end,
+        argument_parser: ->(args) {
+          if args.length < 2
+            options[:prompt] = @config['presets'][args[0]]
+          else
+            options[:preset_prompt] = [args[0], args[1]]
+          end
+        }
+      },
+      'config' => {
+        option_parser: OptionParser.new do |opts|
+          opts.banner = "gpterminal 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
+          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
+          end
+        end
+      }
+    }
+
+    main = OptionParser.new do |opts|
+      opts.banner = "Usage:"
+      opts.banner += "\n\ngpterminal <prompt> [options] [subcommand [options]]"
+      opts.banner += "\n\nSubcommands:"
+      subcommands.each do |name, subcommand|
+        opts.banner += "\n  #{name} - #{subcommand[:option_parser].banner}"
       end
-
-      opts.on("-h", "--help", "Prints this help") do
-        puts opts
-        exit
+      opts.banner += "\n\nOptions:"
+      opts.on("-v", "--verbose", "Run verbosely") do |v|
+        options[:verbose] = true
       end
-
-      opts.on("-k", "--key KEY", "Set the OpenAI API key") do |v|
-        AppConfig.add_openapi_key(@config, v)
-        puts "OpenAI API key saved"
-        exit
-      end
-
-      opts.on("-P", "--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
-      end
-    end.parse!
-
-    options
-  end
-
-  def determine_prompt
-    if @options[:preset_prompt]
-      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
     end
 
-    if ARGV.length == 1
-      # collect a prompt from the preset prompts
-      prompt = @config['presets'][ARGV[0]]
-
-      unless prompt
-        puts "Preset prompt not found: #{ARGV[0]}".colorize(:red)
-        exit
-      end
+    command = ARGV.shift
 
-      puts "Using preset prompt '#{prompt}'".colorize(:magenta)
-    elsif @options[:prompt]
-      prompt = @options[:prompt]
+    main.order!
+    if subcommands.key?(command)
+      subcommands[command][:option_parser].parse!
+      subcommands[command][:argument_parser].call(ARGV) if subcommands[command][:argument_parser]
+    elsif command == 'help'
+      puts main
+      exit
+    elsif command
+      options[:prompt] = command
     else
       puts 'Enter a prompt to generate text from:'.colorize(:yellow)
-      prompt = STDIN.gets.chomp
+      options[:prompt] = STDIN.gets.chomp
     end
 
-    prompt
+    options
   end
 
   def offer_more_information(output)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gpterminal
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Dan Hough
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-02-16 00:00:00.000000000 Z
+date: 2024-02-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-openai
@@ -24,8 +24,8 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '7'
-description: gpterminal is a powerful, flexible and dangerous command-line tool designed
-  to help you generate commands for your terminal using OpenAI's Chat Completions
+description: "[DEPRECATED] gpterminal has been renamed to gpterm. Please use the gpterm
+  gem instead."
 email:
 - daniel.hough@gmail.com
 executables:
@@ -39,12 +39,12 @@ files:
 - lib/client.rb
 - lib/config.rb
 - lib/gpterminal.rb
-homepage: https://github.com/basicallydan/gpterminal
+homepage: https://github.com/basicallydan/gpterm
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/basicallydan/gpterminal
-  source_code_uri: https://github.com/basicallydan/gpterminal
+  homepage_uri: https://github.com/basicallydan/gpterm
+  source_code_uri: https://github.com/basicallydan/gpterm
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -63,5 +63,6 @@ requirements: []
 rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
-summary: A CLI for generating CLI commands with ChatGPT's help.
+summary: "[DEPRECATED] gpterminal has been renamed to gpterm. Please use the gpterm
+  gem instead."
 test_files: []