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

rbcli 0.2.12 → 0.3.0

Files changed (113) hide show

checksums.yaml +4 -4
data/CHANGELOG.md +15 -0
data/Gemfile.lock +39 -38
data/docs-src/content/development/changelog.md +16 -1
data/docs-src/themes/hugo-theme-learn/CHANGELOG.md +74 -2
data/docs-src/themes/hugo-theme-learn/README.md +42 -5
data/docs-src/themes/hugo-theme-learn/exampleSite/config.toml +27 -0
data/docs-src/themes/hugo-theme-learn/exampleSite/content/basics/_index.zh.md +12 -0
data/docs-src/themes/hugo-theme-learn/exampleSite/content/basics/configuration/_index.en.md +6 -4
data/docs-src/themes/hugo-theme-learn/exampleSite/content/basics/configuration/_index.fr.md +7 -5
data/docs-src/themes/hugo-theme-learn/exampleSite/content/basics/installation/_index.en.md +1 -1
data/docs-src/themes/hugo-theme-learn/exampleSite/content/cont/markdown.en.md +88 -61
data/docs-src/themes/hugo-theme-learn/exampleSite/content/cont/pages/_index.fr.md +3 -3
data/docs-src/themes/hugo-theme-learn/exampleSite/content/cont/syntaxhighlight.en.md +89 -0
data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/children/_index.en.md +2 -2
data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/notice.en.md +2 -2
data/docs-src/themes/hugo-theme-learn/exampleSite/content/showcase.en.md +4 -1
data/docs-src/themes/hugo-theme-learn/exampleSite/content/showcase.fr.md +4 -1
data/docs-src/themes/hugo-theme-learn/exampleSite/static/fonts/monogramos-webfont.svg +1 -237
data/docs-src/themes/hugo-theme-learn/exampleSite/static/images/showcase/inteliver_docs.png +0 -0
data/docs-src/themes/hugo-theme-learn/exampleSite/static/images/showcase/tshark_dev.png +0 -0
data/docs-src/themes/hugo-theme-learn/i18n/ar.toml +26 -0
data/docs-src/themes/hugo-theme-learn/i18n/de.toml +26 -0
data/docs-src/themes/hugo-theme-learn/i18n/hi.toml +26 -0
data/docs-src/themes/hugo-theme-learn/i18n/ja.toml +26 -0
data/docs-src/themes/hugo-theme-learn/i18n/ru.toml +26 -0
data/docs-src/themes/hugo-theme-learn/i18n/zh-cn.toml +26 -0
data/docs-src/themes/hugo-theme-learn/layouts/_default/list.html +1 -1
data/docs-src/themes/hugo-theme-learn/layouts/_default/single.html +1 -2
data/docs-src/themes/hugo-theme-learn/layouts/partials/footer.html +3 -4
data/docs-src/themes/hugo-theme-learn/layouts/partials/header.html +8 -6
data/docs-src/themes/hugo-theme-learn/layouts/partials/menu.html +6 -5
data/docs-src/themes/hugo-theme-learn/layouts/shortcodes/children.html +2 -2
data/docs-src/themes/hugo-theme-learn/layouts/shortcodes/ref.html +1 -1
data/docs-src/themes/hugo-theme-learn/layouts/shortcodes/relref.html +1 -1
data/docs-src/themes/hugo-theme-learn/netlify.toml +1 -2
data/docs-src/themes/hugo-theme-learn/static/css/theme.css +4 -0
data/docs-src/themes/hugo-theme-learn/static/fonts/Inconsolata.svg +1 -359
data/docs-src/themes/hugo-theme-learn/static/fonts/Novecentosanswide-Normal-webfont.svg +1 -1019
data/docs-src/themes/hugo-theme-learn/static/fonts/Novecentosanswide-UltraLight-webfont.svg +1 -918
data/docs-src/themes/hugo-theme-learn/static/fonts/Work_Sans_200.svg +1 -332
data/docs-src/themes/hugo-theme-learn/static/fonts/Work_Sans_300.svg +1 -331
data/docs-src/themes/hugo-theme-learn/static/fonts/Work_Sans_500.svg +1 -333
data/docs-src/themes/hugo-theme-learn/static/images/clippy.svg +1 -1
data/docs-src/themes/hugo-theme-learn/static/js/auto-complete.js +3 -223
data/docs-src/themes/hugo-theme-learn/static/js/highlight.pack.js +6 -3
data/docs-src/themes/hugo-theme-learn/static/js/hugo-learn.js +8 -5
data/docs-src/themes/hugo-theme-learn/static/webfonts/fa-brands-400.svg +1 -1260
data/docs-src/themes/hugo-theme-learn/static/webfonts/fa-regular-400.svg +1 -471
data/docs-src/themes/hugo-theme-learn/static/webfonts/fa-solid-900.svg +1 -2763
data/docs/404.html +8 -8
data/docs/advanced/automatic_updates/index.html +85 -65
data/docs/advanced/command_types/index.html +139 -144
data/docs/advanced/distributed_state_locking/index.html +83 -55
data/docs/advanced/hooks/index.html +94 -81
data/docs/advanced/index.html +75 -34
data/docs/advanced/index.xml +8 -8
data/docs/advanced/interactive_commands/index.html +90 -66
data/docs/advanced/logging/index.html +94 -67
data/docs/advanced/remote_execution/index.html +94 -75
data/docs/advanced/state_storage/index.html +122 -119
data/docs/advanced/user_config_files/index.html +94 -71
data/docs/categories/index.html +82 -30
data/docs/categories/index.xml +1 -1
data/docs/css/theme.css +4 -0
data/docs/development/changelog/index.html +185 -177
data/docs/development/code_of_conduct/index.html +85 -64
data/docs/development/contributing/index.html +96 -96
data/docs/development/index.html +75 -34
data/docs/development/index.xml +2 -2
data/docs/development/license/index.html +80 -46
data/docs/fonts/Inconsolata.svg +1 -359
data/docs/fonts/Novecentosanswide-Normal-webfont.svg +1 -1019
data/docs/fonts/Novecentosanswide-UltraLight-webfont.svg +1 -918
data/docs/fonts/Work_Sans_200.svg +1 -332
data/docs/fonts/Work_Sans_300.svg +1 -331
data/docs/fonts/Work_Sans_500.svg +1 -333
data/docs/images/clippy.svg +1 -1
data/docs/index.html +112 -61
data/docs/index.json +24 -24
data/docs/index.xml +13 -13
data/docs/js/auto-complete.js +3 -223
data/docs/js/highlight.pack.js +6 -3
data/docs/js/hugo-learn.js +8 -5
data/docs/quick_reference/index.html +126 -159
data/docs/quick_reference/index.xml +1 -1
data/docs/sitemap.xml +2 -4
data/docs/tags/index.html +82 -30
data/docs/tags/index.xml +1 -1
data/docs/tutorial/10-getting_started/index.html +87 -66
data/docs/tutorial/20-project_layout/index.html +126 -116
data/docs/tutorial/30-your_first_command/index.html +151 -141
data/docs/tutorial/40-options_parameters_and_arguments/index.html +233 -258
data/docs/tutorial/50-publishing/index.html +86 -66
data/docs/tutorial/index.html +75 -34
data/docs/tutorial/index.xml +4 -4
data/docs/webfonts/fa-brands-400.svg +1 -1260
data/docs/webfonts/fa-regular-400.svg +1 -471
data/docs/webfonts/fa-solid-900.svg +1 -2763
data/docs/whoami/index.html +76 -46
data/docs/whoami/index.xml +1 -1
data/lib/rbcli/configuration/configurate_blocks/me.rb +5 -5
data/lib/rbcli/util/deprecation_warning.rb +21 -4
data/lib/rbcli/version.rb +1 -1
data/rbcli.gemspec +8 -8
data/skeletons/project/Gemfile +1 -1
data/skeletons/project/config/general.rb +1 -1
data/skeletons/project/lib/lib.erb +2 -0
data/skeletons/project/spec/spec_helper.rb +7 -7
data/skeletons/project/spec/untitled_spec.rb +6 -6
data/skeletons/project/untitled.gemspec +28 -26
metadata +29 -20
data/docs-src/themes/hugo-theme-learn/static/js/html5shiv-printshiv.min.js +0 -4

