askcii 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 18a37a3681323f04071f337d1b0e8f7b0351fe2879de62224951d4b4c8c7d8d4
+  data.tar.gz: 3e994f5ea755fed88a74fd07be374a412825c8e2227cc048f5c2d2dc219d2b5b
+SHA512:
+  metadata.gz: 9c7c23cc79eb32819c310774894800f6f77cde9fa8466ac4f5674ebeaa626b006f39a487a8d99b8324b9e152a2f8393ecea0c61a9c1e822148c63732c4e9ea64
+  data.tar.gz: e10d8a1726d612e6aeab85aaf717d48d6616eac31dcd744b56a761fad2e0ce71c1f8ad4e2e574590817e1c6a1b12f87c772793a72d1747e69095c9868547e548

data/.gitignore

@@ -0,0 +1,2 @@
+*.gem
+**/.claude/settings.local.json

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,66 @@
+PATH
+  remote: .
+  specs:
+    askcii (0.1.0)
+      amalgalite (~> 1.9)
+      ruby_llm (= 1.3.0rc1)
+      sequel (~> 5.92)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    amalgalite (1.9.4)
+      arrayfields (~> 4.9)
+    arrayfields (4.9.2)
+    base64 (0.2.0)
+    bigdecimal (3.1.9)
+    event_stream_parser (1.0.0)
+    faraday (2.13.1)
+      faraday-net_http (>= 2.0, < 3.5)
+      json
+      logger
+    faraday-multipart (1.1.0)
+      multipart-post (~> 2.0)
+    faraday-net_http (3.4.0)
+      net-http (>= 0.5.0)
+    faraday-retry (2.3.1)
+      faraday (~> 2.0)
+    json (2.12.0)
+    logger (1.7.0)
+    minitest (5.25.5)
+    multipart-post (2.4.1)
+    net-http (0.6.0)
+      uri
+    rake (13.2.1)
+    ruby_llm (1.3.0rc1)
+      base64
+      event_stream_parser (~> 1)
+      faraday (~> 2)
+      faraday-multipart (~> 1)
+      faraday-net_http (~> 3)
+      faraday-retry (~> 2)
+      zeitwerk (~> 2)
+    sequel (5.92.0)
+      bigdecimal
+    uri (1.0.3)
+    zeitwerk (2.7.2)
+
+PLATFORMS
+  aarch64-linux-gnu
+  aarch64-linux-musl
+  arm-linux-gnu
+  arm-linux-musl
+  arm64-darwin
+  x86-linux-gnu
+  x86-linux-musl
+  x86_64-darwin
+  x86_64-linux-gnu
+  x86_64-linux-musl
+
+DEPENDENCIES
+  askcii!
+  minitest (~> 5.25)
+  rake (~> 13.0)
+
+BUNDLED WITH
+   2.6.8

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Roel Bondoc
+
+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,77 @@
+# Askcii
+
+A command-line application for interacting with LLM models in a terminal-friendly way.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'askcii'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install askcii
+
+## Usage
+
+```
+# Basic usage
+askcii 'Your prompt here'
+
+# Pipe input
+echo 'Your context text' | askcii 'Your prompt here'
+
+# File input
+askcii 'Your prompt here' < input.txt
+
+# Set a custom session ID to maintain conversation context
+ASKCII_SESSION_ID="project-research" askcii 'What did we talk about earlier?'
+
+# Or add the following to your .bashrc or .zshrc to always start a new session
+export ASKCII_SESSION=$(openssl rand -hex 16)
+
+# Configure the API key, endpoint, and model ID
+askcii -c
+
+# Get the last response
+askcii -r
+```
+
+## Configuration
+
+You can configure your API key, endpoint, and model ID using the `-c` option:
+
+```
+$ askcii -c
+Configuring askcii...
+Enter API key: your_api_key_here
+Enter API endpoint: http://localhost:11434/v1
+Enter model ID: gemma3:12b
+Configuration saved successfully!
+```
+
+Configuration settings are stored in a SQLite database located at `~/.local/share/askcii/askcii.db`.
+
+You can also use environment variables to override the stored configuration:
+
+```
+ASKCII_API_KEY="your_api_key" askcii 'Hello!'
+ASKCII_API_ENDPOINT="https://api.example.com/v1" askcii 'Hello!'
+ASKCII_MODEL_ID="gpt-4" askcii 'Hello!'
+```
+
+## 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).
+
+## 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,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/askcii.gemspec

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require_relative 'lib/askcii/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'askcii'
+  spec.version       = Askcii::VERSION
+  spec.authors       = ['Roel Bondoc']
+  spec.email         = ['roelbondoc@example.com']
+
+  spec.summary       = 'Command line application for LLM interactions'
+  spec.description   = 'A terminal-friendly interface for interacting with LLM models'
+  spec.homepage      = 'https://github.com/roelbondoc/askcii'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.6.0')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'bin'
+  spec.executables   = ['askcii']
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'sequel', '~> 5.92'
+  spec.add_dependency 'amalgalite', '~> 1.9'
+  spec.add_dependency 'ruby_llm', '1.3.0rc1'
+
+  spec.add_development_dependency 'minitest', '~> 5.25'
+  spec.add_development_dependency 'rake', '~> 13.0'
+end

