rbcli 0.3.1 → 0.3.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (62) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +20 -0
  3. data/Gemfile.lock +63 -63
  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/exe/rbcli +1 -1
  45. data/lib/rbcli/configuration/configurate.rb +1 -1
  46. data/lib/rbcli/engine/command.rb +1 -1
  47. data/lib/rbcli/engine/load_project.rb +1 -1
  48. data/lib/rbcli/engine/parser.rb +9 -7
  49. data/lib/rbcli/features/userconfig.rb +3 -3
  50. data/lib/rbcli/state_storage/localstate.rb +1 -1
  51. data/lib/rbcli/util/optimist.rb +1063 -0
  52. data/lib/rbcli/version.rb +1 -1
  53. data/lib/rbcli-tool/generators.rb +3 -3
  54. data/lib/rbcli-tool/mdless_fix.rb +1 -1
  55. data/lib/rbcli-tool/project.rb +3 -3
  56. data/lib/rbcli-tool/util.rb +3 -3
  57. data/rbcli.gemspec +16 -14
  58. data/skeletons/micro/executable +6 -1
  59. data/skeletons/mini/executable +6 -1
  60. data/skeletons/project/untitled.gemspec +4 -4
  61. metadata +31 -30
  62. data/lib/rbcli/util/trollop.rb +0 -1050
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>
data/docs/advanced/user_config_files/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>User Configuration Files :: 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>
@@ -725,8 +725,8 @@
725
725
  </li>
726
726
  </ul>
727
727
  <p>DSL statements appear in both of the above locations as the following:</p>
728
- <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">config_default <span style="color:#e6db74">:name</span>, <span style="color:#e6db74">description</span>: <span style="color:#e6db74">&#39;&lt;description_help_text&gt;&#39;</span>, <span style="color:#e6db74">default</span>: <span style="color:#e6db74">&#39;&lt;default_value&gt;&#39;</span>
729
- </code></pre></div><h2 id="user-chain">User chain</h2>
728
+ <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>config_default <span style="color:#e6db74">:name</span>, <span style="color:#e6db74">description</span>: <span style="color:#e6db74">&#39;&lt;description_help_text&gt;&#39;</span>, <span style="color:#e6db74">default</span>: <span style="color:#e6db74">&#39;&lt;default_value&gt;&#39;</span>
729
+ </span></span></code></pre></div><h2 id="user-chain">User chain</h2>
730
730
  <p>The user chain has two functions: generating and loading configuration from a YAML file on the end user&rsquo;s machine.</p>
731
731
  <p>Rbcli will determine the correct location to locate the user configuration based on two factors:</p>
732
732
  <ol>