@@ -3,7 +3,7 @@
   <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="generator" content="Hugo 0.74.3" />
     <meta name="description" content="">
@@ -12,20 +12,21 @@
     <title>Advanced :: 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 href="/rbcli/css/nucleus.css?1596148729" rel="stylesheet">
+    <link href="/rbcli/css/fontawesome-all.min.css?1596148729" rel="stylesheet">
+    <link href="/rbcli/css/hybrid.css?1596148729" rel="stylesheet">
+    <link href="/rbcli/css/featherlight.min.css?1596148729" rel="stylesheet">
+    <link href="/rbcli/css/perfect-scrollbar.min.css?1596148729" rel="stylesheet">
+    <link href="/rbcli/css/auto-complete.css?1596148729" rel="stylesheet">
+    <link href="/rbcli/css/atom-one-dark-reasonable.css?1596148729" rel="stylesheet">
+    <link href="/rbcli/css/theme.css?1596148729" rel="stylesheet">
+    <link href="/rbcli/css/hugo-theme.css?1596148729" rel="stylesheet">
+    <link href="/rbcli/css/theme-blue.css?1596148729" rel="stylesheet">
-      <link href="/rbcli/css/theme-blue.css?1561087612" rel="stylesheet">
-    <script src="/rbcli/js/jquery-3.3.1.min.js?1561087612"></script>
+    <script src="/rbcli/js/jquery-3.3.1.min.js?1596148729"></script>
     <style>
       :root #header + #content > #left > #rlblock_left{