data/bin/askcii

@@ -0,0 +1,102 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# Find the right load path
+$LOAD_PATH.unshift File.expand_path('../lib', __dir__)
+require 'askcii'
+require 'optparse'
+
+Askcii.setup_database
+Askcii.configure_llm
+Askcii.require_models
+
+# Parse command-line options
+options = {}
+opt_parser = OptionParser.new do |opts|
+  opts.banner = "Usage: askcii [options] 'Your prompt here'"
+
+  opts.on('-r', '--last-response', 'Output the last response') do
+    options[:last_response] = true
+  end
+
+  opts.on('-c', '--configure', 'Configure API key, endpoint, and model ID') do
+    options[:configure] = true
+  end
+
+  opts.on('-h', '--help', 'Show this help message') do
+    puts opts
+    exit
+  end
+end
+
+# Parse options, keeping remaining arguments in ARGV
+opt_parser.parse!
+
+# Handle configuration if requested
+if options[:configure]
+  puts 'Configuring askcii...'
+
+  # Prompt for API key
+  print 'Enter API key: '
+  api_key = gets.chomp
+
+  # Prompt for API endpoint
+  print "Enter API endpoint: "
+  api_endpoint = gets.chomp
+
+  # Prompt for model ID
+  print 'Enter model ID: '
+  model_id = gets.chomp
+
+  # Save configuration to database
+  Askcii::Config.set('api_key', api_key) unless api_key.empty?
+  Askcii::Config.set('api_endpoint', api_endpoint) unless api_endpoint.empty?
+  Askcii::Config.set('model_id', model_id) unless model_id.empty?
+
+  puts 'Configuration saved successfully!'
+  exit 0
+end
+
+context = ENV['ASKCII_SESSION']
+model_id = Askcii::Config.model_id || ENV['ASKCII_MODEL_ID']
+chat = Askcii::Chat.find_or_create(context: context, model_id: model_id).to_llm
+
+# Output last response if requested
+if options[:last_response]
+  last_message = chat.messages.where(role: 'assistant').last
+  if last_message
+    puts last_message.content
+    exit 0
+  else
+    puts 'No previous response found.'
+    exit 1
+  end
+end
+
+# Process input
+input = nil
+input = $stdin.read unless $stdin.tty?
+
+prompt = ARGV.join(' ')
+
+if prompt.empty?
+  puts 'Usage:'
+  puts "  askcii [options] 'Your prompt here'"
+  puts "  echo 'Your prompt here' | askcii 'Your prompt here'"
+  puts "  askcii 'Your prompt here' < prompt.txt"
+  puts '  askcii -r (to get the last response)'
+  puts '  askcii -c (to configure API key, endpoint, and model ID)'
+  puts "\nOptions:"
+  puts '  -r, --last-response   Output the last response'
+  puts '  -c, --configure       Configure API key, endpoint, and model ID'
+  puts '  -h, --help            Show help'
+  exit 1
+end
+
+chat.with_instructions 'You are a command line application. Your responses should be suitable to be read in a terminal. Your responses should only include the necessary text. Do not include any explanations unless prompted for it.'
+prompt = "With the following text:\n\n#{input}\n\n#{prompt}" if input
+
+chat.ask(prompt) do |chunk|
+  print chunk.content
+end
+puts ''

data/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'askcii'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/lib/askcii/models/chat.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Askcii
+  class Chat < Sequel::Model(Askcii.database[:chats])
+    one_to_many :messages, class: 'Askcii::Message', key: :chat_id
+
+    def to_llm
+      @chat = RubyLLM.chat(
+        model: model_id,
+        provider: :openai,
+        assume_model_exists: true
+      )
+      messages.each do |msg|
+        @chat.add_message(msg.to_llm)
+      end
+      @chat.on_new_message { persist_new_message }
+      @chat.on_end_message { |msg| persist_message_completion(msg) }
+      @chat
+    end
+
+    def persist_new_message
+      @message = add_message(
+        role: :assistant,
+        content: String.new
+      )
+    end
+
+    def persist_message_completion(message)
+      return unless message
+
+      @message.update(
+        role: message.role,
+        content: message.content,
+        model_id: message.model_id,
+        input_tokens: message.input_tokens,
+        output_tokens: message.output_tokens
+      )
+    end
+  end
+end

