greenhat 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4205de8b256423c08291a212511d4d6ecd613d21f232d0d6b4641881779f1303
-  data.tar.gz: 695ce3fb852d8a3167b853b3b8c07448f031305e51072f34e7afb3aed75ca50e
+  metadata.gz: 98d1acd7b3c698127214711199399e78d7b72f4762d8beb575fb2ac1d3e2ae1b
+  data.tar.gz: 011d2f2e27b278a06f87605d13809f3472b5223f39937e6fed55ecc28476ea00
 SHA512:
-  metadata.gz: 6d4653882946a783ddc0e11094205e42b33338afe53334cc9774956047a1b00eb54bca964925efbed47ca4c410e5007d6e5ac79f10376274b50beb1ffaedc8f0
-  data.tar.gz: c2002b0458b334799e4b04a446a9ca0193091f264e7077b9eac84c310423e6c0547d79094da45fa5fa9ce475d110756952602d3274b34f97b4162e7ee4226871
+  metadata.gz: 2b253023196cc698fc9022455e1a43e6add8fae2e63512e946fb207619e7e29c83783e9b9a265e1f77ce3dcbcb81be270b7bb3896a0822c6bad06c51dec8571f
+  data.tar.gz: 850d05cc4ea5d95e53e289c4781232af8719286c9b3c1165cf9afeac25bf19122a79249bc290ddad9cc4b00767d4c5396052fe5c7e9c43b9b7742f9c15eb1c7f

data/bin/greenhat

@@ -1,5 +1,4 @@
-#!/usr/bin/env ruby
-
+#!/usr/bin/env -S RUBY_GC_OLDMALLOC_LIMIT_MAX=600000000 RUBY_GC_OLDMALLOC_LIMIT=256000000 RUBY_GC_MALLOC_LIMIT=16000000 RUBY_GC_MALLOC_LIMIT_MAX=600000000 ruby
 require 'greenhat'
 
 Dir.mktmpdir('greenhat-sauce') do |tmp|

data/lib/greenhat/accessors/gitlab.rb

@@ -35,11 +35,13 @@ module GreenHat
     end
 
     # Show GitLab Services in a grid / include versions
-    # rubocop:disable Metrics/PerceivedComplexity
+    # rubocop:disable Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity
     def self.services(archive, indent = 0)
       manifest = archive.things.find { |x| x.type == 'gitlab/version-manifest.json' }
       gitlab_status = archive.things.find { |x| x.name == 'gitlab_status' }
 
+      # Dont' show invalid
+      return nil if gitlab_status.data.to_s.include? "Could not find 'bundler'"
       return nil unless gitlab_status
 
       list = gitlab_status.data.keys.sort.map do |service|
@@ -73,7 +75,7 @@ module GreenHat
 
       table.render(:unicode, padding: [0, 1, 0, 1], indent: indent)
     end
-    # rubocop:enable Metrics/PerceivedComplexity
+    # rubocop:enable Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity
 
     def self.services_markdown(archive)
       # manifest = archive.things.find { |x| x.type == 'gitlab/version-manifest.json' }

data/lib/greenhat/archive.rb

@@ -61,6 +61,10 @@ module GreenHat
         FileUtils.rm(archive_path)
       when '.gz'
         `gzip -d "#{archive_path}"`
+      when '.zip'
+        `unzip -o -d "#{base_path}" #{archive_path}`
+      when '.bz2'
+        `bzip2 -d #{archive_path}`
       when '.s'
         # Find Original Directory, Split Path, Rename to .gz
         base_path = archive_path.gsub(File.basename(archive_path), '')
@@ -77,7 +81,7 @@ module GreenHat
     end
 
     def self.archive_types
-      %w[s gz tar tgz]
+      %w[s gz tar tgz zip bz2]
     end
     # -- Archive Loader ----------------------------------------------
   end

data/lib/greenhat/cli.rb

@@ -109,19 +109,19 @@ module GreenHat
       if submodule?
         submodule!
         reader.breaker = true