@@ -54,14 +55,14 @@
     <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" src="/rbcli/js/lunr.min.js?1596148729"></script>
+<script type="text/javascript" src="/rbcli/js/auto-complete.js?1596148729"></script>
 <script type="text/javascript">
         var baseurl = "https:\/\/akhoury6.github.io\/rbcli\/";
 </script>
-<script type="text/javascript" src="/rbcli/js/search.js?1561087612"></script>
+<script type="text/javascript" src="/rbcli/js/search.js?1596148729"></script>
   </div>
@@ -74,6 +75,8 @@
@@ -96,6 +99,8 @@
@@ -121,6 +126,8 @@
@@ -140,6 +147,8 @@
@@ -159,6 +168,8 @@
@@ -178,6 +189,8 @@
@@ -197,6 +210,8 @@
@@ -223,6 +238,8 @@
@@ -248,6 +265,8 @@
@@ -267,6 +286,8 @@
@@ -286,6 +307,8 @@
@@ -305,6 +328,8 @@
@@ -324,6 +349,8 @@
@@ -343,6 +370,8 @@
@@ -362,6 +391,8 @@
@@ -381,6 +412,8 @@
@@ -400,6 +433,8 @@
@@ -426,6 +461,8 @@
@@ -451,6 +488,8 @@
@@ -470,6 +509,8 @@
@@ -489,6 +530,8 @@
@@ -508,6 +551,8 @@
@@ -534,6 +579,8 @@
@@ -585,7 +632,6 @@
         <section id="body">
         <div id="overlay"></div>
         <div class="padding highlightable">
@@ -613,7 +659,7 @@
             <a href='/rbcli/'></a> > Advanced
@@ -636,11 +682,7 @@
-<h1 id="advanced-features">Advanced Features</h1>
+	<h1 id="advanced-features">Advanced Features</h1>
 <p>This section describes the more advanced feature of RBCli. Mastering them will make you a CLI tool Ninja.</p>
@@ -1076,20 +1118,19 @@
     <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 src="/rbcli/js/clipboard.min.js?1596148729"></script>
