RubyGems - rbcli - Versions diffs - 0.2.10 → 0.3.1 - Mend

rbcli 0.2.10 → 0.3.1

Files changed (444) hide show

data/docs/advanced/command_types/index.html CHANGED Viewed

@@ -1,982 +1,1262 @@
+<!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.88.1" />
+    <meta name="description" content="">
+    <link rel="icon" href="/rbcli/images/favicon.png" type="image/png">
+    <title>Command Types :: 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>Command Types - RBCli Documentation</title>
+    <link href="/rbcli/css/nucleus.css?1634703589" rel="stylesheet">
+    <link href="/rbcli/css/fontawesome-all.min.css?1634703589" rel="stylesheet">
+    <link href="/rbcli/css/hybrid.css?1634703589" rel="stylesheet">
+    <link href="/rbcli/css/featherlight.min.css?1634703589" rel="stylesheet">
+    <link href="/rbcli/css/perfect-scrollbar.min.css?1634703589" rel="stylesheet">
+    <link href="/rbcli/css/auto-complete.css?1634703589" rel="stylesheet">
+    <link href="/rbcli/css/atom-one-dark-reasonable.css?1634703589" rel="stylesheet">
+    <link href="/rbcli/css/theme.css?1634703589" rel="stylesheet">
+    <link href="/rbcli/css/hugo-theme.css?1634703589" 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?1634703589" rel="stylesheet">
+    <script src="/rbcli/js/jquery-3.3.1.min.js?1634703589"></script>
+    <style>
+      :root #header + #content > #left > #rlblock_left{
+          display:none !important;
+      }
-        <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>
+    </style>
-    <link rel="stylesheet" href="../../assets/fonts/material-icons.css">
+  </head>
+  <body class="" data-url="/rbcli/advanced/command_types/">
+    <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?1634703589"></script>
+<script type="text/javascript" src="/rbcli/js/auto-complete.js?1634703589"></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="../../#advanced-command-types" 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?1634703589"></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">
-                Command Types
-              </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 class="highlightable">
+    <ul class="topics">
+    <li data-nav-id="/rbcli/quick_reference/" title="Quick Reference" class="dd-item
-      </div>
+        ">
+      <a href="/rbcli/quick_reference/">
+          Quick Reference
+      </a>
-        <div class="md-flex__cell md-flex__cell--shrink">
-          <div class="md-header-nav__source">
+    </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>
-        </div>
-    </div>
-  </nav>
-</header>
-    <div class="md-container">
+    <li data-nav-id="/rbcli/tutorial/" title="Tutorial" class="dd-item
-<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 href="/rbcli/tutorial/">
+          Tutorial
       </a>
