openai-cli 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c82b47be860e5ededf34aa24ea681a6bdae7973a71f96b89dee2fdd6c1af7a98
+  data.tar.gz: 809c1f364dc3a1b968930c00d19cabeeb6af13aad2e9cd676d4472b55f054f83
+SHA512:
+  metadata.gz: 36e5e1d18ef2f16412d26429b222c4541383ce97361992c042f88385ec6b10da6f37297be22344b35d65991e818112f74ed1a7ce8d3b002df7091b635d681c03
+  data.tar.gz: a25c8dfaad67745028a19800dcd6d6e11ef93a3cdc61fc349fda2ee2e83808bd022f13d363367a95c0f6ada4977e66e175949a1665147f8a03af116a290a47b5

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-02-14
+
+- Initial release

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in openai-cli.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "rubocop", "~> 1.21"

data/Gemfile.lock

@@ -0,0 +1,109 @@
+PATH
+  remote: .
+  specs:
+    openai-cli (0.1.0)
+      dry-auto_inject
+      dry-cli
+      dry-configurable
+      dry-container
+      dry-types
+      ruby-openai
+      sqlite
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    byebug (11.1.3)
+    coderay (1.1.3)
+    concurrent-ruby (1.2.0)
+    diff-lcs (1.5.0)
+    dry-auto_inject (1.0.1)
+      dry-core (~> 1.0)
+      zeitwerk (~> 2.6)
+    dry-cli (1.0.0)
+    dry-configurable (1.0.1)
+      dry-core (~> 1.0, < 2)
+      zeitwerk (~> 2.6)
+    dry-container (0.11.0)
+      concurrent-ruby (~> 1.0)
+    dry-core (1.0.0)
+      concurrent-ruby (~> 1.0)
+      zeitwerk (~> 2.6)
+    dry-inflector (1.0.0)
+    dry-logic (1.5.0)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 1.0, < 2)
+      zeitwerk (~> 2.6)
+    dry-types (1.7.0)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 1.0, < 2)
+      dry-inflector (~> 1.0, < 2)
+      dry-logic (>= 1.4, < 2)
+      zeitwerk (~> 2.6)
+    httparty (0.21.0)
+      mini_mime (>= 1.0.0)
+      multi_xml (>= 0.5.2)
+    json (2.6.3)
+    method_source (1.0.0)
+    mini_mime (1.1.2)
+    minitest (5.17.0)
+    multi_xml (0.6.0)
+    parallel (1.22.1)
+    parser (3.2.1.0)
+      ast (~> 2.4.1)
+    pry (0.14.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.10.1)
+      byebug (~> 11.0)
+      pry (>= 0.13, < 0.15)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.7.0)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.1)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.45.1)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.24.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.26.0)
+      parser (>= 3.2.1.0)
+    ruby-openai (3.2.0)
+      httparty (>= 0.18.1)
+    ruby-progressbar (1.11.0)
+    sqlite (1.0.2)
+    unicode-display_width (2.4.2)
+    zeitwerk (2.6.7)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  minitest
+  openai-cli!
+  pry-byebug
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.21)
+
+BUNDLED WITH
+   2.4.6

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Viktor Habchak
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,25 @@
+# OpenAI::CLI
+## Installation
+
+```bash
+gem install openai-cli
+```
+
+## TODO Usage
+
+# Future Features
+- `edit` command
+- `edit` command
+- `help` command
+- `moderation` command
+- pass a file to `ask` command
+- Instead of failing on reaching max-tokens, implement the drift mechanism
+  e.g. only submit latest max-tokens allowed in the conversation.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/vikdotdev/openai-cli.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+# require "rubocop/rake_task"
+# RuboCop::RakeTask.new
+
+task default: %i[spec]

data/exe/openai

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require "openai/cli/cli"
+
+Dry::CLI.new(OpenAI::CLI::Commands).call

