rbcli 0.3.0 → 0.3.2
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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +17 -0
- data/Gemfile.lock +55 -51
- data/README.md +2 -2
- data/docs/404.html +8 -8
- data/docs/advanced/automatic_updates/index.html +28 -28
- data/docs/advanced/command_types/index.html +35 -35
- data/docs/advanced/distributed_state_locking/index.html +28 -28
- data/docs/advanced/hooks/index.html +30 -30
- data/docs/advanced/index.html +26 -26
- data/docs/advanced/index.xml +2 -6
- data/docs/advanced/interactive_commands/index.html +29 -29
- data/docs/advanced/logging/index.html +32 -32
- data/docs/advanced/remote_execution/index.html +31 -31
- data/docs/advanced/state_storage/index.html +30 -30
- data/docs/advanced/user_config_files/index.html +28 -28
- data/docs/categories/index.html +26 -26
- data/docs/categories/index.xml +2 -6
- data/docs/development/changelog/index.html +53 -40
- data/docs/development/code_of_conduct/index.html +27 -27
- data/docs/development/contributing/index.html +32 -32
- data/docs/development/index.html +26 -26
- data/docs/development/index.xml +3 -7
- data/docs/development/license/index.html +26 -26
- data/docs/index.html +26 -26
- data/docs/index.json +3 -3
- data/docs/index.xml +3 -7
- data/docs/quick_reference/index.html +39 -39
- data/docs/quick_reference/index.xml +2 -6
- data/docs/sitemap.xml +26 -78
- data/docs/tags/index.html +26 -26
- data/docs/tags/index.xml +2 -6
- data/docs/tutorial/10-getting_started/index.html +29 -29
- data/docs/tutorial/20-project_layout/index.html +29 -29
- data/docs/tutorial/30-your_first_command/index.html +32 -32
- data/docs/tutorial/40-options_parameters_and_arguments/index.html +41 -41
- data/docs/tutorial/50-publishing/index.html +27 -27
- data/docs/tutorial/index.html +26 -26
- data/docs/tutorial/index.xml +2 -6
- data/docs/whoami/index.html +26 -26
- data/docs/whoami/index.xml +2 -6
- data/docs-src/content/development/changelog.md +9 -0
- data/docs-src/content/quick_reference/_index.md +2 -2
- data/exe/rbcli +1 -1
- data/lib/rbcli/configuration/configurate.rb +1 -1
- data/lib/rbcli/engine/command.rb +2 -1
- data/lib/rbcli/engine/load_project.rb +1 -1
- data/lib/rbcli/features/userconfig.rb +3 -3
- data/lib/rbcli/state_storage/localstate.rb +1 -1
- data/lib/rbcli/version.rb +1 -1
- data/lib/rbcli-tool/generators.rb +3 -3
- data/lib/rbcli-tool/mdless_fix.rb +1 -1
- data/lib/rbcli-tool/project.rb +3 -3
- data/lib/rbcli-tool/util.rb +2 -2
- data/rbcli.gemspec +11 -13
- data/skeletons/project/application/commands/scripts/script.sh +6 -1
- data/skeletons/project/untitled.gemspec +3 -3
- metadata +32 -32
|
@@ -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.
|
|
6
|
+
<meta name="generator" content="Hugo 0.88.1" />
|
|
7
7
|
<meta name="description" content="">
|
|
8
8
|
|
|
9
9
|
|
|
@@ -12,21 +12,21 @@
|
|
|
12
12
|
<title>Execution Hooks :: RBCli Documentation</title>
|
|
13
13
|
|
|
14
14
|
|
|
15
|
-
<link href="/rbcli/css/nucleus.css?
|
|
16
|
-
<link href="/rbcli/css/fontawesome-all.min.css?
|
|
17
|
-
<link href="/rbcli/css/hybrid.css?
|
|
18
|
-
<link href="/rbcli/css/featherlight.min.css?
|
|
19
|
-
<link href="/rbcli/css/perfect-scrollbar.min.css?
|
|
20
|
-
<link href="/rbcli/css/auto-complete.css?
|
|
21
|
-
<link href="/rbcli/css/atom-one-dark-reasonable.css?
|
|
22
|
-
<link href="/rbcli/css/theme.css?
|
|
23
|
-
<link href="/rbcli/css/hugo-theme.css?
|
|
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">
|
|
24
24
|
|
|
25
|
-
<link href="/rbcli/css/theme-blue.css?
|
|
25
|
+
<link href="/rbcli/css/theme-blue.css?1634703589" rel="stylesheet">
|
|
26
26
|
|
|
27
27
|
|
|
28
28
|
|
|
29
|
-
<script src="/rbcli/js/jquery-3.3.1.min.js?
|
|
29
|
+
<script src="/rbcli/js/jquery-3.3.1.min.js?1634703589"></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?
|
|
59
|
-
<script type="text/javascript" src="/rbcli/js/auto-complete.js?
|
|
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>
|
|
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?
|
|
65
|
+
<script type="text/javascript" src="/rbcli/js/search.js?1634703589"></script>
|
|
66
66
|
|
|
67
67
|
|
|
68
68
|
</div>
|
|
@@ -711,28 +711,28 @@
|
|
|
711
711
|
<h2 id="the-defailt-action-hook">The Defailt Action Hook</h2>
|
|
712
712
|
<p>The Default hook is called when a user calls your application without providing a command. If the hook is not provided, the application will automatically display the help text (the same as running it with <code>-h</code>).</p>
|
|
713
713
|
<p>To create it in your project, run:</p>
|
|
714
|
-
<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">rbcli hook --default
|
|
714
|
+
<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-bash" data-lang="bash">rbcli hook --default
|
|
715
715
|
<span style="color:#75715e"># or</span>
|
|
716
716
|
rbcli hook -d
|
|
717
717
|
</code></pre></div><p>You will then find the hook under <code>hooks/default_action.rb</code>.</p>
|
|
718
718
|
<h2 id="the-pre-execution-hook">The Pre-Execution Hook</h2>
|
|
719
719
|
<p>The Pre-Execution hook is called after the global command line options are parsed and before a command is executed.</p>
|
|
720
720
|
<p>To create it in your project, run:</p>
|
|
721
|
-
<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">rbcli hook --pre
|
|
721
|
+
<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-bash" data-lang="bash">rbcli hook --pre
|
|
722
722
|
<span style="color:#75715e"># or</span>
|
|
723
723
|
rbcli hook -p
|
|
724
724
|
</code></pre></div><p>You will then find the hook under <code>hooks/pre_execution.rb</code>.</p>
|
|
725
725
|
<h2 id="the-post-execution-hook">The Post-Execution Hook</h2>
|
|
726
726
|
<p>The Pre-Execution hook is called after a command is executed.</p>
|
|
727
727
|
<p>To create it in your project, run:</p>
|
|
728
|
-
<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">rbcli hook --post
|
|
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-bash" data-lang="bash">rbcli hook --post
|
|
729
729
|
<span style="color:#75715e"># or</span>
|
|
730
730
|
rbcli hook -o
|
|
731
731
|
</code></pre></div><p>You will then find the hook under <code>hooks/post_execution.rb</code>.</p>
|
|
732
732
|
<h2 id="the-first-run-hook">The First-Run Hook</h2>
|
|
733
733
|
<p>The First-Run hook is called the first time a user executes your application. Using the first-run hook requires enabling <a href="/rbcli/advanced/state_storage/">Local State Storage</a> for persistence.</p>
|
|
734
734
|
<p>To create it in your project, run:</p>
|
|
735
|
-
<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">rbcli hook --firstrun
|
|
735
|
+
<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-bash" data-lang="bash">rbcli hook --firstrun
|
|
736
736
|
<span style="color:#75715e"># or</span>
|
|
737
737
|
rbcli hook -f
|
|
738
738
|
</code></pre></div><p>You will then find the hook under <code>hooks/first_run.rb</code>.</p>
|
|
@@ -1169,19 +1169,19 @@ rbcli hook -f
|
|
|
1169
1169
|
<div style="left: -1000px; overflow: scroll; position: absolute; top: -1000px; border: none; box-sizing: content-box; height: 200px; margin: 0px; padding: 0px; width: 200px;">
|
|
1170
1170
|
<div style="border: none; box-sizing: content-box; height: 200px; margin: 0px; padding: 0px; width: 200px;"></div>
|
|
1171
1171
|
</div>
|
|
1172
|
-
<script src="/rbcli/js/clipboard.min.js?
|
|
1173
|
-
<script src="/rbcli/js/perfect-scrollbar.min.js?
|
|
1174
|
-
<script src="/rbcli/js/perfect-scrollbar.jquery.min.js?
|
|
1175
|
-
<script src="/rbcli/js/jquery.sticky.js?
|
|
1176
|
-
<script src="/rbcli/js/featherlight.min.js?
|
|
1177
|
-
<script src="/rbcli/js/highlight.pack.js?
|
|
1172
|
+
<script src="/rbcli/js/clipboard.min.js?1634703589"></script>
|
|
1173
|
+
<script src="/rbcli/js/perfect-scrollbar.min.js?1634703589"></script>
|
|
1174
|
+
<script src="/rbcli/js/perfect-scrollbar.jquery.min.js?1634703589"></script>
|
|
1175
|
+
<script src="/rbcli/js/jquery.sticky.js?1634703589"></script>
|
|
1176
|
+
<script src="/rbcli/js/featherlight.min.js?1634703589"></script>
|
|
1177
|
+
<script src="/rbcli/js/highlight.pack.js?1634703589"></script>
|
|
1178
1178
|
<script>hljs.initHighlightingOnLoad();</script>
|
|
1179
|
-
<script src="/rbcli/js/modernizr.custom-3.6.0.js?
|
|
1180
|
-
<script src="/rbcli/js/learn.js?
|
|
1181
|
-
<script src="/rbcli/js/hugo-learn.js?
|
|
1179
|
+
<script src="/rbcli/js/modernizr.custom-3.6.0.js?1634703589"></script>
|
|
1180
|
+
<script src="/rbcli/js/learn.js?1634703589"></script>
|
|
1181
|
+
<script src="/rbcli/js/hugo-learn.js?1634703589"></script>
|
|
1182
1182
|
|
|
1183
|
-
<link href="/rbcli/mermaid/mermaid.css?
|
|
1184
|
-
<script src="/rbcli/mermaid/mermaid.js?
|
|
1183
|
+
<link href="/rbcli/mermaid/mermaid.css?1634703589" rel="stylesheet" />
|
|
1184
|
+
<script src="/rbcli/mermaid/mermaid.js?1634703589"></script>
|
|
1185
1185
|
<script>
|
|
1186
1186
|
mermaid.initialize({ startOnLoad: true });
|
|
1187
1187
|
</script>
|
data/docs/advanced/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.
|
|
6
|
+
<meta name="generator" content="Hugo 0.88.1" />
|
|
7
7
|
<meta name="description" content="">
|
|
8
8
|
|
|
9
9
|
|
|
@@ -12,21 +12,21 @@
|
|
|
12
12
|
<title>Advanced :: RBCli Documentation</title>
|
|
13
13
|
|
|
14
14
|
|
|
15
|
-
<link href="/rbcli/css/nucleus.css?
|
|
16
|
-
<link href="/rbcli/css/fontawesome-all.min.css?
|
|
17
|
-
<link href="/rbcli/css/hybrid.css?
|
|
18
|
-
<link href="/rbcli/css/featherlight.min.css?
|
|
19
|
-
<link href="/rbcli/css/perfect-scrollbar.min.css?
|
|
20
|
-
<link href="/rbcli/css/auto-complete.css?
|
|
21
|
-
<link href="/rbcli/css/atom-one-dark-reasonable.css?
|
|
22
|
-
<link href="/rbcli/css/theme.css?
|
|
23
|
-
<link href="/rbcli/css/hugo-theme.css?
|
|
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">
|
|
24
24
|
|
|
25
|
-
<link href="/rbcli/css/theme-blue.css?
|
|
25
|
+
<link href="/rbcli/css/theme-blue.css?1634703589" rel="stylesheet">
|
|
26
26
|
|
|
27
27
|
|
|
28
28
|
|
|
29
|
-
<script src="/rbcli/js/jquery-3.3.1.min.js?
|
|
29
|
+
<script src="/rbcli/js/jquery-3.3.1.min.js?1634703589"></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?
|
|
59
|
-
<script type="text/javascript" src="/rbcli/js/auto-complete.js?
|
|
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>
|
|
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?
|
|
65
|
+
<script type="text/javascript" src="/rbcli/js/search.js?1634703589"></script>
|
|
66
66
|
|
|
67
67
|
|
|
68
68
|
</div>
|
|
@@ -1118,19 +1118,19 @@
|
|
|
1118
1118
|
<div style="left: -1000px; overflow: scroll; position: absolute; top: -1000px; border: none; box-sizing: content-box; height: 200px; margin: 0px; padding: 0px; width: 200px;">
|
|
1119
1119
|
<div style="border: none; box-sizing: content-box; height: 200px; margin: 0px; padding: 0px; width: 200px;"></div>
|
|
1120
1120
|
</div>
|
|
1121
|
-
<script src="/rbcli/js/clipboard.min.js?
|
|
1122
|
-
<script src="/rbcli/js/perfect-scrollbar.min.js?
|
|
1123
|
-
<script src="/rbcli/js/perfect-scrollbar.jquery.min.js?
|
|
1124
|
-
<script src="/rbcli/js/jquery.sticky.js?
|
|
1125
|
-
<script src="/rbcli/js/featherlight.min.js?
|
|
1126
|
-
<script src="/rbcli/js/highlight.pack.js?
|
|
1121
|
+
<script src="/rbcli/js/clipboard.min.js?1634703589"></script>
|
|
1122
|
+
<script src="/rbcli/js/perfect-scrollbar.min.js?1634703589"></script>
|
|
1123
|
+
<script src="/rbcli/js/perfect-scrollbar.jquery.min.js?1634703589"></script>
|
|
1124
|
+
<script src="/rbcli/js/jquery.sticky.js?1634703589"></script>
|
|
1125
|
+
<script src="/rbcli/js/featherlight.min.js?1634703589"></script>
|
|
1126
|
+
<script src="/rbcli/js/highlight.pack.js?1634703589"></script>
|
|
1127
1127
|
<script>hljs.initHighlightingOnLoad();</script>
|
|
1128
|
-
<script src="/rbcli/js/modernizr.custom-3.6.0.js?
|
|
1129
|
-
<script src="/rbcli/js/learn.js?
|
|
1130
|
-
<script src="/rbcli/js/hugo-learn.js?
|
|
1128
|
+
<script src="/rbcli/js/modernizr.custom-3.6.0.js?1634703589"></script>
|
|
1129
|
+
<script src="/rbcli/js/learn.js?1634703589"></script>
|
|
1130
|
+
<script src="/rbcli/js/hugo-learn.js?1634703589"></script>
|
|
1131
1131
|
|
|
1132
|
-
<link href="/rbcli/mermaid/mermaid.css?
|
|
1133
|
-
<script src="/rbcli/mermaid/mermaid.js?
|
|
1132
|
+
<link href="/rbcli/mermaid/mermaid.css?1634703589" rel="stylesheet" />
|
|
1133
|
+
<script src="/rbcli/mermaid/mermaid.js?1634703589"></script>
|
|
1134
1134
|
<script>
|
|
1135
1135
|
mermaid.initialize({ startOnLoad: true });
|
|
1136
1136
|
</script>
|
data/docs/advanced/index.xml
CHANGED
|
@@ -6,11 +6,7 @@
|
|
|
6
6
|
<description>Recent content in Advanced on RBCli Documentation</description>
|
|
7
7
|
<generator>Hugo -- gohugo.io</generator>
|
|
8
8
|
<language>en-us</language>
|
|
9
|
-
<lastBuildDate>Thu, 20 Jun 2019 15:08:08 -0400</lastBuildDate
|
|
10
|
-
|
|
11
|
-
<atom:link href="https://akhoury6.github.io/rbcli/advanced/index.xml" rel="self" type="application/rss+xml" />
|
|
12
|
-
|
|
13
|
-
|
|
9
|
+
<lastBuildDate>Thu, 20 Jun 2019 15:08:08 -0400</lastBuildDate><atom:link href="https://akhoury6.github.io/rbcli/advanced/index.xml" rel="self" type="application/rss+xml" />
|
|
14
10
|
<item>
|
|
15
11
|
<title>Automatic Updates</title>
|
|
16
12
|
<link>https://akhoury6.github.io/rbcli/advanced/automatic_updates/</link>
|
|
@@ -114,4 +110,4 @@ Defaults chain The defaults chain allows you to specify sane defaults for your C
|
|
|
114
110
|
</item>
|
|
115
111
|
|
|
116
112
|
</channel>
|
|
117
|
-
</rss>
|
|
113
|
+
</rss>
|
|
@@ -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.
|
|
6
|
+
<meta name="generator" content="Hugo 0.88.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?
|
|
16
|
-
<link href="/rbcli/css/fontawesome-all.min.css?
|
|
17
|
-
<link href="/rbcli/css/hybrid.css?
|
|
18
|
-
<link href="/rbcli/css/featherlight.min.css?
|
|
19
|
-
<link href="/rbcli/css/perfect-scrollbar.min.css?
|
|
20
|
-
<link href="/rbcli/css/auto-complete.css?
|
|
21
|
-
<link href="/rbcli/css/atom-one-dark-reasonable.css?
|
|
22
|
-
<link href="/rbcli/css/theme.css?
|
|
23
|
-
<link href="/rbcli/css/hugo-theme.css?
|
|
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">
|
|
24
24
|
|
|
25
|
-
<link href="/rbcli/css/theme-blue.css?
|
|
25
|
+
<link href="/rbcli/css/theme-blue.css?1634703589" rel="stylesheet">
|
|
26
26
|
|
|
27
27
|
|
|
28
28
|
|
|
29
|
-
<script src="/rbcli/js/jquery-3.3.1.min.js?
|
|
29
|
+
<script src="/rbcli/js/jquery-3.3.1.min.js?1634703589"></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?
|
|
59
|
-
<script type="text/javascript" src="/rbcli/js/auto-complete.js?
|
|
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>
|
|
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?
|
|
65
|
+
<script type="text/javascript" src="/rbcli/js/search.js?1634703589"></script>
|
|
66
66
|
|
|
67
67
|
|
|
68
68
|
</div>
|
|
@@ -709,16 +709,16 @@
|
|
|
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’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 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"><</span> <span style="color:#66d9ef">Rbcli</span><span style="color:#f92672">::</span><span style="color:#66d9ef">Command</span>
|
|
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"><</span> <span style="color:#66d9ef">Rbcli</span><span style="color:#f92672">::</span><span style="color:#66d9ef">Command</span>
|
|
713
713
|
parameter <span style="color:#e6db74">:sort</span>, <span style="color:#e6db74">'Sort output alphabetically'</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">"Sort output alphabetically?"</span>
|
|
714
714
|
action <span style="color:#66d9ef">do</span> <span style="color:#f92672">|</span>params, args, global_opts, config<span style="color:#f92672">|</span>
|
|
715
715
|
puts params<span style="color:#f92672">[</span><span style="color:#e6db74">:sort</span><span style="color:#f92672">]</span>
|
|
716
716
|
<span style="color:#66d9ef">end</span>
|
|
717
717
|
<span style="color:#66d9ef">end</span>
|
|
718
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 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
|
|
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
720
|
</code></pre></div><p>That should give you the prompt:</p>
|
|
721
|
-
<pre><code>Sort output alphabetically? (y/N):
|
|
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>
|
|
724
724
|
|
|
@@ -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?
|
|
1158
|
-
<script src="/rbcli/js/perfect-scrollbar.min.js?
|
|
1159
|
-
<script src="/rbcli/js/perfect-scrollbar.jquery.min.js?
|
|
1160
|
-
<script src="/rbcli/js/jquery.sticky.js?
|
|
1161
|
-
<script src="/rbcli/js/featherlight.min.js?
|
|
1162
|
-
<script src="/rbcli/js/highlight.pack.js?
|
|
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>
|
|
1163
1163
|
<script>hljs.initHighlightingOnLoad();</script>
|
|
1164
|
-
<script src="/rbcli/js/modernizr.custom-3.6.0.js?
|
|
1165
|
-
<script src="/rbcli/js/learn.js?
|
|
1166
|
-
<script src="/rbcli/js/hugo-learn.js?
|
|
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>
|
|
1167
1167
|
|
|
1168
|
-
<link href="/rbcli/mermaid/mermaid.css?
|
|
1169
|
-
<script src="/rbcli/mermaid/mermaid.js?
|
|
1168
|
+
<link href="/rbcli/mermaid/mermaid.css?1634703589" rel="stylesheet" />
|
|
1169
|
+
<script src="/rbcli/mermaid/mermaid.js?1634703589"></script>
|
|
1170
1170
|
<script>
|
|
1171
1171
|
mermaid.initialize({ startOnLoad: true });
|
|
1172
1172
|
</script>
|
|
@@ -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.
|
|
6
|
+
<meta name="generator" content="Hugo 0.88.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?
|
|
16
|
-
<link href="/rbcli/css/fontawesome-all.min.css?
|
|
17
|
-
<link href="/rbcli/css/hybrid.css?
|
|
18
|
-
<link href="/rbcli/css/featherlight.min.css?
|
|
19
|
-
<link href="/rbcli/css/perfect-scrollbar.min.css?
|
|
20
|
-
<link href="/rbcli/css/auto-complete.css?
|
|
21
|
-
<link href="/rbcli/css/atom-one-dark-reasonable.css?
|
|
22
|
-
<link href="/rbcli/css/theme.css?
|
|
23
|
-
<link href="/rbcli/css/hugo-theme.css?
|
|
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">
|
|
24
24
|
|
|
25
|
-
<link href="/rbcli/css/theme-blue.css?
|
|
25
|
+
<link href="/rbcli/css/theme-blue.css?1634703589" rel="stylesheet">
|
|
26
26
|
|
|
27
27
|
|
|
28
28
|
|
|
29
|
-
<script src="/rbcli/js/jquery-3.3.1.min.js?
|
|
29
|
+
<script src="/rbcli/js/jquery-3.3.1.min.js?1634703589"></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?
|
|
59
|
-
<script type="text/javascript" src="/rbcli/js/auto-complete.js?
|
|
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>
|
|
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?
|
|
65
|
+
<script type="text/javascript" src="/rbcli/js/search.js?1634703589"></script>
|
|
66
66
|
|
|
67
67
|
|
|
68
68
|
</div>
|
|
@@ -705,10 +705,10 @@
|
|
|
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 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">'These logs can go to STDERR, STDOUT, or a file'</span> }
|
|
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">'These logs can go to STDERR, STDOUT, or a file'</span> }
|
|
709
709
|
</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 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>
|
|
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
712
|
log_target <span style="color:#e6db74">'stderr'</span>
|
|
713
713
|
</code></pre></div><ul>
|
|
714
714
|
<li><code>log_level</code>
|
|
@@ -724,10 +724,10 @@ log_target <span style="color:#e6db74">'stderr'</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’s config file to override defaults:</p>
|
|
727
|
-
<div class="highlight"><pre 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:#
|
|
729
|
-
<span style="color:#
|
|
730
|
-
<span style="color:#
|
|
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 < INFO < WARN < ERROR < FATAL < 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
731
|
</code></pre></div>
|
|
732
732
|
|
|
733
733
|
<footer class="footline">
|
|
@@ -1161,19 +1161,19 @@ log_target <span style="color:#e6db74">'stderr'</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?
|
|
1165
|
-
<script src="/rbcli/js/perfect-scrollbar.min.js?
|
|
1166
|
-
<script src="/rbcli/js/perfect-scrollbar.jquery.min.js?
|
|
1167
|
-
<script src="/rbcli/js/jquery.sticky.js?
|
|
1168
|
-
<script src="/rbcli/js/featherlight.min.js?
|
|
1169
|
-
<script src="/rbcli/js/highlight.pack.js?
|
|
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>
|
|
1170
1170
|
<script>hljs.initHighlightingOnLoad();</script>
|
|
1171
|
-
<script src="/rbcli/js/modernizr.custom-3.6.0.js?
|
|
1172
|
-
<script src="/rbcli/js/learn.js?
|
|
1173
|
-
<script src="/rbcli/js/hugo-learn.js?
|
|
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>
|
|
1174
1174
|
|
|
1175
|
-
<link href="/rbcli/mermaid/mermaid.css?
|
|
1176
|
-
<script src="/rbcli/mermaid/mermaid.js?
|
|
1175
|
+
<link href="/rbcli/mermaid/mermaid.css?1634703589" rel="stylesheet" />
|
|
1176
|
+
<script src="/rbcli/mermaid/mermaid.js?1634703589"></script>
|
|
1177
1177
|
<script>
|
|
1178
1178
|
mermaid.initialize({ startOnLoad: true });
|
|
1179
1179
|
</script>
|
|
@@ -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.
|
|
6
|
+
<meta name="generator" content="Hugo 0.88.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?
|
|
16
|
-
<link href="/rbcli/css/fontawesome-all.min.css?
|
|
17
|
-
<link href="/rbcli/css/hybrid.css?
|
|
18
|
-
<link href="/rbcli/css/featherlight.min.css?
|
|
19
|
-
<link href="/rbcli/css/perfect-scrollbar.min.css?
|
|
20
|
-
<link href="/rbcli/css/auto-complete.css?
|
|
21
|
-
<link href="/rbcli/css/atom-one-dark-reasonable.css?
|
|
22
|
-
<link href="/rbcli/css/theme.css?
|
|
23
|
-
<link href="/rbcli/css/hugo-theme.css?
|
|
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">
|
|
24
24
|
|
|
25
|
-
<link href="/rbcli/css/theme-blue.css?
|
|
25
|
+
<link href="/rbcli/css/theme-blue.css?1634703589" rel="stylesheet">
|
|
26
26
|
|
|
27
27
|
|
|
28
28
|
|
|
29
|
-
<script src="/rbcli/js/jquery-3.3.1.min.js?
|
|
29
|
+
<script src="/rbcli/js/jquery-3.3.1.min.js?1634703589"></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?
|
|
59
|
-
<script type="text/javascript" src="/rbcli/js/auto-complete.js?
|
|
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>
|
|
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?
|
|
65
|
+
<script type="text/javascript" src="/rbcli/js/search.js?1634703589"></script>
|
|
66
66
|
|
|
67
67
|
|
|
68
68
|
</div>
|
|
@@ -708,20 +708,20 @@
|
|
|
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 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>
|
|
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
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 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
|
|
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
714
|
</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 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> <command>
|
|
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> <command>
|
|
717
717
|
<span style="color:#75715e"># or</span>
|
|
718
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> <command>
|
|
719
719
|
</code></pre></div><p>Some valid examples are:</p>
|
|
720
|
-
<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 -r example.com -i myPassword showuserfiles -u MyUser
|
|
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
721
|
mytool -r root@server.local -i ~/.ssh/id_rsa update
|
|
722
722
|
mytool -r admin@172.16.0.1:2202 -i ~/.ssh/mykey cleartemp
|
|
723
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 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
|
|
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
725
|
A simple command line tool.
|
|
726
726
|
For more information on individual commands, run <span style="color:#e6db74">`</span>mytool <command> -h<span style="color:#e6db74">`</span>.
|
|
727
727
|
|
|
@@ -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?
|
|
1171
|
-
<script src="/rbcli/js/perfect-scrollbar.min.js?
|
|
1172
|
-
<script src="/rbcli/js/perfect-scrollbar.jquery.min.js?
|
|
1173
|
-
<script src="/rbcli/js/jquery.sticky.js?
|
|
1174
|
-
<script src="/rbcli/js/featherlight.min.js?
|
|
1175
|
-
<script src="/rbcli/js/highlight.pack.js?
|
|
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>
|
|
1176
1176
|
<script>hljs.initHighlightingOnLoad();</script>
|
|
1177
|
-
<script src="/rbcli/js/modernizr.custom-3.6.0.js?
|
|
1178
|
-
<script src="/rbcli/js/learn.js?
|
|
1179
|
-
<script src="/rbcli/js/hugo-learn.js?
|
|
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>
|
|
1180
1180
|
|
|
1181
|
-
<link href="/rbcli/mermaid/mermaid.css?
|
|
1182
|
-
<script src="/rbcli/mermaid/mermaid.js?
|
|
1181
|
+
<link href="/rbcli/mermaid/mermaid.css?1634703589" rel="stylesheet" />
|
|
1182
|
+
<script src="/rbcli/mermaid/mermaid.js?1634703589"></script>
|
|
1183
1183
|
<script>
|
|
1184
1184
|
mermaid.initialize({ startOnLoad: true });
|
|
1185
1185
|
</script>
|