data/lib/askcii/models/config.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Askcii
+  class Config < Sequel::Model(Askcii.database[:configs])
+    def self.set(key, value)
+      config = find_or_create(key: key)
+      config.update(value: value)
+    end
+
+    def self.get(key)
+      config = find(key: key)
+      config ? config.value : nil
+    end
+
+    def self.api_key
+      get('api_key')
+    end
+
+    def self.api_endpoint
+      get('api_endpoint')
+    end
+
+    def self.model_id
+      get('model_id')
+    end
+  end
+end

data/lib/askcii/models/message.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Askcii
+  class Message < Sequel::Model(Askcii.database[:messages])
+    many_to_one :chat, class: 'Askcii::Chat', key: :chat_id
+
+    def to_llm
+      RubyLLM::Message.new(
+        role: role.to_sym,
+        content: content,
+        tool_calls: {},
+        tool_call_id: nil,
+        input_tokens: input_tokens,
+        output_tokens: output_tokens,
+        model_id: model_id
+      )
+    end
+  end
+end

data/lib/askcii/version.rb

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

data/lib/askcii.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+require 'sequel'
+require 'fileutils'
+require 'ruby_llm'
+require 'ruby_llm/model_info'
+require_relative './askcii/version'
+
+module Askcii
+  class Error < StandardError; end
+
+  def self.database
+    @@database ||= Sequel.amalgalite(db_path)
+  end
+
+  # Get the path to the database file
+  def self.db_path
+    db_dir = File.join(ENV['HOME'], '.local', 'share', 'askcii')
+    FileUtils.mkdir_p(db_dir) unless Dir.exist?(db_dir)
+    File.join(db_dir, 'askcii.db')
+  end
+
+  # Initialize the database
+  def self.setup_database
+    database.create_table :chats do
+      primary_key :id
+      String :model_id, null: true
+      String :context, null: true
+      Datetime :created_at, null: false, default: Sequel::CURRENT_TIMESTAMP
+    end unless database.table_exists?(:chats)
+
+    database.create_table :messages do
+      primary_key :id
+      foreign_key :chat_id, :chats, null: false
+      String :role, null: true
+      Text :content, null: true
+      String :model_id, null: true
+      Integer :input_tokens, null: true
+      Integer :output_tokens, null: true
+      Datetime :created_at, null: false, default: Sequel::CURRENT_TIMESTAMP
+    end unless database.table_exists?(:messages)
+
+    database.create_table :configs do
+      primary_key :id
+      String :key, null: false, unique: true
+      Text :value, null: true
+    end unless database.table_exists?(:configs)
+  end
+
+  def self.configure_llm
+    RubyLLM.configure do |config|
+      config.log_file = '/dev/null'
+
+      # Try to get configuration from the database first, then fallback to ENV variables
+      config.openai_api_key = begin
+        Askcii::Config.api_key || ENV['ASKCII_API_KEY'] || 'blank'
+      rescue StandardError
+        ENV['ASKCII_API_KEY'] || 'blank'
+      end
+
+      config.openai_api_base = begin
+        Askcii::Config.api_endpoint || ENV['ASKCII_API_ENDPOINT'] || 'http://localhost:11434/v1'
+      rescue StandardError
+        ENV['ASKCII_API_ENDPOINT'] || 'http://localhost:11434/v1'
+      end
+    end
+  end
+
+  def self.require_models
+    require_relative './askcii/models/chat'
+    require_relative './askcii/models/message'
+    require_relative './askcii/models/config'
+  end
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: askcii
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Roel Bondoc
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sequel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.92'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.92'
+- !ruby/object:Gem::Dependency
+  name: amalgalite
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: ruby_llm
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.3.0rc1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.3.0rc1
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.25'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.25'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+description: A terminal-friendly interface for interacting with LLM models
+email:
+- roelbondoc@example.com
+executables:
+- askcii
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- askcii.gemspec
+- bin/askcii
+- bin/console
+- bin/setup
+- lib/askcii.rb
+- lib/askcii/models/chat.rb
+- lib/askcii/models/config.rb
+- lib/askcii/models/message.rb
+- lib/askcii/version.rb
+homepage: https://github.com/roelbondoc/askcii
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/roelbondoc/askcii
+  source_code_uri: https://github.com/roelbondoc/askcii
+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.6.8
+specification_version: 4
+summary: Command line application for LLM interactions
+test_files: []