clai 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4e8a4ba69b4bb0403208ae9d6a6d45b90668447ac35606761c546dae4e51451a
+  data.tar.gz: e3bc9eb1ffdb659059ce249cf88334abef0456f504945b3ddb243116bb756374
+SHA512:
+  metadata.gz: c3a31a975f7a3b0a623ae19d895a5ede3ff3156b562f10367d2e6597ecdad1b3713b29874e35b292ac4c6ad8df54494b526486083280da2753bdbd6f9d66b39d
+  data.tar.gz: 4a14d13fda0e91c52c27f3c1cd1cd9b1e6501ce142d397310b650c8277c9f9d6cacb152f6f007e45a23a456b66c32ec1871ee721524c5805ed3e44b400d94930

data/CONTRIBUTING.md

@@ -0,0 +1,19 @@
+# Contributing
+
+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
+* 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 :)
+
+Please open a PR with a short description of your use-case and I will review and merge.
+
+Thank you,
+Niklas

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Niklas Häusele
+
+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,90 @@
+# CLAI - CLI + AI in your terminal
+
+[![MIT](https://img.shields.io/badge/license-mit-green?style=for-the-badge)](LICENSE)
+![Ruby](https://img.shields.io/badge/ruby-%23CC342D.svg?style=for-the-badge&logo=ruby&logoColor=white)
+![ChatGPT](https://img.shields.io/badge/chatGPT-74aa9c?style=for-the-badge&logo=openai&logoColor=white)
+
+![Demo](demo.gif)
+
+CLAI (CLI + AI = CLAI) allows you to interact with the OpenAI API in your terminal.
+
+## Installation
+
+First, ensure that you have Ruby installed on your system. Then, you can install the gem by running:
+
+```
+$ gem install clai
+```
+
+## Configuration
+
+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
+```
+
+This will create a configuration file (`~/.config/clai/clai.yml`) on your system.
+
+Read more about the setup command [here](docs/setup.md).
+
+## Usage
+
+You can chat with ChatGPT with:
+
+```
+$ clai chat "Tell me a funny joke"
+```
+
+This will send the given prompt to the API and display the generated completion.
+
+### Help
+
+To view the available commands and options, you can use the `help` command:
+
+```
+$ clai help
+```
+
+This will display a list of supported commands and their descriptions.
+
+### Starting a session
+
+You can start an interactive session with `clai session` command.
+
+```
+$ clai session
+Your prompt: <Enter your prompt here><Enter>
+```
+
+This will start a REPL like process to interact with the OpenAI api.
+
+## Examples
+
+Here are a few examples to get you started:
+
+```sh
+# Setup clai on your machine
+$ clai setup
+
+# Start an interactive chat session
+$ clai session
+
+# Get help about the available commands and options
+$ clai help
+
+# Send a single prompt
+$ clai chat "Hello World"
+```
+
+## Contributing
+
+Please read [CONTRIBUTING.md](CONTRIBUTING.md) for more information.
+
+## Disclaimer
+
+This is alpha software. Make sure to set a billing limit for your api key or unexpected costs will occur.
+
+## License
+
+This project is licensed under the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/test_*.rb"]
+end
+
+task default: :test

data/docs/chat.md

@@ -0,0 +1,10 @@
+# Chat
+
+Send a single prompt to the completions api.
+
+Some examples:
+
+
+```
+$ clai chat "Tell me a funny joke"
+```

data/docs/intro.md

@@ -0,0 +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.
+
+`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.

data/docs/personas.md

@@ -0,0 +1,23 @@
+# Personas
+
+TODO: This feature is still under development!
+
+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:
+
+```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.
+```
+
+The default setup should have useful personas as a default.

data/docs/session.md

@@ -0,0 +1,3 @@
+# Session
+
+TODO

data/docs/setup.md

@@ -0,0 +1,3 @@
+# Setup
+
+TODO

data/exe/clai

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "clai"
+
+CLAI::CLI.start(ARGV)

data/lib/clai/cli.rb

@@ -0,0 +1,42 @@
+module CLAI
+  class CLI < Thor
+    default_task :session
+
+    desc "session", "Start an interactive chat session"
+    long_desc <<~DESC
+    Starts a REPL like chat process
+
+    > $ clai session
+    DESC
+    def session
+      Commands::Session.new(config).start_session
+    end
+
+    desc "chat", "Prompt on the terminal"
+    long_desc <<~DESC
+    Send a single prompt to AI
+
+    > $ clai chat "Tell me a short story!"
+    DESC
+    def chat(prompt)
+      Commands::Chat.new(config).chat(prompt)
+    end
+
+    option :force, type: :boolean, default: false
+    desc "setup", "Setup clai on your machine"
+    long_desc <<~DESC
+    Setup `clai` on your machine. This will ask you for a api key and create a base config file.
+
+    > $ clai setup
+    DESC
+    def setup
+      Commands::Setup.new.run(options[:force])
+    end
+
+    private
+
+    def config
+      @config ||= Config.parse
+    end
+  end
+end

data/lib/clai/commands/chat.rb

@@ -0,0 +1,13 @@
+module CLAI
+  module Commands
+    class Chat
+      def initialize(config)
+        @config = config
+      end
+
+      def chat(prompt)
+        HTTPClient.new(@config).chat(prompt)
+      end
+    end
+  end
+end

data/lib/clai/commands/session.rb

@@ -0,0 +1,19 @@
+module CLAI
+  module Commands
+    class Session
+      def initialize(config)
+        @config = config
+      end
+
+      def start_session
+        loop do
+          print S.(:prompt)
+          question = $stdin.gets
+          break unless question
+          HTTPClient.new(@config).chat(question.strip)
+          puts
+        end
+      end
+    end
+  end
+end

data/lib/clai/commands/setup.rb

@@ -0,0 +1,49 @@
+module CLAI
+  module Commands
+    class Setup
+      def run(force)
+        if clai_setup? && !force
+          puts S.(:already_setup)
+        else
+          generate_config_directory
+          ask_for_open_ai_api_key
+          generate_sample_config_file
+        end
+      end
+
+      private
+
+      def clai_setup?
+        File.exist?(File.expand_path("~/.config/clai/clai.yml"))
+      end
+
+      def ask_for_open_ai_api_key
+        puts S.(:disclaimer)
+        print S.(:paste_key)
+        input = $stdin.gets.strip
+        if input.length > 0
+          @api_key = input
+        else
+          @api_key = "<No API key specified>"
+        end
+      end
+
+      def generate_config_directory
+        FileUtils.mkdir_p(File.expand_path("~/.config/clai"))
+      end
+
+      def generate_sample_config_file
+        File.write(CLAI.config_file_path, sample_config)
+      end
+
+      # TODO: use erubis and move to /strings and rename /strings
+      def sample_config
+        <<~YML
+          # 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
+        YML
+      end
+    end
+  end
+end

data/lib/clai/config.rb

@@ -0,0 +1,18 @@
+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"])
+    rescue Errno::ENOENT
+      puts S.(:no_clai_yml)
+      exit(false)
+    end
+
+    attr_reader :api_key, :model
+
+    def initialize(api_key:, model:)
+      @api_key = api_key
+      @model = model
+    end
+  end
+end

data/lib/clai/http_client.rb

@@ -0,0 +1,48 @@
+module CLAI
+  class HTTPClient
+    def initialize(config)
+      @config = config
+    end
+  
+    def chat(query)
+      puts
+      client
+        .post("https://api.openai.com/v1/chat/completions",
+          json: {
+            model: @config.model,
+            messages: [
+              { "role": "user", "content": query }
+            ],
+            stream: true
+          }
+        ).body.each_with_index do |chunk, i|
+          if i == 0
+            # TODO: remove workaround
+            splits = chunk.split("\n\n")
+            if splits.length > 1
+              chunk = splits[1]
+            else
+              chunk = splits[0]
+            end
+          end
+          data = chunk.match(/data: (.*)/) || []
+
+          break if data[1] == "[DONE]"
+
+          if data[1] 
+            result = JSON.parse(data[1])
+            print result.dig('choices', 0, "delta", "content")
+          end
+        end
+        puts
+    end
+  
+    private
+  
+    def client
+      HTTP
+        .auth("Bearer #{@config.api_key}")
+        .headers(accept: "application/json")
+    end
+  end
+end

data/lib/clai/version.rb

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

data/lib/clai.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require "thor"
+require "http"
+require "zeitwerk"
+require "debug"
+require "fileutils"
+require "yaml"
+
+loader = Zeitwerk::Loader.for_gem
+loader.inflector.inflect(
+  "clai"   => "CLAI",
+  "http_client" => "HTTPClient",
+  "cli" => "CLI",
+)
+loader.setup
+
+module CLAI
+  class Error < StandardError; end
+  class APIKeyMissing < Error; end
+
+  @@config_file_path = File.expand_path("~/.config/clai/clai.yml")
+  def self.config_file_path
+    @@config_file_path
+  end
+
+  @@strings = YAML.safe_load_file(File.expand_path("../strings/strings.yml", __FILE__))
+  def self.strings
+    @@strings
+  end
+  S = ->(name) { @@strings.fetch(name.to_s) { raise "Unknown translation! Please file a bug!" } }
+end
+
+loader.eager_load

data/lib/strings/strings.yml

@@ -0,0 +1,7 @@
+disclaimer: This is alpha software, it's probably broken. Please specify a billing limit for your API key to avoid unexpected costs
+paste_key: "Paste your OpenAI API key and press enter: "
+already_setup: |
+  Clai is already setup! To regenerate a new config run:
+  $ clai setup --force
+no_clai_yml: No clai.yml config file found. Please run 'clai setup'
+prompt: "Your prompt: "

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: clai
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Niklas Häusele
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-07-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.6.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.6.8
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.1.1
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.2
+description: Your personal AI for the terminal
+email:
+- niklas.haeusele@hey.com
+executables:
+- clai
+extensions: []
+extra_rdoc_files: []
+files:
+- CONTRIBUTING.md
+- LICENSE
+- README.md
+- Rakefile
+- docs/chat.md
+- docs/intro.md
+- docs/personas.md
+- docs/session.md
+- docs/setup.md
+- exe/clai
+- lib/clai.rb
+- lib/clai/cli.rb
+- lib/clai/commands/chat.rb
+- lib/clai/commands/session.rb
+- lib/clai/commands/setup.rb
+- lib/clai/config.rb
+- lib/clai/http_client.rb
+- lib/clai/version.rb
+- lib/strings/strings.yml
+homepage: https://github.com/codergeek121/clai
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/codergeek121/clai
+  source_code_uri: https://github.com/codergeek121/clai
+post_install_message: "  _____ _               _____ \n / ____| |        /   |_   _|\n|
+  |    | |       /      | |  \n| |    | |      / /    | |  \n| |____| |____ / ____
+  \ _| |_ \n _____|______/_/    ______|\n                           \nThank you for
+  using clai.\n\nclai is early alpha software, beware of unexpected costs.\nMake sure
+  to add a billing limit to your OpenAI api key.\n\nTo start using clai, run 'clai
+  setup'\n"
+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.4.16
+signing_key:
+specification_version: 4
+summary: Your personal AI for the terminal
+test_files: []