-  </li>
+        <ul>
-    <li class="md-tabs__item">
-        <a href="../../tutorial/10-getting_started/" title="Tutorial" class="md-tabs__link">
-          Tutorial
+      <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="./" title="Advanced Features" class="md-tabs__link md-tabs__link--active">
-          Advanced Features
+      <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>
-    <li class="md-tabs__item">
-        <a href="../../development/contributing/" title="Development" class="md-tabs__link">
-          Development
+      <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>
-    </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">
-  <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">
-    <a href="../.." title="Home" class="md-nav__link">
-      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>
+        </ul>
+    </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 data-nav-id="/rbcli/advanced/" title="Advanced" class="dd-item
+        parent
+        ">
+      <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 active">
+        <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>
-      </ul>
-    </nav>
-  </li>
+      <li data-nav-id="/rbcli/advanced/hooks/" title="Execution Hooks" class="dd-item ">
+        <a href="/rbcli/advanced/hooks/">
+        Execution Hooks
+        </a>
+    </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 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 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">
-        Command Types
-      </label>
-    <a href="./" title="Command Types" class="md-nav__link md-nav__link--active">
-      Command Types
-    </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="#general-command-structure" title="General Command Structure" class="md-nav__link">
-    General Command Structure
-  </a>
-</li>
-        <li class="md-nav__item">
-  <a href="#standard-commands" title="Standard Commands" class="md-nav__link">
-    Standard Commands
-  </a>
-</li>
-        <li class="md-nav__item">
-  <a href="#scripted-commands" title="Scripted Commands" class="md-nav__link">
-    Scripted Commands
-  </a>
-</li>
-        <li class="md-nav__item">
-  <a href="#external-commands" title="External Commands" class="md-nav__link">
-    External Commands
-  </a>
-    <nav class="md-nav">
-      <ul class="md-nav__list">
+      <li data-nav-id="/rbcli/advanced/logging/" title="Logging" class="dd-item ">
+        <a href="/rbcli/advanced/logging/">
+        Logging
-          <li class="md-nav__item">
-  <a href="#direct-path-mode" title="Direct Path Mode" class="md-nav__link">
-    Direct Path Mode
-  </a>
+        </a>
+    </li>
-</li>
-          <li class="md-nav__item">
-  <a href="#variable-path-mode" title="Variable Path Mode" class="md-nav__link">
-    Variable Path Mode
-  </a>
-</li>
+      <li data-nav-id="/rbcli/advanced/remote_execution/" title="Remote Execution" class="dd-item ">
+        <a href="/rbcli/advanced/remote_execution/">
+        Remote Execution
-      </ul>
-    </nav>
-</li>
-    </ul>
+        </a>
+    </li>
-</nav>
-  </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 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="../hooks/" title="Hooks" class="md-nav__link">
-      Hooks
-    </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="../logging/" title="Logging" class="md-nav__link">
-      Logging
-    </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="../automatic_updates/" title="Automatic Updates" class="md-nav__link">
-      Automatic Updates
-    </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="../state_storage/" title="State Storage" class="md-nav__link">
-      State Storage
-    </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 class="md-nav__item">
-    <a href="../distributed_state_locking/" title="Distributed State Locking" class="md-nav__link">
-      Distributed State Locking
-    </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="../remote_execution/" title="Remote Execution" class="md-nav__link">
-      Remote Execution
-    </a>
-  </li>
+      <li data-nav-id="/rbcli/development/changelog/" title="Changelog" class="dd-item ">
+        <a href="/rbcli/development/changelog/">
+        Changelog
+        </a>
+    </li>
+        </ul>
+    </li>
-  <li class="md-nav__item">
-    <a href="../interactive_commands/" title="Interactive Commands" class="md-nav__link">
-      Interactive Commands
-    </a>
-  </li>
-      </ul>
-    </nav>
-  </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>
+        <section id="body">
+        <div id="overlay"></div>
+        <div class="padding highlightable">
+              <div>
+                <div id="top-bar">
+                <div id="breadcrumbs" itemscope="" itemtype="http://data-vocabulary.org/Breadcrumb">
+                    <span id="sidebar-toggle-span">
+                        <a href="#" id="sidebar-toggle" data-sidebar-toggle="">
+                          <i class="fas fa-bars"></i>
+                        </a>
+                    </span>
+                  <span id="toc-menu"><i class="fas fa-list-alt"></i></span>
+                  <span class="links">
-  <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>
+            <a href='/rbcli/'></a> > <a href='/rbcli/advanced/'>Advanced</a> > Command Types
-  <li class="md-nav__item">
-    <a href="../../imported/changelog/" title="Changelog" class="md-nav__link">
-      Changelog
-    </a>
-  </li>
+                  </span>
+                </div>
+                    <div class="progress">
+    <div class="wrapper">
+<nav id="TableOfContents">
+  <ul>
+    <li><a href="#general-command-structure">General Command Structure</a></li>
+    <li><a href="#standard-commands">Standard Commands</a></li>
+    <li><a href="#scripted-commands">Scripted Commands</a></li>
+    <li><a href="#external-commands">External Commands</a>
+      <ul>
+        <li><a href="#direct-path-mode">Direct Path Mode</a></li>
+        <li><a href="#variable-path-mode">Variable Path Mode</a></li>
       </ul>
-    </nav>
-  </li>
-  <li class="md-nav__item">
-    <a href="../../whoami/" title="whoami" class="md-nav__link">
-      whoami
-    </a>
-  </li>
+    </li>
   </ul>
 </nav>
