RubyGems - rbcli - Versions diffs - 0.2.11 → 0.2.12 - Mend

rbcli 0.2.11 → 0.2.12

Files changed (426) hide show

@@ -0,0 +1,23 @@
+<?xml version="1.0" encoding="utf-8" standalone="yes" ?>
+<rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom">
+  <channel>
+    <title>Importeds on RBCli Documentation</title>
+    <link>https://akhoury6.github.io/imported/</link>
+    <description>Recent content in Importeds on RBCli Documentation</description>
+    <generator>Hugo -- gohugo.io</generator>
+    <language>en-us</language>
+	<atom:link href="https://akhoury6.github.io/imported/index.xml" rel="self" type="application/rss+xml" />
+    <item>
+      <title></title>
+      <link>https://akhoury6.github.io/imported/changelog/</link>
+      <pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
+      <guid>https://akhoury6.github.io/imported/changelog/</guid>
+      <description>Changelog 0.2.12 (Unreleased) Improvements  The base project skeleton now includes an improved structure for the lib/ folder  Features  Development mode can be enabled by setting the environment variables: RBCLI_ENV=development and RBCLI_DEVPATH=[path to local Rbcli folder] to simplify changes to Rbcli during development. Combined with setting alias rbcli=&#39;/path/to/rbcli/exe/rbcli&#39;, gem installation is not required for development work  0.2.11 (Feb 27, 2019) Improvements  Updated the dependent gem verions to use the latest available versions  Bugfixes  Fixed the nested triggers of the message I/O system  0.</description>
+    </item>
+  </channel>
+</rss>

data/docs/index.html CHANGED

@@ -1,771 +1,1087 @@
+<!DOCTYPE html>
+<html lang="en" class="js csstransforms3d">
+  <head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <meta name="generator" content="Hugo 0.55.6" />
+    <meta name="description" content="">
+    <link rel="icon" href="/rbcli/images/favicon.png" type="image/png">
+    <title> :: RBCli Documentation</title>
-<!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-1.0.3, mkdocs-material-3.0.4">
-        <title>RBCli Documentation</title>
+    <link href="/rbcli/css/nucleus.css?1561087612" rel="stylesheet">
+    <link href="/rbcli/css/fontawesome-all.min.css?1561087612" rel="stylesheet">
+    <link href="/rbcli/css/hybrid.css?1561087612" rel="stylesheet">
+    <link href="/rbcli/css/featherlight.min.css?1561087612" rel="stylesheet">
+    <link href="/rbcli/css/perfect-scrollbar.min.css?1561087612" rel="stylesheet">
+    <link href="/rbcli/css/auto-complete.css?1561087612" rel="stylesheet">
+    <link href="/rbcli/css/atom-one-dark-reasonable.css?1561087612" rel="stylesheet">
+    <link href="/rbcli/css/theme.css?1561087612" rel="stylesheet">
+    <link href="/rbcli/css/hugo-theme.css?1561087612" rel="stylesheet">
-      <link rel="stylesheet" href="assets/stylesheets/application.451f80e5.css">
-      <script src="assets/javascripts/modernizr.1aa3b519.js"></script>
+      <link href="/rbcli/css/theme-blue.css?1561087612" rel="stylesheet">
-        <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>
+    <script src="/rbcli/js/jquery-3.3.1.min.js?1561087612"></script>
+    <style>
+      :root #header + #content > #left > #rlblock_left{
+          display:none !important;
+      }
+    </style>
-    <link rel="stylesheet" href="assets/fonts/material-icons.css">
+  </head>
+  <body class="" data-url="/rbcli/">
+    <nav id="sidebar" class="">
+  <div id="header-wrapper">
+    <div id="header">
+      <a id="logo" href="https://akhoury6.github.io/rbcli/" style="font-size: 40px">
+  <span class="fas fa-terminal"></span>&nbsp;𝚁𝙱𝙲𝚕𝚒
+</a>
+    </div>
+        <div class="searchbox">
+    <label for="search-by"><i class="fas fa-search"></i></label>
+    <input data-search-input id="search-by" type="search" placeholder="Search...">
+    <span data-search-clear=""><i class="fas fa-times"></i></span>
+</div>
+<script type="text/javascript" src="/rbcli/js/lunr.min.js?1561087612"></script>
+<script type="text/javascript" src="/rbcli/js/auto-complete.js?1561087612"></script>
+<script type="text/javascript">
-  </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="#this-is-rbcli" tabindex="1" class="md-skip">
-        Skip to content
-      </a>
+        var baseurl = "https:\/\/akhoury6.github.io\/rbcli\/";
+</script>
+<script type="text/javascript" src="/rbcli/js/search.js?1561087612"></script>
-      <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">
-                Home
-              </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">
+    <div class="highlightable">
+    <ul class="topics">
-  <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">
+    <li data-nav-id="/rbcli/quick_reference/" title="Quick Reference" class="dd-item
-<nav class="md-tabs" 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 md-tabs__link--active">
-        Home
+        ">
+      <a href="/rbcli/quick_reference/">
+          Quick Reference
       </a>
