openai-please 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 88db2eab8d2aafb7387f3f13b7da57ec499f85ab25c75b51a2ee342c4a0fa5c1
-  data.tar.gz: f50f4df10b90b1ab68543a9fb14a6494d47a33bccaf3fa54e829c43fe6215caa
+  metadata.gz: ffc331fe72fcbe5a6feec2f0ed039c7aeb453039e40ae533a05f2ff794447ef5
+  data.tar.gz: 55771e4ff93f8b209cda88778ac2eb6ed8118201c3c8d77d2ef61143f747097e
 SHA512:
-  metadata.gz: 692f1d6e44402e12d6fa59a7733b7b6620323be48f8ef999b367616a917d53262ee8bc1aeb9f4628a583978fea77f653536112f2c2a29b2eaddb915feb28f8d7
-  data.tar.gz: 675d9326b5e682e7d45c36162ec1fb52ea6487058843a274f8e75eb9cf8505fc5759241987f7f986bcf2bc13570ebbfa81ee1abed16864d024a98a6c77501b47
+  metadata.gz: 3d40360b108300c1c6e862ffa1ef0ed1339cb5860eb074a0a241f5fd0f631fd802c0f9573ba254fced1a5dfdccc13c71b3cadf39e2aeb05ea51136cfba3e5040
+  data.tar.gz: 0c9978a654d714ff870863bbe5ba0a745073528906999ff0ba6d3513444cb5c31dcf1b34247359e13c76a4bcd92823b2c609b2b11493ccc43277d42d4382a1f7

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    please (0.1.0)
+    openai-please (0.1.1)
       ruby-openai (>= 1.3)
       tty-prompt (>= 0.23)
 
@@ -60,7 +60,7 @@ PLATFORMS
 
 DEPENDENCIES
   minitest (~> 5.0)
-  please!
+  openai-please!
   rake (~> 13.0)
   rubocop (~> 1.7)
 

data/README.md

