RubyGems - rbcli - Versions diffs - 0.1.10 → 0.2.0 - Mend

rbcli 0.1.10 → 0.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (129) hide show

checksums.yaml +4 -4
data/CHANGELOG.md +31 -0
data/CODE_OF_CONDUCT.md +1 -1
data/Gemfile.lock +12 -12
data/LICENSE.txt +674 -21
data/README.md +80 -443
data/bin/console +19 -0
data/bin/setup +20 -0
data/docs/404.html +639 -0
data/docs/advanced/automatic_updates/index.html +791 -0
data/docs/advanced/command_types/index.html +946 -0
data/docs/advanced/distributed_state_locking/index.html +777 -0
data/docs/advanced/hooks/index.html +836 -0
data/docs/advanced/state_storage/index.html +957 -0
data/docs/advanced/user_config_files/index.html +818 -0
data/docs/assets/fonts/font-awesome.css +4 -0
data/docs/assets/fonts/material-icons.css +13 -0
data/docs/assets/fonts/specimen/FontAwesome.ttf +0 -0
data/docs/assets/fonts/specimen/FontAwesome.woff +0 -0
data/docs/assets/fonts/specimen/FontAwesome.woff2 +0 -0
data/docs/assets/fonts/specimen/MaterialIcons-Regular.ttf +0 -0
data/docs/assets/fonts/specimen/MaterialIcons-Regular.woff +0 -0
data/docs/assets/fonts/specimen/MaterialIcons-Regular.woff2 +0 -0
data/docs/assets/images/favicon.png +0 -0
data/docs/assets/images/icons/bitbucket.1b09e088.svg +20 -0
data/docs/assets/images/icons/github.f0b8504a.svg +18 -0
data/docs/assets/images/icons/gitlab.6dd19c00.svg +38 -0
data/docs/assets/javascripts/application.a59e2a89.js +1 -0
data/docs/assets/javascripts/lunr/lunr.da.js +1 -0
data/docs/assets/javascripts/lunr/lunr.de.js +1 -0
data/docs/assets/javascripts/lunr/lunr.du.js +1 -0
data/docs/assets/javascripts/lunr/lunr.es.js +1 -0
data/docs/assets/javascripts/lunr/lunr.fi.js +1 -0
data/docs/assets/javascripts/lunr/lunr.fr.js +1 -0
data/docs/assets/javascripts/lunr/lunr.hu.js +1 -0
data/docs/assets/javascripts/lunr/lunr.it.js +1 -0
data/docs/assets/javascripts/lunr/lunr.jp.js +1 -0
data/docs/assets/javascripts/lunr/lunr.multi.js +1 -0
data/docs/assets/javascripts/lunr/lunr.no.js +1 -0
data/docs/assets/javascripts/lunr/lunr.pt.js +1 -0
data/docs/assets/javascripts/lunr/lunr.ro.js +1 -0
data/docs/assets/javascripts/lunr/lunr.ru.js +1 -0
data/docs/assets/javascripts/lunr/lunr.stemmer.support.js +1 -0
data/docs/assets/javascripts/lunr/lunr.sv.js +1 -0
data/docs/assets/javascripts/lunr/lunr.tr.js +1 -0
data/docs/assets/javascripts/lunr/tinyseg.js +1 -0
data/docs/assets/javascripts/modernizr.1aa3b519.js +1 -0
data/docs/assets/stylesheets/application-palette.6079476c.css +2 -0
data/docs/assets/stylesheets/application.ba0fd1a6.css +2 -0
data/docs/development/code_of_conduct/index.html +883 -0
data/docs/development/contributing/index.html +744 -0
data/docs/development/license/index.html +715 -0
data/docs/imported/changelog/index.html +853 -0
data/docs/imported/quick_reference/index.html +1057 -0
data/docs/index.html +732 -0
data/docs/search/search_index.json +569 -0
data/docs/sitemap.xml +93 -0
data/docs/tutorial/10-getting_started/index.html +806 -0
data/docs/tutorial/20-project_layout/index.html +972 -0
data/docs/tutorial/30-your_first_command/index.html +906 -0
data/docs/tutorial/40-options_parameters_and_arguments/index.html +1049 -0
data/docs/tutorial/50-publishing/index.html +838 -0
data/docs/whoami/index.html +709 -0
data/docs-src/docs/advanced/automatic_updates.md +42 -0
data/docs-src/docs/advanced/command_types.md +144 -0
data/docs-src/docs/advanced/distributed_state_locking.md +33 -0
data/docs-src/docs/advanced/hooks.md +65 -0
data/docs-src/docs/advanced/logging.md +35 -0
data/docs-src/docs/advanced/state_storage.md +117 -0
data/docs-src/docs/advanced/user_config_files.md +47 -0
data/docs-src/docs/development/code_of_conduct.md +74 -0
data/docs-src/docs/development/contributing.md +49 -0
data/docs-src/docs/development/license.md +10 -0
data/docs-src/docs/imported/changelog.md +31 -0
data/docs-src/docs/imported/quick_reference.md +150 -0
data/docs-src/docs/index.md +38 -0
data/docs-src/docs/tutorial/10-getting_started.md +41 -0
data/docs-src/docs/tutorial/20-project_layout.md +115 -0
data/docs-src/docs/tutorial/30-your_first_command.md +126 -0
data/docs-src/docs/tutorial/40-options_parameters_and_arguments.md +251 -0
data/docs-src/docs/tutorial/50-publishing.md +47 -0
data/docs-src/docs/whoami.md +28 -0
data/docs-src/makesite.sh +14 -0
data/docs-src/mkdocs.yml +76 -0
data/docs-src/runsite.sh +3 -0
data/exe/rbcli +76 -5
data/lib/rbcli/autoupdate/autoupdate.rb +24 -4
data/lib/rbcli/autoupdate/gem_updater.rb +23 -2
data/lib/rbcli/autoupdate/github_updater.rb +22 -1
data/lib/rbcli/configuration/config.rb +22 -1
data/lib/rbcli/configuration/configurate.rb +24 -2
data/lib/rbcli/engine/command.rb +26 -6
data/lib/rbcli/engine/load_project.rb +29 -3
data/lib/rbcli/engine/parser.rb +25 -4
data/lib/rbcli/logging/logging.rb +21 -0
data/lib/rbcli/scriptwrapping/scriptwrapper.rb +30 -11
data/lib/rbcli/stateful_systems/configuratestorage.rb +20 -0
data/lib/rbcli/stateful_systems/state_storage.rb +20 -0
data/lib/rbcli/stateful_systems/storagetypes/localstate.rb +20 -0
data/lib/rbcli/stateful_systems/storagetypes/remote_state_connectors/dynamodb.rb +20 -0
data/lib/rbcli/stateful_systems/storagetypes/remotestate_dynamodb.rb +20 -0
data/lib/rbcli/util/hash_deep_symbolize.rb +43 -22
data/lib/rbcli/util/string_colorize.rb +20 -0
data/lib/rbcli/version.rb +21 -1
data/lib/rbcli-tool/generators.rb +20 -0
data/lib/rbcli-tool/mdless_fix.rb +20 -0
data/lib/rbcli-tool/project.rb +27 -2
data/lib/rbcli-tool/util.rb +20 -0
data/lib/rbcli-tool.rb +20 -0
data/lib/rbcli.rb +20 -0
data/lib-sh/lib-rbcli.sh +19 -0
data/rbcli.gemspec +22 -3
data/skeletons/project/CODE_OF_CONDUCT.md +1 -1
data/skeletons/project/README.md +17 -2
data/skeletons/project/application/commands/command.erb +10 -8
data/skeletons/project/application/commands/script.erb +3 -1
data/skeletons/project/application/commands/scripts/script.sh +2 -2
data/skeletons/project/application/options.rb +12 -3
data/skeletons/project/config/autoupdate.rb +5 -2
data/skeletons/project/config/storage.rb +7 -6
data/skeletons/project/config/userspace.rb +6 -1
data/skeletons/project/exe/executable +1 -1
data/skeletons/project/lib/.keep +0 -0
data/skeletons/project/untitled.gemspec +4 -4
data/skeletons/project/{default_user_configs → userconf}/user_defaults.yml +0 -0
metadata +85 -9
data/examples/defaults.yml +0 -4
data/examples/myscript.sh +0 -23
data/examples/mytool +0 -95