-  </li>
+    </li>
-    <li class="md-tabs__item">
-        <a href="tutorial/10-getting_started/" title="Tutorial" class="md-tabs__link">
+    <li data-nav-id="/rbcli/tutorial/" title="Tutorial" class="dd-item
+        ">
+      <a href="/rbcli/tutorial/">
           Tutorial
-        </a>
+      </a>
-    </li>
+        <ul>
-    <li class="md-tabs__item">
-        <a href="advanced/command_types/" title="Advanced Features" class="md-tabs__link">
-          Advanced Features
+      <li data-nav-id="/rbcli/tutorial/10-getting_started/" title="Getting Started" class="dd-item ">
+        <a href="/rbcli/tutorial/10-getting_started/">
+        <b>1. </b>Getting Started
         </a>
     </li>
-    <li class="md-tabs__item">
-        <a href="development/contributing/" title="Development" class="md-tabs__link">
-          Development
+      <li data-nav-id="/rbcli/tutorial/20-project_layout/" title="The Project Layout" class="dd-item ">
+        <a href="/rbcli/tutorial/20-project_layout/">
+        <b>2. </b>The Project Layout
         </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">
-    <a href="." title="RBCli Documentation" class="md-nav__button md-logo">
-        <i class="md-icon">devices</i>
-    </a>
-    RBCli Documentation
-  </label>
-    <div class="md-nav__source">
+      <li data-nav-id="/rbcli/tutorial/30-your_first_command/" title="Your First Command" class="dd-item ">
+        <a href="/rbcli/tutorial/30-your_first_command/">
+        <b>3. </b>Your First Command
+        </a>
+    </li>
-  <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 data-nav-id="/rbcli/tutorial/40-options_parameters_and_arguments/" title="Options, Parameters, and Arguments" class="dd-item ">
+        <a href="/rbcli/tutorial/40-options_parameters_and_arguments/">
+        <b>4. </b>Options, Parameters, and Arguments
+        </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">
-    <a href="." title="Home" class="md-nav__link md-nav__link--active">
-      Home
-    </a>
-  </li>
+      <li data-nav-id="/rbcli/tutorial/50-publishing/" title="Publishing Your Application" class="dd-item ">
+        <a href="/rbcli/tutorial/50-publishing/">
+        <b>5. </b>Publishing Your Application
+        </a>
+    </li>
-  <li class="md-nav__item">
-    <a href="imported/quick_reference/" title="Quick Reference" class="md-nav__link">
-      Quick Reference
-    </a>
-  </li>
+        </ul>
+    </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 data-nav-id="/rbcli/advanced/" title="Advanced" class="dd-item
+        ">
+      <a href="/rbcli/advanced/">
+          Advanced
+      </a>
+        <ul>
-  <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 data-nav-id="/rbcli/advanced/automatic_updates/" title="Automatic Updates" class="dd-item ">
+        <a href="/rbcli/advanced/automatic_updates/">
+        Automatic Updates
+        </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 data-nav-id="/rbcli/advanced/command_types/" title="Command Types" class="dd-item ">
+        <a href="/rbcli/advanced/command_types/">
+        Command Types
+        </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 data-nav-id="/rbcli/advanced/distributed_state_locking/" title="Distributed State and Locking" class="dd-item ">
+        <a href="/rbcli/advanced/distributed_state_locking/">
+        Distributed State and Locking
+        </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>
+      <li data-nav-id="/rbcli/advanced/hooks/" title="Execution Hooks" class="dd-item ">
+        <a href="/rbcli/advanced/hooks/">
+        Execution Hooks
-      </ul>
-    </nav>
-  </li>
+        </a>
+    </li>
-  <li class="md-nav__item md-nav__item--nested">
-      <input class="md-toggle md-nav__toggle" data-md-toggle="nav-4" type="checkbox" id="nav-4">
-    <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 data-nav-id="/rbcli/advanced/interactive_commands/" title="Interactive Commands" class="dd-item ">
+        <a href="/rbcli/advanced/interactive_commands/">
+        Interactive Commands
+        </a>
+    </li>
-  <li class="md-nav__item">
-    <a href="advanced/command_types/" title="Command Types" class="md-nav__link">
-      Command Types
-    </a>
-  </li>
+      <li data-nav-id="/rbcli/advanced/logging/" title="Logging" class="dd-item ">
+        <a href="/rbcli/advanced/logging/">
+        Logging
+        </a>
+    </li>
-  <li class="md-nav__item">
-    <a href="advanced/user_config_files/" title="User Config Files" class="md-nav__link">
-      User Config Files
-    </a>
-  </li>
+      <li data-nav-id="/rbcli/advanced/remote_execution/" title="Remote Execution" class="dd-item ">
+        <a href="/rbcli/advanced/remote_execution/">
+        Remote Execution
+        </a>
+    </li>
-  <li class="md-nav__item">
-    <a href="advanced/hooks/" title="Hooks" class="md-nav__link">
-      Hooks
-    </a>
-  </li>
+      <li data-nav-id="/rbcli/advanced/state_storage/" title="State Storage" class="dd-item ">
+        <a href="/rbcli/advanced/state_storage/">
+        State Storage
+        </a>
+    </li>
-  <li class="md-nav__item">
-    <a href="advanced/logging/" title="Logging" class="md-nav__link">
-      Logging
-    </a>
-  </li>
+      <li data-nav-id="/rbcli/advanced/user_config_files/" title="User Configuration Files" class="dd-item ">
+        <a href="/rbcli/advanced/user_config_files/">
+        User Configuration Files
+        </a>
+    </li>
+        </ul>
+    </li>
-  <li class="md-nav__item">
-    <a href="advanced/automatic_updates/" title="Automatic Updates" class="md-nav__link">
-      Automatic Updates
-    </a>
-  </li>
+    <li data-nav-id="/rbcli/development/" title="Development" class="dd-item
+        ">
+      <a href="/rbcli/development/">
+          Development
+      </a>
+        <ul>
-  <li class="md-nav__item">
-    <a href="advanced/state_storage/" title="State Storage" class="md-nav__link">
-      State Storage
-    </a>
-  </li>
-  <li class="md-nav__item">
-    <a href="advanced/distributed_state_locking/" title="Distributed State Locking" class="md-nav__link">
-      Distributed State Locking
-    </a>
-  </li>
+      <li data-nav-id="/rbcli/development/contributing/" title="Contribution Guide" class="dd-item ">
+        <a href="/rbcli/development/contributing/">
+        Contribution Guide
+        </a>
+    </li>
-  <li class="md-nav__item">
-    <a href="advanced/remote_execution/" title="Remote Execution" class="md-nav__link">
-      Remote Execution
-    </a>
-  </li>
+      <li data-nav-id="/rbcli/development/license/" title="License Info" class="dd-item ">
+        <a href="/rbcli/development/license/">
+        License Info
+        </a>
+    </li>
+      <li data-nav-id="/rbcli/development/code_of_conduct/" title="Code of Conduct" class="dd-item ">
+        <a href="/rbcli/development/code_of_conduct/">
+        Code of Conduct
+        </a>
+    </li>
-  <li class="md-nav__item">
-    <a href="advanced/interactive_commands/" title="Interactive Commands" class="md-nav__link">
-      Interactive Commands
-    </a>
-  </li>
+      <li data-nav-id="/rbcli/development/changelog/" title="Changelog" class="dd-item ">
+        <a href="/rbcli/development/changelog/">
+        Changelog
+        </a>
+    </li>
-      </ul>
-    </nav>
-  </li>
+        </ul>
+    </li>
+    <li data-nav-id="/rbcli/whoami/" title="My Letter To You" class="dd-item
+        ">
+      <a href="/rbcli/whoami/">
+          My Letter To You
+      </a>
+    </li>
+    </ul>
-  <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>
+      <section id="shortcuts">
+        <h3>More</h3>
+        <ul>
+              <li>
+                  <a class="padding" href="https://github.com/akhoury6/rbcli"><i class='fab fa-github'></i> Github repo</a>
+              </li>
+              <li>
+                  <a class="padding" href="https://rubygems.org/gems/rbcli"><i class='far fa-gem'></i> Rubygems</a>
+              </li>
+        </ul>
+      </section>
+    <section id="footer">
+      <p>Built with <a href="https://github.com/matcornic/hugo-theme-learn"><i class="fas fa-heart"></i></a> from <a href="https://getgrav.org">Grav</a> and <a href="https://gohugo.io/">Hugo</a></p>
+    </section>
+  </div>
+</nav>
-  <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>
+        <section id="body">
+        <div id="overlay"></div>
+        <div class="padding highlightable">
+        <div id="head-tags">
+        </div>
+        <div id="body-inner">
-  <li class="md-nav__item">
-    <a href="development/code_of_conduct/" title="Code of Conduct" class="md-nav__link">
-      Code of Conduct
-    </a>
-  </li>
+<span id="sidebar-toggle-span">
+<a href="#" id="sidebar-toggle" data-sidebar-toggle=""><i class="fas fa-bars"></i> navigation</a>
+</span>
+<h1 id="this-is-rbcli">This is RBCli</h1>
+<p>As technologists today, we work with the command line a lot. We script a lot. We write tools to share with each other to make our lives easier. We even write applications to make up for missing features in the 3rd party software that we buy. Unfortunately, when writing CLI tools, this process has typically been very painful. We&rsquo;ve been working with low-level frameworks for decades; frameworks like <code>getopt</code> (1980) and <code>curses</code> (1977). They fit their purpose well; they were both computationally lightweight for the computers of the day, and they gave engineers full control and flexibility when it came to how things were built. Over the years, we&rsquo;ve used them to settle on several design patterns that we know work well. Patterns as to what a CLI command looks like, what a config file looks like, what remote execution looks like, and even how to use locks (mutexes, semaphores, etc) to control application flow and data atomicity. Yet we&rsquo;re stuck writing the same low-level code anytime we want to write our tooling. Not anymore.</p>
+<p>Enter RBCli. RBCli is a framework to quickly develop advanced command-line tools in Ruby. It has been written from the ground up with the needs of the modern technologist in mind, designed to make advanced CLI tool development as painless as possible. In RBCli, low-level code has been wrapped and/or replaced with higher-level methods. Much of the functionality has even been reduced to single methods: for example, it takes just one declaration to define, load, and generate a user&rsquo;s config file at the appropriate times. Many other features are automated and require no work by the engineer. These make RBCli a fundamental re-thining of how we develop CLI tools, enabling the rapid development of applications for everyone from hobbyists to enterprises.</p>
+<p>Some of its key features include:</p>
+<ul>
+<li><p><strong>Simple DSL Interface</strong>: To cut down on the amount of code that needs to be written, RBCli has a DSL that is designed to cut to the chase. This makes the work a lot less tedious.</p></li>
+<li><p><strong>Multiple Levels of Parameters and Arguments</strong>: Forget about writing parsers for command-line options, or about having to differentiate between parameters and arguments. All of that work is taken care of.</p></li>
+<li><p><strong>Config File Generation</strong>: Easily piece together a default configuration even with declarations in different parts of the code. Then the user can generate their own configuration, and it gets stored in whatever location you&rsquo;d like.</p></li>
+<li><p><strong>Multiple Hooks and Entry Points</strong>: Define commands, pre-execution hooks, post-execution hooks, and first_run hooks to quickly and easily customize the flow of your application code.</p></li>
+<li><p><strong>Logging</strong>: Keep track of all instances of your tool through logging. Logs can go to STDOUT, STDERR, or a given file, making them compatible with log aggregators such as Splunk, Logstash, and many others.</p></li>
+<li><p><strong>Local State Storage</strong>: Easily manage a set of data that persists between runs. You get access to a hash that is automatically kept in-sync with a file on disk.</p></li>
+<li><p><strong>Remote State</strong>: It works just like Local State Storage, but store the data on a remote server! It can be used in tandem with Local State Storage or on its own. Currently supports AWS DyanmoDB.</p></li>
+<li><p><strong>State Locking and Sharing</strong>: Share remote state safely between users with built-in locking! When enabled, it makes sure that only one user is accessing the data at any given time.</p></li>
+<li><p><strong>Automatic Update Notifications</strong>: Just provide the gem name or git repo, and RBCli will take care of notifying users!</p></li>
-  <li class="md-nav__item">
-    <a href="imported/changelog/" title="Changelog" class="md-nav__link">
-      Changelog
-    </a>
-  </li>
+<li><p><strong>External Script Wrapping</strong>: High-level wrapping for Bash scripts, or any other applcication you&rsquo;d like to wrap into a command.</p></li>
+<li><p><strong>Project Structure and Generators</strong>: Create a well-defined project directory structure which organizes your code and allows you to package and distribute your application as a Gem. Generators can also help speed up the process of creating new commands, scripts, and hooks!</p></li>
+<li><p><strong>Remote Execution</strong>: Automatically execute commands on remote machines via SSH</p></li>
+<li><p><strong>Interactive Commands</strong>: Automatically prompt users for paramter values if not given on the command line. This pattern allows for easy user interaction while still allowing scripting without the use of <em>expect</em>.</p></li>
+</ul>
+<p>If you&rsquo;re just getting started with RBCli, take a look at the <a href="/rbcli/tutorial/">Tutorial</a>. Or take a look at the <a href="/rbcli/advanced/">Advanced</a> menu to look through RBCli&rsquo;s additional featureset.</p>
+        </div>
-      </ul>
-    </nav>
-  </li>
+      </div>
+    <div id="navigation">
-  <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">
-</nav>
-                  </div>
-                </div>
-              </div>
-          <div class="md-content">
-            <article class="md-content__inner md-typeset">
-                <h1 id="this-is-rbcli">This is RBCli</h1>
-<p>As technologists today, we work with the command line a lot. We script a lot. We write tools to share with each other to make our lives easier. We even write applications to make up for missing features in the 3rd party software that we buy. Unfortunately, when writing CLI tools, this process has typically been very painful. We've been working with low-level frameworks for decades; frameworks like <code>getopt</code> (1980) and <code>curses</code> (1977). They fit their purpose well; they were both computationally lightweight for the computers of the day, and they gave engineers full control and flexibility when it came to how things were built. Over the years, we've used them to settle on several design patterns that we know work well. Patterns as to what a CLI command looks like, what a config file looks like, what remote execution looks like, and even how to use locks (mutexes, semaphores, etc) to control application flow and data atomicity. Yet we're stuck writing the same low-level code anytime we want to write our tooling. Not anymore.</p>
-<p>Enter RBCli. RBCli is a framework to quickly develop advanced command-line tools in Ruby. It has been written from the ground up with the needs of the modern technologist in mind, designed to make advanced CLI tool development as painless as possible. In RBCli, low-level code has been wrapped and/or replaced with higher-level methods. Much of the functionality has even been reduced to single methods: for example, it takes just one declaration to define, load, and generate a user's config file at the appropriate times. Many other features are automated and require no work by the engineer. These make RBCli a fundamental re-thining of how we develop CLI tools, enabling the rapid development of applications for everyone from hobbyists to enterprises.</p>
-<p>Some of its key features include:</p>
-<ul>
-<li>
-<p><strong>Simple DSL Interface</strong>: To cut down on the amount of code that needs to be written, RBCli has a DSL that is designed to cut to the chase. This makes the work a lot less tedious.</p>
-</li>
-<li>
-<p><strong>Multiple Levels of Parameters and Arguments</strong>: Forget about writing parsers for command-line options, or about having to differentiate between parameters and arguments. All of that work is taken care of.</p>
-</li>
-<li>
-<p><strong>Config File Generation</strong>: Easily piece together a default configuration even with declarations in different parts of the code. Then the user can generate their own configuration, and it gets stored in whatever location you'd like.</p>
-</li>
-<li>
-<p><strong>Multiple Hooks and Entry Points</strong>: Define commands, pre-execution hooks, post-execution hooks, and first_run hooks to quickly and easily customize the flow of your application code.</p>
-</li>
-<li>
-<p><strong>Logging</strong>: Keep track of all instances of your tool through logging. Logs can go to STDOUT, STDERR, or a given file, making them compatible with log aggregators such as Splunk, Logstash, and many others.</p>
-</li>
-<li>
-<p><strong>Local State Storage</strong>: Easily manage a set of data that persists between runs. You get access to a hash that is automatically kept in-sync with a file on disk.</p>
-</li>
-<li>
-<p><strong>Remote State</strong>: It works just like Local State Storage, but store the data on a remote server! It can be used in tandem with Local State Storage or on its own. Currently supports AWS DyanmoDB.  </p>
-</li>
-<li>
-<p><strong>State Locking and Sharing</strong>: Share remote state safely between users with built-in locking! When enabled, it makes sure that only one user is accessing the data at any given time.</p>
-</li>
-<li>
-<p><strong>Automatic Update Notifications</strong>: Just provide the gem name or git repo, and RBCli will take care of notifying users!</p>
-</li>
-<li>
-<p><strong>External Script Wrapping</strong>: High-level wrapping for Bash scripts, or any other applcication you'd like to wrap into a command.</p>
-</li>
-<li>
-<p><strong>Project Structure and Generators</strong>: Create a well-defined project directory structure which organizes your code and allows you to package and distribute your application as a Gem. Generators can also help speed up the process of creating new commands, scripts, and hooks!</p>
-</li>
-<li>
-<p><strong>Remote Execution</strong>: Automatically execute commands on remote machines via SSH</p>
-</li>
-</ul>
-<p>If you're just getting started with RBCli, take a look at the <a href="tutorial/10-getting_started/">Tutorial</a>. Or take a look at the <a href="advanced/user_config_files/">Advanced</a> menu above to look through RBCli's additional featureset.</p>
-            </article>
-          </div>
-        </div>
-      </main>
-<footer class="md-footer">
-    <div class="md-footer-nav">
-      <nav class="md-footer-nav__inner md-grid">
-          <a href="imported/quick_reference/" title="Quick Reference" 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>
-                Quick Reference
-              </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>
+			<a class="nav nav-next" href="/rbcli/quick_reference/" title="Quick Reference" style="margin-right: 0px;"><i class="fa fa-chevron-right"></i></a>
     </div>