@@ -734,8 +734,8 @@
734
734
  <li>The location specified on the command line using the <code>--config-file=&lt;filename&gt;</code> option (overrides #1)</li>
735
735
  </ol>
736
736
  <p>To configure the default location, edit <code>config/userspace.rb</code>:</p>
737
- <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">config_userfile <span style="color:#e6db74">&#39;~/.mytool&#39;</span>, <span style="color:#e6db74">merge_defaults</span>: <span style="color:#66d9ef">true</span>, <span style="color:#e6db74">required</span>: <span style="color:#66d9ef">false</span>
738
- </code></pre></div><ul>
737
+ <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>config_userfile <span style="color:#e6db74">&#39;~/.mytool&#39;</span>, <span style="color:#e6db74">merge_defaults</span>: <span style="color:#66d9ef">true</span>, <span style="color:#e6db74">required</span>: <span style="color:#66d9ef">false</span>
738
+ </span></span></code></pre></div><ul>
739
739
  <li><code>path/to/config/file</code>
740
740
  <ul>
741
741
  <li>Self explanatory. Recommended locations are a dotfile in the user&rsquo;s home directory, or a file under <code>/etc</code> such as <code>/etc/mytool/userconf.yaml</code></li>
@@ -1186,19 +1186,19 @@
1186
1186
  <div style="left: -1000px; overflow: scroll; position: absolute; top: -1000px; border: none; box-sizing: content-box; height: 200px; margin: 0px; padding: 0px; width: 200px;">
1187
1187
  <div style="border: none; box-sizing: content-box; height: 200px; margin: 0px; padding: 0px; width: 200px;"></div>
1188
1188
  </div>
1189
- <script src="/rbcli/js/clipboard.min.js?1634703589"></script>
1190
- <script src="/rbcli/js/perfect-scrollbar.min.js?1634703589"></script>
1191
- <script src="/rbcli/js/perfect-scrollbar.jquery.min.js?1634703589"></script>
1192
- <script src="/rbcli/js/jquery.sticky.js?1634703589"></script>
1193
- <script src="/rbcli/js/featherlight.min.js?1634703589"></script>
1194
- <script src="/rbcli/js/highlight.pack.js?1634703589"></script>
1189
+ <script src="/rbcli/js/clipboard.min.js?1713907739"></script>
1190
+ <script src="/rbcli/js/perfect-scrollbar.min.js?1713907739"></script>
1191
+ <script src="/rbcli/js/perfect-scrollbar.jquery.min.js?1713907739"></script>
1192
+ <script src="/rbcli/js/jquery.sticky.js?1713907739"></script>
1193
+ <script src="/rbcli/js/featherlight.min.js?1713907739"></script>
1194
+ <script src="/rbcli/js/highlight.pack.js?1713907739"></script>
1195
1195
  <script>hljs.initHighlightingOnLoad();</script>
1196
- <script src="/rbcli/js/modernizr.custom-3.6.0.js?1634703589"></script>
1197
- <script src="/rbcli/js/learn.js?1634703589"></script>
1198
- <script src="/rbcli/js/hugo-learn.js?1634703589"></script>
1196
+ <script src="/rbcli/js/modernizr.custom-3.6.0.js?1713907739"></script>
1197
+ <script src="/rbcli/js/learn.js?1713907739"></script>
1198
+ <script src="/rbcli/js/hugo-learn.js?1713907739"></script>
1199
1199
 
1200
- <link href="/rbcli/mermaid/mermaid.css?1634703589" rel="stylesheet" />
1201
- <script src="/rbcli/mermaid/mermaid.js?1634703589"></script>
1200
+ <link href="/rbcli/mermaid/mermaid.css?1713907739" rel="stylesheet" />
1201
+ <script src="/rbcli/mermaid/mermaid.js?1713907739"></script>
1202
1202
  <script>
1203
1203
  mermaid.initialize({ startOnLoad: true });
1204
1204
  </script>
data/docs/categories/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>Categories :: 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>
@@ -670,7 +670,7 @@
670
670
 
671
671
  <div class="progress">
672
672
  <div class="wrapper">
673
-
673
+ <nav id="TableOfContents"></nav>
674
674
  </div>
675
675
  </div>
676
676
 
@@ -1124,19 +1124,19 @@
1124
1124
  <div style="left: -1000px; overflow: scroll; position: absolute; top: -1000px; border: none; box-sizing: content-box; height: 200px; margin: 0px; padding: 0px; width: 200px;">
1125
1125
  <div style="border: none; box-sizing: content-box; height: 200px; margin: 0px; padding: 0px; width: 200px;"></div>
1126
1126
  </div>
1127
- <script src="/rbcli/js/clipboard.min.js?1634703589"></script>
1128
- <script src="/rbcli/js/perfect-scrollbar.min.js?1634703589"></script>
1129
- <script src="/rbcli/js/perfect-scrollbar.jquery.min.js?1634703589"></script>
1130
- <script src="/rbcli/js/jquery.sticky.js?1634703589"></script>
1131
- <script src="/rbcli/js/featherlight.min.js?1634703589"></script>
1132
- <script src="/rbcli/js/highlight.pack.js?1634703589"></script>
1127
+ <script src="/rbcli/js/clipboard.min.js?1713907739"></script>
1128
+ <script src="/rbcli/js/perfect-scrollbar.min.js?1713907739"></script>
1129
+ <script src="/rbcli/js/perfect-scrollbar.jquery.min.js?1713907739"></script>
1130
+ <script src="/rbcli/js/jquery.sticky.js?1713907739"></script>
1131
+ <script src="/rbcli/js/featherlight.min.js?1713907739"></script>
1132
+ <script src="/rbcli/js/highlight.pack.js?1713907739"></script>
1133
1133
  <script>hljs.initHighlightingOnLoad();</script>
1134
- <script src="/rbcli/js/modernizr.custom-3.6.0.js?1634703589"></script>
1135
- <script src="/rbcli/js/learn.js?1634703589"></script>
1136
- <script src="/rbcli/js/hugo-learn.js?1634703589"></script>
1134
+ <script src="/rbcli/js/modernizr.custom-3.6.0.js?1713907739"></script>
1135
+ <script src="/rbcli/js/learn.js?1713907739"></script>
1136
+ <script src="/rbcli/js/hugo-learn.js?1713907739"></script>
1137
1137
 
1138
- <link href="/rbcli/mermaid/mermaid.css?1634703589" rel="stylesheet" />
1139
- <script src="/rbcli/mermaid/mermaid.js?1634703589"></script>
1138
+ <link href="/rbcli/mermaid/mermaid.css?1713907739" rel="stylesheet" />
1139
+ <script src="/rbcli/mermaid/mermaid.js?1713907739"></script>
1140
1140
  <script>
1141
1141
  mermaid.initialize({ startOnLoad: true });
1142
1142
  </script>
data/docs/categories/index.xml CHANGED
@@ -4,7 +4,8 @@
4
4
  <title>Categories on RBCli Documentation</title>
5
5
  <link>https://akhoury6.github.io/rbcli/categories/</link>
6
6
  <description>Recent content in Categories on RBCli Documentation</description>
7
- <generator>Hugo -- gohugo.io</generator>
8
- <language>en-us</language><atom:link href="https://akhoury6.github.io/rbcli/categories/index.xml" rel="self" type="application/rss+xml" />
7
+ <generator>Hugo 0.125.1</generator>
8
+ <language>en-us</language>
9
+ <atom:link href="https://akhoury6.github.io/rbcli/categories/index.xml" rel="self" type="application/rss+xml" />
9
10
  </channel>
10
11
  </rss>