rbcli 0.3.2 → 0.3.3

Sign up to get free protection for your applications and to get access to all the features.
Files changed (54) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +12 -0
  3. data/Gemfile.lock +19 -5
  4. data/docs/404.html +9 -9
  5. data/docs/advanced/automatic_updates/index.html +30 -30
  6. data/docs/advanced/command_types/index.html +78 -78
  7. data/docs/advanced/distributed_state_locking/index.html +30 -30
  8. data/docs/advanced/hooks/index.html +42 -42
  9. data/docs/advanced/index.html +27 -27
  10. data/docs/advanced/index.xml +12 -50
  11. data/docs/advanced/interactive_commands/index.html +35 -35
  12. data/docs/advanced/logging/index.html +36 -36
  13. data/docs/advanced/remote_execution/index.html +51 -51
  14. data/docs/advanced/state_storage/index.html +34 -34
  15. data/docs/advanced/user_config_files/index.html +30 -30
  16. data/docs/categories/index.html +27 -27
  17. data/docs/categories/index.xml +3 -2
  18. data/docs/development/changelog/index.html +91 -60
  19. data/docs/development/code_of_conduct/index.html +27 -27
  20. data/docs/development/contributing/index.html +40 -40
  21. data/docs/development/index.html +27 -27
  22. data/docs/development/index.xml +6 -16
  23. data/docs/development/license/index.html +26 -26
  24. data/docs/index.html +26 -26
  25. data/docs/index.json +15 -15
  26. data/docs/index.xml +20 -90
  27. data/docs/quick_reference/index.html +54 -54
  28. data/docs/quick_reference/index.xml +3 -2
  29. data/docs/sitemap.xml +0 -1
  30. data/docs/tags/index.html +27 -27
  31. data/docs/tags/index.xml +3 -2
  32. data/docs/tutorial/10-getting_started/index.html +33 -33
  33. data/docs/tutorial/20-project_layout/index.html +55 -55
  34. data/docs/tutorial/30-your_first_command/index.html +90 -90
  35. data/docs/tutorial/40-options_parameters_and_arguments/index.html +167 -167
  36. data/docs/tutorial/50-publishing/index.html +30 -30
  37. data/docs/tutorial/index.html +27 -27
  38. data/docs/tutorial/index.xml +8 -28
  39. data/docs/whoami/index.html +28 -28
  40. data/docs/whoami/index.xml +3 -2
  41. data/docs-src/.hugo_build.lock +0 -0
  42. data/docs-src/content/development/changelog.md +20 -0
  43. data/docs-src/makesite.sh +4 -4
  44. data/lib/rbcli/engine/command.rb +1 -1
  45. data/lib/rbcli/engine/parser.rb +9 -7
  46. data/lib/rbcli/util/optimist.rb +1063 -0
  47. data/lib/rbcli/version.rb +1 -1
  48. data/lib/rbcli-tool/util.rb +1 -1
  49. data/rbcli.gemspec +7 -3
  50. data/skeletons/micro/executable +6 -1
  51. data/skeletons/mini/executable +6 -1
  52. data/skeletons/project/untitled.gemspec +4 -4
  53. metadata +9 -8
  54. data/lib/rbcli/util/trollop.rb +0 -1050
data/docs/advanced/interactive_commands/index.html CHANGED
@@ -3,7 +3,7 @@
3
3
  <head>
4
4
  <meta charset="utf-8">
5
5
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
6
- <meta name="generator" content="Hugo 0.88.1" />
6
+ <meta name="generator" content="Hugo 0.125.1">
7
7
  <meta name="description" content="">
8
8
 
9
9
 
@@ -12,21 +12,21 @@
12
12
  <title>Interactive Commands :: RBCli Documentation</title>
13
13
 
14
14
 
15
- <link href="/rbcli/css/nucleus.css?1634703589" rel="stylesheet">
16
- <link href="/rbcli/css/fontawesome-all.min.css?1634703589" rel="stylesheet">
17
- <link href="/rbcli/css/hybrid.css?1634703589" rel="stylesheet">
18
- <link href="/rbcli/css/featherlight.min.css?1634703589" rel="stylesheet">
19
- <link href="/rbcli/css/perfect-scrollbar.min.css?1634703589" rel="stylesheet">
20
- <link href="/rbcli/css/auto-complete.css?1634703589" rel="stylesheet">
21
- <link href="/rbcli/css/atom-one-dark-reasonable.css?1634703589" rel="stylesheet">
22
- <link href="/rbcli/css/theme.css?1634703589" rel="stylesheet">
23
- <link href="/rbcli/css/hugo-theme.css?1634703589" rel="stylesheet">
15
+ <link href="/rbcli/css/nucleus.css?1713907739" rel="stylesheet">
16
+ <link href="/rbcli/css/fontawesome-all.min.css?1713907739" rel="stylesheet">
17
+ <link href="/rbcli/css/hybrid.css?1713907739" rel="stylesheet">
18
+ <link href="/rbcli/css/featherlight.min.css?1713907739" rel="stylesheet">
19
+ <link href="/rbcli/css/perfect-scrollbar.min.css?1713907739" rel="stylesheet">
20
+ <link href="/rbcli/css/auto-complete.css?1713907739" rel="stylesheet">
21
+ <link href="/rbcli/css/atom-one-dark-reasonable.css?1713907739" rel="stylesheet">
22
+ <link href="/rbcli/css/theme.css?1713907739" rel="stylesheet">
23
+ <link href="/rbcli/css/hugo-theme.css?1713907739" rel="stylesheet">
24
24
 
25
- <link href="/rbcli/css/theme-blue.css?1634703589" rel="stylesheet">
25
+ <link href="/rbcli/css/theme-blue.css?1713907739" rel="stylesheet">
26
26
 
27
27
 
28
28
 
