sleet 0.3.10 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b4ce6d9391262e355854886ea05dd44082be2f51aec4bb300132f9f26d1a1737
-  data.tar.gz: 210ede2430b468b996c60c5f245a21fea5b1590a50d4636aa6da6d884163f056
+  metadata.gz: 8805bb18d2e088cf5f63494b42e29e4e05afcd187917c8260823911242d5910b
+  data.tar.gz: 3611f50834801d5c2330a1f30a249faf89985bc0675a1d4b00911c25405565ae
 SHA512:
-  metadata.gz: 27afbb4ae3cf79b183af8a8ec1c398d05f1450f3662fa75abf2343c2d703ba68645cd971262767d790b356e6d93a86cbdfcf3f39675e87c9cea3515a419f8fba
-  data.tar.gz: 383e4b3e98cae18a20e9499fc6622ceec0f09cae6e18ca13f994eb4d91ab2e3dd7d25ce1c7e06a22e722a8d41f4f3668924f5ce24381ba3d3bcaf4a83a9ffa0b
+  metadata.gz: 92c65ac25258e338d9e86af77142a172621af44ea3ab9aad61bf91924c2e4a3f8fe15c0428c5acce1c80412e20789c8a8aadfe9e02644aeccaa54888b829038d
+  data.tar.gz: eaf9852bceea8250b85a499af61dda56463aeb6fd85ea1b49c0566b0b99c65ff09ba9ea02a9e0200b13a268960c211402892b2b88d38ce70d06f6db324334ca1

data/.circleci/config.yml

@@ -1,6 +1,6 @@
 version: 2
 jobs:
-  build:
+  test:
     parallelism: 1
     docker:
       - image: circleci/ruby:latest
@@ -8,23 +8,8 @@ jobs:
     steps:
       - checkout
 
-      - run: date +%U-%Y > 'date-cache-key.txt'
-      - run: ruby -v > 'ruby-version.txt'
-
-      ## Bundler
-      # Restore Cache
-      - restore_cache:
-          keys:
-            - gem-cache-{{ checksum "ruby-version.txt" }}-{{ checksum "sleet.gemspec" }}-
-            - gem-cache-{{ checksum "ruby-version.txt" }}-
-            - gem-cache-
       # Install
       - run: bundle check --path vendor/bundle || sudo apt-get install cmake && bundle install --path vendor/bundle
-      # Store Cache
-      - save_cache:
-          key: gem-cache-{{ checksum "ruby-version.txt" }}-{{ checksum "sleet.gemspec" }}-{{ checksum "date-cache-key.txt" }}
-          paths:
-            - vendor/bundle
 
       - type: shell
         command: |
@@ -35,7 +20,7 @@ jobs:
             --out /tmp/test-results/rubocop.xml \
             --format progress \
             --force-exclusion \
-            $(bundle exec rubocop --list-target-files | circleci tests split --split-by=filesize --show-counts)
+            $(circleci tests glob "**/*.rb" | circleci tests split --split-by=filesize --show-counts)
 
       # Run rspec in parallel
       - type: shell
@@ -53,3 +38,8 @@ jobs:
       - store_artifacts:
           path: spec/.rspec_example_statuses
 
+workflows:
+  version: 2
+  test-workflow:
+    jobs:
+      - test

data/.gitignore

@@ -12,3 +12,5 @@
 
 # Ignore Rspec Example Status File
 spec/.rspec_example_statuses
+
+.envrc

data/.rubocop.yml

@@ -1,35 +1,11 @@
-require: rubocop-rspec
+inherit_gem:
+  rubocop-coreyja:
+    - config/default.yml
 
 inherit_from: .rubocop_todo.yml
 
 AllCops:
   TargetRubyVersion: 2.4