-                  </div>
-                </div>
+    </div>
+</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="#general-command-structure" title="General Command Structure" class="md-nav__link">
-    General Command Structure
-  </a>
-</li>
-        <li class="md-nav__item">
-  <a href="#standard-commands" title="Standard Commands" class="md-nav__link">
-    Standard Commands
-  </a>
-</li>
-        <li class="md-nav__item">
-  <a href="#scripted-commands" title="Scripted Commands" class="md-nav__link">
-    Scripted Commands
-  </a>
-</li>
-        <li class="md-nav__item">
-  <a href="#external-commands" title="External Commands" class="md-nav__link">
-    External Commands
-  </a>
-    <nav class="md-nav">
-      <ul class="md-nav__list">
-          <li class="md-nav__item">
-  <a href="#direct-path-mode" title="Direct Path Mode" class="md-nav__link">
-    Direct Path Mode
-  </a>
-</li>
+        <div id="head-tags">
-          <li class="md-nav__item">
-  <a href="#variable-path-mode" title="Variable Path Mode" class="md-nav__link">
-    Variable Path Mode
-  </a>
-</li>
+        </div>
-      </ul>
-    </nav>
-</li>
-    </ul>
-</nav>
-                  </div>
-                </div>
-              </div>
+        <div id="body-inner">
-          <div class="md-content">
-            <article class="md-content__inner md-typeset">
+            <h1>
-                <h1 id="advanced-command-types">Advanced Command Types</h1>
+              Command Types
+            </h1>
 <p>RBCli has three different command types:</p>
 <ul>
 <li><strong>Standard Commands</strong> (Ruby-based)</li>
 <li><strong>Scripted Commands</strong> (Ruby+Bash based)</li>
 <li><strong>External Commands</strong> (Wrapping a 3rd party application)</li>
 </ul>
-<p>This document is provided to be a reference. If you would like an in-depth tutorial, please see <a href="../../tutorial/30-your_first_command/">Your First Command</a>.</p>
+<p>This document is provided to be a reference. If you would like an in-depth tutorial, please see <a href="/rbcli/tutorial/30-your_first_command/">Your First Command</a>.</p>
 <h2 id="general-command-structure">General Command Structure</h2>
 <p>Commands in RBCli are created by subclassing <code>Rbcli::Command</code>. All commands share a certain common structure:</p>
-<pre><code class="ruby">class List &lt; Rbcli::Command                                                           # Declare a new command by subclassing Rbcli::Command
-    description 'TODO: Description goes here'                                           # (Required) Short description for the global help
-    usage &lt;&lt;-EOF
-TODO: Usage text goes here
-EOF                                                                                   # (Required) Long description for the command-specific help
-    parameter :force, 'Force testing', type: :boolean, default: false, required: false  # (Optional, Multiple) Add a command-specific CLI parameter. Can be called multiple times
-    config_default :myopt2, description: 'My Option #2', default: 'Default Value Here'  # (Optional, Multiple) Specify an individual configuration parameter and set a default value. These will also be included in generated user config.
-                                                                                      # Alternatively, you can simply create a yaml file in the `default_user_configs` directory in your project that specifies the default values of all options
-end
-</code></pre>
+<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-ruby" data-lang="ruby"><span style="color:#66d9ef">class</span> <span style="color:#a6e22e">List</span> <span style="color:#f92672">&lt;</span> <span style="color:#66d9ef">Rbcli</span><span style="color:#f92672">::</span><span style="color:#66d9ef">Command</span>                                                           <span style="color:#75715e"># Declare a new command by subclassing Rbcli::Command</span>
+	description <span style="color:#e6db74">&#39;TODO: Description goes here&#39;</span>                                           <span style="color:#75715e"># (Required) Short description for the global help</span>
+	usage <span style="color:#e6db74">&lt;&lt;-EOF
+</span><span style="color:#e6db74"></span><span style="color:#e6db74">TODO</span>: <span style="color:#66d9ef">Usage</span> text goes here
+<span style="color:#66d9ef">EOF</span>                                                                                   <span style="color:#75715e"># (Required) Long description for the command-specific help</span>
+	parameter <span style="color:#e6db74">:force</span>, <span style="color:#e6db74">&#39;Force testing&#39;</span>, <span style="color:#e6db74">type</span>: <span style="color:#e6db74">:boolean</span>, <span style="color:#e6db74">default</span>: <span style="color:#66d9ef">false</span>, <span style="color:#e6db74">required</span>: <span style="color:#66d9ef">false</span>  <span style="color:#75715e"># (Optional, Multiple) Add a command-specific CLI parameter. Can be called multiple times</span>
+	config_default <span style="color:#e6db74">:myopt2</span>, <span style="color:#e6db74">description</span>: <span style="color:#e6db74">&#39;My Option #2&#39;</span>, <span style="color:#e6db74">default</span>: <span style="color:#e6db74">&#39;Default Value Here&#39;</span>  <span style="color:#75715e"># (Optional, Multiple) Specify an individual configuration parameter and set a default value. These will also be included in generated user config.</span>
+                                                                                      <span style="color:#75715e"># Alternatively, you can simply create a yaml file in the `default_user_configs` directory in your project that specifies the default values of all options</span>
+<span style="color:#66d9ef">end</span>
+</code></pre></div><ul>
+<li><code>description</code>
 <ul>
