clai 0.1.1 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4e8a4ba69b4bb0403208ae9d6a6d45b90668447ac35606761c546dae4e51451a
-  data.tar.gz: e3bc9eb1ffdb659059ce249cf88334abef0456f504945b3ddb243116bb756374
+  metadata.gz: 12a0492d4b34d7e6366d5a05b262333e11acee78b80fff34e5fa37c4eb1ce6dc
+  data.tar.gz: 51ca0c434ad228d034a7879d5ad6c05b7892912173e8ab3659539b52d00d2ff0
 SHA512:
-  metadata.gz: c3a31a975f7a3b0a623ae19d895a5ede3ff3156b562f10367d2e6597ecdad1b3713b29874e35b292ac4c6ad8df54494b526486083280da2753bdbd6f9d66b39d
-  data.tar.gz: 4a14d13fda0e91c52c27f3c1cd1cd9b1e6501ce142d397310b650c8277c9f9d6cacb152f6f007e45a23a456b66c32ec1871ee721524c5805ed3e44b400d94930
+  metadata.gz: a817fb1aaa112664e6647d6480eb6eb42c837d48db311f92ff7dd34ea08c1b308cca77011117b46a4100386071f0ac59773ff515c34ebefcc895a4670e1e1fe9
+  data.tar.gz: e40075423db3770dfad17e272bd8cd403f5be4c50cabd8ec0b4f05efaec3049f0ac3461fbf4c43c48803546be7026470da8558940e0ab6521a4a450dacd29f36

data/CONTRIBUTING.md

@@ -3,15 +3,14 @@
 The following topics are missing for a 1.0.0 release:
 
 ```
-* Allow adding "personas" to the config ([see here](docs/personas.md))
-* Rewrite with tests as soon as the basic prototype is useful
+* Rewrite/Refactor with tests as soon as the basic prototype is useful
 * Add GitHub Actions for PRs
 * Build a landing page
 ```
 
 Please use `clai` and contribute here on GitHub. I'm open to all suggestions and improvements.
 
-0.x.x versions don't need tests or extensive documentation. Adding a small description will help me understand your change though :)
+PRs for the 0.x.x versions don't need tests or extensive documentation. Adding a small description will help me understand your change though :)
 
 Please open a PR with a short description of your use-case and I will review and merge.
 

data/README.md

@@ -13,7 +13,7 @@ CLAI (CLI + AI = CLAI) allows you to interact with the OpenAI API in your termin
 First, ensure that you have Ruby installed on your system. Then, you can install the gem by running:
 
 ```
-$ gem install clai
+gem install clai
 ```
 
 ## Configuration
@@ -21,7 +21,7 @@ $ gem install clai
 Before using the CLI tool, you need to configure it with your OpenAI API key. You can obtain an API key from the OpenAI website. Once you have your API key, run the following command and provide your key when prompted:
 
 ```
-$ clai setup
+clai setup
 ```
 
 This will create a configuration file (`~/.config/clai/clai.yml`) on your system.
@@ -33,7 +33,7 @@ Read more about the setup command [here](docs/setup.md).
 You can chat with ChatGPT with:
 
 ```
-$ clai chat "Tell me a funny joke"
+clai chat "Tell me a funny joke"
 ```
 
 This will send the given prompt to the API and display the generated completion.
@@ -43,7 +43,7 @@ This will send the given prompt to the API and display the generated completion.
 To view the available commands and options, you can use the `help` command:
 
 ```
-$ clai help
+clai help
 ```
 
 This will display a list of supported commands and their descriptions.
@@ -53,7 +53,7 @@ This will display a list of supported commands and their descriptions.
 You can start an interactive session with `clai session` command.
 
 ```
-$ clai session
+clai session
 Your prompt: <Enter your prompt here><Enter>
 ```
 
@@ -63,18 +63,18 @@ This will start a REPL like process to interact with the OpenAI api.
 
 Here are a few examples to get you started:
 