+    </section>
-      <script src="assets/javascripts/application.583bbe55.js"></script>
-      <script>app.initialize({version:"1.0.3",url:{base:"."}})</script>
+    <div style="left: -1000px; overflow: scroll; position: absolute; top: -1000px; border: none; box-sizing: content-box; height: 200px; margin: 0px; padding: 0px; width: 200px;">
+      <div style="border: none; box-sizing: content-box; height: 200px; margin: 0px; padding: 0px; width: 200px;"></div>
+    </div>
+    <script src="/rbcli/js/clipboard.min.js?1561087612"></script>
+    <script src="/rbcli/js/perfect-scrollbar.min.js?1561087612"></script>
+    <script src="/rbcli/js/perfect-scrollbar.jquery.min.js?1561087612"></script>
+    <script src="/rbcli/js/jquery.sticky.js?1561087612"></script>
+    <script src="/rbcli/js/featherlight.min.js?1561087612"></script>
+    <script src="/rbcli/js/html5shiv-printshiv.min.js?1561087612"></script>
+    <script src="/rbcli/js/highlight.pack.js?1561087612"></script>
+    <script>hljs.initHighlightingOnLoad();</script>
+    <script src="/rbcli/js/modernizr.custom-3.6.0.js?1561087612"></script>
+    <script src="/rbcli/js/learn.js?1561087612"></script>
+    <script src="/rbcli/js/hugo-learn.js?1561087612"></script>
+    <link href="/rbcli/mermaid/mermaid.css?1561087612" rel="stylesheet" />
+    <script src="/rbcli/mermaid/mermaid.js?1561087612"></script>
+    <script>
+        mermaid.initialize({ startOnLoad: true });
+    </script>
   </body>
-</html>
+</html>