-<li><code>description</code><ul>
 <li>A short description of the command, which will appear in the top-level help (when the user runs <code>mytool -h</code>).</li>
 </ul>
 </li>
-<li><code>usage</code><ul>
-<li>A description of how the command is meant to be used. This description can be as long as you want, and can be as in-depth as you'd like. It will show up as a long, multi-line description when the user runs the command-sepcific help (<code>mytool list -h</code>).</li>
+<li><code>usage</code>
+<ul>
+<li>A description of how the command is meant to be used. This description can be as long as you want, and can be as in-depth as you&rsquo;d like. It will show up as a long, multi-line description when the user runs the command-sepcific help (<code>mytool list -h</code>).</li>
 </ul>
 </li>
-<li><code>parameter</code><ul>
-<li>Command-line tags that the user can enter that are specific to only this command. We will get into these in the next section on <a href="../../tutorial/40-options_parameters_and_arguments/">Options, Parameters, and Arguments</a></li>
+<li><code>parameter</code>
+<ul>
+<li>Command-line tags that the user can enter that are specific to only this command. We will get into these in the next section on <a href="/rbcli/tutorial/40-options_parameters_and_arguments/">Options, Parameters, and Arguments</a></li>
 </ul>
 </li>
-<li><code>config_default</code><ul>
-<li>This sets a single item in the config file that will be made available to the user. More information can be found in the documentation on <a href="../user_config_files/">User Config Files</a></li>
+<li><code>config_default</code>
+<ul>
+<li>This sets a single item in the config file that will be made available to the user. More information can be found in the documentation on <a href="/rbcli/advanced/user_config_files/">User Config Files</a></li>
 </ul>
 </li>
 </ul>
 <h2 id="standard-commands">Standard Commands</h2>
 <p>Standard commands are written as ruby code. To create a standard command called <code>list</code>, run:</p>
-<pre><code class="bash">rbcli command --name=list
-#or
+<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-bash" data-lang="bash">rbcli command --name<span style="color:#f92672">=</span>list
+<span style="color:#75715e">#or</span>
 rbcli command -n list
-</code></pre>
-<p>A standard command can be identified by the presence of an <code>action</code> block in the definition:</p>
-<pre><code class="ruby">class List &lt; Rbcli::Command
-    action do |params, args, global_opts, config|
-        # Code goes here
-    end
-end
-</code></pre>
-<p>Your application's <strong>parameters</strong>, <strong>arguments</strong>, <strong>options</strong>, and <strong>config</strong> are available in the variables passed into the block. For more information on these, see <a href="../../tutorial/40-options_parameters_and_arguments/">Options, Parameters, and Arguments</a>.</p>
+</code></pre></div><p>A standard command can be identified by the presence of an <code>action</code> block in the definition:</p>
+<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-ruby" data-lang="ruby"><span style="color:#66d9ef">class</span> <span style="color:#a6e22e">List</span> <span style="color:#f92672">&lt;</span> <span style="color:#66d9ef">Rbcli</span><span style="color:#f92672">::</span><span style="color:#66d9ef">Command</span>
+	action <span style="color:#66d9ef">do</span> <span style="color:#f92672">|</span>params, args, global_opts, config<span style="color:#f92672">|</span>
+		<span style="color:#75715e"># Code goes here</span>
+	<span style="color:#66d9ef">end</span>
+<span style="color:#66d9ef">end</span>
+</code></pre></div><p>Your application&rsquo;s <strong>parameters</strong>, <strong>arguments</strong>, <strong>options</strong>, and <strong>config</strong> are available in the variables passed into the block. For more information on these, see <a href="/rbcli/tutorial/40-options_parameters_and_arguments/">Options, Parameters, and Arguments</a>.</p>
 <h2 id="scripted-commands">Scripted Commands</h2>