29
- <script src="/rbcli/js/jquery-3.3.1.min.js?1634703589"></script>
29
+ <script src="/rbcli/js/jquery-3.3.1.min.js?1713907739"></script>
30
30
 
31
31
  <style>
32
32
  :root #header + #content > #left > #rlblock_left{
@@ -55,14 +55,14 @@
55
55
  <span data-search-clear=""><i class="fas fa-times"></i></span>
56
56
  </div>
57
57
 
58
- <script type="text/javascript" src="/rbcli/js/lunr.min.js?1634703589"></script>
59
- <script type="text/javascript" src="/rbcli/js/auto-complete.js?1634703589"></script>
58
+ <script type="text/javascript" src="/rbcli/js/lunr.min.js?1713907739"></script>
59
+ <script type="text/javascript" src="/rbcli/js/auto-complete.js?1713907739"></script>
60
60
  <script type="text/javascript">
61
61
 
62
62
  var baseurl = "https:\/\/akhoury6.github.io\/rbcli\/";
63
63
 
64
64
  </script>
65
- <script type="text/javascript" src="/rbcli/js/search.js?1634703589"></script>
65
+ <script type="text/javascript" src="/rbcli/js/search.js?1713907739"></script>
66
66
 
67
67
 
68
68
  </div>
@@ -709,15 +709,15 @@
709
709
  <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>
710
710
  <h2 id="how-to-do-it-with-rbcli">How to do it with Rbcli</h2>
711
711
  <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>
712
- <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">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>
713
- 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>
714
- action <span style="color:#66d9ef">do</span> <span style="color:#f92672">|</span>params, args, global_opts, config<span style="color:#f92672">|</span>
715
- puts params<span style="color:#f92672">[</span><span style="color:#e6db74">:sort</span><span style="color:#f92672">]</span>
716
- <span style="color:#66d9ef">end</span>
717
- <span style="color:#66d9ef">end</span>
718
- </code></pre></div><p>Now, if we run the command while omitting the <code>--sort</code> parameter, as such:</p>
719
- <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">mytool mycmd
720
- </code></pre></div><p>That should give you the prompt:</p>
712
+ <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="display:flex;"><span><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>
713
+ </span></span><span style="display:flex;"><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>
714
+ </span></span><span style="display:flex;"><span> action <span style="color:#66d9ef">do</span> <span style="color:#f92672">|</span>params, args, global_opts, config<span style="color:#f92672">|</span>
715
+ </span></span><span style="display:flex;"><span> puts params<span style="color:#f92672">[</span><span style="color:#e6db74">:sort</span><span style="color:#f92672">]</span>
716
+ </span></span><span style="display:flex;"><span> <span style="color:#66d9ef">end</span>
717
+ </span></span><span style="display:flex;"><span><span style="color:#66d9ef">end</span>
718
+ </span></span></code></pre></div><p>Now, if we run the command while omitting the <code>--sort</code> parameter, as such:</p>
719
+ <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"><span style="display:flex;"><span>mytool mycmd
720
+ </span></span></code></pre></div><p>That should give you the prompt:</p>
721
721
  <pre tabindex="0"><code>Sort output alphabetically? (y/N):
722
722
  </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>
723
723
  <p>String parameters behave similarly, but default to the string defined instead of a boolean value.</p>
@@ -1154,19 +1154,19 @@
1154
1154
  <div style="left: -1000px; overflow: scroll; position: absolute; top: -1000px; border: none; box-sizing: content-box; height: 200px; margin: 0px; padding: 0px; width: 200px;">
1155
1155
  <div style="border: none; box-sizing: content-box; height: 200px; margin: 0px; padding: 0px; width: 200px;"></div>
1156
1156
  </div>
1157
- <script src="/rbcli/js/clipboard.min.js?1634703589"></script>
1158
- <script src="/rbcli/js/perfect-scrollbar.min.js?1634703589"></script>
1159
- <script src="/rbcli/js/perfect-scrollbar.jquery.min.js?1634703589"></script>
1160
- <script src="/rbcli/js/jquery.sticky.js?1634703589"></script>
1161
- <script src="/rbcli/js/featherlight.min.js?1634703589"></script>
1162
- <script src="/rbcli/js/highlight.pack.js?1634703589"></script>
1157
+ <script src="/rbcli/js/clipboard.min.js?1713907739"></script>
1158
+ <script src="/rbcli/js/perfect-scrollbar.min.js?1713907739"></script>
1159
+ <script src="/rbcli/js/perfect-scrollbar.jquery.min.js?1713907739"></script>
1160
+ <script src="/rbcli/js/jquery.sticky.js?1713907739"></script>
1161
+ <script src="/rbcli/js/featherlight.min.js?1713907739"></script>
1162
+ <script src="/rbcli/js/highlight.pack.js?1713907739"></script>
1163
1163
  <script>hljs.initHighlightingOnLoad();</script>
1164
- <script src="/rbcli/js/modernizr.custom-3.6.0.js?1634703589"></script>
1165
- <script src="/rbcli/js/learn.js?1634703589"></script>
1166
- <script src="/rbcli/js/hugo-learn.js?1634703589"></script>
1164
+ <script src="/rbcli/js/modernizr.custom-3.6.0.js?1713907739"></script>
1165
+ <script src="/rbcli/js/learn.js?1713907739"></script>
1166
+ <script src="/rbcli/js/hugo-learn.js?1713907739"></script>
1167
1167
 
1168
- <link href="/rbcli/mermaid/mermaid.css?1634703589" rel="stylesheet" />
1169
- <script src="/rbcli/mermaid/mermaid.js?1634703589"></script>
1168
+ <link href="/rbcli/mermaid/mermaid.css?1713907739" rel="stylesheet" />
1169
+ <script src="/rbcli/mermaid/mermaid.js?1713907739"></script>
1170
1170
  <script>
