Class: Help

Inherits:
Object
  • Object
show all
Extended by:
Logging
Defined in:
lib/help.rb

Class Method Summary collapse

Methods included from Logging

log

Class Method Details

.display_version ⇒ Object 



7
8
9
10
11
 
# File 'lib/help.rb', line 7

def self.display_version()
  ## Without using gemspec
  spec = Gem::Specification::find_by_name("ask-ai")
  log("Version: ask-ai-#{spec.version}")
end

.interactive_desc ⇒ Object 



38
39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/help.rb', line 38

def self.interactive_desc()
  log("Type 'exit' or 'quit' to exit.")
  log("Type 'clear' to clear context.")
  log("Type 'show' to show context.")
  log("Type 'help' to show help.")
  log("Type 'config [key, temp, context]' to change config.")
  log("Type '-w <filepath>' to whisper transcribe.")
  log("Type '-t' <filepath> to whisper translate.")
  log("Type '-lf' <filepath> to load file.")
  log "Type '-df' to delete file context."
  log("Type '-f' to use loaded file as context.")
end

.interactive_help(command) ⇒ Object 



13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
 
# File 'lib/help.rb', line 13

def self.interactive_help(command)
  case command
  when '-w'
    log("Ex: -w /home/name/sound_file.m4a")
    log("Will transcribe the audio file.")
  when '-t'
    log("Ex: -t /home/name/sound_file.m4a")
    log("Will translate the audio file to English.")
  when '-lf'
    log("Ex: -lf /home/name/some_text_file.txt'")
    log("Will load the file into context.")
    log("The file should a [txt, CSV]. More formats coming soon.")
  when '-f'
    log("Ex: -f Can you describe the file i provided?")
  when 'config'
    log("Ex: config key <your API key>")
    log("Ex: config temp <0.0 - 1.0>")
    log("Ex: config context <0 - 100>")
    log("Beaware that the more context you use, the more expensive it will be.")
  else
    log("No help for: #{command}")
  end

end