-      # Only one Match!
+        # Only one Match!
       elsif matches.count == 1
         auto_update(matches.first, word)
 
-      # Print List of Options
+        # Print List of Options
       elsif matches.count > 1
         puts matches.join("\t").pastel(:bright_green)
 
-      # General Filename Matching
+        # General Filename Matching
       elsif !file_matches(word).empty?
         auto_files(file_matches(word), word)
 
-      # Submodule Autocompletion
+        # Submodule Autocompletion
       elsif current_methods.include?('auto_complete')
         update_text = current_location.auto_complete(@list, word)
         auto_update(update_text, word) unless update_text.blank?
@@ -133,7 +133,7 @@ module GreenHat
       if matches.count == 1
         auto_update(matches.first, word)
 
-      # Print List of Options
+        # Print List of Options
       elsif matches.count > 1
         auto_update(common_substr(matches), word)
         puts matches.join("\t").pastel(:bright_green)
@@ -245,12 +245,11 @@ module GreenHat
         run!
 
         return true # End Early
-
       elsif current_submodule?
         @list.shift
       elsif submodule?
         submodule!
-      # Prepend Default if exists
+        # Prepend Default if exists
       elsif default?
         @list.unshift 'default'
       else
@@ -284,7 +283,6 @@ module GreenHat
 
           puts "=> #{item.to_s.pastel(:blue)}"
         end
-
       end
 
       puts ''
@@ -366,8 +364,12 @@ module GreenHat
       @quiet
     end
 
-    # Toggle Quiet Settings
     def self.quiet!
+      @quiet = true
+    end
+
+    # Toggle Quiet Settings
+    def self.quiet_toggle
       @quiet = !@quiet
     end
 
@@ -427,5 +429,6 @@ module GreenHat
       exit 1
     end
   end
+
   # rubocop:enable Metrics/ModuleLength
 end

data/lib/greenhat/entrypoint.rb

@@ -36,7 +36,7 @@ module GreenHat
       Settings.settings[:assume_raw] = false if flags?(%i[prompt p], flags)
 
       # Quiet Flag
-      @quiet = true if flags?(%i[quiet q], flags)
+      Cli.quiet! if flags?(%i[quiet q], flags)
 
       if flags?(%i[load-local ll], flags)
         # Hook in loading local
@@ -60,17 +60,17 @@ module GreenHat
 
       # Run report and exit / Don't Clear for reports
       if flags?(%i[report r], flags)
-        @quiet = true
+        Cli.quiet!
         # Don't Use Pagination
         GreenHat::Shell.report(['--raw'])
         exit 0
       elsif flags?(%i[full-report f], flags)
-        @quiet = true
+        Cli.quiet!
         # Don't Use Pagination
         GreenHat::Shell.report(['--raw', '--full'])
         exit 0
       elsif flags?(%i[markdown m], flags)
-        @quiet = true
+        Cli.quiet!
         # Don't Use Pagination
         GreenHat::Shell.markdown_report(['--raw'])
         exit 0

data/lib/greenhat/settings.rb

@@ -3,20 +3,42 @@ module GreenHat
   # Helper for all things user environment / settings / history
   module Settings
     def self.settings
+      # round: [2],
+      # page: [:true] Automatic,
       @settings ||= {
-        history: [],
         assume_json: true,
-        assume_raw: false,
         fuzzy_file_match: true,
-
-        # round: [2],
-        # page: [:true] Automatic,
-        truncate: TTY::Screen.width * 4,
+        assume_raw: false,
+        truncate: TTY::Screen.width * 4, # Dynamic Setting
         color: true
-
       }
     end
 
