openai-please 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: de7075efdfbec978dc13fa6621f80e9e146e81cffb9652b19c17577befb4258a
-  data.tar.gz: 22fcdec50244d7d02826e25a3f4fb7a5e542f151da749ab67d7d9a3de0e7d7cb
+  metadata.gz: f57df851a98cb38c098cae4762fb1174ceb8a43e6bae36104c1dcc479fbcedb9
+  data.tar.gz: 23e3002663ae954bfd109500a7bedde579a5f28add34fb94abfdf114a48dbe92
 SHA512:
-  metadata.gz: 7aa0a478868627ba84898ca812958f5c37a46bd0872fe4ddbba4d1c222d2700f0d887b0e7ba207683e3a4620e9a73c63e61d73f77e6bf76f8b422a9f54a2bbf6
-  data.tar.gz: 978bcfb2597c5b2f7c1157cedd755b6a058395c9d844472649524ddc9531d5f9a4fde7e6f7af5dd237ed4801274f3274d14753cfd6c25e65387ff16b38ee2250
+  metadata.gz: fa0e870e7d6ef5cb147ea92b96ecaf6b5dae6c4c138732dfcca90a2af5646be62fdc1aa59931aa19c5d1f4197616116d223f218e4bd4df190a4bd41f5e30cb44
+  data.tar.gz: 32b6ebf0c3fa2f5228dfd2a97ff019e01984d59f92e27d1f50fafbaab53b841c00be4b4678d1caf87983a8b00a3770d4488a7746aecf3eeeac92936680c71a8e

data/Gemfile.lock

@@ -1,21 +1,18 @@
 PATH
   remote: .
   specs:
-    openai-please (0.1.2)
-      ruby-openai (>= 1.3)
-      tty-prompt (>= 0.23)
+    openai-please (0.2.0)
+      ruby-openai (~> 3.0)
+      tty-prompt (~> 0.23)
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.2)
-    dotenv (2.7.6)
-    httparty (0.18.1)
-      mime-types (~> 3.0)
+    httparty (0.21.0)
+      mini_mime (>= 1.0.0)
       multi_xml (>= 0.5.2)
-    mime-types (3.3.1)
-      mime-types-data (~> 3.2015)
-    mime-types-data (3.2021.0901)
+    mini_mime (1.1.2)
     minitest (5.14.4)
     multi_xml (0.6.0)
     parallel (1.21.0)
@@ -38,9 +35,8 @@ GEM
       unicode-display_width (>= 1.4.0, < 3.0)
     rubocop-ast (1.11.0)
       parser (>= 3.0.1.1)
-    ruby-openai (1.3.1)
-      dotenv (~> 2.7.6)
-      httparty (~> 0.18.1)
+    ruby-openai (3.0.3)
+      httparty (>= 0.18.1, < 0.22.0)
     ruby-progressbar (1.11.0)
     tty-color (0.6.0)
     tty-cursor (0.7.1)
@@ -65,4 +61,4 @@ DEPENDENCIES
   rubocop (~> 1.7)
 
 BUNDLED WITH
-   2.2.22
+   2.4.3

data/README.md

@@ -10,7 +10,7 @@ Convert natural language to bash commands using OpenAI Codex
 
     $ gem install openai-please
 
-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.
+Provide your [OpenAI API key](https://help.openai.com/en/articles/5480100-how-do-i-gain-access-to-openai-codex) in an environment variable, or using the [configuration file](#configuration).
 
 ```
 OPENAI_ACCESS_TOKEN=[YOUR ACCESS TOKEN HERE]
@@ -18,20 +18,66 @@ OPENAI_ACCESS_TOKEN=[YOUR ACCESS TOKEN HERE]
 
 ## Usage
 
+Type `please`, followed by an instruction written in natural language.
+
 ```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]
 ```
 
-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.
+You can [e]dit the command before running it by pressing the 'e' key. This uses the command specified in the `$EDITOR` variable, or `vi` if no editor is set.
+
+See `please --help` for more information.
+
+## Configuration
+
+You can modify the default configuration in `~/.config/please/config.yml`.
+
+```yaml
+send_pwd: false             # default: true
+send_ls: false              # default: true
+send_uname: true            # default: true
+
+access_token: ...           # default: $OPENAI_ACCESS_TOKEN
+
+examples:                   # default: []
+  - instruction: Run my super secret command
+    command: /super/secret/command
+    
+  - instruction: Show git status
+    command: git status
+    execute: true           # default: false
+    
+skip_default_examples: true # default: false
+```
+
+### `examples`
+
+Any examples listed here will be added to the prompt in the following form.
+
+```
+# INSTRUCTION
+$ COMMAND
+[RESULT, if execute is set to true]
+```
+
+If `execute` is set to true, the command will be executed prior to sending the request and the result will be included in the prompt. This is useful for providing dynamic context which the AI can use to inform completions.
+
+### `skip_default_examples`
+
+Do not include the default set of examples in the prompt. You can see the full prompt by running `please --show-prompt`. 
+
+*Note:* This option does not automatically imply `send_*: false`. To remove all examples from the prompt other than those explicitly specified, use this option in combination with the `send_*: false` options.
 
 ## Privacy
 
-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.
+By default, the result of each of the following commands is sent to OpenAI Codex to improve the relevance of completions.
 
 - `pwd`
 - `uname -a`
 - `ls -a`
 
+This behaviour can be disabled using the configuration options described above. You can review the prompt before sending it to OpenAI by running `please --show-prompt`. 
+
 See [OpenAI's privacy policy](https://beta.openai.com/policies/privacy-policy) for more information.

data/lib/please/openai/codex_service.rb

@@ -9,10 +9,7 @@ module Please
         client = ::OpenAI::Client.new(access_token: access_token)
 
         response = client.completions(
-          engine: 'davinci-codex',
-          parameters: default_parameters.merge(
-            prompt: prompt,
-          ),
+          parameters: default_parameters.merge(prompt: prompt),
         )
 
         response.parsed_response.fetch('choices').first.fetch('text')
@@ -22,6 +19,7 @@ module Please
 
       def default_parameters
         {
+          model: 'code-davinci-002',
           temperature: 0,
           max_tokens: 512,
           top_p: 1,

data/lib/please/version.rb

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

data/please.gemspec

@@ -26,8 +26,8 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   # Uncomment to register a new dependency of your gem
-  spec.add_dependency 'ruby-openai', '>= 1.3'
-  spec.add_dependency 'tty-prompt', '>= 0.23'
+  spec.add_dependency 'ruby-openai', '~> 3.0'
+  spec.add_dependency 'tty-prompt', '~> 0.23'
 
   # For more information and examples about making a new gem, checkout our
   # guide at: https://bundler.io/guides/creating_gem.html

metadata

@@ -1,41 +1,41 @@
 --- !ruby/object:Gem::Specification
 name: openai-please
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Joe Anderson
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-09-16 00:00:00.000000000 Z
+date: 2023-01-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-openai
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: tty-prompt
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.23'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.23'
 description: 
@@ -87,7 +87,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.4.1
 signing_key: 
 specification_version: 4
 summary: Convert natural language to bash commands using OpenAI Codex