-<p>Scripted commands are part Ruby, part Bash scripting. They are a good choice to use if you feel something might be easier or more performant to script with Bash, or if you already have a Bash script you'd like to use in your project. You can create one with:</p>
-<pre><code class="bash">rbcli script -n list
-</code></pre>
-<p>This will create two files in your RBCli project: a Ruby file with the common command declaration (see <a href="#general-command-structure">General Command Structure</a>), and a bash script in the folder <code>application/commands/scripts/</code>.</p>
+<p>Scripted commands are part Ruby, part Bash scripting. They are a good choice to use if you feel something might be easier or more performant to script with Bash, or if you already have a Bash script you&rsquo;d like to use in your project. You can create one with:</p>
+<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-bash" data-lang="bash">rbcli script -n list
+</code></pre></div><p>This will create two files in your RBCli project: a Ruby file with the common command declaration (see <a href="#general-command-structure">General Command Structure</a>), and a bash script in the folder <code>application/commands/scripts/</code>.</p>
 <p>You can tell a command is a script by the line:</p>
-<pre><code class="ruby">class List &lt; Rbcli::Command
-    script
-end
-</code></pre>
-<p>RBCli will pass along your applications config and CLI parameters through JSON environment variables. To make things easy, a Bash library is provided that makes retrieving and parsing these variables easy. It is already imported when you generate the command, with the line:</p>
-<pre><code class="bash">source $(echo $(cd &quot;$(dirname $(gem which rbcli))/../lib-sh&quot; &amp;&amp; pwd)/lib-rbcli.sh)
-</code></pre>
-<p>This will find the library which is stored on the system as part of the RBCli gem.</p>
+<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-ruby" data-lang="ruby"><span style="color:#66d9ef">class</span> <span style="color:#a6e22e">List</span> <span style="color:#f92672">&lt;</span> <span style="color:#66d9ef">Rbcli</span><span style="color:#f92672">::</span><span style="color:#66d9ef">Command</span>
+	script
+<span style="color:#66d9ef">end</span>
+</code></pre></div><p>RBCli will pass along your applications config and CLI parameters through JSON environment variables. To make things easy, a Bash library is provided that makes retrieving and parsing these variables easy. It is already imported when you generate the command, with the line:</p>
+<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-bash" data-lang="bash">source <span style="color:#66d9ef">$(</span>echo <span style="color:#66d9ef">$(</span>cd <span style="color:#e6db74">&#34;</span><span style="color:#66d9ef">$(</span>dirname <span style="color:#66d9ef">$(</span>gem which rbcli<span style="color:#66d9ef">))</span><span style="color:#e6db74">/../lib-sh&#34;</span> <span style="color:#f92672">&amp;&amp;</span> pwd<span style="color:#66d9ef">)</span>/lib-rbcli.sh<span style="color:#66d9ef">)</span>
+</code></pre></div><p>This will find the library which is stored on the system as part of the RBCli gem.</p>
 <p>You can then retrieve the values present in your variables like such:</p>
-<pre><code class="bash">rbcli params
+<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-bash" data-lang="bash">rbcli params
 rbcli args
 rbcli global_opts
 rbcli config
 rbcli myvars