+    <script src="/rbcli/js/perfect-scrollbar.min.js?1596148729"></script>
+    <script src="/rbcli/js/perfect-scrollbar.jquery.min.js?1596148729"></script>
+    <script src="/rbcli/js/jquery.sticky.js?1596148729"></script>
+    <script src="/rbcli/js/featherlight.min.js?1596148729"></script>
+    <script src="/rbcli/js/highlight.pack.js?1596148729"></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>
+    <script src="/rbcli/js/modernizr.custom-3.6.0.js?1596148729"></script>
+    <script src="/rbcli/js/learn.js?1596148729"></script>
+    <script src="/rbcli/js/hugo-learn.js?1596148729"></script>
-    <link href="/rbcli/mermaid/mermaid.css?1561087612" rel="stylesheet" />
-    <script src="/rbcli/mermaid/mermaid.js?1561087612"></script>
+    <link href="/rbcli/mermaid/mermaid.css?1596148729" rel="stylesheet" />
+    <script src="/rbcli/mermaid/mermaid.js?1596148729"></script>
     <script>
         mermaid.initialize({ startOnLoad: true });
     </script>

data/docs/advanced/index.xml CHANGED

@@ -1,4 +1,4 @@
-<?xml version="1.0" encoding="utf-8" standalone="yes" ?>
+<?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>
@@ -31,7 +31,7 @@ GitHub Update Check The GitHub update check works best when paired with GitHub&a
       <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>
+class List &amp;lt; Rbcli::Command # Declare a new command by subclassing Rbcli::Command description &amp;#39;TODO: Description goes here&amp;#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, &amp;#39;Force testing&amp;#39;, type: :boolean, default: false, required: false # (Optional, Multiple) Add a command-specific CLI parameter.</description>
     </item>
     <item>