-  Exclude:
-    - 'vendor/**/*'
-
-Metrics/LineLength:
-  Max: 120
-
-Metrics/ClassLength:
-  Exclude:
-    - 'spec/**/*'
-
-Metrics/BlockLength:
-  Exclude:
-    - 'spec/**/*'
-    - '*.gemspec'
-
-Documentation:
-  Enabled: false
-
-Style/StringLiterals:
-  Description: Checks if uses of quotes match the configured preference.
-  StyleGuide: https://github.com/bbatsov/ruby-style-guide#consistent-string-literals
-  Enabled: true
-  EnforcedStyle: single_quotes
-  SupportedStyles:
-  - single_quotes
-  - double_quotes
 
 RSpec/MultipleExpectations:
   Enabled: false

data/.rubocop_todo.yml

@@ -1,11 +1,15 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2018-03-04 17:57:32 -0500 using RuboCop version 0.52.1.
+# on 2018-03-08 00:46:21 -0500 using RuboCop version 0.53.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
+# Offense count: 1
+Metrics/AbcSize:
+  Max: 18
+
 # Offense count: 1
 # Configuration parameters: Max.
 RSpec/NestedGroups:

data/CHANGELOG.md

@@ -1,14 +1,103 @@
-# Change Log
+# Changelog
+
+## [v0.5.0](https://github.com/coreyja/sleet/tree/v0.5.0) (2020-06-13)
+
+[Full Changelog](https://github.com/coreyja/sleet/compare/v0.4.3...v0.5.0)
+
+**Closed issues:**
+
+- Add Support for Forked Repos in Github [\#41](https://github.com/coreyja/sleet/issues/41)
+
+**Merged pull requests:**
+
+- Support PR builds from forked repos!!! ✨ [\#77](https://github.com/coreyja/sleet/pull/77) ([smudge](https://github.com/smudge))
+- Update rugged requirement from \>= 0.26, \< 0.100 to \>= 0.26, \< 1.1 [\#76](https://github.com/coreyja/sleet/pull/76) ([dependabot-preview[bot]](https://github.com/apps/dependabot-preview))
+- Update rugged requirement from \>= 0.26, \< 0.29 to \>= 0.26, \< 0.100 [\#75](https://github.com/coreyja/sleet/pull/75) ([dependabot-preview[bot]](https://github.com/apps/dependabot-preview))
+- Update thor requirement from ~\> 0.20.0 to \>= 0.20, \< 1.1 [\#70](https://github.com/coreyja/sleet/pull/70) ([dependabot-preview[bot]](https://github.com/apps/dependabot-preview))
+
+## [v0.4.3](https://github.com/coreyja/sleet/tree/v0.4.3) (2020-03-07)
+
+[Full Changelog](https://github.com/coreyja/sleet/compare/v0.4.2...v0.4.3)
+
+**Closed issues:**
+
+- s/Artifcats/Artifacts/ [\#44](https://github.com/coreyja/sleet/issues/44)
+
+**Merged pull requests:**
+
+- fix: Replace "artifi🐱s" with "artifacts". [\#74](https://github.com/coreyja/sleet/pull/74) ([temochka](https://github.com/temochka))
+- feat: Look at 100 recent builds instead of just 30. [\#73](https://github.com/coreyja/sleet/pull/73) ([temochka](https://github.com/temochka))
+- Update webmock requirement from ~\> 3.7.0 to ~\> 3.8.0 [\#72](https://github.com/coreyja/sleet/pull/72) ([dependabot-preview[bot]](https://github.com/apps/dependabot-preview))
+- Update faraday requirement from \>= 0.13.1, \< 0.16.0 to \>= 0.13.1, \< 1.1.0 [\#71](https://github.com/coreyja/sleet/pull/71) ([dependabot-preview[bot]](https://github.com/apps/dependabot-preview))
+- Update gem-release requirement from = 2.1.0 to = 2.1.1 [\#69](https://github.com/coreyja/sleet/pull/69) ([dependabot-preview[bot]](https://github.com/apps/dependabot-preview))
+- Update gem-release requirement from = 2.0.4 to = 2.1.0 [\#68](https://github.com/coreyja/sleet/pull/68) ([dependabot-preview[bot]](https://github.com/apps/dependabot-preview))
+- Update gem-release requirement from = 2.0.3 to = 2.0.4 [\#67](https://github.com/coreyja/sleet/pull/67) ([dependabot-preview[bot]](https://github.com/apps/dependabot-preview))
+- Update rake requirement from ~\> 12.3 to ~\> 13.0 [\#64](https://github.com/coreyja/sleet/pull/64) ([dependabot-preview[bot]](https://github.com/apps/dependabot-preview))
+- Update webmock requirement from ~\> 3.6.0 to ~\> 3.7.0 [\#63](https://github.com/coreyja/sleet/pull/63) ([dependabot-preview[bot]](https://github.com/apps/dependabot-preview))
+- Update gem-release requirement from = 2.0.2 to = 2.0.3 [\#62](https://github.com/coreyja/sleet/pull/62) ([dependabot-preview[bot]](https://github.com/apps/dependabot-preview))
+- Update gem-release requirement from = 2.0.1 to = 2.0.2 [\#61](https://github.com/coreyja/sleet/pull/61) ([dependabot-preview[bot]](https://github.com/apps/dependabot-preview))
+- Update webmock requirement from ~\> 3.5.1 to ~\> 3.6.0 [\#60](https://github.com/coreyja/sleet/pull/60) ([dependabot-preview[bot]](https://github.com/apps/dependabot-preview))
+
+## [v0.4.2](https://github.com/coreyja/sleet/tree/v0.4.2) (2019-05-27)
+
+[Full Changelog](https://github.com/coreyja/sleet/compare/v0.4.1...v0.4.2)
+
+**Closed issues:**
+
+- Dependabot can't resolve your Ruby dependency files [\#51](https://github.com/coreyja/sleet/issues/51)
+- Dependabot can't resolve your Ruby dependency files [\#50](https://github.com/coreyja/sleet/issues/50)
+- Dependabot can't resolve your Ruby dependency files [\#48](https://github.com/coreyja/sleet/issues/48)
+- Dependabot can't resolve your Ruby dependency files [\#49](https://github.com/coreyja/sleet/issues/49)
+
+**Merged pull requests:**
+
+- Fix CircleCI Builds [\#59](https://github.com/coreyja/sleet/pull/59) ([coreyja](https://github.com/coreyja))
+- Add a Gitter chat badge to README.md [\#58](https://github.com/coreyja/sleet/pull/58) ([gitter-badger](https://github.com/gitter-badger))
+- Symlink to docs README.md from top level [\#57](https://github.com/coreyja/sleet/pull/57) ([coreyja](https://github.com/coreyja))
+- Docs site fixes [\#56](https://github.com/coreyja/sleet/pull/56) ([coreyja](https://github.com/coreyja))
+- Setup Github Pages [\#54](https://github.com/coreyja/sleet/pull/54) ([coreyja](https://github.com/coreyja))
+- Update rugged requirement from \>= 0.26, \< 0.28 to \>= 0.26, \< 0.29 [\#53](https://github.com/coreyja/sleet/pull/53) ([dependabot-preview[bot]](https://github.com/apps/dependabot-preview))
+- Remove direct dependency on Bundler [\#52](https://github.com/coreyja/sleet/pull/52) ([dependabot-preview[bot]](https://github.com/apps/dependabot-preview))
+- Update webmock requirement from ~\> 3.4.0 to ~\> 3.5.1 [\#47](https://github.com/coreyja/sleet/pull/47) ([dependabot-preview[bot]](https://github.com/apps/dependabot-preview))
+
+## [v0.4.1](https://github.com/coreyja/sleet/tree/v0.4.1) (2018-11-24)
+
+[Full Changelog](https://github.com/coreyja/sleet/compare/v0.4.0...v0.4.1)
+
+**Merged pull requests:**
+
+- chore: Set up Rubocop-Coreyja gem [\#45](https://github.com/coreyja/sleet/pull/45) ([coreyja](https://github.com/coreyja))
+- Update README.md [\#40](https://github.com/coreyja/sleet/pull/40) ([coreyja](https://github.com/coreyja))
+- Update gem-release requirement to = 2.0.1 [\#33](https://github.com/coreyja/sleet/pull/33) ([dependabot-preview[bot]](https://github.com/apps/dependabot-preview))
+- Update webmock requirement to ~\> 3.4.0 [\#28](https://github.com/coreyja/sleet/pull/28) ([dependabot-preview[bot]](https://github.com/apps/dependabot-preview))
+- Update faraday requirement to \>= 0.13.1, \< 0.16.0 [\#27](https://github.com/coreyja/sleet/pull/27) ([dependabot-preview[bot]](https://github.com/apps/dependabot-preview))
+- Update rubocop requirement to ~\> 0.55.0 [\#26](https://github.com/coreyja/sleet/pull/26) ([dependabot-preview[bot]](https://github.com/apps/dependabot-preview))
+- Update gem-release requirement to = 2.0.0.rc.3 [\#25](https://github.com/coreyja/sleet/pull/25) ([dependabot-preview[bot]](https://github.com/apps/dependabot-preview))
+- Update rugged requirement to \>= 0.26, \< 0.28 [\#24](https://github.com/coreyja/sleet/pull/24) ([dependabot-preview[bot]](https://github.com/apps/dependabot-preview))
+
+## [v0.4.0](https://github.com/coreyja/sleet/tree/v0.4.0) (2018-03-08)
+
+[Full Changelog](https://github.com/coreyja/sleet/compare/v0.3.10...v0.4.0)
+
+**Closed issues:**
+
+- Allow Specifying Token from Config Files [\#9](https://github.com/coreyja/sleet/issues/9)
+
+**Merged pull requests:**
+
+- Get Token From Config File [\#21](https://github.com/coreyja/sleet/pull/21) ([coreyja](https://github.com/coreyja))
+
+## [v0.3.10](https://github.com/coreyja/sleet/tree/v0.3.10) (2018-03-08)
 
-## [v0.3.10](https://github.com/coreyja/sleet/tree/v0.3.10) (2018-03-07)
 [Full Changelog](https://github.com/coreyja/sleet/compare/v0.3.9...v0.3.10)
 
 **Merged pull requests:**
 
 - Base Version Option [\#20](https://github.com/coreyja/sleet/pull/20) ([coreyja](https://github.com/coreyja))
-- Update rubocop requirement to ~\> 0.53.0 [\#19](https://github.com/coreyja/sleet/pull/19) ([dependabot[bot]](https://github.com/apps/dependabot))
+- Update rubocop requirement to ~\> 0.53.0 [\#19](https://github.com/coreyja/sleet/pull/19) ([dependabot-preview[bot]](https://github.com/apps/dependabot-preview))
 
 ## [v0.3.9](https://github.com/coreyja/sleet/tree/v0.3.9) (2018-03-04)
+
 [Full Changelog](https://github.com/coreyja/sleet/compare/v0.3.8...v0.3.9)
 
 **Closed issues:**
@@ -18,17 +107,16 @@
 **Merged pull requests:**
 
 - Refactor [\#18](https://github.com/coreyja/sleet/pull/18) ([coreyja](https://github.com/coreyja))
-- Update rake requirement to ~\> 12.3 [\#17](https://github.com/coreyja/sleet/pull/17) ([dependabot[bot]](https://github.com/apps/dependabot))
-- Update faraday requirement to \>= 0.13.1, \< 0.15.0 [\#16](https://github.com/coreyja/sleet/pull/16) ([dependabot[bot]](https://github.com/apps/dependabot))
+- Update rake requirement to ~\> 12.3 [\#17](https://github.com/coreyja/sleet/pull/17) ([dependabot-preview[bot]](https://github.com/apps/dependabot-preview))
+- Update faraday requirement to \>= 0.13.1, \< 0.15.0 [\#16](https://github.com/coreyja/sleet/pull/16) ([dependabot-preview[bot]](https://github.com/apps/dependabot-preview))
+- More Specs [\#15](https://github.com/coreyja/sleet/pull/15) ([coreyja](https://github.com/coreyja))
 
 ## [v0.3.8](https://github.com/coreyja/sleet/tree/v0.3.8) (2018-02-25)
-[Full Changelog](https://github.com/coreyja/sleet/compare/v0.3.7...v0.3.8)
 
-**Merged pull requests:**
-
-- More Specs [\#15](https://github.com/coreyja/sleet/pull/15) ([coreyja](https://github.com/coreyja))
+[Full Changelog](https://github.com/coreyja/sleet/compare/v0.3.7...v0.3.8)
 
 ## [v0.3.7](https://github.com/coreyja/sleet/tree/v0.3.7) (2018-01-19)
+
 [Full Changelog](https://github.com/coreyja/sleet/compare/v0.3.6...v0.3.7)
 
 **Merged pull requests:**
@@ -36,6 +124,7 @@
 - Fix token auth and finally add a spec for it so I don't break it again [\#14](https://github.com/coreyja/sleet/pull/14) ([coreyja](https://github.com/coreyja))
 
 ## [v0.3.6](https://github.com/coreyja/sleet/tree/v0.3.6) (2018-01-18)
+
 [Full Changelog](https://github.com/coreyja/sleet/compare/v0.3.5...v0.3.6)
 
 **Merged pull requests:**
@@ -43,9 +132,11 @@
 - Fix Auth By Going Back to Query Params [\#13](https://github.com/coreyja/sleet/pull/13) ([coreyja](https://github.com/coreyja))
 
 ## [v0.3.5](https://github.com/coreyja/sleet/tree/v0.3.5) (2018-01-17)
+
 [Full Changelog](https://github.com/coreyja/sleet/compare/v0.3.4...v0.3.5)
 
 ## [v0.3.4](https://github.com/coreyja/sleet/tree/v0.3.4) (2018-01-17)
+
 [Full Changelog](https://github.com/coreyja/sleet/compare/v0.3.3...v0.3.4)
 
 **Merged pull requests:**
@@ -54,6 +145,7 @@
 - Fix Auth [\#11](https://github.com/coreyja/sleet/pull/11) ([coreyja](https://github.com/coreyja))
 
 ## [v0.3.3](https://github.com/coreyja/sleet/tree/v0.3.3) (2018-01-16)
+
 [Full Changelog](https://github.com/coreyja/sleet/compare/v0.3.2...v0.3.3)
 
 **Merged pull requests:**
@@ -61,6 +153,7 @@
 - Add `version` cmd [\#10](https://github.com/coreyja/sleet/pull/10) ([coreyja](https://github.com/coreyja))
 
 ## [v0.3.2](https://github.com/coreyja/sleet/tree/v0.3.2) (2018-01-16)
+
 [Full Changelog](https://github.com/coreyja/sleet/compare/v0.3.1...v0.3.2)
 
 **Merged pull requests:**
@@ -68,6 +161,7 @@
 - Update Readme and Add Descriptions to Help Menus [\#8](https://github.com/coreyja/sleet/pull/8) ([coreyja](https://github.com/coreyja))
 
 ## [v0.3.1](https://github.com/coreyja/sleet/tree/v0.3.1) (2018-01-15)
+
 [Full Changelog](https://github.com/coreyja/sleet/compare/v0.3.0...v0.3.1)
 
 **Merged pull requests:**
@@ -75,6 +169,7 @@
 - Add Dependency Versions [\#5](https://github.com/coreyja/sleet/pull/5) ([coreyja](https://github.com/coreyja))
 
 ## [v0.3.0](https://github.com/coreyja/sleet/tree/v0.3.0) (2018-01-15)
+
 [Full Changelog](https://github.com/coreyja/sleet/compare/v0.2.0...v0.3.0)
 
 **Closed issues:**
@@ -87,10 +182,13 @@
 - Error Messages [\#3](https://github.com/coreyja/sleet/pull/3) ([coreyja](https://github.com/coreyja))
 
 ## [v0.2.0](https://github.com/coreyja/sleet/tree/v0.2.0) (2018-01-14)
+
+[Full Changelog](https://github.com/coreyja/sleet/compare/aa005fdae00ae843909f3a2d1753db3727a27c2c...v0.2.0)
+
 **Merged pull requests:**
 
 - Gemify [\#2](https://github.com/coreyja/sleet/pull/2) ([coreyja](https://github.com/coreyja))
 
 
 
-\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*
+\* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator)*

data/README.md

@@ -0,0 +1 @@
+./docs/README.md

data/docs/CNAME

@@ -0,0 +1 @@
+sleet.dev

data/docs/README.md

@@ -0,0 +1,160 @@
+# Sleet ☁️ ❄️
+
+[![Gem Version](https://badge.fury.io/rb/sleet.svg)](https://badge.fury.io/rb/sleet)
+[![Maintainability](https://api.codeclimate.com/v1/badges/7f346b368d72b53ef630/maintainability)](https://codeclimate.com/github/coreyja/sleet/maintainability)
+[![CircleCI](https://circleci.com/gh/coreyja/sleet.svg?style=svg)](https://circleci.com/gh/coreyja/sleet)
+[![Join the chat at https://gitter.im/rspec-sleet/community](https://badges.gitter.im/rspec-sleet/community.svg)](https://gitter.im/rspec-sleet/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+
+## Background and Problem
+
+RSpec has a [feature](https://relishapp.com/rspec/rspec-core/v/3-7/docs/command-line/only-failures) that I find very useful which is the `--only-failures` option. This will re-run only that examples that failed the previous run.
+
+CircleCI has support for [uploading artifacts](https://circleci.com/docs/2.0/artifacts/) with your builds, which allows us to store the persistance file that powers the RSpec only failures option.
+However! CircleCI also supports and encourages parallelizing your build, which means even if you upload your rspec persistance file, you actually have a number of them each containing a subset of your test suite.
+This is where `Sleet` comes in!
+
+## Purpose
+
+This tool does two things:
+1. It downloads all of the `.rspec_failed_examples` files that were uploaded to CircleCI for the most recent build of the current branch
+2. It combines the multiple files into a single sorted `.rspec_failed_examples` file, and moves it to the [current directory](https://github.com/coreyja/CRSPFA/issues/1)
+
+## Getting Started
+
+### 1. Configure RSpec to Create and Use an example persistance file
+
+We need to set the `example_status_persistence_file_path` config in RSpec. Here are the relevant [RSpec docs](https://relishapp.com/rspec/rspec-core/v/3-7/docs/command-line/only-failures#background).
+
+The first step is to create(/or add to) your `spec/spec_helper.rb` file. We want to include the following configuration, which tells RSpec where to store the status persistance file. The actual location and file name are up to you, this is just an example. (Though using this name will require less configuration later.)
+
+```
+RSpec.configure do |c|
+  c.example_status_persistence_file_path = ".rspec_example_statuses"
+end
+```
+
+if you just created the `spec_helper.rb` file then you will need to create a `.rspec` file containing the following to load your new helper file.
+
+```
+--require spec_helper
+```
+
+Again there are other ways to load your `spec_helper.rb` file, including requiring it from each spec. Pick one that works for you.
+
+### 2. Collect the example persistance files in CircleCI
+
+To do this we need to create a step which [saves](https://circleci.com/docs/2.0/artifacts/) the `.rspec_example_statuses` as artifacts of the build. The following is an example of such a step in CircleCI. This must happen after rspec has run or else the persistance file will not exist.
+
+```
+- store_artifacts:
+    path: .rspec_example_statuses
+
+```
+
+### 3. Save a CircleCI Token locally (to access private builds)
+
+In order to see private builds/repos in CircleCI you will need to get a CircleCI token and save it locally to a Sleet Configuration file.
+The recommended approach is to create a yml file in your home directory which contains your the key `circle_ci_token`
+
+```
+circle_ci_token: PLACE_TOKEN_HERE
+```
+
+An API token can be generated here: [https://circleci.com/account/api](https://circleci.com/account/api)
+
+### 4. Run this tool from your project
+
+```
+sleet
+```
+
+This will look up the latest completed build in CircleCI for this branch, and download all the relevant `.rspec_example_statuses` files. It then combines and sorts them and saves the result to the `.rspec_example_statuses` file locally.
+
+### 5. Run RSpec with `--only-failures`
+
+```
+bundle exec rspec --only-failures
+```
+
+This will run only the examples that failed in CircleCI!
+
+## Configuration
+
+If you are using Worklfows in your CircleCI builds, or you are working with a different persistance file name, you may need to configure Sleet beyond the defaults.
+
+Sleet currently supports two ways to input configurations:
+
+1. Through YML files
+    - `Sleet` will search 'up' from where the command was run and look for `.sleet.yml` files. It will combine all the files it finds, such that 'deeper' files take presedence. This allows you to have a user-level config at `~/.sleet.yml` and have project specific files which take presendence over the user level config (ex: `~/Projects/foo/.sleet.yml`)
+2. Through the CLI
+    - These always take presendece the options provided in the YML files
+
+To view your current configuration use the `sleet config` command which will give you a table of the current configuration. You can also use the `--print-config` flag with the `fetch` command to print out the config, including any other CLI options. This can be useful for bebugging as the output also tells you where each option came from.
+
+### Options
+
+These are the options that are currently supported
+
+#### `--source_dir`
+
+Alias: `s`
+
+This is the directory of the source git repo. If a `source_dir` is NOT given we look up from the current directory for the nearest git repo.
+
+#### `--input_file`
+
+Alias: `i`
+
+This is the name of the Rspec Circle Persistance File in CircleCI. The default is `.rspec_example_statuses`
+
+This will match if the full path on CircleCI ends in the given name.
+
+#### `--output_file`
+
+Alias: `o`
+
+This is the name for the output file, on your local system. It is relative to the `source_dir`.
+
+Will be IGNORED if `workflows` is provided.
+
+#### `--workflows`
+
+Alias: `w`
+
+If you are using workflows in CircleCI, then this is for you! You need to tell `Sleet` which build(s) to look in, and where each output should be saved.
+The input is a hash, where the key is the build name and the value is the `output_file` for that build. Sleet supports saving the artifacts to multiple builds, meaning it can support a mono-repo setup.
+
+Build-Test-Deploy Demo:
+
+For this example you have three jobs in your CircleCI Workflow, `build`, `test` and `deploy`, but only 1 (the `test` build) generate an Rspec persistance file
+
+This command will pick the `test` build and save its artifacts to the `.rspec_example_statuses` file
+
+```
+sleet fetch --workflows test:.rspec_example_statuses
+```
+MonoRepo Demo:
+
+If you have a mono-repo that contains 3 sub-dirs. `foo`, `bar` and `baz`. And each one has an accompanying build. We can process all these sub-dirs at once with the following workflow command.
+
+```
+sleet fetch --workflows foo-test:foo/.rpsec_example_statuses bar-test:bar/.rspec_example_statuses baz-specs:baz/spec/examples.txt
+```
+
+#### `--username`
+
+Alias: `u`
+
+This is the GitHub username that is referenced by the CircleCI build. By default, Sleet will base this on your upstream git remote.
+
+#### `--project`
+
+Alias: `p`
+
+This is the GitHub project that is referenced by the CircleCI build. By default, Sleet will base this on your upstream git remote.
+
+#### `--branch`
+
+Alias: `b`
+
+This is the remote branch that is referenced by the CircleCI build. Sleet will attempt to guess this by default, but if you are pushing to a forked repo, you may need to specify a different branch name (e.g. "pull/1234").