+    def self.configure_choices
+      [
+
+        { name: 'Assume JSON - auto injest json', value: :assume_json },
+        { name: 'Assume Raw - do not attempt unknown parsing', value: :assume_raw },
+        { name: 'Fuzzy File Match - all partial matching', value: :fuzzy_file_match },
+        { name: 'Color Output', value: :color }
+      ]
+    end
+
+    def self.configure_settings
+      puts 'Current Settings'.pastel(:green)
+      ap @settings.except(:truncate)
+      puts
+
+      prompt = TTY::Prompt.new
+      choice = prompt.select('Change Which Setting?', configure_choices, filter: true)
+
+      setting = configure_choices.find { |x| x.value == choice }
+      value = prompt.yes?("#{setting[:name]} (Y/n)")
+      @settings[choice] = value
+
+      File.write(settings_file, Oj.dump(@settings.except(:truncate)))
+    end
+
     def self.assume_json?
       settings.assume_json
     end

data/lib/greenhat/shell/filter_help.rb

@@ -2,191 +2,205 @@ module GreenHat
   # CLI Helper
   module ShellHelper
     # Unify Filter / Filter Help
-    # rubocop:disable Metrics/MethodLength,Metrics/ModuleLength,Layout/LineLength
+    # rubocop:disable Metrics/MethodLength,Layout/LineLength
     module Filter
