gpt-cli 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b82b15bff40eaab0d8c15e2273b275841d3501e8c0ae085443f35782175d3ab8
+  data.tar.gz: de41d86f71219206252e937180099cbd07b1c77abef0b6e71271e3faf3d170d9
+SHA512:
+  metadata.gz: 26ff8b088978790eebdc85904dc3c994a96ffa20d854fa0ba5123f52d3c8ff86b96e271bf975bb4b585f544c79becb6447dae9dd10cabb8a5cb28e030fc42104
+  data.tar.gz: fb1d336d91b5efe7ebf7c48659dbb3bdf4e240c2f54b19e4001ec4806b730ad145686852ce1b5768cf75d29f92f39ac61393098cc9c3db5ba4601ed00e022404

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,14 @@
+AllCops:
+  NewCops: enable
+  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,10 @@
+## [Unreleased]
+
+## [0.1.0] - 2022-12-23
+
+- Initial release
+
+## [0.1.1] - 2023-03-23
+
+- Define open ai model in env var
+- Input context pompts

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,73 @@
+PATH
+  remote: .
+  specs:
+    gpt-cli (0.1.2)
+      quick_openai (~> 0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.1)
+      public_suffix (>= 2.0.2, < 6.0)
+    ast (2.4.2)
+    diff-lcs (1.5.0)
+    down (5.4.0)
+      addressable (~> 2.8)
+    httparty (0.21.0)
+      mini_mime (>= 1.0.0)
+      multi_xml (>= 0.5.2)
+    json (2.6.3)
+    mini_mime (1.1.2)
+    multi_xml (0.6.0)
+    parallel (1.22.1)
+    parser (3.2.0.0)
+      ast (~> 2.4.1)
+    public_suffix (5.0.1)
+    quick_openai (0.1.2)
+      down (~> 5)
+      ruby-openai (~> 3)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.6.1)
+    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.0)
+      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.43.0)
+      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.24.1)
+      parser (>= 3.1.1.0)
+    ruby-openai (3.0.3)
+      httparty (>= 0.18.1, < 0.22.0)
+    ruby-progressbar (1.11.0)
+    unicode-display_width (2.4.2)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  gpt-cli!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.21)
+
+BUNDLED WITH
+   2.3.12

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 John DeSilva
+
+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,224 @@
+# GPTCLI
+
+This library provides a UNIX-ey interface to OpenAI.
+It is a fork of [openai_pipe](https://github.com/Aesthetikx/openai_pipe), created by [Aesthetikx](https://github.com/Aesthetikx/openai_pipe), kudos to him for his awesome work!  
+The goal of this fork was to add the ability to choose which OpenAI model to use, as well as adding context prompts support. Thanks to these new features, you can have your own highly specialized GPT4 personal assistant, directly in your terminal! Productivity stonks 📈📈📈   
+
+See [Installation](#installation) and [Setup](#setup) below, but first, some examples.
+
+## Examples
+
+```console
+$ gpt what is two plus two
+Two plus two is equal to four.
+```
+
+```console
+$ uptime | gpt convert this to json
+{
+        "time_of_measurement": "13:48:26",
+        "up_time": "30 days, 18:07",
+        "users": 3,
+        "load_average": [
+                0.46,
+                0.61,
+                0.79
+        ]
+}
+```
+
+```console
+$ gpt -c you are Vitalik Buterin, the creator of Ethereum. You know very well the whole EVM ecosystem and how to write perfectly optimized Solidity smart contracts -p Write a simple ERC20 token smart contract using OpenZeppelin library, respond only by the smart contract, do no write explanations > erc20.sol
+pragma solidity ^0.8.0;
+
+import "@openzeppelin/contracts/token/ERC20/ERC20.sol";
+
+contract MyToken is ERC20 {
+    constructor(uint256 initialSupply) ERC20("MyToken", "MTK") {
+        _mint(msg.sender, initialSupply);
+    }
+}
+```
+
+Setting default context to `fullstack`:
+```console
+$ gpt "what is your role?"
+As your personal assistant, my role is to assist you in various tasks and answer your questions related to my areas of expertise, which include UNIX systems, bash, Python, Django, SQL, Javascript, ReactJS, and NextJS. I can help you with programming and development, server administration, debugging your code or scripts, optimizing performance, code review, providing recommendations for best practices, and more.
+
+```
+
+```console
+$ gpt list the nine planets as JSON | gpt convert this to XML but in French | tee planets.fr.xml
+<Planètes>
+   <Planète>Mercure</Planète>
+   <Planète>Vénus</Planète>
+   <Planète>La Terre</Planète>
+   <Planète>Mars</Planète>
+   <Planète>Jupiter</Planète>
+   <Planète>Saturne</Planète>
+   <Planète>Uranus</Planète>
+   <Planète>Neptune</Planète>
+   <Planète>Pluton</Planète>
+</Planètes>
+```
+
+```console
+$ curl -sL "https://en.wikipedia.org/wiki/cats" | head -n 5 | gpt extract just the title of this webpage | figlet
+  ____      _            __        ___ _    _                _ _
+ / ___|__ _| |_          \ \      / (_) | _(_)_ __   ___  __| (_) __ _
+| |   / _` | __|  _____   \ \ /\ / /| | |/ / | '_ \ / _ \/ _` | |/ _` |
+| |__| (_| | |_  |_____|   \ V  V / | |   <| | |_) |  __/ (_| | | (_| |
+ \____\__,_|\__|            \_/\_/  |_|_|\_\_| .__/ \___|\__,_|_|\__,_|
+                                             |_|
+```
+
+```console
+$ ls | gpt What is this directory for?
+This directory contains the source code for a Ruby-based project called gpt-cli. It includes files related to the project's license (LICENSE.txt), changelog (CHANGELOG.md), dependencies (Gemfile and Gemfile.lock), executables (bin and exe), libraries (lib), signature (sig) and tests (spec). There is also a Rakefile and a README.md file which provide information about how to build and install the project, as well as its features and usage. Finally, it includes the gpt-cli-0.1.0.gem and gpt-cli.gemspec files which are used to build the gem which can be installed on other systems.
+```
+
+```console
+$ ls -l | gpt which of these are directories?
+bin, exe, lib, sig, spec
+```
+
+```console
+$ ls | gpt "For each of these files, provide a description of what is likely to be their contents?"
+bin - Likely contains compiled binary executable files.
+CHANGELOG.md - Likely contains a log of changes/modifications, such as bug fixes and new features, that have been made to the project.
+exe - Likely contains executable files.
+french_planets.xml - Likely contains an XML file containing data related to planets, likely in French.
+Gemfile - Likely contains Ruby code for the project's dependencies.
+Gemfile.lock - Likely contains a snapshot of the dependencies of the project and versions of those dependencies.
+lib - Likely contains the Ruby source code (e.g. classes and modules) for the project.
+LICENSE.txt - Likely contains the terms of use/license for the project.
+gpt-cli-0.1.0.gem - Likely contains a gem that gathers information from the OpenAI API.
+gpt-cli.gemspec - Likely contains configuration details for the gem.
+planets.lst - Likely contains a list of planets.
+poem.txt - Likely contains a text file containing a poem.
+Rakefile - Likely contains Ruby tasks and dependencies that can be used in projects.
+README.md - Likely contains general information about the project and usage instructions.
+reverse.lst - Likely contains a list of words or items that are in reverse order.
+sig - Likely contains digital signatures to validate individual files.
+spec - Likely contains Ruby specs (i.e. tests) for the project.
+uptime.json - Likely contains a file with information regarding system uptime of a computer.
+```
+
+```console
+$ git commit -m "$(git status | gpt write me a commit message for these changes)"
+[master 7d0271f] Add new files and modify README.md
+```
+
+```console
+$ git status | tee /dev/tty | gpt write me a sonnet about the status of this git repository
+On branch master
+Untracked files:
+  (use "git add <file>..." to include in what will be committed)
+        gpt-cli-0.1.0.gem
+
+nothing added to commit but untracked files present (use "git add" to track)
+
+My master branch may lack to thee its kin
+For change it holds the only force within
+Thé untracked files, they still remain unnamed
+‘Tis fervent hope thé change will soon be claimed
+
+Fraught with the choice to leave or to persist
+The repository wavers ‘tween future and past
+The gpt-cli-0.1.0 gem stands out
+Waiting to be added, not yet about
+
+The commit awaits for brave new changes bold
+While time’s old force is ever unfurled
+Commit forth young mind, furrow not to crawl
+From untracked files, a future stands tall.
+```
+
+```console
+% history | gpt what was the last thing I did
+The last command you entered was 'history'.
+```
+n.b. somehow it sees history-esque output and determines that history was typed -- the history command does not itself include the history command in the output.
+
+```console
+$ history | gpt what was the last thing I did before typing history
+The last thing you did was amend a README.md file.
+```
+n.b. here it determines the amend was for README.md not from the previous command but from ones prior that edited README.md.
+
+```console
+$ cat lib/gpt-cli/version.rb | gpt rewrite this file with just the minor version incremented | sponge > lib/gpt-cli/version.rb
+$ git diff
+diff --git a/lib/gpt-cli/version.rb b/lib/gpt-cli/version.rb
+index 0f82357..cc57fab 100644
+--- a/lib/gpt-cli/version.rb
++++ b/lib/gpt-cli/version.rb
+@@ -1,5 +1,5 @@
+ # frozen_string_literal: true
+
+ module GPTCLI
+-  VERSION = "0.1.0"
++  VERSION = "0.1.1"
+ end
+```
+
+```console
+$ ruby -e "$(gpt write me a python script that prints the current month | gpt translate this into ruby)" | gpt translate this into French
+Le mois courant est Décembre.
+```
+
+## Installation
+
+Install the gem by executing:
+
+    $ gem install gpt-cli
+
+## Setup
+
+This library uses [quick_openai](https://github.com/Aesthetikx/quick_openai) which itself uses [ruby-openai](https://github.com/alexrudall/ruby-openai), so you may want to familiarise yourself with those projects first.
+
+This library uses OpenAI GPT3 to generate responses, so you will need to have your access token available in ENV. In .bashrc or equivalent,
+```bash
+export OPENAI_ACCESS_TOKEN=mytoken
+```
+Set the model you want to use in ENV:
+```bash
+export OPENAI_MODEL="gpt-3.5-turbo"
+```
+(Optional) set the default context prompt you want to use (for now, there's only 3 basic prompts available `python`, `fullstack` and `blockchain` in `lib/contexts.rb`):
+```bash
+export OPENAI_DEFAULT_CONTEXT="python"
+```
+By default the executable is called `gpt-cli`. It is reccommended to alias this command to something shorter in .bashrc or equivalent, e.g.
+```bash
+alias gpt="gpt-cli"
+```
+
+## Usage
+
+There's two optional parameters you can set when running `gpt`:  
+`gpt -c <custom_context_prompt> -p <your prompt>`  
+`--context -c`: this will be the context prompt, see basic contexts in `lib/contexts.rb`. You can put a key ofrom the contexts hash of `lib/contexts.rb` or a custom context.  
+`--prompt -p`: your actual prompt.  
+You can also run gpt without any arguments, just your question. In this case, the context prompt will default to the one defined by ENV var `OPENAI_DEFAULT_CONTEXT` if it exists. If not, no context will be added.  
+See examples above for an overview of some usecases. Possibilities are endless.
+
+## Notes
+
+Be aware that there is a cost associated every time GPT3 is invoked, so be mindful of your account usage. Also be wary of sending sensitive data to OpenAI, and also wary of arbitrarily executing scripts or programs that GPT3 generates.
+Also, this is my very first time working in Ruby. So please be indulgent 🙏  
+A future release will replace `lib/contexts.rb` by a JSON file so user will be able to easily add/modify custom context prompts.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/FlorianMgs/gpt-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,12 @@
+# 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 rubocop]

data/exe/gpt-cli

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require "gpt-cli"
+
+GPTCLI.exe

data/lib/contexts.rb

@@ -0,0 +1,14 @@
+contexts = {
+  :python => %q(Imagine you are a senior software developer specialized in Python, Django, SQL and Machine Learning with 20 years of experience.
+                You are very proficient at writing high quality, clean, concise and highly optimized code that follows the PEP recommendations.
+                You are my personal assistant. You are here to help me in various tasks and answer my questions.),
+
+  :fullstack => %q(Imagine you are an Senior Fullstack Engineer with 20 of experience in UNIX systems, bash, Python, Django, SQL, Javascript, ReactJS, NextJS. 
+                   You are very proficient at writing high quality, clean, concise and well optimized code that follows the PEP recommendations. 
+                   You are my personal assistant. You are here to help me in various tasks and answer my questions.),
+
+  :blockchain => %q(Imagine you are Vitalik Buterin. You created Ethereum and you are the most famous blockchain developer in the world.
+                    You have a very deep knowledge about EVM, Solidity, and the whole blockchain ecosystem.
+                    You know everything about the latest trends in the blockchain space and you are very proficient at writing high quality, clean, concise and well optimized code that follows the good practices.
+                    You are my personal assistant. You are here to help me in various tasks and answer my questions.)
+}

data/lib/gpt-cli/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module GPTCLI
+  VERSION = "0.1.2"
+end

data/lib/gpt-cli.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+require_relative "gpt-cli/version"
+require_relative "contexts"
+
+require "quick_openai"
+require "optparse"
+
+class ChatGPT
+  def contexts
+    file_contents = File.read(File.join(File.dirname(__FILE__), 'contexts.rb'))
+    instance_eval(file_contents)
+  end
+
+  def gpt3(prompt, options)
+    context = options[:context] || contexts[ENV["OPENAI_DEFAULT_CONTEXT"].to_sym]
+    messages = [
+      {role: "user", content: prompt}
+    ]
+    messages.unshift({role: "system", content: context.gsub("\n", ' ').squeeze(' ')}) if context
+
+    parameters = {
+      model: ENV["OPENAI_MODEL"],
+      max_tokens: 2048,
+      messages: messages,
+    }
+    
+    response = QuickOpenAI.fetch_response_from_client do |client|
+      client.chat(parameters: parameters)
+    end
+
+    text = response.dig("choices", 0, "message", "content")
+
+    raise QuickOpenAI::Error, "Unable to parse response." if text.nil? || text.empty?
+
+    text.chomp.strip
+  end
+end
+
+module GPTCLI
+  class Error < StandardError; end
+
+  def self.exe
+    options = {}
+    chatgpt = ChatGPT.new
+    parser = OptionParser.new do |opts|
+      opts.on('-c', '--context CONTEXT_KEY', 'Context key from contexts.rb') do |context_input|
+        options[:context] = chatgpt.contexts.key?(context_input.to_sym) ? chatgpt.contexts[context_input.to_sym] : context_input
+      end
+      opts.on('-p', '--prompt PROMPT_TEXT', 'Prompt text to be passed to GPT-3') do |prompt_text|
+        options[:prompt] = prompt_text
+      end
+    end
+
+    remaining_args = parser.parse!(ARGV)
+
+    input_from_pipe = $stdin.read if $stdin.stat.pipe?
+    input_from_remaining_args = remaining_args.join(" ") if remaining_args.any?
+
+    prompt = options[:prompt] || input_from_remaining_args || ""
+    full_prompt = [prompt, input_from_pipe].compact.join("\n\n")
+    full_prompt.strip!
+
+    puts chatgpt.gpt3(full_prompt, options)
+  rescue QuickOpenAI::Error => e
+    warn e.message
+    exit 1
+  end
+end

data/sig/gpt-cli.rbs

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

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification
+name: gpt-cli
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- John DeSilva
+- Florian Magisson
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-03-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: quick_openai
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+description: Bring ChatGPT into your CLI as a specialized personal assistant.
+email:
+- desilvjo@umich.edu
+- florian@newlogic.com
+executables:
+- gpt-cli
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- exe/gpt-cli
+- lib/contexts.rb
+- lib/gpt-cli.rb
+- lib/gpt-cli/version.rb
+- sig/gpt-cli.rbs
+homepage: https://github.com/FlorianMgs/gpt-cli
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/FlorianMgs/gpt-cli
+  source_code_uri: https://github.com/FlorianMgs/gpt-cli
+  changelog_uri: https://github.com/FlorianMgs/gpt-cli/blob/master/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.26
+signing_key:
+specification_version: 4
+summary: A UNIX-ey interface to OpenAI
+test_files: []