-```sh
+```
 # Setup clai on your machine
-$ clai setup
+clai setup
 
 # Start an interactive chat session
-$ clai session
+clai session
 
 # Get help about the available commands and options
-$ clai help
+clai help
 
 # Send a single prompt
-$ clai chat "Hello World"
+clai chat "Hello World"
 ```
 
 ## Contributing

data/docs/chat.md

@@ -4,7 +4,9 @@ Send a single prompt to the completions api.
 
 Some examples:
 
-
 ```
-$ clai chat "Tell me a funny joke"
+clai chat "Tell me a funny joke"
+
+# Write ruby code
+clai chat "Count to 10" --persona ruby
 ```

data/docs/intro.md

@@ -1,10 +1,10 @@
 # Introduction
 
 You can think of `clai` as ChatGPT for the terminal.
-It's very basic at the moment. You can think of it as ChatGPT for the terminal. I'm currently trying to incorporate clai in my daily work, so I'm still experimenting with the API.
+It's very basic at the moment. I'm currently trying to incorporate clai in my daily work, so I'm still experimenting with the API.
 
 `clai` currently supports OpenAI and needs a paid API key to work.
 
 My main use case currently is to have a terminal opened with a clai session and ask questions instead of googling.
 
-0.x.0 will be unstable and untested, I'm currently aiming to release a tested 1.0.0 soon. Please see [here](https://github.com/codergeek121/clai/CONTRIBUTING.MD) on how to contribute at this stage of the project.
+0.x.0 will be unstable and untested, I'm currently aiming to release a tested 1.0.0 soon. Please see [here](https://github.com/codergeek121/clai/CONTRIBUTING.MD) on how to contribute at the current stage of the project.

data/docs/personas.md

@@ -1,23 +1,36 @@
 # Personas
 
-TODO: This feature is still under development!
+Clai allows you to configure different personas. Whenever you're calling clai, it's possible to pass a specified persona with `--persona`. This will pass system prompts to ChatGPT. It works similar to "Custom instructions" in ChatGPT.
 
-A clai setup should allow preconfiguring multiple personas. Each command should support a `--persona` option to allow setting some default prompts to the api.
-
-An example could look like this:
+The base clai setup comes with the following default personas config:
 
 ```yaml
 personas:
