richat 0.2.1 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f1d2620e07b7c772f88b49478da45414f8310dbd68fd6029a3abfb6140cd74b6
-  data.tar.gz: 53bd0492ac8fc0a3f841eb228c3a51764d3f6151e75b5b1a2c8224142cf9f242
+  metadata.gz: f9d0ef493fcedb52399b88baee0ef20c11d90fdf258c5aa4f8df2caca0e2ec23
+  data.tar.gz: caf49bffd8f470ba54bcfd27d639899a10068a4a7ba696eab2e3bcba8416a755
 SHA512:
-  metadata.gz: d00712292be7c61dc2de2566fd64d7c63550d90fc88fa82a1f94b4ae8f865258f04c9cf407f539d2b4f19bdb3fc1a9b8e874712f69aa42fa0c5314e7068addaa
-  data.tar.gz: fc9c556892178a6f9b944e5797c0a12547560195e0bcab1a07278761d1eedabbc5f04f12c2ac75c3c160771d0b60d21519f2ca1f345698a04349bf44e25567c6
+  metadata.gz: 207d40655ca0be10eb68a2409943206ba1ef42d946a70553d8f0db4260d415486e8922fa9da578eb9b9634622d77b7d68f9c2496a9f3cfaebfcf476759b13e29
+  data.tar.gz: 9d4091ce31a3783ddd50cc5f1a00844ac1baa61937e8edcbf5b21f3e03ccfd909854212da22b4d284073104c6894b8472c4ac5ad1ff996117a7fe84f5cb9a697

data/exe/richat

@@ -16,6 +16,11 @@ chat_config = {
   stream: true
 }
 
+if chat_config[:api_key].nil? || chat_config[:api_key].empty?
+  puts "OpenAI API key not set, refer https://github.com/fzdp/richat#usage for more info."
+  exit
+end
+
 if Richat::Config.get("log", "enable")
   logger = Richat::Logger.new(log_file: "#{log_dir}/#{Time.now.strftime('%Y%m%d')}.md")
 else

data/lib/richat/version.rb

@@ -1,3 +1,3 @@
 module Richat
-  VERSION = "0.2.1"
+  VERSION = "0.2.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: richat
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.3
 platform: ruby
 authors:
 - fzdp
@@ -10,6 +10,20 @@ bindir: exe
 cert_chain: []
 date: 2023-03-31 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -62,17 +76,6 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".travis.yml"
-- CODE_OF_CONDUCT.md
-- Gemfile
-- Gemfile.lock
-- LICENSE.txt
-- README.md
-- Rakefile
-- bin/console
-- bin/setup
 - exe/richat
 - lib/extension/hash.rb
 - lib/openai/chat.rb
@@ -83,7 +86,6 @@ files:
 - lib/richat/logger.rb
 - lib/richat/shell.rb
 - lib/richat/version.rb
-- richat.gemspec
 homepage: https://github.com/fzdp/richat
 licenses:
 - MIT
@@ -98,7 +100,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/.gitignore

@@ -1,11 +0,0 @@
-/.bundle/
-/.yardoc
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-
-# rspec failure tracking
-.rspec_status

data/.rspec

@@ -1,3 +0,0 @@
---format documentation
---color
---require spec_helper

data/.travis.yml

@@ -1,7 +0,0 @@
----
-sudo: false
-language: ruby
-cache: bundler
-rvm:
-  - 2.6.7
-before_install: gem install bundler -v 1.17.3

data/CODE_OF_CONDUCT.md