data/lib/openai/cli/cli.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require "openai/cli/config"
+
+OpenAI::CLI::Config.configure
+
+require "openai/cli/commands/version"
+require "openai/cli/commands/complete"
+require "openai/cli/commands/status"
+require "openai/cli/commands/config"
+
+module OpenAI
+  module CLI
+    module Commands
+      register "complete", Complete, aliases: ["c"]
+      register "status", Status
+      register "config", Config
+      register "version", Version, aliases: ["v", "-v", "--version"]
+    end
+  end
+end
+

data/lib/openai/cli/commands/complete.rb

@@ -0,0 +1,31 @@
+require "dry/cli"
+
+module OpenAI
+  module CLI
+    module Commands
+      extend Dry::CLI::Registry
+
+      class Complete < Dry::CLI::Command
+        desc "Send requests to OpenAI completion endpoint"
+
+        argument :message, required: false, desc: "Prompt message"
+        option :max_tokens, required: false, default: 100, desc: <<~DESC
+          Maximum amount of tokens permitted in the response
+        DESC
+        option :interactive, required: false, default: true, desc: "Interactive mode"
+        option :model, required: false, desc: "Specify OpenAI model"
+
+        example [
+          'openai complete "What is the meaning of life?" # A single completion',
+          "openai complete -i # Enter interactive mode"
+        ]
+
+        def call(message: "", **opts)
+          # either message or interactive mode should be present
+          # model should be read from the configuration
+          puts "complete command called with arguments: #{message.inspect}, #{opts.inspect}"
+        end
+      end
+    end
+  end
+end

data/lib/openai/cli/commands/config.rb

@@ -0,0 +1,28 @@
+require "dry/cli"
+
+module OpenAI
+  module CLI
+    module Commands
+      extend Dry::CLI::Registry
+
+      class Config < Dry::CLI::Command
+        desc "Configure the CLI"
+
+        option :restore_default, desc: <<~DESC
+          Restores configuration to default
+        DESC
+
+        def call(**opts)
+          puts "config command called with arguments: #{opts.inspect}"
+        end
+
+        # This should attempt to fetch OPENAI_API_KEY if available
+        # openai config auth -k <your-api-key>
+        #
+        # openai config completion -m text-davince-001
+      end
+    end
+  end
+end
+
+

data/lib/openai/cli/commands/status.rb

@@ -0,0 +1,24 @@
+require "dry/cli"
+
+module OpenAI
+  module CLI
+    module Commands
+      extend Dry::CLI::Registry
+
+      class Status < Dry::CLI::Command
+        desc "Show CLI status"
+
+        example [
+          "openai status"
+        ]
+
+        def call(**)
+          puts "status command called"
+        end
+
+        # Display token usage.
+        # opanai status
+      end
+    end
+  end
+end

data/lib/openai/cli/commands/version.rb

@@ -0,0 +1,20 @@
+# TODO print api version too ??
+#
+require "dry/cli"
+require "openai/cli/version"
+
+module OpenAI
+  module CLI
+    module Commands
+      extend Dry::CLI::Registry
+
+      class Version < Dry::CLI::Command
+        desc "Print version"
+
+        def call(*)
+          puts OpenAI::CLI::VERSION
+        end
+      end
+    end
+  end
+end

data/lib/openai/cli/config.rb

@@ -0,0 +1,28 @@
+require "dry/configurable"
+require "ruby/openai"
+
+module OpenAI
+  module CLI
+
+    class Config
+      def self.configure
+        Ruby::OpenAI.configure do |config|
+          config.access_token = ENV["OPENAI_API_KEY"]
+          config.organization_id = ENV["OPENAI_ORGANIZATION_ID"]
+        end
+      end
+
+      # generate default config if does not exist from env or otherwise
+      #
+      # read config and provide values
+      #
+      # determine whether this is the first command execution
+      #
+      # write default configuration, copy a yaml file to location or something
+      #
+      # put api key into that configuration
+      #
+      # all this with error handling when config is malformed, with option to recreate default config
+    end
+  end
+end