@@ -1,39 +1,37 @@
 # Please
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/please`. To experiment with that code, run `bin/console` for an interactive prompt.
+**⚠️ Requires an access token for OpenAI Codex, which is currently in private beta**
 
-TODO: Delete this and the text above, and describe your gem
+Convert natural language to bash commands using OpenAI Codex
 
-## Installation
-
-Add this line to your application's Gemfile:
+![Demo video](https://user-images.githubusercontent.com/4272090/133416481-febce287-1c3b-4a10-ab3e-b7228d403d7a.gif)
 
-```ruby
-gem 'please'
-```
-
-And then execute:
+## Installation
 
-    $ bundle install
+    $ gem install openai-please
 
-Or install it yourself as:
+Ensure your [OpenAI API key](https://help.openai.com/en/articles/5480100-how-do-i-gain-access-to-openai-codex) is stored in an environment variable.
 
-    $ gem install please
+```
+OPENAI_ACCESS_TOKEN=[YOUR ACCESS TOKEN HERE]
+```
 
 ## Usage
 
-TODO: Write usage instructions here
-
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+```shell
+user@host:~$ please find all files larger than 1 mb
+$ find . -type f -size +1M
+Run the command? (enter "h" for help) [y,n,e,h]
+```
 
-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).
+You can [e]dit the command before running it by pressing the 'e' key. This uses the editor specified in the $EDITOR variable, defaulting to vi.
 
-## Contributing
+## Privacy
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/please.
+In addition to the instruction text, the result of each of the following commands is sent to OpenAI Codex to improve the relevance of completions.
 
-## License
+- `pwd`
+- `uname -a`
+- `ls -a`
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+See [OpenAI's privacy policy](https://beta.openai.com/policies/privacy-policy) for more information.

data/lib/please/cli.rb

@@ -1,67 +1,100 @@
 # frozen_string_literal: true
 
+require 'English'
 require 'tty-prompt'
 require 'optparse'
 require 'please'
 require 'tempfile'
 
-tty_prompt = TTY::Prompt.new
+begin
+  tty_prompt = TTY::Prompt.new
 
-options = {}
+  options = {
+    show_prompt: false,
+    send_pwd: true,
+    send_uname: true,
+    send_ls: true,
+  }
 
-USAGE = 'Usage: please [options] <instruction>'
+  USAGE = 'Usage: please [options] <instruction>'
 
-OptionParser.new do |opts|
-  opts.banner = USAGE
-end.parse!
+  OptionParser.new do |opts|
+    opts.banner = USAGE
 
-access_token = ENV.fetch('OPENAI_ACCESS_TOKEN') do
-  tty_prompt.error 'Ensure the OPENAI_ACCESS_TOKEN environment variable is set'
-  exit 1
-end
+    opts.on('--show-prompt', 'Output the prompt that would ordinarily be sent to OpenAI Codex, and then exit') do |v|
+      options[:show_prompt] = v
+    end
 
-codex_service = Please::OpenAI::CodexService.new(access_token: access_token)
+    opts.on('--[no-]send-pwd', 'Send the result of `pwd` as part of the prompt') do |v|
+      options[:send_pwd] = v
+    end
 
-instruction = ARGV.join(' ')
+    opts.on('--[no-]send-uname', 'Send the result of `uname -a` as part of the prompt') do |v|
+      options[:send_uname] = v
+    end
 
-if instruction.empty?
-  tty_prompt.error USAGE
-  exit 1
-end
+    opts.on('--[no-]send-ls', 'Send the result of `ls -a` as part of the prompt') do |v|
+      options[:send_ls] = v
+    end
+  end.parse!
 
-request = Please::Request.new(
-  options: options,
-  instruction: instruction,
-  codex_service: codex_service,
-)
+  access_token = ENV.fetch('OPENAI_ACCESS_TOKEN') do
+    tty_prompt.error 'Ensure the OPENAI_ACCESS_TOKEN environment variable is set'
+    exit 1
+  end
 
-command = request.send
+  codex_service = Please::OpenAI::CodexService.new(access_token: access_token)
 
-loop do
-  print '$ '
-  tty_prompt.ok command
+  instruction = ARGV.join(' ')
 
-  action = tty_prompt.expand('Run the command?') do |q|
-    q.choice key: 'y', name: 'Yes', value: :run
-    q.choice key: 'n', name: 'No', value: :abort
-    q.choice key: 'e', name: 'Edit command before running', value: :edit
+  if instruction.empty?
+    tty_prompt.error USAGE
+    exit 1
   end
 
-  case action
-  when :run
-    Process.wait spawn(command)
-    exit $?.exitstatus
-  when :abort
-    break
-  when :edit
-    Tempfile.open('command') do |file|
-      file << command
-      file.flush
-
-      Process.wait spawn("${EDITOR:-vi} #{file.path}")
-
-      file.rewind
-      command = file.read.chomp
+  context = Please::Context.new(options)
+
+  request = Please::Request.new(
+    instruction: instruction,
+    context: context,
+    codex_service: codex_service,
+  )
+
+  if options[:show_prompt]
+    tty_prompt.say request.prompt
+    exit
+  end
+
+  command = request.send
+
+  loop do
+    print '$ '
+    tty_prompt.ok command
+
+    action = tty_prompt.expand('Run the command?') do |q|
+      q.choice key: 'y', name: 'Yes', value: :run
+      q.choice key: 'n', name: 'No', value: :abort
+      q.choice key: 'e', name: 'Edit command before running', value: :edit
+    end
+
+    case action
+    when :run
+      Process.wait spawn(command)
+      exit $CHILD_STATUS.exitstatus
+    when :abort
+      break
+    when :edit
+      Tempfile.open('command') do |file|
+        file << command
+        file.flush
+
+        Process.wait spawn("${EDITOR:-vi} #{file.path}")
+
+        file.rewind
+        command = file.read.chomp
+      end
     end
   end
+rescue Interrupt
+  exit 130
 end

data/lib/please/context.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+module Please
+  class Context
+    def initialize(options)
+      @examples = default_examples
+
+      if options[:send_pwd]
+        @examples << {
+          instruction: 'Print the current working directory',
+          command: 'pwd',
+        }
+      end
+
+      if options[:send_uname]
+        @examples << {
+          instruction: 'Show information about the operating system',
+          command: 'uname -a',
+        }
+      end
+
+      if options[:send_ls]
+        @examples << {
+          instruction: 'List all files in the current directory',
+          command: 'ls -a',
+        }
+      end
+    end
+
+    def to_s
+      @examples.map do |example|
+        <<~EXAMPLE.chomp
+          # #{example[:instruction]}
+          $ #{example[:command]}
+          #{example.fetch(:result) { `#{example[:command]}` }}
+        EXAMPLE
+      end.join("\n")
+    end
+
+    private
+
+    def default_examples
+      [
+        {
+          instruction: 'Find all files older than 1 week and open each of them in vim',
+          command: 'find . -type f -mtime +7 -exec vim {} \;',
+          result: '',
+        },
+
+        {
+          instruction: 'Download a random dog picture',
+          command: 'python3 -c \'import urllib.request; import json; import subprocess; data = urllib.request.urlopen("https://dog.ceo/api/breeds/image/random").read(); url = json.loads(data)["message"]; subprocess.call(["curl", url, "-o", "dog.jpg"])\'',
+          result: '',
+        },
+
+        {
+          instruction: 'Read from stdin until EOF, and then output the length of the string',
+          command: 'python3 -c \'import sys; print(len(sys.stdin.read().strip()))\'',
+          result: '',
+        },
+
+        {
+          instruction: 'Read a single line from stdin and pipe it to cowsay',
+          command: 'python3 -c \'print(input())\' | cowsay',
+          result: '',
+        },
+
+        {
+          instruction: 'Run the fortune command 5 times',
+          command: 'for i in {1..5}; do fortune; done',
+          result: '',
+        },
+      ]
+    end
+  end
+end