@@ -1,74 +0,0 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-In the interest of fostering an open and welcoming environment, we as
-contributors and maintainers pledge to making participation in our project and
-our community a harassment-free experience for everyone, regardless of age, body
-size, disability, ethnicity, gender identity and expression, level of experience,
-nationality, personal appearance, race, religion, or sexual identity and
-orientation.
-
-## Our Standards
-
-Examples of behavior that contributes to creating a positive environment
-include:
-
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
-
-Examples of unacceptable behavior by participants include:
-
-* The use of sexualized language or imagery and unwelcome sexual attention or
-advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or electronic
-  address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
-  professional setting
-
-## Our Responsibilities
-
-Project maintainers are responsible for clarifying the standards of acceptable
-behavior and are expected to take appropriate and fair corrective action in
-response to any instances of unacceptable behavior.
-
-Project maintainers have the right and responsibility to remove, edit, or
-reject comments, commits, code, wiki edits, issues, and other contributions
-that are not aligned to this Code of Conduct, or to ban temporarily or
-permanently any contributor for other behaviors that they deem inappropriate,
-threatening, offensive, or harmful.
-
-## Scope
-
-This Code of Conduct applies both within project spaces and in public spaces
-when an individual is representing the project or its community. Examples of
-representing a project or community include using an official project e-mail
-address, posting via an official social media account, or acting as an appointed
-representative at an online or offline event. Representation of a project may be
-further defined and clarified by project maintainers.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at fzdp01@gmail.com. All
-complaints will be reviewed and investigated and will result in a response that
-is deemed necessary and appropriate to the circumstances. The project team is
-obligated to maintain confidentiality with regard to the reporter of an incident.
-Further details of specific enforcement policies may be posted separately.
-
-Project maintainers who do not follow or enforce the Code of Conduct in good
-faith may face temporary or permanent repercussions as determined by other
-members of the project's leadership.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
-available at [http://contributor-covenant.org/version/1/4][version]
-
-[homepage]: http://contributor-covenant.org
-[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -1,6 +0,0 @@
-source "https://rubygems.org"
-
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
-gem "faraday"
-# Specify your gem's dependencies in richat.gemspec
-gemspec

data/Gemfile.lock

@@ -1,41 +0,0 @@
-PATH
-  remote: .
-  specs:
-    richat (0.2.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    diff-lcs (1.4.4)
-    faraday (2.7.4)
-      faraday-net_http (>= 2.0, < 3.1)
-      ruby2_keywords (>= 0.0.4)
-    faraday-net_http (3.0.2)
-    rake (10.5.0)
-    rspec (3.10.0)
-      rspec-core (~> 3.10.0)
-      rspec-expectations (~> 3.10.0)
-      rspec-mocks (~> 3.10.0)
-    rspec-core (3.10.1)
-      rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.1)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.2)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-support (3.10.2)
-    ruby2_keywords (0.0.5)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler (~> 1.17)
-  faraday
-  rake (~> 10.0)
-  richat!
-  rspec (~> 3.0)
-
-BUNDLED WITH
-   1.17.3

data/LICENSE.txt

@@ -1,21 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2023 fzdp
-
-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

@@ -1,145 +0,0 @@
-# Richat
-
-## A powerful command-line ChatGPT tool.
-
-Richat is a command-line ChatGPT tool implemented in Ruby that supports highly customizable configuration. It can save chat logs, performs fuzzy searches on historical inputs, allows for prompt customization and switching at any time.
-
-https://user-images.githubusercontent.com/6159178/228784846-a31772c0-53a5-4aff-92ae-2e33d9c6fad5.mov
-
-## Installation
-
-```
-gem install richat
-```
-
-## Usage
-
-There are two ways to configure OpenAI API key
-
-1. set `OPENAI_API_KEY` env variable
-2. edit `~/.richat/config.json` file and set API key, for example
-
-```
-{
-  "chatgpt": {
-    "api_key": "YOUR OPENAI API KEY"
-  }
-}
-```
-
-Then run `richat` command to talk with ChatGPT.
-
-<img width="800" alt="image" src="https://user-images.githubusercontent.com/6159178/228755576-5d76a777-f07e-43f6-8141-4f9e19f15372.png">
-
-### Configuration
-
-Use `/config` command to show current configuration.
-
-```
->> /config
-Configuration file path is /Users/fzdp/.richat/config.json
-{
-  "chatgpt": {
-    "api_key": "YOUR_OPENAI_API_KEY",
-    "model": "gpt-3.5-turbo",
-    "temperature": 0.7
-  },
-  "log": {
-    "enable": true,
-    "log_dir": "~/.richat/logs",
-    "user_role": "USR",
-    "ai_role": "GPT",
-    "system_role": "SYS"
-  },
-  "shell": {
-    "save_history": true,
-    "enable_chat_context": true,
-    "show_welcome_info": true,
-    "history_file": "~/.richat/shell_history.txt"
-  },
-  "prompt": {
-    "prompt_dir": "~/.richat/prompts",
-    "default": ""
-  }
-}
-```
-
-Edit `~/.richat/config.json` if you need customize configuration.
-
-### Chat log
-
-By default, Richat will log your chat history and log names are in date format.
-
-Set `log.enable` to false if you don't need log feature.
-
-<img width="409" alt="" src="https://user-images.githubusercontent.com/6159178/228758657-1dbbe25b-e768-403d-8b42-3b270f53fe2a.png">
-
-### Prompt
-
-You can place prompt files in `~/.richat/prompts` or other directory defined in configure file.
-
-For example, if you place `emoji`, `linux`, `wikipedia` in the directory, then in Richat shell `/prompt` command will show these prompt files.
-
-<img width="960" alt="" src="https://user-images.githubusercontent.com/6159178/228761906-4ab74529-3ccb-41b7-badc-98cc0fd9bd72.png">
-
-#### Change prompt
-
-You can use `/prompt` command to switch prompt, the argument is prompt file name or prompt file index.
-
-<img width="960" alt="" src="https://user-images.githubusercontent.com/6159178/228764026-79bbbfef-cd5d-4641-9edf-91f7d71063a5.png">
-
-#### Set default prompt
-
-For example if you want to use linux as default prompt, just edit config file
-
-```json
-{
-  "prompt": {
-    "default": "linux"
-  }
-}
-```
-
-Then Richat shell will use linux prompt when it's run
-
-<img width="960" alt="" src="https://user-images.githubusercontent.com/6159178/228766064-12230d33-158a-413e-8473-6a7dc60f28bd.png">
-
-### Input history 
-
-By default your input history will be saved in `~/.richat/shell_history_file`.
-
-In Richat shell mode, there are three ways to enhance chat experience.
-
-1. press TAB to auto complete input
-2. press Arrow keys to traverse history
-3. press `Control + R` to fuzzy search input
-
-### Stream mode
-
-ChatGPT stream mode is auto enabled in Richat shell mode
-
-https://user-images.githubusercontent.com/6159178/228770757-c3e1c286-7077-4a00-b376-a491ca280126.mov
-
-### Cli
-
-You can run `richat` with additional chat content directly
-
-```
-~ richat hello world
-Hello! How can I assist you today?
-```
-
-### Chat context
-
-Chat context is enabled by default, because ChatGPT have no memory of past requests, all relevant information must be supplied via the conversation.
-
-You can turn it off in config file.
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/fzdp/richat.
-
-## License
-
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
-

data/Rakefile

@@ -1,6 +0,0 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-
-RSpec::Core::RakeTask.new(:spec)
-
-task :default => :spec

data/bin/console

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "richat"
-
-# 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.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start(__FILE__)

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here

data/richat.gemspec

@@ -1,38 +0,0 @@
-
-lib = File.expand_path("../lib", __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "richat/version"
-
-Gem::Specification.new do |spec|
-  spec.name          = "richat"
-  spec.version       = Richat::VERSION
-  spec.authors       = ["fzdp"]
-  spec.email         = ["fzdp01@gmail.com"]
-
-  spec.summary       = %q{Richat is a command-line ChatGPT tool}
-  spec.description   = %q{Richat is a command-line ChatGPT tool implemented in Ruby that supports highly customizable configuration. It can save chat logs, performs fuzzy searches on historical inputs, allows for prompt customization and switching at any time}
-  spec.homepage      = "https://github.com/fzdp/richat"
-  spec.license       = "MIT"
-
-  # to allow pushing to a single host or delete this section to allow pushing to any host.
-  if spec.respond_to?(:metadata)
-    spec.metadata["homepage_uri"] = spec.homepage
-    spec.metadata["source_code_uri"] = "https://github.com/fzdp/richat"
-  else
-    raise "RubyGems 2.0 or newer is required to protect against " \
-      "public gem pushes."
-  end
-
-  # 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('..', __FILE__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  end
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-
-  spec.add_development_dependency "bundler", "~> 1.17"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
-end