-      def self.help
-        puts "\u2500".pastel(:cyan) * 20
-        puts 'Filter'.pastel(:yellow)
-        puts "\u2500".pastel(:cyan) * 20
-
-        puts 'Options'.pastel(:blue)
-        puts '--raw'.pastel(:green)
-        puts '  Disable formatting and page/less'
-        puts
-
-        puts '--page'.pastel(:green)
-        puts '  Specifically enable or disable paging'
-        puts '  E.g. --page (default to true), --page=true, --page=false'
-        puts
-
-        puts '--round'.pastel(:green)
-        puts '  Attempt to round all integers. Default: 2.'
-        puts '  E.g. --round, --round=3, --round=0'
-        puts
-
-        puts '--limit'.pastel(:green)
-        puts '  Limit total output lines. Disabled by default. Default without value is based on screen height'
-        puts '  E.g. --limit, --limit=5'
-        puts
-
-        puts '--json'.pastel(:green)
-        puts '  Print output back into JSON'
-        puts
-
-        puts '--or'.pastel(:green)
-        puts '  Filters will use OR instead of AND (all match vs any match)'
-        puts
-
-        puts '--total'.pastel(:green)
-        puts '  Show total count, duration, start/end time for matching entries'
-        puts
-
-        puts '--fields'.pastel(:green)
-        puts '  Print only Available fields for selected files'
-        puts
-
-        puts '--slice'.pastel(:green)
-        puts '  Extract specific fields from entries (slice multiple with comma)'
-        puts '  Ex: --slice=path or --slice=path,params'
-        puts
-
-        puts '--except'.pastel(:green)
-        puts '  Exclude specific fields (except multiple with comma)'
-        puts '  Ex: --except=params --except=params,path'
-        puts
-
-        puts '--exists'.pastel(:green)
-        puts '  Ensure field exists regardless of contents'
-        puts '  Ex: --exists=params --exists=params,path'
-        puts
-
-        puts '--stats'.pastel(:green)
-        puts '  Order/Count occurrances by field. Combine with `truncate` for key names'
-        puts '  Ex: --stats=params --except=params,path'
-        puts
-
-        puts '--uniq'.pastel(:green)
-        puts '  Show unique values only'
-        puts '  Ex: --uniq=params --uniq=params,path'
-        puts
-
-        puts '--pluck'.pastel(:green)
-        puts '  Extract values from entries'
-        puts '  Ex: --pluck=params --pluck=params,path'
-        puts
-
-        puts '--archive'.pastel(:green)
-        puts '  Limit to specific archvie name (partial matching /inclusive). Matching SOS tar.gz name'
-        puts '  Ex: --archive=dev-gitlab_20210622154626, --archive=202106,202107'
-        puts
-
-        puts '--sort'.pastel(:green)
-        puts '  Sort by multiple fields'
-        puts '  Ex: --sort=duration_s,db_duration_s'
-        puts
-
-        puts '--reverse'.pastel(:green)
-        puts '  Reverse all results'
-        puts '  Ex: --reverse'
-        puts
-
-        puts '--combine'.pastel(:green)
-        puts '  Omit archive identifier dividers. Useful with sort or time filters'
-        puts '  Ex: --combine'
-        puts
-
-        puts '--case'.pastel(:green)
-        puts '  Exact case match. Defaults to case insensitive'
-        puts '  Ex: --case; --name=Jon, --name=jane --case'
-        puts
-
-        puts '--exact'.pastel(:green)
-        puts '  Exact parameter/value match. Defaults to partial match'
-        puts '  Ex: --field=CommonPartial --exact'
-        puts
-
-        puts '--start'.pastel(:green)
-        puts '  Show events after specified time. Filtered by the `time` field'
-        puts '  Use with `--end` for between selections'
-        puts '  Ex: log filter --start="2021-06-22 14:44 UTC" --end="2021-06-22 14:45 UTC"'
-        puts
-
-        puts '--end'.pastel(:green)
-        puts '  Show events before specified time. Filtered by the `time` field'
-        puts '  Use with `--start` for between selections'
-        puts '  Ex: log filter --end="2021-06-22"'
-        puts
-
-        puts '--time_zone'.pastel(:green)
-        puts '  Manipulate the `time` field into a specific timezone'
-        puts '  Ex: log filter --time_zone=EDT'
-        puts
-
-        puts '--text'.pastel(:green)
-        puts '  Full entry text searching (slow)'
-        puts '    --text="anything here"'
-        puts
-
-        puts '--table_style'.pastel(:green)
-        puts '  Renderer used for formatted output. basic, ascii, or unicode(default)'
-        puts '  Ex: log filter --table_style=base'
-        puts
-
-        puts '--truncate'.pastel(:green)
-        puts '  Truncate field length. On by default (4 rows). Performance issues!'
-        puts '  Disable with --truncate=0'.pastel(:bright_red)
-        puts '  Ex: --truncate=200, --truncate=2048"'
-        puts
-
-        puts 'Search specific logs'.pastel(:blue)
-        puts '  Any non dash parameters will be the log list to search from'
-        puts "  Ex: log filter --path=api sidekiq/current (hint: use  `#{'ls'.pastel(:yellow)}` for log names"
-        puts
-
-        puts 'General (Field) Searching'.pastel(:blue)
-        puts "  There are different ways filter within specific keys/fields within log. The baseline is #{'--[key]=[value]'.pastel(:green)}"
-        puts '  This will, by default, select any entries with any partial match (case insensitive) of [value] in the entry [key]'
-        puts '  Example: --path=mirror/pull'
-        puts
-
-        puts "  You can modify logic with params like: #{'case'.pastel(:green)}, #{'exact'.pastel(:green)}"
-        puts '  Ex Case turn on case sensitivity, exact will change from the inclusive to only exact matching.'
-        puts
-
-        puts "  You can also use multiple #{'--[key]=[value]'.pastel(:green)} to narrow down, or combine it with #{'or'.pastel(:green)} to be more inclusive"
-        puts '  Ex nginx/gitlab_access.log --http_user_agent=gitlab-runner --path=/api/v4/jobs/request'
-        puts '  This will look through the access logs for anything that is a runner (user agent) and hitting the request endpoint'
-        puts
-
-        puts " You can also modify whether a field search excluded or a integer (and technically string) comparison by changing the operator:  #{'(!= >= <=)'.pastel(:green)}"
-        puts ' Ex "nginx/gitlab_access.log --http_user_agent=gitlab-runner  --http_user_agent!=13.12.0" will exclude any entries with 13.12.0/13.12 runners'
-        puts ' Ex "sidekiq/current --duration_s>=5 --class!=LdapSyncWorker" Duration over 5 that is not an ldap job'
-        puts
-
-        puts 'Pipe to Shell'.pastel(:blue)
-        puts '  This is very experimental! The idea is to take all the output from the search and allow a pipe into a traditional shell command.'
-        puts '  Due to the arg parsing its not a straight send to the terminal. You may need to escape quotes.'
-        puts '  Order is relevant, no arguments after the pipe'
-        puts
-        puts '  <files> <params> | grep path'
-        puts
-
-        puts 'Example Queries'.pastel(:blue)
-        puts "  Also see #{'examples'.pastel(:bright_blue)} for even more examples"
-        puts '  log filter --class=BuildFinishedWorker sidekiq/current --slice=time,message'
-        puts '  log filter gitlab-rails/api_json.log --slice=ua --uniq=ua --ua=gitlab-runner'
-
-        puts
+      def self.help(args = '')
+        if args.blank?
+          help_index.values.map { |x| x.push '' }
+        else
+          list = help_index.select do |k, _v|
+            k.to_s.include? args
+          end
+
+          list.values
+        end
+
+        # .map { |x| x.join("\n") }.join("\n\n")
       end
 