data/lib/openai/cli/persistence/entities/completion.rb

@@ -0,0 +1,12 @@
+module OpenAI
+  module CLI
+    module Persistence
+      module Entities
+        class Completion
+          # Represents a response from /completion API. Is aware of it's place
+          # in the conversation.
+        end
+      end
+    end
+  end
+end

data/lib/openai/cli/persistence/entities/conversation.rb

@@ -0,0 +1,11 @@
+module OpenAI
+  module CLI
+    module Persistence
+      module Entities
+        class Conversation
+          # Holds references to prompts and completions.
+        end
+      end
+    end
+  end
+end

data/lib/openai/cli/persistence/entities/prompt.rb

@@ -0,0 +1,12 @@
+module OpenAI
+  module CLI
+    module Persistence
+      module Entities
+        class Prompt
+          # Represents a request text for the /completion API. Is aware of it's
+          # place in the conversation.
+        end
+      end
+    end
+  end
+end

data/lib/openai/cli/version.rb

@@ -0,0 +1,7 @@
+module OpenAI
+  module CLI
+    VERSION = "0.1.0"
+  end
+end
+
+

data/openai-cli.gemspec

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require_relative "lib/openai/cli/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "openai-cli"
+  spec.version = OpenAI::CLI::VERSION
+  spec.authors = ["Viktor Habchak"]
+  spec.email = ["vikdotdev@gmail.com"]
+
+  spec.summary = "Command line tool to interact with OpenAI APIs"
+  spec.description = <<~DESCRIPTION
+    Command line tool to interact with OpenAI APIs. Aims to be ergonomic and
+    rely on GNU tools when possible.
+  DESCRIPTION
+  spec.homepage = "https://github.com/vikdotdev/openai-cli"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.7.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/vikdotdev/openai-cli"
+  spec.metadata["changelog_uri"] = "https://github.com/vikdotdev/openai-cli/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|circleci)|appveyor)})
+    end
+  end
+
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "dry-auto_inject"
+  spec.add_dependency "dry-cli"
+  spec.add_dependency "dry-configurable"
+  spec.add_dependency "dry-container"
+  spec.add_dependency "dry-types"
+  spec.add_dependency "ruby-openai"
+  spec.add_dependency "sqlite"
+
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "pry-byebug"
+  spec.add_development_dependency "rspec"
+end

data/sig/chatgpt/cli.rbs

@@ -0,0 +1,6 @@
+module Chatgpt
+  module Cli
+    VERSION: String
+    # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+  end
+end

metadata

@@ -0,0 +1,210 @@
+--- !ruby/object:Gem::Specification
+name: openai-cli
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Viktor Habchak
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-02-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dry-auto_inject
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: dry-cli
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: dry-configurable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: dry-container
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: dry-types
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ruby-openai
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |
+  Command line tool to interact with OpenAI APIs. Aims to be ergonomic and
+  rely on GNU tools when possible.
+email:
+- vikdotdev@gmail.com
+executables:
+- openai
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- exe/openai
+- lib/openai/cli/cli.rb
+- lib/openai/cli/commands/complete.rb
+- lib/openai/cli/commands/config.rb
+- lib/openai/cli/commands/status.rb
+- lib/openai/cli/commands/version.rb
+- lib/openai/cli/config.rb
+- lib/openai/cli/persistence/entities/completion.rb
+- lib/openai/cli/persistence/entities/conversation.rb
+- lib/openai/cli/persistence/entities/prompt.rb
+- lib/openai/cli/version.rb
+- openai-cli.gemspec
+- sig/chatgpt/cli.rbs
+homepage: https://github.com/vikdotdev/openai-cli
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/vikdotdev/openai-cli
+  source_code_uri: https://github.com/vikdotdev/openai-cli
+  changelog_uri: https://github.com/vikdotdev/openai-cli/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: Command line tool to interact with OpenAI APIs
+test_files: []