main.rb in chronicle-etl-0.5.3

- old
+ new
@@ -52,53 +52,62 @@
         def help(meth = nil, subcommand = false)
           if meth && !respond_to?(meth)
             klass, task = ::Thor::Util.find_class_and_task_by_namespace("#{meth}:#{meth}")
             klass.start(['-h', task].compact, shell: shell)
           else
-            shell.say "ABOUT".bold
-            shell.say "  #{'chronicle-etl'.italic} is a utility tool for #{'extracting'.underline}, #{'transforming'.underline}, and #{'loading'.underline} personal data."
+            shell.say "ABOUT:".bold
+            shell.say "  #{'chronicle-etl'.italic} is a toolkit for extracting and working with your digital"
+            shell.say "  history. 📜"
             shell.say
-            shell.say "USAGE".bold
-            shell.say "  $ chronicle-etl COMMAND"
+            shell.say "  A job #{'extracts'.underline} personal data from a source, #{'transforms'.underline} it (Chronicle"
+            shell.say "  Schema or preserves raw data), and then #{'loads'.underline} it to a destination. Use"
+            shell.say "  built-in extractors (json, csv, stdin) and loaders (csv, json, table,"
+            shell.say "  rest) or use plugins to connect to third-party services."
             shell.say
-            shell.say "EXAMPLES".bold
-            shell.say "  Show available connectors:".italic.light_black
-            shell.say "  $ chronicle-etl connectors:list"
+            shell.say "  Plugins: https://github.com/chronicle-app/chronicle-etl#currently-available"
             shell.say
-            shell.say "  Run a simple job:".italic.light_black
-            shell.say "  $ chronicle-etl jobs:run --extractor stdin --transformer null --loader stdout"
+            shell.say "USAGE:".bold
+            shell.say "  # Basic job usage:".italic.light_black
+            shell.say "  $ chronicle-etl --extractor NAME --transformer NAME --loader NAME"
             shell.say
-            shell.say "  Show full job options:".italic.light_black
+            shell.say "  # Read test.csv and display it to stdout as a table:".italic.light_black
+            shell.say "  $ chronicle-etl --extractor csv --input data.csv --loader table"
+            shell.say
+            shell.say "  # Show available plugins:".italic.light_black
+            shell.say "  $ chronicle-etl plugins:list"
+            shell.say
+            shell.say "  # Save an access token as a secret and use it in a job:".italic.light_black
+            shell.say "  $ chronicle-etl secrets:set pinboard access_token username:foo123"
+            shell.say "  $ chronicle-etl secrets:list"
+            shell.say "  $ chronicle-etl -e pinboard --since 1mo"
+            shell.say
+            shell.say "  # Show full job options:".italic.light_black
             shell.say "  $ chronicle-etl jobs help run"
+            shell.say
+            shell.say "FULL DOCUMENTATION:".bold
+            shell.say "  https://github.com/chronicle-app/chronicle-etl".blue
+            shell.say
 
             list = []
-
             ::Thor::Util.thor_classes_in(Chronicle::ETL::CLI).each do |thor_class|
               list += thor_class.printable_tasks(false)
             end
             list.sort! { |a, b| a[0] <=> b[0] }
             list.unshift ["help", "# This help menu"]
 
             shell.say
-            shell.say 'ALL COMMANDS'.bold
+            shell.say 'ALL COMMANDS:'.bold
             shell.print_table(list, indent: 2, truncate: true)
             shell.say
-            shell.say "VERSION".bold
+            shell.say "VERSION:".bold
             shell.say "  #{Chronicle::ETL::VERSION}"
             shell.say
             shell.say "  Display current version:".italic.light_black
             shell.say "  $ chronicle-etl --version"
-            shell.say
-            shell.say "FULL DOCUMENTATION".bold
-            shell.say "  https://github.com/chronicle-app/chronicle-etl".blue
-            shell.say
           end
         end
 
         no_commands do
-          def testb
-            puts "hi"
-          end
           def set_color_output
             String.disable_colorization true if options[:'no-color'] || ENV['NO_COLOR']
           end
 
           def set_log_level