1171
1171
  mermaid.initialize({ startOnLoad: true });
1172
1172
  </script>
data/docs/advanced/logging/index.html CHANGED
@@ -3,7 +3,7 @@
3
3
  <head>
4
4
  <meta charset="utf-8">
5
5
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
6
- <meta name="generator" content="Hugo 0.88.1" />
6
+ <meta name="generator" content="Hugo 0.125.1">
7
7
  <meta name="description" content="">
8
8
 
9
9
 
@@ -12,21 +12,21 @@
12
12
  <title>Logging :: RBCli Documentation</title>
13
13
 
14
14
 
15
- <link href="/rbcli/css/nucleus.css?1634703589" rel="stylesheet">
16
- <link href="/rbcli/css/fontawesome-all.min.css?1634703589" rel="stylesheet">
17
- <link href="/rbcli/css/hybrid.css?1634703589" rel="stylesheet">
18
- <link href="/rbcli/css/featherlight.min.css?1634703589" rel="stylesheet">
19
- <link href="/rbcli/css/perfect-scrollbar.min.css?1634703589" rel="stylesheet">
20
- <link href="/rbcli/css/auto-complete.css?1634703589" rel="stylesheet">
21
- <link href="/rbcli/css/atom-one-dark-reasonable.css?1634703589" rel="stylesheet">
22
- <link href="/rbcli/css/theme.css?1634703589" rel="stylesheet">
23
- <link href="/rbcli/css/hugo-theme.css?1634703589" rel="stylesheet">
15
+ <link href="/rbcli/css/nucleus.css?1713907739" rel="stylesheet">
16
+ <link href="/rbcli/css/fontawesome-all.min.css?1713907739" rel="stylesheet">
17
+ <link href="/rbcli/css/hybrid.css?1713907739" rel="stylesheet">
18
+ <link href="/rbcli/css/featherlight.min.css?1713907739" rel="stylesheet">
19
+ <link href="/rbcli/css/perfect-scrollbar.min.css?1713907739" rel="stylesheet">
20
+ <link href="/rbcli/css/auto-complete.css?1713907739" rel="stylesheet">
21
+ <link href="/rbcli/css/atom-one-dark-reasonable.css?1713907739" rel="stylesheet">
22
+ <link href="/rbcli/css/theme.css?1713907739" rel="stylesheet">
23
+ <link href="/rbcli/css/hugo-theme.css?1713907739" rel="stylesheet">
24
24
 
25
- <link href="/rbcli/css/theme-blue.css?1634703589" rel="stylesheet">
25
+ <link href="/rbcli/css/theme-blue.css?1713907739" rel="stylesheet">
26
26
 
27
27
 
28
28
 
29
- <script src="/rbcli/js/jquery-3.3.1.min.js?1634703589"></script>
29
+ <script src="/rbcli/js/jquery-3.3.1.min.js?1713907739"></script>
30
30
 
31
31
  <style>
32
32
  :root #header + #content > #left > #rlblock_left{
@@ -55,14 +55,14 @@
55
55
  <span data-search-clear=""><i class="fas fa-times"></i></span>
56
56
  </div>
57
57
 
58
- <script type="text/javascript" src="/rbcli/js/lunr.min.js?1634703589"></script>
59
- <script type="text/javascript" src="/rbcli/js/auto-complete.js?1634703589"></script>
58
+ <script type="text/javascript" src="/rbcli/js/lunr.min.js?1713907739"></script>
59
+ <script type="text/javascript" src="/rbcli/js/auto-complete.js?1713907739"></script>
60
60
  <script type="text/javascript">
61
61
 
62
62
  var baseurl = "https:\/\/akhoury6.github.io\/rbcli\/";
63
63
 
64
64
  </script>
65
- <script type="text/javascript" src="/rbcli/js/search.js?1634703589"></script>
65
+ <script type="text/javascript" src="/rbcli/js/search.js?1713907739"></script>
66
66
 
67
67
 
68
68
  </div>
@@ -705,12 +705,12 @@
705
705
 
706
706
 
707
707
  <p>Logging with RBCli is straightforward - it looks at the config file for logging settings, and instantiates a single, globally accessible <a href="https://ruby-doc.org/stdlib-2.4.0/libdoc/logger/rdoc/Logger.html">Logger</a> object. You can access it within a standard command like this:</p>
