ruby-openai-cli 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3c5856a8ea31123a8d4e09f28f32bad0ac09a610cb82c980272c72deebc55f77
+  data.tar.gz: c8c0b098bef65ced164868f30cb9956b11238419ab28e4365bc7300bb9dc2dc8
+SHA512:
+  metadata.gz: 455d5a4b2354e8ba320ca8a964d42974f65d5bca5125170e3f2b04fda06210d2c47df11ef009f6f65389c2d2f95410b1466f666c05ed132cf26947469861d254
+  data.tar.gz: 19d6bb2e7f9cabe0ad63378bf0ab9a6bb1f36d9adc7b40e7dda25681569cc59cf091e296f83ede2ce3a2e70a22e68153e710b364fc2f714f4bda8eff69696677

data/README.MD

@@ -0,0 +1,23 @@
+[![Gem Version](https://badge.fury.io/rb/ruby-openai-cli.svg)](https://badge.fury.io/rb/ruby-openai-cli)
+
+## Ruby-OpenAI-CLI
+
+A tool to query OpenAI's GPT APIs from the command line.
+
+### Usage
+
+To run the tool, you need an API key from OpenAI, you can get one here:
+https://platform.openai.com/account/api-keys
+You will be asked to provide on first use of `ruby-openai-cli`, or you can
+provide it as `OPENAI_API_KEY` in your environment.
+
+To install the gem, run: `gem install ruby-openai-cli`. Then you can 
+use the tool by calling `ruby-openai-cli` on your command line.
+
+![image](https://user-images.githubusercontent.com/582520/229295020-e8aa962c-6a87-45e2-802a-c8d41026a56d.png)
+
+### Development
+
+* Install dev dependencies: `gem install awesome_print byebug rubocop`
+* Build Rubygem: `gem build ruby-openai-cli.gemspec`
+* Publish Rubygem: `gem push ruby-openai-cli-1.0.gem`

data/bin/ruby-openai-cli

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/prompt'

data/lib/context.rb

@@ -0,0 +1,7 @@
+DEFAULT_CONTEXTS = {
+  "ruby": 'Imagine you are a senior software developer specialized in Ruby, ' \
+          'Ruby on Rails and SQL with 20 years of experience. ' \
+          'You are very proficient at writing high quality, clean, concise and highly ' \
+          'optimized code that follows the standards. You are my personal assistant. ' \
+          'You are here to help me in various tasks and answer my questions.'
+}

data/lib/prompt.rb

@@ -0,0 +1,140 @@
+require 'openai'
+require 'dotenv/load'
+require 'optparse'
+require 'tty-markdown' # https://github.com/piotrmurach/tty-markdown
+require_relative 'context'
+require_relative 'version'
+
+CONFIG_DIR = Dir.home + '/.config/ruby-openai-cli'
+CHATS_DIR = CONFIG_DIR + '/chats'
+API_KEY_FILE = CONFIG_DIR + '/api_key'
+CONTEXTS_FILE = CONFIG_DIR + '/contexts.json'
+
+MODEL = 'gpt-3.5-turbo'
+
+options = {}
+bin_name = File.basename($0)
+OptionParser.new do |opts|
+  opts.banner = "#{bin_name}, version: #{VERSION}. Usage: #{bin_name} [options]"
+  opts.on('-q', '--question QUESTION', 'Provide question as parameter and receive answer to stdout') do |v|
+    options[:q] = v
+  end
+  opts.on('--context CONTEXT', 'Use a context') { |v| options[:context] = v }
+  opts.on('--list-contexts', 'List available contexts') { |_v| options[:lc] = true }
+  opts.on('-d', '--debug', 'Debug mode') { |_v| options[:d] = true }
+  opts.on('-c', '--chat [NAME]', 'Start an interactive conversation (saved as NAME). ' \
+                                 'You can continue a previous chat by providing the same name') do |name|
+    options[:chat] = true
+    FileUtils.mkdir_p(CHATS_DIR) if name
+    options[:chat_name] = name
+    options[:chat_file] = CHATS_DIR + "/#{name}.json"
+  end
+  opts.on('-l', '--list-chats', 'List stored chats') { |_v| options[:l] = true }
+end.parse!
+
+unless ENV.fetch('OPENAI_API_KEY', nil)
+  unless File.exist?(API_KEY_FILE)
+    puts 'To use the OpenAI API, you need to get API key at https://platform.openai.com/account/api-keys.'
+    puts "It will get stored at #{API_KEY_FILE}."
+    puts 'Please enter your API key:'
+    FileUtils.mkdir_p(CONFIG_DIR)
+    key = gets.chomp
+    test_response = OpenAI::Client.new(access_token: key).models.list
+    unless test_response.code == 200
+      puts test_response['error']['message']
+      exit 1
+    end
+    File.write(API_KEY_FILE, key)
+  end
+  ENV['OPENAI_API_KEY'] = File.read(API_KEY_FILE)
+end
+
+OpenAI.configure do |config|
+  config.access_token = ENV.fetch('OPENAI_API_KEY')
+  config.request_timeout = 240
+end
+
+prompt = ''
+client = OpenAI::Client.new
+
+def get_input
+  printf TTY::Markdown.parse('**Your message>**', theme: { strong: %i[yellow bold] })
+  gets.chomp
+end
+
+def format_input(input)
+  puts TTY::Markdown.parse("**Your message>**\n" + input + "\n",
+                           theme: { strong: %i[yellow bold] })
+end
+
+def format_response(response)
+  puts TTY::Markdown.parse("\n**ChatGPT response:**\n" + response + "\n\n",
+                           theme: { strong: %i[blue bold] })
+end
+
+if options[:lc]
+  puts 'Available contexts: '
+  DEFAULT_CONTEXTS.keys.each do |ctx|
+    puts ctx
+  end
+  exit
+end
+
+if options[:l]
+  out = "**Available chats:**\n\n"
+  Dir[CHATS_DIR + '/*'].each do |file|
+    out += "* '#{File.basename(file, '.json')}'\n"
+  end
+  out += "\nYou can continue a chat with: `#{bin_name} -c '<chat name>'`"
+  out += "\nYour chats are stored at `#{CHATS_DIR}`"
+  puts TTY::Markdown.parse(out)
+  exit
+end
+
+messages_history = []
+if options[:chat_name] && File.exist?(options[:chat_file])
+  messages_history = JSON.parse(File.read(options[:chat_file]))
+  messages_history.each do |message|
+    format_input(message['content']) if message['role'] == 'user'
+    format_response(message['content']) if message['role'] == 'assistant'
+  end
+end
+
+if options[:context]
+  context = DEFAULT_CONTEXTS[options[:context].to_sym] || options[:context]
+  messages_history << { role: 'system', content: context }
+end
+
+begin
+  loop do
+    prompt = options[:q]
+    prompt = get_input unless options[:q]
+    options[:q] = nil
+    messages_history << { "role": 'user', "content": prompt }
+    parameters = {
+      model: MODEL,
+      messages: messages_history,
+      temperature: 0.3, # low temperature = very high probability response (0 to 1)
+      max_tokens: 2000
+    }
+    puts "Sending: #{parameters}" if options[:d]
+    response = client.chat(parameters:)
+    puts "Received: #{response}" if options[:d]
+    begin
+      response_text = response['choices'][0]['message']['content']
+      if options[:chat]
+        format_response response_text
+      else
+        puts response_text
+      end
+      messages_history << { "role": 'assistant', "content": response_text }
+      File.write(options[:chat_file], messages_history.to_json) if options[:chat_name]
+    rescue StandardError
+      puts "Error: '#{response['error']['message']}'"
+    end
+    break unless options[:chat]
+  end
+rescue Interrupt
+  puts "Your current chat was saved as '#{options[:chat_name]}' at #{options[:chat_file]}" if options[:chat_name]
+  exit 1
+end

data/lib/version.rb

@@ -0,0 +1 @@
+VERSION = '1.0.1'

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: ruby-openai-cli
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Thomas Schmidt
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-04-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ruby-openai
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+- !ruby/object:Gem::Dependency
+  name: optparse
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: tty-markdown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.1'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.48'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.48'
+description: Using ChatGPT from the command line.
+email: tom@digitalflow.de
+executables:
+- ruby-openai-cli
+extensions: []
+extra_rdoc_files: []
+files:
+- README.MD
+- bin/ruby-openai-cli
+- lib/context.rb
+- lib/prompt.rb
+- lib/version.rb
+homepage: https://github.com/digitaltom/ruby-openai-cli
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/digitaltom/ruby-openai-cli
+  source_code_uri: https://github.com/digitaltom/ruby-openai-cli
+  changelog_uri: https://github.com/digitaltom/ruby-openai-cli
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.6
+signing_key: 
+specification_version: 4
+summary: CLI interface for OpenAI ChatGPT
+test_files: []