data/lib/please/openai/codex_service.rb

@@ -27,7 +27,7 @@ module Please
           top_p: 1,
           frequency_penalty: 0,
           presence_penalty: 0,
-          stop: ["\n"],
+          stop: ["\n\n"],
         }
       end
     end

data/lib/please/request.rb

@@ -1,22 +1,25 @@
 # frozen_string_literal: true
 
 module Please
-  Request = Struct.new(:options, :instruction, :codex_service, keyword_init: true) do
+  Request = Struct.new(:instruction, :codex_service, :context, keyword_init: true) do
     def send
-      codex_service.completion(<<~PROMPT.chomp).strip
-        Write a one-line bash command each of the following tasks.
+      codex_service.completion(prompt)
+        .strip
+        # Collapse multiline commands into one line
+        .gsub(/\s*\\\n\s*/, ' ')
+        # Remove subsequent lines that do not contain commands
+        .gsub(/\n[^\$][^\n]*$/, '')
+        # Collapse multiple commands into one line
+        .gsub(/\n\$ /, '; ')
+        # Remove multiple consecutive spaces
+        .gsub(/\s+/, ' ')
+    end
 
-        # Print the current working directory
-        $ pwd
-        #{`pwd`}
+    def prompt
+      <<~PROMPT.chomp
+        Write a one-line bash command for each of the following tasks.
 
-        # Show information about the operating system
-        $ uname -a
-        #{`uname -a`}
-      
-        # List all files in the current directory
-        $ ls -a
-        #{`ls -a`}
+        #{context.to_s}
 
         # #{instruction.gsub(/\n/, " ")}
         $

data/lib/please/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Please
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

data/lib/please.rb

@@ -2,6 +2,7 @@
 
 require_relative 'please/version'
 require_relative 'please/request'
+require_relative 'please/context'
 require_relative 'please/openai/codex_service'
 
 module Please

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openai-please
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Joe Anderson
@@ -61,6 +61,7 @@ files:
 - exe/please
 - lib/please.rb
 - lib/please/cli.rb
+- lib/please/context.rb
 - lib/please/openai/codex_service.rb
 - lib/please/request.rb
 - lib/please/version.rb