708
- <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">Rbcli</span><span style="color:#f92672">::</span>log<span style="color:#f92672">.</span>info { <span style="color:#e6db74">&#39;These logs can go to STDERR, STDOUT, or a file&#39;</span> }
709
- </code></pre></div><h2 id="enabling-logging">Enabling Logging</h2>
708
+ <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="display:flex;"><span><span style="color:#66d9ef">Rbcli</span><span style="color:#f92672">::</span>log<span style="color:#f92672">.</span>info { <span style="color:#e6db74">&#39;These logs can go to STDERR, STDOUT, or a file&#39;</span> }
709
+ </span></span></code></pre></div><h2 id="enabling-logging">Enabling Logging</h2>
710
710
  <p>To enable logging, simply set the default values in the <code>config/logging.rb</code> file:</p>
711
- <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">log_level <span style="color:#e6db74">:info</span>
712
- log_target <span style="color:#e6db74">&#39;stderr&#39;</span>
713
- </code></pre></div><ul>
711
+ <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="display:flex;"><span>log_level <span style="color:#e6db74">:info</span>
712
+ </span></span><span style="display:flex;"><span>log_target <span style="color:#e6db74">&#39;stderr&#39;</span>
713
+ </span></span></code></pre></div><ul>
714
714
  <li><code>log_level</code>
715
715
  <ul>
716
716
  <li>You can set the default log level using either numeric or standard Ruby logger levels: 0-5, or DEBUG &lt; INFO &lt; WARN &lt; ERROR &lt; FATAL &lt; UNKNOWN</li>
@@ -724,11 +724,11 @@ log_target <span style="color:#e6db74">&#39;stderr&#39;</span>
724
724
  </ul>
725
725
  <h2 id="userspace-config-overrides">Userspace Config Overrides</h2>
726
726
  <p>If <a href="/rbcli/advanced/user_config_files/">Userspace Configuration</a> is enabled, these options will also be present in the user&rsquo;s config file to override defaults:</p>
727
- <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-yaml" data-lang="yaml"><span style="color:#75715e"># Log Settings</span>
728
- <span style="color:#f92672">logger</span>:
729
- <span style="color:#f92672">log_level</span>: <span style="color:#ae81ff">warn </span> <span style="color:#75715e"># 0-5, or DEBUG &lt; INFO &lt; WARN &lt; ERROR &lt; FATAL &lt; UNKNOWN</span>
730
- <span style="color:#f92672">log_target</span>: <span style="color:#ae81ff">stderr </span> <span style="color:#75715e"># STDOUT, STDERR, or a file path</span>
731
- </code></pre></div>
727
+ <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-yaml" data-lang="yaml"><span style="display:flex;"><span><span style="color:#75715e"># Log Settings</span>
728
+ </span></span><span style="display:flex;"><span><span style="color:#f92672">logger</span>:
729
+ </span></span><span style="display:flex;"><span> <span style="color:#f92672">log_level</span>: <span style="color:#ae81ff">warn </span> <span style="color:#75715e"># 0-5, or DEBUG &lt; INFO &lt; WARN &lt; ERROR &lt; FATAL &lt; UNKNOWN</span>
730
+ </span></span><span style="display:flex;"><span> <span style="color:#f92672">log_target</span>: <span style="color:#ae81ff">stderr </span> <span style="color:#75715e"># STDOUT, STDERR, or a file path</span>
731
+ </span></span></code></pre></div>
732
732
 
733
733
  <footer class="footline">
734
734
 
@@ -1161,19 +1161,19 @@ log_target <span style="color:#e6db74">&#39;stderr&#39;</span>
1161
1161
  <div style="left: -1000px; overflow: scroll; position: absolute; top: -1000px; border: none; box-sizing: content-box; height: 200px; margin: 0px; padding: 0px; width: 200px;">
1162
1162
  <div style="border: none; box-sizing: content-box; height: 200px; margin: 0px; padding: 0px; width: 200px;"></div>
1163
1163
  </div>
1164
- <script src="/rbcli/js/clipboard.min.js?1634703589"></script>
1165
- <script src="/rbcli/js/perfect-scrollbar.min.js?1634703589"></script>
1166
- <script src="/rbcli/js/perfect-scrollbar.jquery.min.js?1634703589"></script>
1167
- <script src="/rbcli/js/jquery.sticky.js?1634703589"></script>
1168
- <script src="/rbcli/js/featherlight.min.js?1634703589"></script>
1169
- <script src="/rbcli/js/highlight.pack.js?1634703589"></script>
1164
+ <script src="/rbcli/js/clipboard.min.js?1713907739"></script>
1165
+ <script src="/rbcli/js/perfect-scrollbar.min.js?1713907739"></script>
1166
+ <script src="/rbcli/js/perfect-scrollbar.jquery.min.js?1713907739"></script>
1167
+ <script src="/rbcli/js/jquery.sticky.js?1713907739"></script>
1168
+ <script src="/rbcli/js/featherlight.min.js?1713907739"></script>
1169
+ <script src="/rbcli/js/highlight.pack.js?1713907739"></script>
1170
1170
  <script>hljs.initHighlightingOnLoad();</script>
1171
- <script src="/rbcli/js/modernizr.custom-3.6.0.js?1634703589"></script>
1172
- <script src="/rbcli/js/learn.js?1634703589"></script>
1173
- <script src="/rbcli/js/hugo-learn.js?1634703589"></script>
1171
+ <script src="/rbcli/js/modernizr.custom-3.6.0.js?1713907739"></script>
1172
+ <script src="/rbcli/js/learn.js?1713907739"></script>
1173
+ <script src="/rbcli/js/hugo-learn.js?1713907739"></script>
1174
1174
 
1175
- <link href="/rbcli/mermaid/mermaid.css?1634703589" rel="stylesheet" />
1176
- <script src="/rbcli/mermaid/mermaid.js?1634703589"></script>
1175
+ <link href="/rbcli/mermaid/mermaid.css?1713907739" rel="stylesheet" />
1176
+ <script src="/rbcli/mermaid/mermaid.js?1713907739"></script>
1177
1177
  <script>
1178
1178
  mermaid.initialize({ startOnLoad: true });
1179
1179
  </script>
data/docs/advanced/remote_execution/index.html CHANGED
@@ -3,7 +3,7 @@
3
3
  <head>
4
4
  <meta charset="utf-8">
5
5
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
6
- <meta name="generator" content="Hugo 0.88.1" />
6
+ <meta name="generator" content="Hugo 0.125.1">
7
7
  <meta name="description" content="">
8
8
 
9
9
 
@@ -12,21 +12,21 @@
12
12
  <title>Remote Execution :: RBCli Documentation</title>
13
13
 
14
14
 
15
- <link href="/rbcli/css/nucleus.css?1634703589" rel="stylesheet">
16
- <link href="/rbcli/css/fontawesome-all.min.css?1634703589" rel="stylesheet">
17
- <link href="/rbcli/css/hybrid.css?1634703589" rel="stylesheet">
18
- <link href="/rbcli/css/featherlight.min.css?1634703589" rel="stylesheet">
19
- <link href="/rbcli/css/perfect-scrollbar.min.css?1634703589" rel="stylesheet">
20
- <link href="/rbcli/css/auto-complete.css?1634703589" rel="stylesheet">
21
- <link href="/rbcli/css/atom-one-dark-reasonable.css?1634703589" rel="stylesheet">
22
- <link href="/rbcli/css/theme.css?1634703589" rel="stylesheet">
23
- <link href="/rbcli/css/hugo-theme.css?1634703589" rel="stylesheet">
15
+ <link href="/rbcli/css/nucleus.css?1713907739" rel="stylesheet">
16
+ <link href="/rbcli/css/fontawesome-all.min.css?1713907739" rel="stylesheet">
17
+ <link href="/rbcli/css/hybrid.css?1713907739" rel="stylesheet">
18
+ <link href="/rbcli/css/featherlight.min.css?1713907739" rel="stylesheet">
19
+ <link href="/rbcli/css/perfect-scrollbar.min.css?1713907739" rel="stylesheet">
20
+ <link href="/rbcli/css/auto-complete.css?1713907739" rel="stylesheet">
21
+ <link href="/rbcli/css/atom-one-dark-reasonable.css?1713907739" rel="stylesheet">
22
+ <link href="/rbcli/css/theme.css?1713907739" rel="stylesheet">
23
+ <link href="/rbcli/css/hugo-theme.css?1713907739" rel="stylesheet">
24
24
 
25
- <link href="/rbcli/css/theme-blue.css?1634703589" rel="stylesheet">
25
+ <link href="/rbcli/css/theme-blue.css?1713907739" rel="stylesheet">
26
26
 
27
27
 
28
28
 
29
- <script src="/rbcli/js/jquery-3.3.1.min.js?1634703589"></script>
29
+ <script src="/rbcli/js/jquery-3.3.1.min.js?1713907739"></script>
30
30
 
31
31
  <style>
32
32
  :root #header + #content > #left > #rlblock_left{
@@ -55,14 +55,14 @@
55
55
  <span data-search-clear=""><i class="fas fa-times"></i></span>
56
56
  </div>
57
57
 
58
- <script type="text/javascript" src="/rbcli/js/lunr.min.js?1634703589"></script>
59
- <script type="text/javascript" src="/rbcli/js/auto-complete.js?1634703589"></script>
58
+ <script type="text/javascript" src="/rbcli/js/lunr.min.js?1713907739"></script>
59
+ <script type="text/javascript" src="/rbcli/js/auto-complete.js?1713907739"></script>
60
60
  <script type="text/javascript">
61
61
 
62
62
  var baseurl = "https:\/\/akhoury6.github.io\/rbcli\/";
63
63
 
64
64
  </script>
65
- <script type="text/javascript" src="/rbcli/js/search.js?1634703589"></script>
65
+ <script type="text/javascript" src="/rbcli/js/search.js?1713907739"></script>
66
66
 
67
67
 
68
68
  </div>
@@ -708,32 +708,32 @@
708
708
  <p>Currently, only <code>script</code> and <code>extern</code> commands are supported.</p>
709
709
  <h2 id="configuration">Configuration</h2>
710
710
  <p>To allow remote execution, go to <code>config/general.rb</code> and change the following line to <code>true</code>:</p>
711
- <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">remote_execution <span style="color:#e6db74">permitted</span>: <span style="color:#66d9ef">false</span>
712
- </code></pre></div><p>Then, for each command that you would like to enable remote execution for, add the following directive to the command class declaration:</p>
713
- <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">remote_permitted
714
- </code></pre></div><h2 id="usage">Usage</h2>
711
+ <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="display:flex;"><span>remote_execution <span style="color:#e6db74">permitted</span>: <span style="color:#66d9ef">false</span>
712
+ </span></span></code></pre></div><p>Then, for each command that you would like to enable remote execution for, add the following directive to the command class declaration:</p>
713
+ <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="display:flex;"><span>remote_permitted
714
+ </span></span></code></pre></div><h2 id="usage">Usage</h2>
715
715
  <p>Your end users can now execute a command remotely by specifying the connection string and credentials on the command line as follows:</p>
716
- <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">mytool --remote-exec <span style="color:#f92672">[</span>user@<span style="color:#f92672">]</span>host<span style="color:#f92672">[</span>:port<span style="color:#f92672">]</span> --identity <span style="color:#f92672">(</span>/path/to/private/ssh/key or password<span style="color:#f92672">)</span> &lt;command&gt;
717
- <span style="color:#75715e"># or</span>
718
- mytool -r <span style="color:#f92672">[</span>user@<span style="color:#f92672">]</span>host<span style="color:#f92672">[</span>:port<span style="color:#f92672">]</span> -i <span style="color:#f92672">(</span>/path/to/private/ssh/key or password<span style="color:#f92672">)</span> &lt;command&gt;
719
- </code></pre></div><p>Some valid examples are:</p>
720
- <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">mytool -r example.com -i myPassword showuserfiles -u MyUser
721
- mytool -r root@server.local -i ~/.ssh/id_rsa update
722
- mytool -r admin@172.16.0.1:2202 -i ~/.ssh/mykey cleartemp
723
- </code></pre></div><p>If the end user is unsure of which commands can or can not be executed remotely, they can check by running <code>mytool -h</code>. Commands that have remote execution enabled will have an asterisk (*) by their name:</p>
724
- <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">$ mytool -h
725
- A simple command line tool.
726
- For more information on individual commands, run <span style="color:#e6db74">`</span>mytool &lt;command&gt; -h<span style="color:#e6db74">`</span>.
727
-
728
- Usage:
729
- foo <span style="color:#f92672">[</span>options<span style="color:#f92672">]</span> command <span style="color:#f92672">[</span>parameters<span style="color:#f92672">]</span>
730
-
731
- Commands:
732
- bar TODO: Description goes here
733
- * baz TODO: Description goes here
734
-
735
- ...
736
- </code></pre></div><p>In this example, the command <code>baz</code> is available for remote execution</p>
716
+ <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"><span style="display:flex;"><span>mytool --remote-exec <span style="color:#f92672">[</span>user@<span style="color:#f92672">]</span>host<span style="color:#f92672">[</span>:port<span style="color:#f92672">]</span> --identity <span style="color:#f92672">(</span>/path/to/private/ssh/key or password<span style="color:#f92672">)</span> &lt;command&gt;
717
+ </span></span><span style="display:flex;"><span><span style="color:#75715e"># or</span>
718
+ </span></span><span style="display:flex;"><span>mytool -r <span style="color:#f92672">[</span>user@<span style="color:#f92672">]</span>host<span style="color:#f92672">[</span>:port<span style="color:#f92672">]</span> -i <span style="color:#f92672">(</span>/path/to/private/ssh/key or password<span style="color:#f92672">)</span> &lt;command&gt;
719
+ </span></span></code></pre></div><p>Some valid examples are:</p>
720
+ <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"><span style="display:flex;"><span>mytool -r example.com -i myPassword showuserfiles -u MyUser
721
+ </span></span><span style="display:flex;"><span>mytool -r root@server.local -i ~/.ssh/id_rsa update
722
+ </span></span><span style="display:flex;"><span>mytool -r admin@172.16.0.1:2202 -i ~/.ssh/mykey cleartemp
723
+ </span></span></code></pre></div><p>If the end user is unsure of which commands can or can not be executed remotely, they can check by running <code>mytool -h</code>. Commands that have remote execution enabled will have an asterisk (*) by their name:</p>
724
+ <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"><span style="display:flex;"><span>$ mytool -h
725
+ </span></span><span style="display:flex;"><span>A simple command line tool.
726
+ </span></span><span style="display:flex;"><span>For more information on individual commands, run <span style="color:#e6db74">`</span>mytool &lt;command&gt; -h<span style="color:#e6db74">`</span>.
727
+ </span></span><span style="display:flex;"><span>
728
+ </span></span><span style="display:flex;"><span>Usage:
729
+ </span></span><span style="display:flex;"><span> foo <span style="color:#f92672">[</span>options<span style="color:#f92672">]</span> command <span style="color:#f92672">[</span>parameters<span style="color:#f92672">]</span>
730
+ </span></span><span style="display:flex;"><span>
731
+ </span></span><span style="display:flex;"><span>Commands:
732
+ </span></span><span style="display:flex;"><span> bar TODO: Description goes here
733
+ </span></span><span style="display:flex;"><span> * baz TODO: Description goes here
734
+ </span></span><span style="display:flex;"><span>
735
+ </span></span><span style="display:flex;"><span>...
736
+ </span></span></code></pre></div><p>In this example, the command <code>baz</code> is available for remote execution</p>
737
737
 
738
738
 
739
739
  <footer class="footline">
@@ -1167,19 +1167,19 @@ Commands:
1167
1167
  <div style="left: -1000px; overflow: scroll; position: absolute; top: -1000px; border: none; box-sizing: content-box; height: 200px; margin: 0px; padding: 0px; width: 200px;">
1168
1168
  <div style="border: none; box-sizing: content-box; height: 200px; margin: 0px; padding: 0px; width: 200px;"></div>
1169
1169
  </div>
1170
- <script src="/rbcli/js/clipboard.min.js?1634703589"></script>
1171
- <script src="/rbcli/js/perfect-scrollbar.min.js?1634703589"></script>
1172
- <script src="/rbcli/js/perfect-scrollbar.jquery.min.js?1634703589"></script>
1173
- <script src="/rbcli/js/jquery.sticky.js?1634703589"></script>
1174
- <script src="/rbcli/js/featherlight.min.js?1634703589"></script>
1175
- <script src="/rbcli/js/highlight.pack.js?1634703589"></script>
1170
+ <script src="/rbcli/js/clipboard.min.js?1713907739"></script>
1171
+ <script src="/rbcli/js/perfect-scrollbar.min.js?1713907739"></script>
1172
+ <script src="/rbcli/js/perfect-scrollbar.jquery.min.js?1713907739"></script>
1173
+ <script src="/rbcli/js/jquery.sticky.js?1713907739"></script>
1174
+ <script src="/rbcli/js/featherlight.min.js?1713907739"></script>
1175
+ <script src="/rbcli/js/highlight.pack.js?1713907739"></script>
1176
1176
  <script>hljs.initHighlightingOnLoad();</script>
1177
- <script src="/rbcli/js/modernizr.custom-3.6.0.js?1634703589"></script>
1178
- <script src="/rbcli/js/learn.js?1634703589"></script>
1179
- <script src="/rbcli/js/hugo-learn.js?1634703589"></script>
1177
+ <script src="/rbcli/js/modernizr.custom-3.6.0.js?1713907739"></script>
1178
+ <script src="/rbcli/js/learn.js?1713907739"></script>
1179
+ <script src="/rbcli/js/hugo-learn.js?1713907739"></script>
1180
1180
 
1181
- <link href="/rbcli/mermaid/mermaid.css?1634703589" rel="stylesheet" />
1182
- <script src="/rbcli/mermaid/mermaid.js?1634703589"></script>
1181
+ <link href="/rbcli/mermaid/mermaid.css?1713907739" rel="stylesheet" />
1182
+ <script src="/rbcli/mermaid/mermaid.js?1713907739"></script>
1183
1183
  <script>
1184
1184
  mermaid.initialize({ startOnLoad: true });
1185
1185
  </script>
data/docs/advanced/state_storage/index.html CHANGED
@@ -3,7 +3,7 @@
3
3
  <head>
4
4
  <meta charset="utf-8">
5
5
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
6
- <meta name="generator" content="Hugo 0.88.1" />
6
+ <meta name="generator" content="Hugo 0.125.1">
7
7
  <meta name="description" content="">
8
8
 
9
9
 
@@ -12,21 +12,21 @@
12
12
  <title>State Storage :: RBCli Documentation</title>
13
13
 
14
14
 
15
- <link href="/rbcli/css/nucleus.css?1634703589" rel="stylesheet">
16
- <link href="/rbcli/css/fontawesome-all.min.css?1634703589" rel="stylesheet">
17
- <link href="/rbcli/css/hybrid.css?1634703589" rel="stylesheet">
18
- <link href="/rbcli/css/featherlight.min.css?1634703589" rel="stylesheet">
19
- <link href="/rbcli/css/perfect-scrollbar.min.css?1634703589" rel="stylesheet">
20
- <link href="/rbcli/css/auto-complete.css?1634703589" rel="stylesheet">
21
- <link href="/rbcli/css/atom-one-dark-reasonable.css?1634703589" rel="stylesheet">
22
- <link href="/rbcli/css/theme.css?1634703589" rel="stylesheet">
23
- <link href="/rbcli/css/hugo-theme.css?1634703589" rel="stylesheet">
15
+ <link href="/rbcli/css/nucleus.css?1713907739" rel="stylesheet">
16
+ <link href="/rbcli/css/fontawesome-all.min.css?1713907739" rel="stylesheet">
17
+ <link href="/rbcli/css/hybrid.css?1713907739" rel="stylesheet">
18
+ <link href="/rbcli/css/featherlight.min.css?1713907739" rel="stylesheet">
19
+ <link href="/rbcli/css/perfect-scrollbar.min.css?1713907739" rel="stylesheet">
20
+ <link href="/rbcli/css/auto-complete.css?1713907739" rel="stylesheet">
21
+ <link href="/rbcli/css/atom-one-dark-reasonable.css?1713907739" rel="stylesheet">
22
+ <link href="/rbcli/css/theme.css?1713907739" rel="stylesheet">
23
+ <link href="/rbcli/css/hugo-theme.css?1713907739" rel="stylesheet">
24
24
 
25
- <link href="/rbcli/css/theme-blue.css?1634703589" rel="stylesheet">
25
+ <link href="/rbcli/css/theme-blue.css?1713907739" rel="stylesheet">
26
26
 
27
27
 
28
28
 
29
- <script src="/rbcli/js/jquery-3.3.1.min.js?1634703589"></script>
29
+ <script src="/rbcli/js/jquery-3.3.1.min.js?1713907739"></script>
30
30
 
31
31
  <style>
32
32
  :root #header + #content > #left > #rlblock_left{
@@ -55,14 +55,14 @@
55
55
  <span data-search-clear=""><i class="fas fa-times"></i></span>
56
56
  </div>
57
57
 
58
- <script type="text/javascript" src="/rbcli/js/lunr.min.js?1634703589"></script>
59
- <script type="text/javascript" src="/rbcli/js/auto-complete.js?1634703589"></script>
58
+ <script type="text/javascript" src="/rbcli/js/lunr.min.js?1713907739"></script>
59
+ <script type="text/javascript" src="/rbcli/js/auto-complete.js?1713907739"></script>
60
60
  <script type="text/javascript">
61
61
 
62
62
  var baseurl = "https:\/\/akhoury6.github.io\/rbcli\/";
63
63
 
64
64
  </script>
65
- <script type="text/javascript" src="/rbcli/js/search.js?1634703589"></script>
65
+ <script type="text/javascript" src="/rbcli/js/search.js?1713907739"></script>
66
66
 
67
67
 
68
68
  </div>
@@ -719,8 +719,8 @@
719
719
  <p>RBCli&rsquo;s local state storage gives you access to a hash that is automatically persisted to disk when changes are made.</p>
720
720
  <h3 id="configuration">Configuration</h3>
721
721
  <p>You can configure it in <code>config/storage.rb</code>.</p>
722
- <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">local_state <span style="color:#e6db74">&#39;/var/mytool/localstate&#39;</span>, <span style="color:#e6db74">force_creation</span>: <span style="color:#66d9ef">true</span>, <span style="color:#e6db74">halt_on_error</span>: <span style="color:#66d9ef">true</span>
723
- </code></pre></div><p>There are three parameters to configure it with:</p>
722
+ <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="display:flex;"><span>local_state <span style="color:#e6db74">&#39;/var/mytool/localstate&#39;</span>, <span style="color:#e6db74">force_creation</span>: <span style="color:#66d9ef">true</span>, <span style="color:#e6db74">halt_on_error</span>: <span style="color:#66d9ef">true</span>
723
+ </span></span></code></pre></div><p>There are three parameters to configure it with:</p>
724
724
  <ul>
725
725
  <li>The <code>path</code> as a string (self-explanatory)</li>
726
726
  <li><code>force_creation</code>
@@ -743,8 +743,8 @@
743
743
  </ul>
744
744
  <h3 id="access-and-usage">Access and Usage</h3>
745
745
  <p>Once configured you can access it with a standard hash syntax in your Standard Commands:</p>
746
- <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">Rbcli</span><span style="color:#f92672">.</span>local_state<span style="color:#f92672">[</span><span style="color:#e6db74">:yourkeyhere</span><span style="color:#f92672">]</span>
747
- </code></pre></div><p>The methods available for use at the top level are as follows:</p>
746
+ <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="display:flex;"><span><span style="color:#66d9ef">Rbcli</span><span style="color:#f92672">.</span>local_state<span style="color:#f92672">[</span><span style="color:#e6db74">:yourkeyhere</span><span style="color:#f92672">]</span>
747
+ </span></span></code></pre></div><p>The methods available for use at the top level are as follows:</p>
748
748
  <p>Hash native methods:</p>
749
749
  <ul>
750
750
  <li><code>[]</code> (Regular hash syntax. Keys are accessed via either symbols or strings indifferently.)</li>
@@ -789,8 +789,8 @@
789
789
  </ol>
790
790
  <p>For more information about generating and storing AWS credentials, see <a href="https://docs.aws.amazon.com/sdk-for-ruby/v3/developer-guide/setup-config.html">Configuring the AWS SDK for Ruby</a>. Please make sure that your users are aware that they will need to provide their own credentials to use this feature.</p>
791
791
  <p>You can configure it in <code>config/storage.rb</code>.</p>
792
- <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">remote_state_dynamodb <span style="color:#e6db74">table_name</span>: <span style="color:#e6db74">&#39;mytable&#39;</span>, <span style="color:#e6db74">region</span>: <span style="color:#e6db74">&#39;us-east-1&#39;</span>, <span style="color:#e6db74">force_creation</span>: <span style="color:#66d9ef">true</span>, <span style="color:#e6db74">halt_on_error</span>: <span style="color:#66d9ef">true</span>, <span style="color:#e6db74">locking</span>: <span style="color:#66d9ef">false</span>
793
- </code></pre></div><p>These are the parameters:</p>
792
+ <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="display:flex;"><span>remote_state_dynamodb <span style="color:#e6db74">table_name</span>: <span style="color:#e6db74">&#39;mytable&#39;</span>, <span style="color:#e6db74">region</span>: <span style="color:#e6db74">&#39;us-east-1&#39;</span>, <span style="color:#e6db74">force_creation</span>: <span style="color:#66d9ef">true</span>, <span style="color:#e6db74">halt_on_error</span>: <span style="color:#66d9ef">true</span>, <span style="color:#e6db74">locking</span>: <span style="color:#66d9ef">false</span>
793
+ </span></span></code></pre></div><p>These are the parameters:</p>
794
794
  <ul>
795
795
  <li><code>table_name</code>
796
796
  <ul>
@@ -821,8 +821,8 @@
821
821
  </ul>
822
822
  <h3 id="access-and-usage-1">Access and Usage</h3>
823
823
  <p>Once configured you can access it with a standard hash syntax:</p>
824
- <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">Rbcli</span><span style="color:#f92672">.</span>remote_state<span style="color:#f92672">[</span><span style="color:#e6db74">:yourkeyhere</span><span style="color:#f92672">]</span>
825
- </code></pre></div><p>This works the same way that <a href="#local-state">Local State</a> does, with the same performance caveats (try not to write too frequently).</p>
824
+ <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="display:flex;"><span><span style="color:#66d9ef">Rbcli</span><span style="color:#f92672">.</span>remote_state<span style="color:#f92672">[</span><span style="color:#e6db74">:yourkeyhere</span><span style="color:#f92672">]</span>
825
+ </span></span></code></pre></div><p>This works the same way that <a href="#local-state">Local State</a> does, with the same performance caveats (try not to write too frequently).</p>
826
826
  <p>Note that all state in Rbcli is <strong>lazy-loaded</strong>, so no connections will be made until your code attempts to access the data even if the feature is enabled.</p>
827
827
  <p>For more information on the available commands, see the documentation on <a href="#local-state">Local State</a></p>
828
828
 
@@ -1258,19 +1258,19 @@
1258
1258
  <div style="left: -1000px; overflow: scroll; position: absolute; top: -1000px; border: none; box-sizing: content-box; height: 200px; margin: 0px; padding: 0px; width: 200px;">
1259
1259
  <div style="border: none; box-sizing: content-box; height: 200px; margin: 0px; padding: 0px; width: 200px;"></div>
1260
1260
  </div>
1261
- <script src="/rbcli/js/clipboard.min.js?1634703589"></script>
1262
- <script src="/rbcli/js/perfect-scrollbar.min.js?1634703589"></script>
1263
- <script src="/rbcli/js/perfect-scrollbar.jquery.min.js?1634703589"></script>
1264
- <script src="/rbcli/js/jquery.sticky.js?1634703589"></script>
1265
- <script src="/rbcli/js/featherlight.min.js?1634703589"></script>
1266
- <script src="/rbcli/js/highlight.pack.js?1634703589"></script>
1261
+ <script src="/rbcli/js/clipboard.min.js?1713907739"></script>
1262
+ <script src="/rbcli/js/perfect-scrollbar.min.js?1713907739"></script>
1263
+ <script src="/rbcli/js/perfect-scrollbar.jquery.min.js?1713907739"></script>
1264
+ <script src="/rbcli/js/jquery.sticky.js?1713907739"></script>
1265
+ <script src="/rbcli/js/featherlight.min.js?1713907739"></script>
1266
+ <script src="/rbcli/js/highlight.pack.js?1713907739"></script>
1267
1267
  <script>hljs.initHighlightingOnLoad();</script>
1268
- <script src="/rbcli/js/modernizr.custom-3.6.0.js?1634703589"></script>
1269
- <script src="/rbcli/js/learn.js?1634703589"></script>
1270
- <script src="/rbcli/js/hugo-learn.js?1634703589"></script>
1268
+ <script src="/rbcli/js/modernizr.custom-3.6.0.js?1713907739"></script>
1269
+ <script src="/rbcli/js/learn.js?1713907739"></script>
1270
+ <script src="/rbcli/js/hugo-learn.js?1713907739"></script>
1271
1271
 
1272
- <link href="/rbcli/mermaid/mermaid.css?1634703589" rel="stylesheet" />
1273
- <script src="/rbcli/mermaid/mermaid.js?1634703589"></script>
1272
+ <link href="/rbcli/mermaid/mermaid.css?1713907739" rel="stylesheet" />
1273
+ <script src="/rbcli/mermaid/mermaid.js?1713907739"></script>
1274
1274
  <script>
1275
1275
  mermaid.initialize({ startOnLoad: true });
1276
1276
  </script>