chronicle-etl 0.2.4 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7a02a2377d0e8d4135f3b931bc73641eac28058d736d9c1dba0a97107c1d4c0e
-  data.tar.gz: 810d5bff80e852fa08ef9824ed6b313aa309bb69e84228bc1fbb7595069e043b
+  metadata.gz: 5fd411a9a41a645b85780230c79b09f361e121d0e8ca7f3270ca8eba55a76ca8
+  data.tar.gz: c09053715910ab4f027fbdc3a5b7d10c042eee962f7fa93c6571ce8359f51009
 SHA512:
-  metadata.gz: 0d5fbea3c63349bb3f566e6137755f6cc8a4060d0e401abf5a0e7d8b44a4c4278089c10ffb8bb9cf2d783a238449140e5e54d90f3ad158aa362c6335eedca5aa
-  data.tar.gz: bf6fa83b1d5e55760e62d3cc090bf09bb69a7c761ae4a9358fb4d82192c7efc7500b6db361f39adac3581982862654aa4603a78dfbb3aed53b51d01137ffd736
+  metadata.gz: 2c9ec14b6c0a51f1c5ec77ee8d9a7f016d16bdc35db5634f9fa5d38aabc30dec201cd4b8bef06a31b86773a0c1cda2d271d7008dcb247a86d956c094919f3c0f
+  data.tar.gz: 0dca41e1654e5b2b98a148f853492a67126cdac767000b3c5f97c5c8ff88b77464e17a2fab38b72c1f014f3515c911e5f3f391eaf68d64e73dcfcff5d8e6cb6a

data/.github/workflows/ruby.yml

@@ -0,0 +1,35 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Ruby
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.7', '3.0']
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+    # uses: ruby/setup-ruby@v1
+      uses: ruby/setup-ruby@473e4d8fe5dd94ee328fdfca9f8c9c7afc9dae5e
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - name: Run tests
+      run: bundle exec rake

data/.gitignore

@@ -7,6 +7,9 @@
 /spec/reports/
 /tmp/
 
+# https://yehudakatz.com/2010/12/16/clarifying-the-roles-of-the-gemspec-and-gemfile/
+Gemfile.lock
+
 # rspec failure tracking
 .rspec_status
 .DS_Store

data/.rubocop.yml

@@ -1,8 +1,38 @@
 AllCops:
   EnabledByDefault: true
+  TargetRubyVersion: 2.7
+
+Style/FrozenStringLiteralComment:
+  SafeAutoCorrect: true
 
 Style/StringLiterals:
   Enabled: false
 
+Layout/MultilineAssignmentLayout:
+  Enabled: false
+
+Layout/RedundantLineBreak:
+  Enabled: false
+
 Style/MethodCallWithArgsParentheses:
-  Enabled: false
+  Enabled: false
+
+Style/MethodCalledOnDoEndBlock:
+  Exclude:
+    - 'spec/**/*'
+
+Style/OpenStructUse:
+  Enabled: false
+
+Style/Copyright:
+  Enabled: false
+
+Style/SymbolArray:
+  EnforcedStyle: brackets
+
+Style/WordArray:
+  EnforcedStyle: brackets
+
+Lint/ConstantResolution:
+  Enabled: false
+

data/Guardfile

@@ -0,0 +1,7 @@
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end

data/README.md

@@ -1,6 +1,6 @@
 # Chronicle::ETL
 