+      # TODO: Confirm Remove
+      # def self.legacy
+      #   puts "\u2500".pastel(:cyan) * 20
+      #   puts 'Filter'.pastel(:yellow)
+      #   puts "\u2500".pastel(:cyan) * 20
+
+      #   puts 'Options'.pastel(:blue)
+      #   puts '--raw'.pastel(:green)
+      #   puts '  Disable formatting and page/less'
+      #   puts
+
+      #   puts '--page'.pastel(:green)
+      #   puts '  Specifically enable or disable paging'
+      #   puts '  E.g. --page (default to true), --page=true, --page=false'
+      #   puts
+
+      #   puts '--round'.pastel(:green)
+      #   puts '  Attempt to round all integers. Default: 2.'
+      #   puts '  E.g. --round, --round=3, --round=0'
+      #   puts
+
+      #   puts '--limit'.pastel(:green)
+      #   puts '  Limit total output lines. Disabled by default. Default without value is based on screen height'
+      #   puts '  E.g. --limit, --limit=5'
+      #   puts
+
+      #   puts '--json'.pastel(:green)
+      #   puts '  Print output back into JSON'
+      #   puts
+
+      #   puts '--or'.pastel(:green)
+      #   puts '  Filters will use OR instead of AND (all match vs any match)'
+      #   puts
+
+      #   puts '--total'.pastel(:green)
+      #   puts '  Show total count, duration, start/end time for matching entries'
+      #   puts
+
+      #   puts '--fields'.pastel(:green)
+      #   puts '  Print only Available fields for selected files'
+      #   puts
+
+      #   puts '--slice'.pastel(:green)
+      #   puts '  Extract specific fields from entries (slice multiple with comma)'
+      #   puts '  Ex: --slice=path or --slice=path,params'
+      #   puts
+
+      #   puts '--except'.pastel(:green)
+      #   puts '  Exclude specific fields (except multiple with comma)'
+      #   puts '  Ex: --except=params --except=params,path'
+      #   puts
+
+      #   puts '--exists'.pastel(:green)
+      #   puts '  Ensure field exists regardless of contents'
+      #   puts '  Ex: --exists=params --exists=params,path'
+      #   puts
+
+      #   puts '--stats'.pastel(:green)
+      #   puts '  Order/Count occurrances by field. Combine with `truncate` for key names'
+      #   puts '  Ex: --stats=params --except=params,path'
+      #   puts
+
+      #   puts '--uniq'.pastel(:green)
+      #   puts '  Show unique values only'
+      #   puts '  Ex: --uniq=params --uniq=params,path'
+      #   puts
+
+      #   puts '--pluck'.pastel(:green)
+      #   puts '  Extract values from entries'
+      #   puts '  Ex: --pluck=params --pluck=params,path'
+      #   puts
+
+      #   puts '--archive'.pastel(:green)
+      #   puts '  Limit to specific archvie name (partial matching /inclusive). Matching SOS tar.gz name'
+      #   puts '  Ex: --archive=dev-gitlab_20210622154626, --archive=202106,202107'
+      #   puts
+
+      #   puts '--sort'.pastel(:green)
+      #   puts '  Sort by multiple fields'
+      #   puts '  Ex: --sort=duration_s,db_duration_s'
+      #   puts
+
+      #   puts '--reverse'.pastel(:green)
+      #   puts '  Reverse all results'
+      #   puts '  Ex: --reverse'
+      #   puts
+
+      #   puts '--combine'.pastel(:green)
+      #   puts '  Omit archive identifier dividers. Useful with sort or time filters'
+      #   puts '  Ex: --combine'
+      #   puts
+
+      #   puts '--case'.pastel(:green)
+      #   puts '  Exact case match. Defaults to case insensitive'
+      #   puts '  Ex: --case; --name=Jon, --name=jane --case'
+      #   puts
+
+      #   puts '--exact'.pastel(:green)
+      #   puts '  Exact parameter/value match. Defaults to partial match'
+      #   puts '  Ex: --field=CommonPartial --exact'
+      #   puts
+
+      #   puts '--start'.pastel(:green)
+      #   puts '  Show events after specified time. Filtered by the `time` field'
+      #   puts '  Use with `--end` for between selections'
+      #   puts '  Ex: log filter --start="2021-06-22 14:44 UTC" --end="2021-06-22 14:45 UTC"'
+      #   puts
+
+      #   puts '--end'.pastel(:green)
+      #   puts '  Show events before specified time. Filtered by the `time` field'
+      #   puts '  Use with `--start` for between selections'
+      #   puts '  Ex: log filter --end="2021-06-22"'
+      #   puts
+
+      #   puts '--time_zone'.pastel(:green)
+      #   puts '  Manipulate the `time` field into a specific timezone'
+      #   puts '  Ex: log filter --time_zone=EDT'
+      #   puts
+
+      #   puts '--text'.pastel(:green)
+      #   puts '  Full entry text searching (slow)'
+      #   puts '    --text="anything here"'
+      #   puts
+
+      #   puts '--table_style'.pastel(:green)
+      #   puts '  Renderer used for formatted output. basic, ascii, or unicode(default)'
+      #   puts '  Ex: log filter --table_style=base'
+      #   puts
+
+      #   puts '--truncate'.pastel(:green)
+      #   puts '  Truncate field length. On by default (4 rows). Performance issues!'
+      #   puts '  Disable with --truncate=0'.pastel(:bright_red)
+      #   puts '  Ex: --truncate=200, --truncate=2048"'
+      #   puts
+
+      #   puts 'Search specific logs'.pastel(:blue)
+      #   puts '  Any non dash parameters will be the log list to search from'
+      #   puts "  Ex: log filter --path=api sidekiq/current (hint: use  `#{'ls'.pastel(:yellow)}` for log names"
+      #   puts
+
+      #   puts 'General (Field) Searching'.pastel(:blue)
+      #   puts "  There are different ways filter within specific keys/fields within log. The baseline is #{'--[key]=[value]'.pastel(:green)}"
+      #   puts '  This will, by default, select any entries with any partial match (case insensitive) of [value] in the entry [key]'
+      #   puts '  Example: --path=mirror/pull'
+      #   puts
+
+      #   puts "  You can modify logic with params like: #{'case'.pastel(:green)}, #{'exact'.pastel(:green)}"
+      #   puts '  Ex Case turn on case sensitivity, exact will change from the inclusive to only exact matching.'
+      #   puts
+
+      #   puts "  You can also use multiple #{'--[key]=[value]'.pastel(:green)} to narrow down, or combine it with #{'or'.pastel(:green)} to be more inclusive"
+      #   puts '  Ex nginx/gitlab_access.log --http_user_agent=gitlab-runner --path=/api/v4/jobs/request'
+      #   puts '  This will look through the access logs for anything that is a runner (user agent) and hitting the request endpoint'
+      #   puts
+
+      #   puts " You can also modify whether a field search excluded or a integer (and technically string) comparison by changing the operator:  #{'(!= >= <=)'.pastel(:green)}"
+      #   puts ' Ex "nginx/gitlab_access.log --http_user_agent=gitlab-runner  --http_user_agent!=13.12.0" will exclude any entries with 13.12.0/13.12 runners'
+      #   puts ' Ex "sidekiq/current --duration_s>=5 --class!=LdapSyncWorker" Duration over 5 that is not an ldap job'
+      #   puts
+
+      #   puts 'Pipe to Shell'.pastel(:blue)
+      #   puts '  This is very experimental! The idea is to take all the output from the search and allow a pipe into a traditional shell command.'
+      #   puts '  Due to the arg parsing its not a straight send to the terminal. You may need to escape quotes.'
+      #   puts '  Order is relevant, no arguments after the pipe'
+      #   puts
+      #   puts '  <files> <params> | grep path'
+      #   puts
+
+      #   puts 'Example Queries'.pastel(:blue)
+      #   puts "  Also see #{'examples'.pastel(:bright_blue)} for even more examples"
+      #   puts '  log filter --class=BuildFinishedWorker sidekiq/current --slice=time,message'
+      #   puts '  log filter gitlab-rails/api_json.log --slice=ua --uniq=ua --ua=gitlab-runner'
+
+      #   puts
+      # end
+
       def self.help_index
         {
           title: [
             "\u2500".pastel(:cyan) * 20,
             'Filter'.pastel(:yellow),
-            "\u2500".pastel(:cyan) * 20
-          ],
-          options: [
+            "\u2500".pastel(:cyan) * 20,
+            '',
             'Options'.pastel(:blue)
           ],
 
@@ -357,11 +371,30 @@ module GreenHat
             '  Ex: --truncate=200, --truncate=2048"'
           ],
 