@@ -73,8 +73,8 @@ Of course, we want to make sure that scripting with the tool still works well (h
       <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>
+Rbcli::log.info { &amp;#39;These logs can go to STDERR, STDOUT, or a file&amp;#39; } Enabling Logging To enable logging, simply set the default values in the config/logging.rb file:
+log_level :info log_target &amp;#39;stderr&amp;#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>
@@ -86,8 +86,8 @@ log_level :info log_target &#39;stderr&#39;   log_level  You can set the default
       <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>
+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>
@@ -99,8 +99,8 @@ remote_permitted  Usage Your end users can now execute a command remotely by spe
       <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>
+local_state &amp;#39;/var/mytool/localstate&amp;#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>

data/docs/advanced/interactive_commands/index.html CHANGED

@@ -3,7 +3,7 @@
   <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="generator" content="Hugo 0.74.3" />
     <meta name="description" content="">
@@ -12,20 +12,21 @@
     <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 href="/rbcli/css/nucleus.css?1596148729" rel="stylesheet">
+    <link href="/rbcli/css/fontawesome-all.min.css?1596148729" rel="stylesheet">
+    <link href="/rbcli/css/hybrid.css?1596148729" rel="stylesheet">
+    <link href="/rbcli/css/featherlight.min.css?1596148729" rel="stylesheet">
+    <link href="/rbcli/css/perfect-scrollbar.min.css?1596148729" rel="stylesheet">
+    <link href="/rbcli/css/auto-complete.css?1596148729" rel="stylesheet">
+    <link href="/rbcli/css/atom-one-dark-reasonable.css?1596148729" rel="stylesheet">
+    <link href="/rbcli/css/theme.css?1596148729" rel="stylesheet">
+    <link href="/rbcli/css/hugo-theme.css?1596148729" rel="stylesheet">
+    <link href="/rbcli/css/theme-blue.css?1596148729" rel="stylesheet">
-      <link href="/rbcli/css/theme-blue.css?1561087612" rel="stylesheet">
-    <script src="/rbcli/js/jquery-3.3.1.min.js?1561087612"></script>
+    <script src="/rbcli/js/jquery-3.3.1.min.js?1596148729"></script>
     <style>
       :root #header + #content > #left > #rlblock_left{
@@ -54,14 +55,14 @@
     <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" src="/rbcli/js/lunr.min.js?1596148729"></script>
+<script type="text/javascript" src="/rbcli/js/auto-complete.js?1596148729"></script>
 <script type="text/javascript">
         var baseurl = "https:\/\/akhoury6.github.io\/rbcli\/";
 </script>
-<script type="text/javascript" src="/rbcli/js/search.js?1561087612"></script>
+<script type="text/javascript" src="/rbcli/js/search.js?1596148729"></script>
   </div>
@@ -74,6 +75,8 @@
@@ -96,6 +99,8 @@
@@ -121,6 +126,8 @@
@@ -140,6 +147,8 @@
@@ -159,6 +168,8 @@
@@ -178,6 +189,8 @@
@@ -197,6 +210,8 @@
@@ -223,6 +238,8 @@
@@ -248,6 +265,8 @@
@@ -267,6 +286,8 @@
@@ -286,6 +307,8 @@
@@ -305,6 +328,8 @@
@@ -324,6 +349,8 @@
@@ -343,6 +370,8 @@
@@ -362,6 +391,8 @@
@@ -381,6 +412,8 @@
@@ -400,6 +433,8 @@
@@ -426,6 +461,8 @@
@@ -451,6 +488,8 @@
@@ -470,6 +509,8 @@
@@ -489,6 +530,8 @@
@@ -508,6 +551,8 @@
@@ -534,6 +579,8 @@
@@ -585,7 +632,6 @@
         <section id="body">
         <div id="overlay"></div>
         <div class="padding highlightable">
@@ -619,9 +665,9 @@
             <a href='/rbcli/'></a> > <a href='/rbcli/advanced/'>Advanced</a> > Interactive Commands
@@ -631,13 +677,10 @@
                     <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>
+  <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>
 </nav>
     </div>
 </div>
@@ -661,47 +704,29 @@
 <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 &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&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="language-bash">mytool mycmd
-</code></pre>
-<p>That should give you the prompt:</p>
+<div class="highlight"><pre 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">Mycmd</span> <span style="color:#f92672">&lt;</span> <span style="color:#66d9ef">Rbcli</span><span style="color:#f92672">::</span><span style="color:#66d9ef">Command</span>
+	parameter <span style="color:#e6db74">:sort</span>, <span style="color:#e6db74">&#39;Sort output alphabetically&#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">prompt</span>: <span style="color:#e6db74">&#34;Sort output alphabetically?&#34;</span>
+	action <span style="color:#66d9ef">do</span> <span style="color:#f92672">|</span>params, args, global_opts, config<span style="color:#f92672">|</span>
+		puts params<span style="color:#f92672">[</span><span style="color:#e6db74">:sort</span><span style="color:#f92672">]</span>
+	<span style="color:#66d9ef">end</span>
+<span style="color:#66d9ef">end</span>
+</code></pre></div><p>Now, if we run the command while omitting the <code>--sort</code> parameter, as such:</p>
+<div class="highlight"><pre style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-bash" data-lang="bash">mytool mycmd
+</code></pre></div><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>
+</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 class="footline">
 </footer>
         </div>
@@ -1129,20 +1154,19 @@ end
     <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 src="/rbcli/js/clipboard.min.js?1596148729"></script>
+    <script src="/rbcli/js/perfect-scrollbar.min.js?1596148729"></script>
+    <script src="/rbcli/js/perfect-scrollbar.jquery.min.js?1596148729"></script>
+    <script src="/rbcli/js/jquery.sticky.js?1596148729"></script>
+    <script src="/rbcli/js/featherlight.min.js?1596148729"></script>
+    <script src="/rbcli/js/highlight.pack.js?1596148729"></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>
+    <script src="/rbcli/js/modernizr.custom-3.6.0.js?1596148729"></script>
+    <script src="/rbcli/js/learn.js?1596148729"></script>
+    <script src="/rbcli/js/hugo-learn.js?1596148729"></script>
-    <link href="/rbcli/mermaid/mermaid.css?1561087612" rel="stylesheet" />
-    <script src="/rbcli/mermaid/mermaid.js?1561087612"></script>
+    <link href="/rbcli/mermaid/mermaid.css?1596148729" rel="stylesheet" />
+    <script src="/rbcli/mermaid/mermaid.js?1596148729"></script>
     <script>
         mermaid.initialize({ startOnLoad: true });
     </script>