data/docs/advanced/automatic_updates/index.html ADDED Viewed

@@ -0,0 +1,791 @@
+<!DOCTYPE html>
+<html lang="en" class="no-js">
+  <head>
+      <meta charset="utf-8">
+      <meta name="viewport" content="width=device-width,initial-scale=1">
+      <meta http-equiv="x-ua-compatible" content="ie=edge">
+        <meta name="description" content="Description">
+        <meta name="author" content="Andrew Khoury">
+        <meta name="lang:clipboard.copy" content="Copy to clipboard">
+        <meta name="lang:clipboard.copied" content="Copied to clipboard">
+        <meta name="lang:search.language" content="en">
+        <meta name="lang:search.pipeline.stopwords" content="True">
+        <meta name="lang:search.pipeline.trimmer" content="True">
+        <meta name="lang:search.result.none" content="No matching documents">
+        <meta name="lang:search.result.one" content="1 matching document">
+        <meta name="lang:search.result.other" content="# matching documents">
+        <meta name="lang:search.tokenizer" content="[\s\-]+">
+      <link rel="shortcut icon" href="../../assets/images/favicon.png">
+      <meta name="generator" content="mkdocs-0.17.5, mkdocs-material-2.9.2">
+        <title>Automatic Updates - RBCli Documentation</title>
+      <link rel="stylesheet" href="../../assets/stylesheets/application.ba0fd1a6.css">
+      <script src="../../assets/javascripts/modernizr.1aa3b519.js"></script>
+      <link href="https://fonts.gstatic.com" rel="preconnect" crossorigin>
+        <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,400,400i,700|Roboto+Mono">
+        <style>body,input{font-family:"Roboto","Helvetica Neue",Helvetica,Arial,sans-serif}code,kbd,pre{font-family:"Roboto Mono","Courier New",Courier,monospace}</style>
+    <link rel="stylesheet" href="../../assets/fonts/material-icons.css">
+  </head>
+    <body dir="ltr">
+    <svg class="md-svg">
+      <defs>
+          <svg xmlns="http://www.w3.org/2000/svg" width="416" height="448"
+    viewBox="0 0 416 448" id="__github">
+  <path fill="currentColor" d="M160 304q0 10-3.125 20.5t-10.75 19-18.125
+        8.5-18.125-8.5-10.75-19-3.125-20.5 3.125-20.5 10.75-19 18.125-8.5
+        18.125 8.5 10.75 19 3.125 20.5zM320 304q0 10-3.125 20.5t-10.75
+        19-18.125 8.5-18.125-8.5-10.75-19-3.125-20.5 3.125-20.5 10.75-19
+        18.125-8.5 18.125 8.5 10.75 19 3.125 20.5zM360
+        304q0-30-17.25-51t-46.75-21q-10.25 0-48.75 5.25-17.75 2.75-39.25
+        2.75t-39.25-2.75q-38-5.25-48.75-5.25-29.5 0-46.75 21t-17.25 51q0 22 8
+        38.375t20.25 25.75 30.5 15 35 7.375 37.25 1.75h42q20.5 0
+        37.25-1.75t35-7.375 30.5-15 20.25-25.75 8-38.375zM416 260q0 51.75-15.25
+        82.75-9.5 19.25-26.375 33.25t-35.25 21.5-42.5 11.875-42.875 5.5-41.75
+        1.125q-19.5 0-35.5-0.75t-36.875-3.125-38.125-7.5-34.25-12.875-30.25-20.25-21.5-28.75q-15.5-30.75-15.5-82.75
+        0-59.25 34-99-6.75-20.5-6.75-42.5 0-29 12.75-54.5 27 0 47.5 9.875t47.25
+        30.875q36.75-8.75 77.25-8.75 37 0 70 8 26.25-20.5
+        46.75-30.25t47.25-9.75q12.75 25.5 12.75 54.5 0 21.75-6.75 42 34 40 34
+        99.5z" />
+</svg>
+      </defs>
+    </svg>
+    <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
+    <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
+    <label class="md-overlay" data-md-component="overlay" for="__drawer"></label>
+      <a href="#automatic-updates" tabindex="1" class="md-skip">
+        Skip to content
+      </a>
+      <header class="md-header" data-md-component="header">
+  <nav class="md-header-nav md-grid">
+    <div class="md-flex">
+      <div class="md-flex__cell md-flex__cell--shrink">
+        <a href="../.." title="RBCli Documentation" class="md-header-nav__button md-logo">
+            <i class="md-icon">devices</i>
+        </a>
+      </div>
+      <div class="md-flex__cell md-flex__cell--shrink">
+        <label class="md-icon md-icon--menu md-header-nav__button" for="__drawer"></label>
+      </div>
+      <div class="md-flex__cell md-flex__cell--stretch">
+        <div class="md-flex__ellipsis md-header-nav__title" data-md-component="title">
+              <span class="md-header-nav__topic">
+                RBCli Documentation
+              </span>
+              <span class="md-header-nav__topic">
+                Automatic Updates
+              </span>
+        </div>
+      </div>
+      <div class="md-flex__cell md-flex__cell--shrink">
+            <label class="md-icon md-icon--search md-header-nav__button" for="__search"></label>
+<div class="md-search" data-md-component="search" role="dialog">
+  <label class="md-search__overlay" for="__search"></label>
+  <div class="md-search__inner" role="search">
+    <form class="md-search__form" name="search">
+      <input type="text" class="md-search__input" name="query" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="query" data-md-state="active">
+      <label class="md-icon md-search__icon" for="__search"></label>
+      <button type="reset" class="md-icon md-search__icon" data-md-component="reset" tabindex="-1">
+        &#xE5CD;
+      </button>
+    </form>
+    <div class="md-search__output">
+      <div class="md-search__scrollwrap" data-md-scrollfix>
+        <div class="md-search-result" data-md-component="result">
+          <div class="md-search-result__meta">
+            Type to start searching
+          </div>
+          <ol class="md-search-result__list"></ol>
+        </div>
+      </div>
+    </div>
+  </div>
+</div>
+      </div>
+        <div class="md-flex__cell md-flex__cell--shrink">
+          <div class="md-header-nav__source">
+  <a href="https://github.com/akhoury6/rbcli/" title="Go to repository" class="md-source" data-md-source="github">
+      <div class="md-source__icon">
+        <svg viewBox="0 0 24 24" width="24" height="24">
+          <use xlink:href="#__github" width="24" height="24"></use>
+        </svg>
+      </div>
+    <div class="md-source__repository">
+      GitHub
+    </div>
+  </a>
+          </div>
+        </div>
+    </div>
+  </nav>
+</header>
+    <div class="md-container">
+<nav class="md-tabs md-tabs--active" data-md-component="tabs">
+  <div class="md-tabs__inner md-grid">
+    <ul class="md-tabs__list">
+  <li class="md-tabs__item">
+      <a href="../.." title="Home" class="md-tabs__link">
+        Home
+      </a>
+  </li>
+    <li class="md-tabs__item">
+        <a href="../../tutorial/10-getting_started/" title="Tutorial" class="md-tabs__link">
+          Tutorial
+        </a>
+    </li>
+    <li class="md-tabs__item">
+        <a href="../command_types/" title="Advanced Features" class="md-tabs__link md-tabs__link--active">
+          Advanced Features
+        </a>
+    </li>
+    <li class="md-tabs__item">
+        <a href="../../development/contributing/" title="Development" class="md-tabs__link">
+          Development
+        </a>
+    </li>
+    </ul>
+  </div>
+</nav>
+      <main class="md-main">
+        <div class="md-main__inner md-grid" data-md-component="container">
+              <div class="md-sidebar md-sidebar--primary" data-md-component="navigation">
+                <div class="md-sidebar__scrollwrap">
+                  <div class="md-sidebar__inner">
+                    <nav class="md-nav md-nav--primary" data-md-level="0">
+  <label class="md-nav__title md-nav__title--site" for="__drawer">
+    <span class="md-nav__button md-logo">
+        <i class="md-icon">devices</i>
+    </span>
+    RBCli Documentation
+  </label>
+    <div class="md-nav__source">
+  <a href="https://github.com/akhoury6/rbcli/" title="Go to repository" class="md-source" data-md-source="github">
+      <div class="md-source__icon">
+        <svg viewBox="0 0 24 24" width="24" height="24">
+          <use xlink:href="#__github" width="24" height="24"></use>
+        </svg>
+      </div>
+    <div class="md-source__repository">
+      GitHub
+    </div>
+  </a>
+    </div>
+  <ul class="md-nav__list" data-md-scrollfix>
+  <li class="md-nav__item">
+    <a href="../.." title="Home" class="md-nav__link">
+      Home
+    </a>
+  </li>
+  <li class="md-nav__item">
+    <a href="../../imported/quick_reference/" title="Quick Reference" class="md-nav__link">
+      Quick Reference
+    </a>
+  </li>
+  <li class="md-nav__item md-nav__item--nested">
+      <input class="md-toggle md-nav__toggle" data-md-toggle="nav-3" type="checkbox" id="nav-3">
+    <label class="md-nav__link" for="nav-3">
+      Tutorial
+    </label>
+    <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
+      <label class="md-nav__title" for="nav-3">
+        Tutorial
+      </label>
+      <ul class="md-nav__list" data-md-scrollfix>
+  <li class="md-nav__item">
+    <a href="../../tutorial/10-getting_started/" title="Getting Started" class="md-nav__link">
+      Getting Started
+    </a>
+  </li>
+  <li class="md-nav__item">
+    <a href="../../tutorial/20-project_layout/" title="The Project Layout" class="md-nav__link">
+      The Project Layout
+    </a>
+  </li>
+  <li class="md-nav__item">
+    <a href="../../tutorial/30-your_first_command/" title="Your First Command" class="md-nav__link">
+      Your First Command
+    </a>
+  </li>
+  <li class="md-nav__item">
+    <a href="../../tutorial/40-options_parameters_and_arguments/" title="Options, Parameters, and Arguments" class="md-nav__link">
+      Options, Parameters, and Arguments
+    </a>
+  </li>
+  <li class="md-nav__item">
+    <a href="../../tutorial/50-publishing/" title="Publishing and Distribution" class="md-nav__link">
+      Publishing and Distribution
+    </a>
+  </li>
+      </ul>
+    </nav>
+  </li>
+  <li class="md-nav__item md-nav__item--active md-nav__item--nested">
+      <input class="md-toggle md-nav__toggle" data-md-toggle="nav-4" type="checkbox" id="nav-4" checked>
+    <label class="md-nav__link" for="nav-4">
+      Advanced Features
+    </label>
+    <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
+      <label class="md-nav__title" for="nav-4">
+        Advanced Features
+      </label>
+      <ul class="md-nav__list" data-md-scrollfix>
+  <li class="md-nav__item">
+    <a href="../command_types/" title="Command Types" class="md-nav__link">
+      Command Types
+    </a>
+  </li>
+  <li class="md-nav__item">
+    <a href="../user_config_files/" title="User Config Files" class="md-nav__link">
+      User Config Files
+    </a>
+  </li>
+  <li class="md-nav__item">
+    <a href="../hooks/" title="Hooks" class="md-nav__link">
+      Hooks
+    </a>
+  </li>
+  <li class="md-nav__item md-nav__item--active">
+    <input class="md-toggle md-nav__toggle" data-md-toggle="toc" type="checkbox" id="__toc">
+      <label class="md-nav__link md-nav__link--active" for="__toc">
+        Automatic Updates
+      </label>
+    <a href="./" title="Automatic Updates" class="md-nav__link md-nav__link--active">
+      Automatic Updates
+    </a>
+<nav class="md-nav md-nav--secondary">
+    <label class="md-nav__title" for="__toc">Table of contents</label>
+    <ul class="md-nav__list" data-md-scrollfix>
+        <li class="md-nav__item">
+  <a href="#github-update-check" title="GitHub Update Check" class="md-nav__link">
+    GitHub Update Check
+  </a>
+</li>
+        <li class="md-nav__item">
+  <a href="#rubygemsorg-update-check" title="Rubygems.org Update Check" class="md-nav__link">
+    Rubygems.org Update Check
+  </a>
+</li>
+    </ul>
+</nav>
+  </li>
+  <li class="md-nav__item">
+    <a href="../state_storage/" title="State Storage" class="md-nav__link">
+      State Storage
+    </a>
+  </li>
+  <li class="md-nav__item">
+    <a href="../distributed_state_locking/" title="Distributed State Locking" class="md-nav__link">
+      Distributed State Locking
+    </a>
+  </li>
+      </ul>
+    </nav>
+  </li>
+  <li class="md-nav__item md-nav__item--nested">
+      <input class="md-toggle md-nav__toggle" data-md-toggle="nav-5" type="checkbox" id="nav-5">
+    <label class="md-nav__link" for="nav-5">
+      Development
+    </label>
+    <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
+      <label class="md-nav__title" for="nav-5">
+        Development
+      </label>
+      <ul class="md-nav__list" data-md-scrollfix>
+  <li class="md-nav__item">
+    <a href="../../development/contributing/" title="Contribution Guide" class="md-nav__link">
+      Contribution Guide
+    </a>
+  </li>
+  <li class="md-nav__item">
+    <a href="../../development/license/" title="License Info" class="md-nav__link">
+      License Info
+    </a>
+  </li>
+  <li class="md-nav__item">
+    <a href="../../development/code_of_conduct/" title="Code of Conduct" class="md-nav__link">
+      Code of Conduct
+    </a>
+  </li>
+  <li class="md-nav__item">
+    <a href="../../imported/changelog/" title="Changelog" class="md-nav__link">
+      Changelog
+    </a>
+  </li>
+      </ul>
+    </nav>
+  </li>
+  <li class="md-nav__item">
+    <a href="../../whoami/" title="$ whoami" class="md-nav__link">
+      $ whoami
+    </a>
+  </li>
+  </ul>
+</nav>
+                  </div>
+                </div>
+              </div>
+              <div class="md-sidebar md-sidebar--secondary" data-md-component="toc">
+                <div class="md-sidebar__scrollwrap">
+                  <div class="md-sidebar__inner">
+<nav class="md-nav md-nav--secondary">
+    <label class="md-nav__title" for="__toc">Table of contents</label>
+    <ul class="md-nav__list" data-md-scrollfix>
+        <li class="md-nav__item">
+  <a href="#github-update-check" title="GitHub Update Check" class="md-nav__link">
+    GitHub Update Check
+  </a>
+</li>
+        <li class="md-nav__item">
+  <a href="#rubygemsorg-update-check" title="Rubygems.org Update Check" class="md-nav__link">
+    Rubygems.org Update Check
+  </a>
+</li>
+    </ul>
+</nav>
+                  </div>
+                </div>
+              </div>
+          <div class="md-content">
+            <article class="md-content__inner md-typeset">
+                <h1 id="automatic-updates">Automatic Updates</h1>
+<p>RBCli can automatically notify users when an update is available. If <code>force_update</code> is set (see below), RBCli can halt execution until the user updates their application.</p>
+<p>Two sources are currently supported: <strong>Github</strong> (including Enterprise) and <strong>RubyGems</strong>.</p>
+<h2 id="github-update-check">GitHub Update Check</h2>
+<p>The GitHub update check works best when paired with GitHub's best practices on releases, where new releases are tagged on master with the format <strong>vX.X.X</strong>. See <a href="https://help.github.com/articles/creating-releases/">Github's release documentation</a> to learn more.</p>
+<p>RBCli will check your github repo's tags and compare that version number with one specified in your application at <code>config/version.rb</code>.</p>
+<pre><code class="ruby">autoupdate github_repo: '&lt;your_user&gt;/&lt;your_repo&gt;', access_token: nil, enterprise_hostname: nil, force_update: false, message: nil
+</code></pre>
+<p>The <code>github_repo</code> should point to the repo using the <code>user/repo</code> syntax. </p>
+<p>The <code>access_token</code> can be overridden by the user via their config file, so it can be left as <code>nil</code> if you enable <a href="../user_config_files/">Userspace Configuration</a>. The token is not needed at all if using a public repo. For instructions on generating a new access token, see <a href="https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/">here</a>. </p>
+<p>The <code>enterprise_hostname</code> setting allows you to point RBCli at a local GitHub Enterprise server.</p>
+<p>Setting <code>force_update: true</code> will halt execution if an update is available, forcing the user to update.</p>
+<p>The <code>message</code> parameter allows setting a custom message that will be displayed when an update is available. Leaving it as <code>nil</code> will use the default message provided by RBCli.</p>
+<h2 id="rubygemsorg-update-check">Rubygems.org Update Check</h2>
+<p>The Rubygems update check will check if there is a new published version of the gem on Rubygems.org. The latest published version is compared to the version number you configured RBCli with.</p>
+<pre><code class="ruby">autoupdate gem: '&lt;your_gem&gt;', force_update: false, message: nil
+</code></pre>
+<p>The <code>gem</code> parameter should simply state the name of the gem.</p>
+<p>Setting <code>force_update: true</code> will halt execution if an update is available, forcing the user to update.</p>
+<p>The <code>message</code> parameter allows setting a custom message that will be displayed when an update is available. Leaving it as <code>nil</code> will use the default message provided by RBCli.</p>
+            </article>
+          </div>
+        </div>
+      </main>
+<footer class="md-footer">
+    <div class="md-footer-nav">
+      <nav class="md-footer-nav__inner md-grid">
+          <a href="../hooks/" title="Hooks" class="md-flex md-footer-nav__link md-footer-nav__link--prev" rel="prev">
+            <div class="md-flex__cell md-flex__cell--shrink">
+              <i class="md-icon md-icon--arrow-back md-footer-nav__button"></i>
+            </div>
+            <div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title">
+              <span class="md-flex__ellipsis">
+                <span class="md-footer-nav__direction">
+                  Previous
+                </span>
+                Hooks
+              </span>
+            </div>
+          </a>
+          <a href="../state_storage/" title="State Storage" class="md-flex md-footer-nav__link md-footer-nav__link--next" rel="next">
+            <div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title">
+              <span class="md-flex__ellipsis">
+                <span class="md-footer-nav__direction">
+                  Next
+                </span>
+                State Storage
+              </span>
+            </div>
+            <div class="md-flex__cell md-flex__cell--shrink">
+              <i class="md-icon md-icon--arrow-forward md-footer-nav__button"></i>
+            </div>
+          </a>
+      </nav>
+    </div>
+  <div class="md-footer-meta md-typeset">
+    <div class="md-footer-meta__inner md-grid">
+      <div class="md-footer-copyright">
+          <div class="md-footer-copyright__highlight">
+            Copyright © 2018 Andrew Khoury
+          </div>
+        powered by
+        <a href="https://www.mkdocs.org">MkDocs</a>
+        and
+        <a href="https://squidfunk.github.io/mkdocs-material/">
+          Material for MkDocs</a>
+      </div>
+    </div>
+  </div>
+</footer>
+    </div>
+      <script src="../../assets/javascripts/application.a59e2a89.js"></script>
+      <script>app.initialize({version:"0.17.5",url:{base:"../.."}})</script>
+  </body>
+</html>