-[![Gem Version](https://badge.fury.io/rb/chronicle-etl.svg)](https://badge.fury.io/rb/chronicle-etl)
+[![Gem Version](https://badge.fury.io/rb/chronicle-etl.svg)](https://badge.fury.io/rb/chronicle-etl) [![Ruby](https://github.com/chronicle-app/chronicle-etl/actions/workflows/ruby.yml/badge.svg)](https://github.com/chronicle-app/chronicle-etl/actions/workflows/ruby.yml)
 
 Chronicle ETL is a utility that helps you archive and processes personal data. You can *extract* it from a variety of sources, *transform* it, and *load* it to an external API, file, or stdout.
 
@@ -31,6 +31,9 @@ Connectors are available to read, process, and load data from different formats
 ```bash
 # List all available connectors
 $ chronicle-etl connectors:list
+
+# Install a connector
+$ chronicle-etl connectors:install imessage
 ```
 
 Built in connectors:
@@ -44,16 +47,18 @@ Built in connectors:
 - `null` - (default) Don't do anything
 
 ### Loaders
-- `stdout` - (default) output transformed records to stdount
+- `stdout` - (default) output records to stdout serialized as JSON
 - `csv` - Load records to a csv file
+- `rest` - Serialize records with [JSONAPI](https://jsonapi.org/) and send to a REST API
 - `table` - Output an ascii table of records. Useful for debugging.
 
 ### Provider-specific importers
 
 In addition to the built-in importers, importers for third-party platforms are available. They are packaged as individual Ruby gems.
 
-- [email](https://github.com/chronicle-app/chronicle-email). Extractors for `mbox` and other email files. Transformers for chronicle schema
-- [bash](https://github.com/chronicle-app/chronicle-bash). Extract bash history from `~/.bash_history`. Transform it for chronicle schema
+- [email](https://github.com/chronicle-app/chronicle-email). Extractors for `mbox` and other email files
+- [shell](https://github.com/chronicle-app/chronicle-shell). Extract shell history from Bash or Zsh`
+- [imessage](https://github.com/chronicle-app/chronicle-imessage). Extract iMessage messages from a local macOS installation
 
 To install any of these, run `gem install chronicle-PROVIDER`. 
 
@@ -61,7 +66,7 @@ If you don't want to use the available rubygem importers, `chronicle-etl` can us
 
 I'll be open-sourcing more importers. Please [contact me](mailto:andrew@hyfen.net) to chat about what will be available!
 
-### Full commands
+## Full commands
 
 ```
 $ chronicle-etl help 
@@ -75,26 +80,28 @@ ALL COMMANDS
   jobs:create                # Create a job
   jobs:list                  # List all available jobs
   jobs:run                   # Start a job
-  jobs:show                  # Show a job
+  jobs:show                  # Show details about a job
 ```
 
-### Job options
+### Running a job
 
 ```
 Usage:
   chronicle-etl jobs:run
 
 Options:
-  -e, [--extractor=extractor-name]      # Extractor class (available: stdin, csv, file)
-                                        # Default: stdin
+      [--log-level=LOG_LEVEL]           # Log level (debug, info, warn, error, fatal)
+                                        # Default: info
+  -v, [--verbose], [--no-verbose]       # Set log level to verbose
+      [--dry-run], [--no-dry-run]       # Only run the extraction and transform steps, not the loading
+  -e, [--extractor=extractor-name]      # Extractor class. Default: stdin
       [--extractor-opts=key:value]      # Extractor options
-  -t, [--transformer=transformer-name]  # Transformer class (available: null)
-                                        # Default: null
+  -t, [--transformer=transformer-name]  # Transformer class. Default: null
       [--transformer-opts=key:value]    # Transformer options
-  -l, [--loader=loader-name]            # Loader class (available: stdout, csv, table)
-                                        # Default: stdout
+  -l, [--loader=loader-name]            # Loader class. Default: stdout
       [--loader-opts=key:value]         # Loader options
-  -j, [--job=JOB]                       # Job configuration file
+  -j, [--name=NAME]                     # Job configuration name
+
 
 Runs an ETL job
 ```

data/Rakefile

@@ -1,6 +1,8 @@
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
-
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+require 'yard'
+YARD::Rake::YardocTask.new
+
+task default: :spec

data/chronicle-etl.gemspec

@@ -17,11 +17,11 @@ Gem::Specification.new do |spec|
   # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
   # to allow pushing to a single host or delete this section to allow pushing to any host.
   if spec.respond_to?(:metadata)
-    # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
 
     spec.metadata["homepage_uri"] = spec.homepage
     spec.metadata["source_code_uri"] = "https://github.com/chronicle-app/chronicle-etl"
-    spec.metadata["changelog_uri"] = "https://github.com/chronicle-app/chronicle-etl/blob/master/CHANGELOG.md"
+    spec.metadata["changelog_uri"] = "https://github.com/chronicle-app/chronicle-etl/releases"
   else
     raise "RubyGems 2.0 or newer is required to protect against " \
       "public gem pushes."
@@ -35,19 +35,27 @@ Gem::Specification.new do |spec|
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
+  spec.required_ruby_version = ">= 2.7"
 
-  spec.add_dependency "thor", "~> 0.20"
+  spec.add_dependency "activesupport", "~> 7.0"
+  spec.add_dependency "chronic_duration", "~> 0.10.6"
   spec.add_dependency "colorize", "~> 0.8.1"
-  spec.add_dependency "tty-table", "~> 0.11"
+  spec.add_dependency "marcel", "~> 1.0.2"
+  spec.add_dependency "mini_exiftool", "~> 2.10"
+  spec.add_dependency "nokogiri", "~> 1.13"
+  spec.add_dependency "runcom", ">= 6.0"
+  spec.add_dependency "sequel", "~> 5.35"
+  spec.add_dependency "sqlite3", "~> 1.4"
+  spec.add_dependency "thor", "~> 1.2"
   spec.add_dependency "tty-progressbar", "~> 0.17"
-  spec.add_dependency 'sequel', '~> 5.35'
-  spec.add_dependency 'deep_merge', '~> 1.2'
+  spec.add_dependency "tty-table", "~> 0.11"
 
   spec.add_development_dependency "bundler", "~> 2.1"
+  spec.add_development_dependency "pry-byebug", "~> 3.9"
   spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.9"
-  spec.add_development_dependency "pry-byebug", "~> 3.9"
-  spec.add_development_dependency 'runcom', '~> 6.2'
-  spec.add_development_dependency 'redcarpet', '~> 3.5'
-  spec.add_development_dependency 'sqlite3', '~> 1.4'
+  spec.add_development_dependency "simplecov", "~> 0.21"
+  spec.add_development_dependency "guard-rspec", "~> 4.7.3"
+  spec.add_development_dependency "yard", "~> 0.9.7"
+  spec.add_development_dependency "rubocop", "~> 1.25.1"
 end

data/exe/chronicle-etl

@@ -1,5 +1,5 @@
 #!/usr/bin/env ruby
 
-require "chronicle/etl/cli/main"
+require "chronicle/etl/cli"
 
 Chronicle::ETL::CLI::Main.start(ARGV)

data/lib/chronicle/etl/cli/connectors.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Chronicle
   module ETL
     module CLI
@@ -7,23 +9,67 @@ module Chronicle
         namespace :connectors
 
         desc "install NAME", "Installs connector NAME"
-        def install
-          puts "Installing"
+        def install(name)
+          Chronicle::ETL::Registry.install_connector(name)
         end
 
         desc "list", "Lists available connectors"
         # Display all available connectors that chronicle-etl has access to
         def list
-          klasses = Chronicle::ETL::Catalog.available_classes
-          klasses = klasses.sort_by do |a|
-            [a[:built_in].to_s, a[:provider], a[:phase]]
+          Chronicle::ETL::Registry.load_all!
+
+          connector_info = Chronicle::ETL::Registry.connectors.map do |connector_registration|
+            {
+              identifier: connector_registration.identifier,
+              phase: connector_registration.phase,
+              description: connector_registration.descriptive_phrase,
+              provider: connector_registration.provider,
+              core: connector_registration.built_in? ? '✓' : '',
+              class: connector_registration.klass_name
+            }
+          end
+
+          connector_info = connector_info.sort_by do |a|
+            [a[:core].to_s, a[:provider], a[:phase], a[:identifier]]
           end
 
-          headers = klasses.first.keys.map do |key|
+          headers = connector_info.first.keys.map do |key|
             key.to_s.upcase.bold
           end
 
-          table = TTY::Table.new(headers, klasses.map(&:values))
+          table = TTY::Table.new(headers, connector_info.map(&:values))
+          puts table.render(indent: 0, padding: [0, 2])
+        end
+
+        desc "show PHASE IDENTIFIER", "Show information about a connector"
+        def show(phase, identifier)
+          unless ['extractor', 'transformer', 'loader'].include?(phase)
+            puts "phase argument must be one of: [extractor, transformer, loader]"
+            return
+          end
+
+          begin
+            connector = Chronicle::ETL::Registry.find_by_phase_and_identifier(phase.to_sym, identifier)
+          rescue Chronicle::ETL::ConnectorNotAvailableError
+            puts "Could not find #{phase} #{identifier}"
+            return
+          end
+
+          puts connector.klass.to_s.bold
+          puts "  #{connector.descriptive_phrase}"
+          puts
+          puts "OPTIONS"
+
+          headers = ['name', 'default', 'required'].map{ |h| h.to_s.upcase.bold }
+
+          settings = connector.klass.settings.map do |name, setting|
+            [
+              name,
+              setting.default,
+              setting.required ? 'yes' : 'no'
+            ]
+          end
+          table = TTY::Table.new(headers, settings)
           puts table.render(indent: 0, padding: [0, 2])
         end
       end

data/lib/chronicle/etl/cli/jobs.rb

@@ -1,4 +1,5 @@
 require 'pp'
+
 module Chronicle
   module ETL
     module CLI
@@ -7,16 +8,33 @@ module Chronicle
         default_task "start"
         namespace :jobs
 
-        class_option :extractor, aliases: '-e', desc: 'Extractor class (available: stdin, csv, file)', default: 'stdin', banner: 'extractor-name'
+        class_option :name, aliases: '-j', desc: 'Job configuration name'
+
+        class_option :extractor, aliases: '-e', desc: "Extractor class. Default: stdin", banner: 'extractor-name'
         class_option :'extractor-opts', desc: 'Extractor options', type: :hash, default: {}
-        class_option :transformer, aliases: '-t', desc: 'Transformer class (available: null)', default: 'null', banner: 'transformer-name'
+        class_option :transformer, aliases: '-t', desc: 'Transformer class. Default: null', banner: 'transformer-name'
         class_option :'transformer-opts', desc: 'Transformer options', type: :hash, default: {}
-        class_option :loader, aliases: '-l', desc: 'Loader class (available: stdout, csv, table)', default: 'stdout', banner: 'loader-name'
+        class_option :loader, aliases: '-l', desc: 'Loader class. Default: stdout', banner: 'loader-name'
         class_option :'loader-opts', desc: 'Loader options', type: :hash, default: {}
-        class_option :name, aliases: '-j', desc: 'Job configuration name'
 
-        map run: :start  # Thor doesn't like `run` as a command name
+        # This is an array to deal with shell globbing
+        class_option :input, aliases: '-i', desc: 'Input filename or directory', default: [], type: 'array', banner: 'FILENAME'
+        class_option :since, desc: "Load records SINCE this date. Overrides job's `load_since` configuration option in extractor's options", banner: 'DATE'
+        class_option :until, desc: "Load records UNTIL this date", banner: 'DATE'
+        class_option :limit, desc: "Only extract the first LIMIT records", banner: 'N'
+
+        class_option :output, aliases: '-o', desc: 'Output filename', type: 'string'
+        class_option :fields, desc: 'Output only these fields', type: 'array', banner: 'field1 field2 ...'
+
+        class_option :log_level, desc: 'Log level (debug, info, warn, error, fatal)', default: 'info'
+        class_option :verbose, aliases: '-v', desc: 'Set log level to verbose', type: :boolean
+
+        # Thor doesn't like `run` as a command name
+        map run: :start
         desc "run", "Start a job"
+        option :log_level, desc: 'Log level (debug, info, warn, error, fatal)', default: 'info'
+        option :verbose, aliases: '-v', desc: 'Set log level to verbose', type: :boolean
+        option :dry_run, desc: 'Only run the extraction and transform steps, not the loading', type: :boolean
         long_desc <<-LONG_DESC
           This will run an ETL job. Each job needs three parts:
 
@@ -24,23 +42,17 @@ module Chronicle
 
             2. #{'Transformer'.underline}: transforms data into a new format. If none is specified, we use the `null` transformer which does nothing to the data.
 
-            3. #{'Loader'.underline}: takes that transformed data and loads it externally. This can be an API, flat files, (or by default), stdout.
+            3. #{'Loader'.underline}: takes that transformed data and loads it externally. This can be an API, flat files, (or by default), stdout. With the --dry-run option, this step won't be run.
 
             If you do not want to use the command line flags, you can also configure a job with a .yml config file. You can either specify the path to this file or use the filename and place the file in ~/.config/chronicle/etl/jobs/NAME.yml and call it with `--job NAME`
 LONG_DESC
         # Run an ETL job
         def start
+          setup_log_level
           job_definition = build_job_definition(options)
           job = Chronicle::ETL::Job.new(job_definition)
           runner = Chronicle::ETL::Runner.new(job)
           runner.run!
-        rescue Chronicle::ETL::ProviderNotAvailableError => e
-          warn(e.message.red)
-          warn("  Perhaps you haven't installed it yet: `$ gem install chronicle-#{e.provider}`")
-          exit(false)
-        rescue Chronicle::ETL::ConnectorNotAvailableError => e
-          warn(e.message.red)
-          exit(false)
         end
 
         desc "create", "Create a job"
@@ -48,14 +60,13 @@ LONG_DESC
         def create
           job_definition = build_job_definition(options)
           path = File.join('chronicle', 'etl', 'jobs', options[:name])
-          Chronicle::ETL::Config.write(path, job_definition)
+          Chronicle::ETL::Config.write(path, job_definition.definition)
         end
 
         desc "show", "Show details about a job"
         # Show an ETL job
         def show
-          job_config = build_job_definition(options)
-          pp job_config
+          puts Chronicle::ETL::Job.new(build_job_definition(options))
         end
 
         desc "list", "List all available jobs"
@@ -73,7 +84,7 @@ LONG_DESC
             [job, extractor, transformer, loader]
           end
 
-          headers = ['name', 'extractor', 'transformer', 'loader'].map{|h| h.upcase.bold }
+          headers = ['name', 'extractor', 'transformer', 'loader'].map { |h| h.upcase.bold }
 
           table = TTY::Table.new(headers, job_details)
           puts table.render(indent: 0, padding: [0, 2])
@@ -81,11 +92,20 @@ LONG_DESC
 
         private
 
+        def setup_log_level
+          if options[:verbose]
+            Chronicle::ETL::Logger.log_level = Chronicle::ETL::Logger::DEBUG
+          elsif options[:log_level]
+            level = Chronicle::ETL::Logger.const_get(options[:log_level].upcase)
+            Chronicle::ETL::Logger.log_level = level 
+          end
+        end
+
         # Create job definition by reading config file and then overwriting with flag options
         def build_job_definition(options)
           definition = Chronicle::ETL::JobDefinition.new
-          definition.add_config(process_flag_options(options))
           definition.add_config(load_job_config(options[:name]))
+          definition.add_config(process_flag_options(options).transform_keys(&:to_sym))
           definition
         end
 
@@ -95,19 +115,34 @@ LONG_DESC
 
         # Takes flag options and turns them into a runner config
         def process_flag_options options
+          extractor_options = options[:'extractor-opts'].merge({
+            filename: (options[:input] if options[:input].any?),
+            since: options[:since],
+            until: options[:until],
+            limit: options[:limit],
+          }.compact)
+
+          transformer_options = options[:'transformer-opts']
+
+          loader_options = options[:'loader-opts'].merge({
+            output: options[:output],
+            fields: options[:fields]
+          }.compact)
+
           {
+            dry_run: options[:dry_run],
             extractor: {
               name: options[:extractor],
-              options: options[:'extractor-opts']
-            },
+              options: extractor_options
+            }.compact,
             transformer: {
               name: options[:transformer],
-              options: options[:'transformer-opts']
-            },
+              options: transformer_options
+            }.compact,
             loader: {
               name: options[:loader],
-              options: options[:'loader-opts']
-            }
+              options: loader_options
+            }.compact
           }
         end
       end

data/lib/chronicle/etl/cli/main.rb

@@ -1,17 +1,10 @@
-require 'thor'
-require 'chronicle/etl'
 require 'colorize'
 
-require 'chronicle/etl/cli/subcommand_base'
-require 'chronicle/etl/cli/connectors'
-require 'chronicle/etl/cli/jobs'
-
 module Chronicle
   module ETL
     module CLI
       # Main entrypoint for CLI app
-      class Main < Thor
-        class_option "verbose", type: :boolean, default: false
+      class Main < ::Thor
         default_task "jobs"
 
         desc 'connectors:COMMAND', 'Connectors available for ETL jobs', hide: true
@@ -22,10 +15,6 @@ module Chronicle
 
         # Entrypoint for the CLI
         def self.start(given_args = ARGV, config = {})
-          if given_args.none?
-            abort "No command entered or job specified. To see commands, run `chronicle-etl help`".red
-          end
-
           # take a subcommand:command and splits them so Thor knows how to hand off to the subcommand class
           if given_args.any? && given_args[0].include?(':')
             commands = given_args.shift.split(':')
@@ -35,10 +24,20 @@ module Chronicle
           super(given_args, config)
         end
 
+        def self.exit_on_failure?
+          true
+        end
+
+        desc "version", "Show version"
+        map %w(--version -v) => :version
+        def version
+          shell.say "chronicle-etl #{Chronicle::ETL::VERSION}"
+        end
+
         # Displays help options for chronicle-etl
         def help(meth = nil, subcommand = false)
           if meth && !respond_to?(meth)
-            klass, task = Thor::Util.find_class_and_task_by_namespace("#{meth}:#{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
@@ -52,14 +51,14 @@ module Chronicle
             shell.say "  $ chronicle-etl connectors:list"
             shell.say
             shell.say "  Run a simple job:".italic.light_black
-            shell.say "  $ chronicle-etl jobs:start --extractor stdin --transformer null --loader stdout"
+            shell.say "  $ chronicle-etl jobs:run --extractor stdin --transformer null --loader stdout"
             shell.say
             shell.say "  Show full job options:".italic.light_black
-            shell.say "  $ chronicle-etl jobs help start"
+            shell.say "  $ chronicle-etl jobs help run"
 
             list = []
 
-            Thor::Util.thor_classes_in(Chronicle::ETL::CLI).each do |thor_class|
+            ::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] }
@@ -72,6 +71,9 @@ module Chronicle
             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

data/lib/chronicle/etl/cli/subcommand_base.rb

@@ -2,11 +2,11 @@ module Chronicle
   module ETL
     module CLI
       # Base class for CLI subcommands. Overrides Thor methods so we can use command:subcommand syntax
-      class SubcommandBase < Thor
+      class SubcommandBase < ::Thor
         # Print usage instructions for a subcommand
         def self.help(shell, subcommand = false)
           list = printable_commands(true, subcommand)
-          Thor::Util.thor_classes_in(self).each do |klass|
+          ::Thor::Util.thor_classes_in(self).each do |klass|
             list += klass.printable_commands(false)
           end
           list.sort! { |a, b| a[0] <=> b[0] }

data/lib/chronicle/etl/cli.rb

@@ -0,0 +1,7 @@
+require 'thor'
+require 'chronicle/etl'
+
+require 'chronicle/etl/cli/subcommand_base'
+require 'chronicle/etl/cli/connectors'
+require 'chronicle/etl/cli/jobs'
+require 'chronicle/etl/cli/main'

data/lib/chronicle/etl/config.rb

@@ -30,7 +30,7 @@ module Chronicle
         end
       end
 
-      # Returns all available credentials available in ~/.config/chronilce/etl/credenetials/*.yml
+      # Returns all available credentials available in ~/.config/chronicle/etl/credentials/*.yml
       def available_credentials
         job_directory = Runcom::Config.new('chronicle/etl/credentials').current
         Dir.glob(File.join(job_directory, "*.yml")).map do |filename|