-  work:
-    - Use professional language
-    - Keep your answer below 100 words
-  bavarian:
-    - Use a bavarian accent
-
-# Starting a session with a preselected persona
-$ clai session --persona bavarian
-Your prompt: <Your prompt><Enter>
-Some bavarian answer.
+  default:
+    - You are a helpful assistant
+    - You answers are formatted in markdown
+  ruby:
+    - You are a ruby programmer
+    - You do not comment your code
+```
+
+Compare the outputs when using different personas.
+
+```
+$ clai chat "Count to 10" --persona ruby
+Sure, here's how you can count to 10 in Ruby:
+
+(1..10).each do |num|
+  puts num
+end
+
+// Without a persona, fallbacks to the "default" persona
+$ clai chat "Count to 10"
+
+1, 2, 3, 4, 5, 6, 7, 8, 9, 10
+
+// Start a ruby persona session
+$ clai session --persona ruby
 ```
 
-The default setup should have useful personas as a default.
+The persona under the key `default:` is used whenever you're not specifying a explicit persona.

data/docs/session.md

@@ -1,3 +1,12 @@
 # Session
 
-TODO
+Start a REPL like chat session.
+
+Some examples:
+
+```
+clai session
+
+# Start a Ruby session
+clai session --persona ruby
+```

data/docs/setup.md

@@ -1,3 +1,5 @@
 # Setup
 
-TODO
+`clai setup` will create a config file with a base configuration.
+
+`clai setup --force` will overwrite the basic config with the default configuration. It's mainly useful in development of the gem.

data/lib/clai/cli.rb

@@ -2,24 +2,34 @@ module CLAI
   class CLI < Thor
     default_task :session
 
+    option :persona, type: :string
     desc "session", "Start an interactive chat session"
     long_desc <<~DESC
     Starts a REPL like chat process
 
     > $ clai session
+
+    Use a preconfigured persona with --persona
+
+    > $ clai chat "Count to 10" --persona ruby
     DESC
     def session
-      Commands::Session.new(config).start_session
+      Commands::Session.new(config).start_session(persona: options['persona'])
     end
 
+    option :persona, type: :string
     desc "chat", "Prompt on the terminal"
     long_desc <<~DESC
     Send a single prompt to AI
 
     > $ clai chat "Tell me a short story!"
+
+    Use a preconfigured persona with --persona
+
+    > $ clai chat "Count to 10" --persona ruby
     DESC
     def chat(prompt)
-      Commands::Chat.new(config).chat(prompt)
+      Commands::Chat.new(config).chat(prompt, persona: options['persona'])
     end
 
     option :force, type: :boolean, default: false

data/lib/clai/commands/chat.rb

@@ -5,8 +5,9 @@ module CLAI
         @config = config
       end
 
-      def chat(prompt)
-        HTTPClient.new(@config).chat(prompt)
+      def chat(prompt, persona: 'default')
+        system_prompts = @config.personas.fetch(persona, [])
+        HTTPClient.new(@config).chat(prompt, system_prompts: system_prompts)
       end
     end
   end

data/lib/clai/commands/session.rb

@@ -5,12 +5,13 @@ module CLAI
         @config = config
       end
 
-      def start_session
+      def start_session(persona: 'default')
+        system_prompts = @config.personas.fetch(persona, [])
         loop do
           print S.(:prompt)
           question = $stdin.gets
           break unless question
-          HTTPClient.new(@config).chat(question.strip)
+          HTTPClient.new(@config).chat(question.strip, system_prompts: system_prompts)
           puts
         end
       end

data/lib/clai/commands/setup.rb

@@ -42,6 +42,13 @@ module CLAI
           # Read more about the clai.yml config file at https://github.com/codergeek121/clai/docs/setup.md
           api_key: #{@api_key}
           model: gpt-3.5-turbo
+          personas:
+            default:
+              - You are a helpful assistant
+              - You answers are formatted in markdown
+            ruby:
+              - You are a ruby programmer
+              - You do not comment your code
         YML
       end
     end

data/lib/clai/config.rb

@@ -2,17 +2,22 @@ module CLAI
   class Config
     def self.parse
       config = YAML.safe_load_file(CLAI.config_file_path)
-      new(api_key: config["api_key"], model: config["model"])
+      new(
+        api_key: config["api_key"],
+        model: config["model"],
+        personas: config["personas"]
+      )
     rescue Errno::ENOENT
       puts S.(:no_clai_yml)
       exit(false)
     end
 
-    attr_reader :api_key, :model
+    attr_reader :api_key, :model, :personas
 
-    def initialize(api_key:, model:)
+    def initialize(api_key:, model:, personas:)
       @api_key = api_key
       @model = model
+      @personas = personas
     end
   end
 end

data/lib/clai/http_client.rb

@@ -4,14 +4,16 @@ module CLAI
       @config = config
     end
   
-    def chat(query)
+    def chat(query, system_prompts: [])
+      system_prompts = system_prompts.map { |prompt| { role: :system, content: prompt } }
       puts
       client
         .post("https://api.openai.com/v1/chat/completions",
           json: {
             model: @config.model,
             messages: [
-              { "role": "user", "content": query }
+              *system_prompts,
+              { "role": "user", "content": query },
             ],
             stream: true
           }

data/lib/clai/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module CLAI
-  VERSION = "0.1.1"
+  VERSION = "0.2.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: clai
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.1
 platform: ruby
 authors:
 - Niklas Häusele
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-07-17 00:00:00.000000000 Z
+date: 2023-07-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: zeitwerk