-          field: [
-            'Field Searching'.pastel(:blue),
-            '  --[key]=[value]',
-            '  Search in key for value',
-            '  Example: --path=mirror/pull'
+          field_search: [
+            'General (Field) Searching'.pastel(:blue),
+            "  There are different ways filter within specific keys/fields within log. The baseline is #{'--[key]=[value]'.pastel(:green)}",
+            '  This will, by default, select any entries with any partial match (case insensitive) of [value] in the entry [key]',
+            '  Example: --path=mirror/pull',
+            '',
+            "  You can modify logic with params like: #{'case'.pastel(:green)}, #{'exact'.pastel(:green)}",
+            '  Ex Case turn on case sensitivity, exact will change from the inclusive to only exact matching.',
+            '',
+            "  You can also use multiple #{'--[key]=[value]'.pastel(:green)} to narrow down, or combine it with #{'or'.pastel(:green)} to be more inclusive",
+            '  Ex nginx/gitlab_access.log --http_user_agent=gitlab-runner --path=/api/v4/jobs/request',
+            '  This will look through the access logs for anything that is a runner (user agent) and hitting the request endpoint',
+            '',
+            " You can also modify whether a field search excluded or a integer (and technically string) comparison by changing the operator:  #{'(!= >= <=)'.pastel(:green)}",
+            ' Ex "nginx/gitlab_access.log --http_user_agent=gitlab-runner  --http_user_agent!=13.12.0" will exclude any entries with 13.12.0/13.12 runners',
+            ' Ex "sidekiq/current --duration_s>=5 --class!=LdapSyncWorker" Duration over 5 that is not an ldap job'
+          ],
+
+          pipe_to_shell: [
+            'Pipe to Shell'.pastel(:blue),
+            '  This is very experimental! The idea is to take all the output from the search and allow a pipe into a traditional shell command.',
+            '  Due to the arg parsing its not a straight send to the terminal. You may need to escape quotes.',
+            '  Order is relevant, no arguments after the pipe',
+            '  <files> <params> | grep path'
           ],
 
           ls: [
@@ -379,7 +412,7 @@ module GreenHat
 
         }
       end
-      # rubocop:enable Metrics/MethodLength,Metrics/ModuleLength,Layout/LineLength
+      # rubocop:enable Metrics/MethodLength,Layout/LineLength
     end
   end
 end

data/lib/greenhat/shell/gitlab.rb

@@ -99,6 +99,7 @@ module GreenHat
         end
       end
     end
+
     # -----
   end
 end