-echo &quot;Usage Examples:&quot;
-echo &quot;Log Level:  $(rbcli config .logger.log_level)&quot;
-echo &quot;Log Target: $(rbcli config .logger.log_target)&quot;
-echo &quot;First Argument (if passed): $(rbcli args .[0])&quot;
-</code></pre>
-<p>For your convenience, the script will have all the instructions needed there. For more instructions on how to use JQ syntax to parse values, see the <a href="https://stedolan.github.io/jq/manual/">JQ documentation</a>.</p>
+echo <span style="color:#e6db74">&#34;Usage Examples:&#34;</span>
+echo <span style="color:#e6db74">&#34;Log Level:  </span><span style="color:#66d9ef">$(</span>rbcli config .logger.log_level<span style="color:#66d9ef">)</span><span style="color:#e6db74">&#34;</span>
+echo <span style="color:#e6db74">&#34;Log Target: </span><span style="color:#66d9ef">$(</span>rbcli config .logger.log_target<span style="color:#66d9ef">)</span><span style="color:#e6db74">&#34;</span>
+echo <span style="color:#e6db74">&#34;First Argument (if passed): </span><span style="color:#66d9ef">$(</span>rbcli args .<span style="color:#f92672">[</span>0<span style="color:#f92672">]</span><span style="color:#66d9ef">)</span><span style="color:#e6db74">&#34;</span>
+</code></pre></div><p>For your convenience, the script will have all the instructions needed there. For more instructions on how to use JQ syntax to parse values, see the <a href="https://stedolan.github.io/jq/manual/">JQ documentation</a>.</p>
 <h2 id="external-commands">External Commands</h2>
 <p>External Commands are used to wrap 3rd party applications. RBCli accomplishes this by allowing you to set environment variables and command line parameters based on your input variables.</p>
-<p>RBCli provides this feature through the <code>extern</code> keyword. It provides two modes -- <strong>direct path</strong> and <strong>variable path</strong> -- which work similarly.</p>
+<p>RBCli provides this feature through the <code>extern</code> keyword. It provides two modes &ndash; <strong>direct path</strong> and <strong>variable path</strong> &ndash; which work similarly.</p>
 <h3 id="direct-path-mode">Direct Path Mode</h3>
 <p>Direct path mode is the simpler mode of the two External Command modes. It allows you to provide a specific command with environment variables set, though it does not allow using RBCli parameters, arguments, options, and config.</p>
-<p><code>ruby
-class List &lt; Rbcli::Command
-    extern path: 'path/to/application', envvars: {MYVAR: 'some_value'}                               # (Required) Runs a given application, with optional environment variables, when the user runs the command.
-end</code></p>
-<p>Here, we supply a string to run the command. We can optioanlly provide environment variables which will be set for the external application.</p>
+<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-ruby" data-lang="ruby"><span style="color:#66d9ef">class</span> <span style="color:#a6e22e">List</span> <span style="color:#f92672">&lt;</span> <span style="color:#66d9ef">Rbcli</span><span style="color:#f92672">::</span><span style="color:#66d9ef">Command</span>
+   extern <span style="color:#e6db74">path</span>: <span style="color:#e6db74">&#39;path/to/application&#39;</span>, <span style="color:#e6db74">envvars</span>: {<span style="color:#e6db74">MYVAR</span>: <span style="color:#e6db74">&#39;some_value&#39;</span>}                               <span style="color:#75715e"># (Required) Runs a given application, with optional environment variables, when the user runs the command.</span>
+<span style="color:#66d9ef">end</span>
+</code></pre></div><p>Here, we supply a string to run the command. We can optioanlly provide environment variables which will be set for the external application.</p>
 <h3 id="variable-path-mode">Variable Path Mode</h3>
 <p>Variable Path mode works the same as Direct Path Mode, only instead of providing a string we provide a block that returns a string (which will be the command executed). This allows us to generate different commands based on the CLI parameters that the user passed, or pass configuration as CLI parameters to the external application:</p>
