rbcli 0.2.11 → 0.2.12

data/docs/advanced/index.xml

@@ -0,0 +1,117 @@
+<?xml version="1.0" encoding="utf-8" standalone="yes" ?>
+<rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom">
+  <channel>
+    <title>Advanced on RBCli Documentation</title>
+    <link>https://akhoury6.github.io/rbcli/advanced/</link>
+    <description>Recent content in Advanced on RBCli Documentation</description>
+    <generator>Hugo -- gohugo.io</generator>
+    <language>en-us</language>
+    <lastBuildDate>Thu, 20 Jun 2019 15:08:08 -0400</lastBuildDate>
+    
+	<atom:link href="https://akhoury6.github.io/rbcli/advanced/index.xml" rel="self" type="application/rss+xml" />
+    
+    
+    <item>
+      <title>Automatic Updates</title>
+      <link>https://akhoury6.github.io/rbcli/advanced/automatic_updates/</link>
+      <pubDate>Thu, 20 Jun 2019 15:07:21 -0400</pubDate>
+      
+      <guid>https://akhoury6.github.io/rbcli/advanced/automatic_updates/</guid>
+      <description>RBCli can automatically notify users when an update is available. If force_update is set (see below), RBCli can halt execution until the user updates their application.
+Two sources are currently supported: Github (including Enterprise) and RubyGems.
+GitHub Update Check The GitHub update check works best when paired with GitHub&amp;rsquo;s best practices on releases, where new releases are tagged on master with the format vX.X.X. See Github&amp;rsquo;s release documentation to learn more.</description>
+    </item>
+    
+    <item>
+      <title>Command Types</title>
+      <link>https://akhoury6.github.io/rbcli/advanced/command_types/</link>
+      <pubDate>Thu, 20 Jun 2019 15:07:21 -0400</pubDate>
+      
+      <guid>https://akhoury6.github.io/rbcli/advanced/command_types/</guid>
+      <description>RBCli has three different command types:
+ Standard Commands (Ruby-based) Scripted Commands (Ruby+Bash based) External Commands (Wrapping a 3rd party application)  This document is provided to be a reference. If you would like an in-depth tutorial, please see Your First Command.
+General Command Structure Commands in RBCli are created by subclassing Rbcli::Command. All commands share a certain common structure:
+class List &amp;lt; Rbcli::Command # Declare a new command by subclassing Rbcli::Command description &#39;TODO: Description goes here&#39; # (Required) Short description for the global help usage &amp;lt;&amp;lt;-EOF TODO: Usage text goes here EOF # (Required) Long description for the command-specific help parameter :force, &#39;Force testing&#39;, type: :boolean, default: false, required: false # (Optional, Multiple) Add a command-specific CLI parameter.</description>
+    </item>
+    
+    <item>
+      <title>Distributed State and Locking</title>
+      <link>https://akhoury6.github.io/rbcli/advanced/distributed_state_locking/</link>
+      <pubDate>Thu, 20 Jun 2019 15:07:21 -0400</pubDate>
+      
+      <guid>https://akhoury6.github.io/rbcli/advanced/distributed_state_locking/</guid>
+      <description>Distributed Locking allows a Remote State to be shared among multiple users of the application to make writes appear atomic between sessions. To use it, simply set the locking: parameter to true when enabling remote state.
+This is how locking works:
+ The application attempts to acquire a lock on the remote state when you first access it If the backend is locked by a different application, wait and try again If it succeeds, the lock is held and refreshed periodically When the application exits, the lock is released If the application does not refresh its lock, or fails to release it when it exits, the lock will automatically expire within 60 seconds If another application steals the lock (unlikely but possible), and the application tries to save data, a StandardError will be thrown You can manually attempt to lock/unlock by calling Rbcli.</description>
+    </item>
+    
+    <item>
+      <title>Execution Hooks</title>
+      <link>https://akhoury6.github.io/rbcli/advanced/hooks/</link>
+      <pubDate>Thu, 20 Jun 2019 15:07:21 -0400</pubDate>
+      
+      <guid>https://akhoury6.github.io/rbcli/advanced/hooks/</guid>
+      <description>RBCli provides you with hooks that can be used to have code execute at certain places in the execution chain. These hooks are optional, and do not have to be defined for your application to run.
+All hooks will be created in the hooks/ folder in your project.
+The Defailt Action Hook The Default hook is called when a user calls your application without providing a command. If the hook is not provided, the application will automatically display the help text (the same as running it with -h).</description>
+    </item>
+    
+    <item>
+      <title>Interactive Commands</title>
+      <link>https://akhoury6.github.io/rbcli/advanced/interactive_commands/</link>
+      <pubDate>Thu, 20 Jun 2019 15:07:21 -0400</pubDate>
+      
+      <guid>https://akhoury6.github.io/rbcli/advanced/interactive_commands/</guid>
+      <description>Why interactive commands? When catering to an audience of users who are not accustomed to scripting, you may want to prompt them for the information directly (the typical CS-101 &amp;lsquo;puts&amp;rsquo; and &amp;lsquo;gets&amp;rsquo; pattern). This can be a lot more straightforward than having to read the help texts of your tool, and trying multiple times to enter all of the required data.
+Of course, we want to make sure that scripting with the tool still works well (headless interaction).</description>
+    </item>
+    
+    <item>
+      <title>Logging</title>
+      <link>https://akhoury6.github.io/rbcli/advanced/logging/</link>
+      <pubDate>Thu, 20 Jun 2019 15:07:21 -0400</pubDate>
+      
+      <guid>https://akhoury6.github.io/rbcli/advanced/logging/</guid>
+      <description>Logging with RBCli is straightforward - it looks at the config file for logging settings, and instantiates a single, globally accessible Logger object. You can access it within a standard command like this:
+Rbcli::log.info { &#39;These logs can go to STDERR, STDOUT, or a file&#39; }  Enabling Logging To enable logging, simply set the default values in the config/logging.rb file:
+log_level :info log_target &#39;stderr&#39;   log_level  You can set the default log level using either numeric or standard Ruby logger levels: 0-5, or DEBUG &amp;lt; INFO &amp;lt; WARN &amp;lt; ERROR &amp;lt; FATAL &amp;lt; UNKNOWN  log_target  This specifies where the logs will be placed.</description>
+    </item>
+    
+    <item>
+      <title>Remote Execution</title>
+      <link>https://akhoury6.github.io/rbcli/advanced/remote_execution/</link>
+      <pubDate>Thu, 20 Jun 2019 15:07:21 -0400</pubDate>
+      
+      <guid>https://akhoury6.github.io/rbcli/advanced/remote_execution/</guid>
+      <description>RBCli can be configured to execute commands on a remote machine via SSH instead of locally.
+Currently, only script and extern commands are supported.
+Configuration To allow remote execution, go to config/general.rb and change the following line to true:
+remote_execution permitted: false  Then, for each command that you would like to enable remote execution for, add the following directive to the command class declaration:
+remote_permitted  Usage Your end users can now execute a command remotely by specifying the connection string and credentials on the command line as follows:</description>
+    </item>
+    
+    <item>
+      <title>State Storage</title>
+      <link>https://akhoury6.github.io/rbcli/advanced/state_storage/</link>
+      <pubDate>Thu, 20 Jun 2019 15:07:21 -0400</pubDate>
+      
+      <guid>https://akhoury6.github.io/rbcli/advanced/state_storage/</guid>
+      <description>RBCli supports both local and remote state storage. This is done by synchronizing a Hash with either the local disk or a remote database.
+Local State RBCli&amp;rsquo;s local state storage gives you access to a hash that is automatically persisted to disk when changes are made.
+Configuration You can configure it in config/storage.rb.
+local_state &#39;/var/mytool/localstate&#39;, force_creation: true, halt_on_error: true  There are three parameters to configure it with:
+ The path as a string (self-explanatory) force_creation  This will attempt to create the path and file if it does not exist (equivalent to an mkdir -p and touch in linux)  halt_on_error  RBCli&amp;rsquo;s default behavior is to raise an exception if the file can not be created, read, or updated at any point in time If this is set to false, RBCli will silence any errors pertaining to file access and will fall back to whatever data is available.</description>
+    </item>
+    
+    <item>
+      <title>User Configuration Files</title>
+      <link>https://akhoury6.github.io/rbcli/advanced/user_config_files/</link>
+      <pubDate>Thu, 20 Jun 2019 15:07:21 -0400</pubDate>
+      
+      <guid>https://akhoury6.github.io/rbcli/advanced/user_config_files/</guid>
+      <description>RBCli provides built-in support for creating and managing userspace configuration files. It does this through two chains: the defaults chain and the user chain.
+Defaults chain The defaults chain allows you to specify sane defaults for your CLI tool throughout your code. This gives you the ability to declare configuration alongside the code, and allows RBCli to generate a user config automatically given your defaults. There are two ways to set them:</description>
+    </item>
+    
+  </channel>
+</rss>

data/docs/advanced/interactive_commands/index.html

@@ -1,829 +1,1153 @@
+<!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>Interactive Commands :: 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>Interactive Commands - 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/advanced/interactive_commands/">
+    <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="../../#interactive-commands" 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">
-                Interactive Commands
-              </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">
+
         
-      </div>
-      
-        <div class="md-flex__cell md-flex__cell--shrink">
-          <div class="md-header-nav__source">
-            
+          
+          
 
 
+ 
+  
+    
+    <li data-nav-id="/rbcli/quick_reference/" title="Quick Reference" class="dd-item 
+        
+        
+        
+        ">
+      <a href="/rbcli/quick_reference/">
+          Quick Reference
+          
+      </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>
-        </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="../command_types/" 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>
+      <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>
+     
   
-  <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 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 
+        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 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/automatic_updates/" title="Automatic Updates" class="dd-item ">
+        <a href="/rbcli/advanced/automatic_updates/">
+        Automatic Updates
         
-          
-          
-          
-
-
-  <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>
+        </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/command_types/" title="Command Types" class="dd-item ">
+        <a href="/rbcli/advanced/command_types/">
+        Command Types
+        
+        </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/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="../command_types/" title="Command Types" class="md-nav__link">
-      Command Types
-    </a>
-  </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">
-    <a href="../user_config_files/" title="User Config Files" class="md-nav__link">
-      User Config Files
-    </a>
-  </li>
 
+ 
+  
+    
+      <li data-nav-id="/rbcli/advanced/interactive_commands/" title="Interactive Commands" class="dd-item active">
+        <a href="/rbcli/advanced/interactive_commands/">
+        Interactive Commands
         
-          
-          
-          
+        </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/logging/" title="Logging" class="dd-item ">
+        <a href="/rbcli/advanced/logging/">
+        Logging
         
-          
-          
-          
+        </a>
+    </li>
+     
+  
+ 
 
+            
+          
+            
+            
 
-  <li class="md-nav__item">
-    <a href="../logging/" title="Logging" class="md-nav__link">
-      Logging
-    </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="../automatic_updates/" title="Automatic Updates" class="md-nav__link">
-      Automatic Updates
-    </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="../state_storage/" title="State Storage" class="md-nav__link">
-      State Storage
-    </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="../distributed_state_locking/" title="Distributed State Locking" class="md-nav__link">
-      Distributed State Locking
-    </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="../remote_execution/" title="Remote Execution" class="md-nav__link">
-      Remote Execution
-    </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">
-        Interactive Commands
-      </label>
-    
-    <a href="./" title="Interactive Commands" class="md-nav__link md-nav__link--active">
-      Interactive Commands
-    </a>
-    
-      
-<nav class="md-nav md-nav--secondary">
-  
+ 
   
     
+      <li data-nav-id="/rbcli/development/contributing/" title="Contribution Guide" class="dd-item ">
+        <a href="/rbcli/development/contributing/">
+        Contribution Guide
+        
+        </a>
+    </li>
+     
   
+ 
+
+            
+          
+            
+            
+
+
+ 
   
-    <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="#why-interactive-commands" title="Why interactive commands?" class="md-nav__link">
-    Why interactive commands?
-  </a>
-  
-</li>
-      
-        <li class="md-nav__item">
-  <a href="#how-to-do-it-with-rbcli" title="How to do it with Rbcli" class="md-nav__link">
-    How to do it with Rbcli
-  </a>
-  
-</li>
-      
-      
-      
-      
-      
-    </ul>
-  
-</nav>
     
-  </li>
-
+      <li data-nav-id="/rbcli/development/license/" title="License Info" class="dd-item ">
+        <a href="/rbcli/development/license/">
+        License Info
         
-      </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-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 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="../../development/contributing/" title="Contribution Guide" class="md-nav__link">
-      Contribution Guide
-    </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="../../development/license/" title="License Info" class="md-nav__link">
-      License Info
-    </a>
-  </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>
+  
+ 
 
-  <li class="md-nav__item">
-    <a href="../../development/code_of_conduct/" title="Code of Conduct" class="md-nav__link">
-      Code of Conduct
-    </a>
-  </li>
+          
+         
+    </ul>
 
-        
+    
+    
+      <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>
 
-  <li class="md-nav__item">
-    <a href="../../imported/changelog/" title="Changelog" class="md-nav__link">
-      Changelog
-    </a>
-  </li>
+    </section>
+  </div>
+</nav>
 
-        
-      </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>
+        <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">
+                 
+                 
+                    
+          
+          
             
             
-              <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="#why-interactive-commands" title="Why interactive commands?" class="md-nav__link">
-    Why interactive commands?
-  </a>
-  
-</li>
-      
-        <li class="md-nav__item">
-  <a href="#how-to-do-it-with-rbcli" title="How to do it with Rbcli" class="md-nav__link">
-    How to do it with Rbcli
-  </a>
-  
-</li>
-      
-      
-      
-      
-      
-    </ul>
-  
-</nav>
-                  </div>
+          
+          
+            
+            
+          
+          
+            <a href='/rbcli/'></a> > <a href='/rbcli/advanced/'>Advanced</a> > Interactive Commands
+          
+         
+          
+         
+          
+        
+                 
+                  </span>
                 </div>
+                
+                    <div class="progress">
+    <div class="wrapper">
+<nav id="TableOfContents">
+<ul>
+<li>
+<ul>
+<li><a href="#why-interactive-commands">Why interactive commands?</a></li>
+<li><a href="#how-to-do-it-with-rbcli">How to do it with Rbcli</a></li>
+</ul></li>
+</ul>
+</nav>
+    </div>
+</div>
+
+                
               </div>
+            </div>
             
+        <div id="head-tags">
+        
+        </div>
+        
+        <div id="body-inner">
           
-          <div class="md-content">
-            <article class="md-content__inner md-typeset">
+            <h1>
               
-                
-                
-                <h1 id="interactive-commands">Interactive Commands</h1>
+              Interactive Commands
+            </h1>
+          
+
+        
+
+
+
+
+
 <h2 id="why-interactive-commands">Why interactive commands?</h2>
-<p>When catering to an audience of users who are not accustomed to scripting, you may want to prompt them for the information directly (the typical CS-101 'puts' and 'gets' pattern). This can be a lot more straightforward than having to read the help texts of your tool, and trying multiple times to enter all of the required data.</p>
+
+<p>When catering to an audience of users who are not accustomed to scripting, you may want to prompt them for the information directly (the typical CS-101 &lsquo;puts&rsquo; and &lsquo;gets&rsquo; pattern). This can be a lot more straightforward than having to read the help texts of your tool, and trying multiple times to enter all of the required data.</p>
+
 <p>Of course, we want to make sure that scripting with the tool still works well (headless interaction). We accomplish this by extending our parameters with a <code>prompt</code> option; RBCli will continue to accept the parameter as usual, but if the parameter is omitted then it will prompt the user with the given text.</p>
+
 <h2 id="how-to-do-it-with-rbcli">How to do it with Rbcli</h2>
-<p>There is an option when declaring a command's parameters to prompt the user for a value if not entered on the command line. This can be done with the <code>prompt:</code> keyword. For example:</p>
-<pre><code class="ruby">class Mycmd &lt; Rbcli::Command
-    parameter :sort, 'Sort output alphabetically', type: :boolean, default: false, prompt: &quot;Sort output alphabetically?&quot;
-    action do |params, args, global_opts, config|
-        puts params[:sort]
-    end
+
+<p>There is an option when declaring a command&rsquo;s parameters to prompt the user for a value if not entered on the command line. This can be done with the <code>prompt:</code> keyword. For example:</p>
+
+<pre><code class="language-ruby">class Mycmd &lt; Rbcli::Command
+	parameter :sort, 'Sort output alphabetically', type: :boolean, default: false, prompt: &quot;Sort output alphabetically?&quot;
+	action do |params, args, global_opts, config|
+		puts params[:sort]
+	end
 end
 </code></pre>
 
 <p>Now, if we run the command while omitting the <code>--sort</code> parameter, as such:</p>
-<pre><code class="bash">mytool mycmd
+
+<pre><code class="language-bash">mytool mycmd
 </code></pre>
 
 <p>That should give you the prompt:</p>
+
 <pre><code>Sort output alphabetically? (y/N):
 </code></pre>
 
 <p>Because we set the parameter to default to <code>false</code> the default here is <code>N</code>, which is used if the user hits enter without entering a letter. If the default was set to <code>true</code>, then the <code>Y</code> would be capitalized and be the default.</p>
+
 <p>String parameters behave similarly, but default to the string defined instead of a boolean value.</p>
+
+
+<footer class=" footline" >
+	
+</footer>
+
+
+        
+        </div> 
+        
+
+      </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="../remote_execution/" title="Remote Execution" 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>
-                Remote Execution
-              </span>
-            </div>
-          </a>
+                    
+                        
+            
+            
+                
+                    
+                
+                
+
+                    
+                    
+                    
+
+                    
+            
+        
+                    
+                        
+            
+            
+                
+                    
+                
+                
+
+                    
+                    
+                    
+
+                    
+            
         
+                    
+                        
+            
+            
+                
+                    
+                
+                
+
+                    
+                    
+                    
+
+                    
+            
         
-          <a href="../../development/contributing/" title="Contribution Guide" 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>
-                Contribution Guide
-              </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/hooks/" title="Execution Hooks"> <i class="fa fa-chevron-left"></i></a>
+		
+		
+			<a class="nav nav-next" href="/rbcli/advanced/logging/" title="Logging" 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>
+