-<pre><code class="ruby">class Test &lt; Rbcli::Command
-    extern envvars: {MY_OTHER_VAR: 'another_value'} do |params, args, global_opts, config|          # Alternate usage. Supplying a block instead of a path allows us to modify the command based on the arguments and configuration supplied by the user. This allows passing config settings as command line arguments to external applications. The block must return a string, which is the command to be executed.
-        cmd = '/path/to/application'
-        cmd += ' --test-script foo --ignore-errors' if params[:force]
-        cmd
-    end
-end
-</code></pre>
+<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-ruby" data-lang="ruby"><span style="color:#66d9ef">class</span> <span style="color:#a6e22e">Test</span> <span style="color:#f92672">&lt;</span> <span style="color:#66d9ef">Rbcli</span><span style="color:#f92672">::</span><span style="color:#66d9ef">Command</span>
+	extern <span style="color:#e6db74">envvars</span>: {<span style="color:#e6db74">MY_OTHER_VAR</span>: <span style="color:#e6db74">&#39;another_value&#39;</span>} <span style="color:#66d9ef">do</span> <span style="color:#f92672">|</span>params, args, global_opts, config<span style="color:#f92672">|</span>          <span style="color:#75715e"># Alternate usage. Supplying a block instead of a path allows us to modify the command based on the arguments and configuration supplied by the user. This allows passing config settings as command line arguments to external applications. The block must return a string, which is the command to be executed.</span>
+		cmd <span style="color:#f92672">=</span> <span style="color:#e6db74">&#39;/path/to/application&#39;</span>
+		cmd <span style="color:#f92672">+=</span> <span style="color:#e6db74">&#39; --test-script foo --ignore-errors&#39;</span> <span style="color:#66d9ef">if</span> params<span style="color:#f92672">[</span><span style="color:#e6db74">:force</span><span style="color:#f92672">]</span>
+		cmd
+	<span style="color:#66d9ef">end</span>
+<span style="color:#66d9ef">end</span>
+</code></pre></div><p><strong>NOTE</strong>: Passing user-supplied data as part of the command string may be a security risk (example: <code>/path/to/application --name #{params[:name]}</code>). It is highly recommended to provide the fixed strings yourself, and only select which strings are used based on the variables provided. This is demonstrated in the example above.</p>
+<footer class="footline">
+</footer>
+        </div>
-<p><strong>NOTE</strong>: Passing user-supplied data as part of the command string may be a security risk (example: <code>/path/to/application --name #{params[:name]}</code>). It is highly recommended to provide the fixed strings yourself, and only select which strings are used based on the variables provided. This is demonstrated in the example above.</p>
+      </div>
+    <div id="navigation">
-            </article>
-          </div>
-        </div>
-      </main>
-<footer class="md-footer">
-    <div class="md-footer-nav">
-      <nav class="md-footer-nav__inner md-grid">
-          <a href="../../tutorial/50-publishing/" title="Publishing and Distribution" 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>
-                Publishing and Distribution
-              </span>
-            </div>
-          </a>
-          <a href="../user_config_files/" title="User Config Files" 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>
-                User Config Files
-              </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-prev" href="/rbcli/advanced/automatic_updates/" title="Automatic Updates"> <i class="fa fa-chevron-left"></i></a>
+			<a class="nav nav-next" href="/rbcli/advanced/distributed_state_locking/" title="Distributed State and Locking" 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?1634703589"></script>
+    <script src="/rbcli/js/perfect-scrollbar.min.js?1634703589"></script>
+    <script src="/rbcli/js/perfect-scrollbar.jquery.min.js?1634703589"></script>
+    <script src="/rbcli/js/jquery.sticky.js?1634703589"></script>
+    <script src="/rbcli/js/featherlight.min.js?1634703589"></script>
+    <script src="/rbcli/js/highlight.pack.js?1634703589"></script>
+    <script>hljs.initHighlightingOnLoad();</script>
+    <script src="/rbcli/js/modernizr.custom-3.6.0.js?1634703589"></script>
+    <script src="/rbcli/js/learn.js?1634703589"></script>
+    <script src="/rbcli/js/hugo-learn.js?1634703589"></script>
+    <link href="/rbcli/mermaid/mermaid.css?1634703589" rel="stylesheet" />
+    <script src="/rbcli/mermaid/mermaid.js?1634703589"></script>
+    <script>
+        mermaid.initialize({ startOnLoad: true });
+    </script>
   </body>
-</html>
+</html>