rbcli 0.2.12 → 0.3.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +15 -0
- data/Gemfile.lock +39 -38
- data/docs-src/content/development/changelog.md +16 -1
- data/docs-src/themes/hugo-theme-learn/CHANGELOG.md +74 -2
- data/docs-src/themes/hugo-theme-learn/README.md +42 -5
- data/docs-src/themes/hugo-theme-learn/exampleSite/config.toml +27 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/basics/_index.zh.md +12 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/basics/configuration/_index.en.md +6 -4
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/basics/configuration/_index.fr.md +7 -5
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/basics/installation/_index.en.md +1 -1
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/cont/markdown.en.md +88 -61
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/cont/pages/_index.fr.md +3 -3
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/cont/syntaxhighlight.en.md +89 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/children/_index.en.md +2 -2
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/notice.en.md +2 -2
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/showcase.en.md +4 -1
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/showcase.fr.md +4 -1
- data/docs-src/themes/hugo-theme-learn/exampleSite/static/fonts/monogramos-webfont.svg +1 -237
- data/docs-src/themes/hugo-theme-learn/exampleSite/static/images/showcase/inteliver_docs.png +0 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/static/images/showcase/tshark_dev.png +0 -0
- data/docs-src/themes/hugo-theme-learn/i18n/ar.toml +26 -0
- data/docs-src/themes/hugo-theme-learn/i18n/de.toml +26 -0
- data/docs-src/themes/hugo-theme-learn/i18n/hi.toml +26 -0
- data/docs-src/themes/hugo-theme-learn/i18n/ja.toml +26 -0
- data/docs-src/themes/hugo-theme-learn/i18n/ru.toml +26 -0
- data/docs-src/themes/hugo-theme-learn/i18n/zh-cn.toml +26 -0
- data/docs-src/themes/hugo-theme-learn/layouts/_default/list.html +1 -1
- data/docs-src/themes/hugo-theme-learn/layouts/_default/single.html +1 -2
- data/docs-src/themes/hugo-theme-learn/layouts/partials/footer.html +3 -4
- data/docs-src/themes/hugo-theme-learn/layouts/partials/header.html +8 -6
- data/docs-src/themes/hugo-theme-learn/layouts/partials/menu.html +6 -5
- data/docs-src/themes/hugo-theme-learn/layouts/shortcodes/children.html +2 -2
- data/docs-src/themes/hugo-theme-learn/layouts/shortcodes/ref.html +1 -1
- data/docs-src/themes/hugo-theme-learn/layouts/shortcodes/relref.html +1 -1
- data/docs-src/themes/hugo-theme-learn/netlify.toml +1 -2
- data/docs-src/themes/hugo-theme-learn/static/css/theme.css +4 -0
- data/docs-src/themes/hugo-theme-learn/static/fonts/Inconsolata.svg +1 -359
- data/docs-src/themes/hugo-theme-learn/static/fonts/Novecentosanswide-Normal-webfont.svg +1 -1019
- data/docs-src/themes/hugo-theme-learn/static/fonts/Novecentosanswide-UltraLight-webfont.svg +1 -918
- data/docs-src/themes/hugo-theme-learn/static/fonts/Work_Sans_200.svg +1 -332
- data/docs-src/themes/hugo-theme-learn/static/fonts/Work_Sans_300.svg +1 -331
- data/docs-src/themes/hugo-theme-learn/static/fonts/Work_Sans_500.svg +1 -333
- data/docs-src/themes/hugo-theme-learn/static/images/clippy.svg +1 -1
- data/docs-src/themes/hugo-theme-learn/static/js/auto-complete.js +3 -223
- data/docs-src/themes/hugo-theme-learn/static/js/highlight.pack.js +6 -3
- data/docs-src/themes/hugo-theme-learn/static/js/hugo-learn.js +8 -5
- data/docs-src/themes/hugo-theme-learn/static/webfonts/fa-brands-400.svg +1 -1260
- data/docs-src/themes/hugo-theme-learn/static/webfonts/fa-regular-400.svg +1 -471
- data/docs-src/themes/hugo-theme-learn/static/webfonts/fa-solid-900.svg +1 -2763
- data/docs/404.html +8 -8
- data/docs/advanced/automatic_updates/index.html +85 -65
- data/docs/advanced/command_types/index.html +139 -144
- data/docs/advanced/distributed_state_locking/index.html +83 -55
- data/docs/advanced/hooks/index.html +94 -81
- data/docs/advanced/index.html +75 -34
- data/docs/advanced/index.xml +8 -8
- data/docs/advanced/interactive_commands/index.html +90 -66
- data/docs/advanced/logging/index.html +94 -67
- data/docs/advanced/remote_execution/index.html +94 -75
- data/docs/advanced/state_storage/index.html +122 -119
- data/docs/advanced/user_config_files/index.html +94 -71
- data/docs/categories/index.html +82 -30
- data/docs/categories/index.xml +1 -1
- data/docs/css/theme.css +4 -0
- data/docs/development/changelog/index.html +185 -177
- data/docs/development/code_of_conduct/index.html +85 -64
- data/docs/development/contributing/index.html +96 -96
- data/docs/development/index.html +75 -34
- data/docs/development/index.xml +2 -2
- data/docs/development/license/index.html +80 -46
- data/docs/fonts/Inconsolata.svg +1 -359
- data/docs/fonts/Novecentosanswide-Normal-webfont.svg +1 -1019
- data/docs/fonts/Novecentosanswide-UltraLight-webfont.svg +1 -918
- data/docs/fonts/Work_Sans_200.svg +1 -332
- data/docs/fonts/Work_Sans_300.svg +1 -331
- data/docs/fonts/Work_Sans_500.svg +1 -333
- data/docs/images/clippy.svg +1 -1
- data/docs/index.html +112 -61
- data/docs/index.json +24 -24
- data/docs/index.xml +13 -13
- data/docs/js/auto-complete.js +3 -223
- data/docs/js/highlight.pack.js +6 -3
- data/docs/js/hugo-learn.js +8 -5
- data/docs/quick_reference/index.html +126 -159
- data/docs/quick_reference/index.xml +1 -1
- data/docs/sitemap.xml +2 -4
- data/docs/tags/index.html +82 -30
- data/docs/tags/index.xml +1 -1
- data/docs/tutorial/10-getting_started/index.html +87 -66
- data/docs/tutorial/20-project_layout/index.html +126 -116
- data/docs/tutorial/30-your_first_command/index.html +151 -141
- data/docs/tutorial/40-options_parameters_and_arguments/index.html +233 -258
- data/docs/tutorial/50-publishing/index.html +86 -66
- data/docs/tutorial/index.html +75 -34
- data/docs/tutorial/index.xml +4 -4
- data/docs/webfonts/fa-brands-400.svg +1 -1260
- data/docs/webfonts/fa-regular-400.svg +1 -471
- data/docs/webfonts/fa-solid-900.svg +1 -2763
- data/docs/whoami/index.html +76 -46
- data/docs/whoami/index.xml +1 -1
- data/lib/rbcli/configuration/configurate_blocks/me.rb +5 -5
- data/lib/rbcli/util/deprecation_warning.rb +21 -4
- data/lib/rbcli/version.rb +1 -1
- data/rbcli.gemspec +8 -8
- data/skeletons/project/Gemfile +1 -1
- data/skeletons/project/config/general.rb +1 -1
- data/skeletons/project/lib/lib.erb +2 -0
- data/skeletons/project/spec/spec_helper.rb +7 -7
- data/skeletons/project/spec/untitled_spec.rb +6 -6
- data/skeletons/project/untitled.gemspec +28 -26
- metadata +29 -20
- data/docs-src/themes/hugo-theme-learn/static/js/html5shiv-printshiv.min.js +0 -4
|
@@ -3,7 +3,7 @@
|
|
|
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.74.3" />
|
|
7
7
|
<meta name="description" content="">
|
|
8
8
|
|
|
9
9
|
|
|
@@ -12,20 +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?1596148729" rel="stylesheet">
|
|
16
|
+
<link href="/rbcli/css/fontawesome-all.min.css?1596148729" rel="stylesheet">
|
|
17
|
+
<link href="/rbcli/css/hybrid.css?1596148729" rel="stylesheet">
|
|
18
|
+
<link href="/rbcli/css/featherlight.min.css?1596148729" rel="stylesheet">
|
|
19
|
+
<link href="/rbcli/css/perfect-scrollbar.min.css?1596148729" rel="stylesheet">
|
|
20
|
+
<link href="/rbcli/css/auto-complete.css?1596148729" rel="stylesheet">
|
|
21
|
+
<link href="/rbcli/css/atom-one-dark-reasonable.css?1596148729" rel="stylesheet">
|
|
22
|
+
<link href="/rbcli/css/theme.css?1596148729" rel="stylesheet">
|
|
23
|
+
<link href="/rbcli/css/hugo-theme.css?1596148729" rel="stylesheet">
|
|
24
|
+
|
|
25
|
+
<link href="/rbcli/css/theme-blue.css?1596148729" rel="stylesheet">
|
|
24
26
|
|
|
25
|
-
<link href="/rbcli/css/theme-blue.css?1561087612" rel="stylesheet">
|
|
26
27
|
|
|
27
28
|
|
|
28
|
-
<script src="/rbcli/js/jquery-3.3.1.min.js?
|
|
29
|
+
<script src="/rbcli/js/jquery-3.3.1.min.js?1596148729"></script>
|
|
29
30
|
|
|
30
31
|
<style>
|
|
31
32
|
:root #header + #content > #left > #rlblock_left{
|
|
@@ -54,14 +55,14 @@
|
|
|
54
55
|
<span data-search-clear=""><i class="fas fa-times"></i></span>
|
|
55
56
|
</div>
|
|
56
57
|
|
|
57
|
-
<script type="text/javascript" src="/rbcli/js/lunr.min.js?
|
|
58
|
-
<script type="text/javascript" src="/rbcli/js/auto-complete.js?
|
|
58
|
+
<script type="text/javascript" src="/rbcli/js/lunr.min.js?1596148729"></script>
|
|
59
|
+
<script type="text/javascript" src="/rbcli/js/auto-complete.js?1596148729"></script>
|
|
59
60
|
<script type="text/javascript">
|
|
60
61
|
|
|
61
62
|
var baseurl = "https:\/\/akhoury6.github.io\/rbcli\/";
|
|
62
63
|
|
|
63
64
|
</script>
|
|
64
|
-
<script type="text/javascript" src="/rbcli/js/search.js?
|
|
65
|
+
<script type="text/javascript" src="/rbcli/js/search.js?1596148729"></script>
|
|
65
66
|
|
|
66
67
|
|
|
67
68
|
</div>
|
|
@@ -74,6 +75,8 @@
|
|
|
74
75
|
|
|
75
76
|
|
|
76
77
|
|
|
78
|
+
|
|
79
|
+
|
|
77
80
|
|
|
78
81
|
|
|
79
82
|
|
|
@@ -96,6 +99,8 @@
|
|
|
96
99
|
|
|
97
100
|
|
|
98
101
|
|
|
102
|
+
|
|
103
|
+
|
|
99
104
|
|
|
100
105
|
|
|
101
106
|
|
|
@@ -121,6 +126,8 @@
|
|
|
121
126
|
|
|
122
127
|
|
|
123
128
|
|
|
129
|
+
|
|
130
|
+
|
|
124
131
|
|
|
125
132
|
|
|
126
133
|
|
|
@@ -140,6 +147,8 @@
|
|
|
140
147
|
|
|
141
148
|
|
|
142
149
|
|
|
150
|
+
|
|
151
|
+
|
|
143
152
|
|
|
144
153
|
|
|
145
154
|
|
|
@@ -159,6 +168,8 @@
|
|
|
159
168
|
|
|
160
169
|
|
|
161
170
|
|
|
171
|
+
|
|
172
|
+
|
|
162
173
|
|
|
163
174
|
|
|
164
175
|
|
|
@@ -178,6 +189,8 @@
|
|
|
178
189
|
|
|
179
190
|
|
|
180
191
|
|
|
192
|
+
|
|
193
|
+
|
|
181
194
|
|
|
182
195
|
|
|
183
196
|
|
|
@@ -197,6 +210,8 @@
|
|
|
197
210
|
|
|
198
211
|
|
|
199
212
|
|
|
213
|
+
|
|
214
|
+
|
|
200
215
|
|
|
201
216
|
|
|
202
217
|
|
|
@@ -223,6 +238,8 @@
|
|
|
223
238
|
|
|
224
239
|
|
|
225
240
|
|
|
241
|
+
|
|
242
|
+
|
|
226
243
|
|
|
227
244
|
|
|
228
245
|
|
|
@@ -248,6 +265,8 @@
|
|
|
248
265
|
|
|
249
266
|
|
|
250
267
|
|
|
268
|
+
|
|
269
|
+
|
|
251
270
|
|
|
252
271
|
|
|
253
272
|
|
|
@@ -267,6 +286,8 @@
|
|
|
267
286
|
|
|
268
287
|
|
|
269
288
|
|
|
289
|
+
|
|
290
|
+
|
|
270
291
|
|
|
271
292
|
|
|
272
293
|
|
|
@@ -286,6 +307,8 @@
|
|
|
286
307
|
|
|
287
308
|
|
|
288
309
|
|
|
310
|
+
|
|
311
|
+
|
|
289
312
|
|
|
290
313
|
|
|
291
314
|
|
|
@@ -305,6 +328,8 @@
|
|
|
305
328
|
|
|
306
329
|
|
|
307
330
|
|
|
331
|
+
|
|
332
|
+
|
|
308
333
|
|
|
309
334
|
|
|
310
335
|
|
|
@@ -324,6 +349,8 @@
|
|
|
324
349
|
|
|
325
350
|
|
|
326
351
|
|
|
352
|
+
|
|
353
|
+
|
|
327
354
|
|
|
328
355
|
|
|
329
356
|
|
|
@@ -343,6 +370,8 @@
|
|
|
343
370
|
|
|
344
371
|
|
|
345
372
|
|
|
373
|
+
|
|
374
|
+
|
|
346
375
|
|
|
347
376
|
|
|
348
377
|
|
|
@@ -362,6 +391,8 @@
|
|
|
362
391
|
|
|
363
392
|
|
|
364
393
|
|
|
394
|
+
|
|
395
|
+
|
|
365
396
|
|
|
366
397
|
|
|
367
398
|
|
|
@@ -381,6 +412,8 @@
|
|
|
381
412
|
|
|
382
413
|
|
|
383
414
|
|
|
415
|
+
|
|
416
|
+
|
|
384
417
|
|
|
385
418
|
|
|
386
419
|
|
|
@@ -400,6 +433,8 @@
|
|
|
400
433
|
|
|
401
434
|
|
|
402
435
|
|
|
436
|
+
|
|
437
|
+
|
|
403
438
|
|
|
404
439
|
|
|
405
440
|
|
|
@@ -426,6 +461,8 @@
|
|
|
426
461
|
|
|
427
462
|
|
|
428
463
|
|
|
464
|
+
|
|
465
|
+
|
|
429
466
|
|
|
430
467
|
|
|
431
468
|
|
|
@@ -451,6 +488,8 @@
|
|
|
451
488
|
|
|
452
489
|
|
|
453
490
|
|
|
491
|
+
|
|
492
|
+
|
|
454
493
|
|
|
455
494
|
|
|
456
495
|
|
|
@@ -470,6 +509,8 @@
|
|
|
470
509
|
|
|
471
510
|
|
|
472
511
|
|
|
512
|
+
|
|
513
|
+
|
|
473
514
|
|
|
474
515
|
|
|
475
516
|
|
|
@@ -489,6 +530,8 @@
|
|
|
489
530
|
|
|
490
531
|
|
|
491
532
|
|
|
533
|
+
|
|
534
|
+
|
|
492
535
|
|
|
493
536
|
|
|
494
537
|
|
|
@@ -508,6 +551,8 @@
|
|
|
508
551
|
|
|
509
552
|
|
|
510
553
|
|
|
554
|
+
|
|
555
|
+
|
|
511
556
|
|
|
512
557
|
|
|
513
558
|
|
|
@@ -534,6 +579,8 @@
|
|
|
534
579
|
|
|
535
580
|
|
|
536
581
|
|
|
582
|
+
|
|
583
|
+
|
|
537
584
|
|
|
538
585
|
|
|
539
586
|
|
|
@@ -585,7 +632,6 @@
|
|
|
585
632
|
|
|
586
633
|
|
|
587
634
|
|
|
588
|
-
|
|
589
635
|
<section id="body">
|
|
590
636
|
<div id="overlay"></div>
|
|
591
637
|
<div class="padding highlightable">
|
|
@@ -619,9 +665,9 @@
|
|
|
619
665
|
|
|
620
666
|
<a href='/rbcli/'></a> > <a href='/rbcli/advanced/'>Advanced</a> > Logging
|
|
621
667
|
|
|
622
|
-
|
|
668
|
+
|
|
623
669
|
|
|
624
|
-
|
|
670
|
+
|
|
625
671
|
|
|
626
672
|
|
|
627
673
|
|
|
@@ -631,13 +677,10 @@
|
|
|
631
677
|
<div class="progress">
|
|
632
678
|
<div class="wrapper">
|
|
633
679
|
<nav id="TableOfContents">
|
|
634
|
-
<ul>
|
|
635
|
-
<li>
|
|
636
|
-
<
|
|
637
|
-
|
|
638
|
-
<li><a href="#userspace-config-overrides">Userspace Config Overrides</a></li>
|
|
639
|
-
</ul></li>
|
|
640
|
-
</ul>
|
|
680
|
+
<ul>
|
|
681
|
+
<li><a href="#enabling-logging">Enabling Logging</a></li>
|
|
682
|
+
<li><a href="#userspace-config-overrides">Userspace Config Overrides</a></li>
|
|
683
|
+
</ul>
|
|
641
684
|
</nav>
|
|
642
685
|
</div>
|
|
643
686
|
</div>
|
|
@@ -661,51 +704,36 @@
|
|
|
661
704
|
|
|
662
705
|
|
|
663
706
|
|
|
664
|
-
|
|
665
|
-
|
|
666
|
-
|
|
667
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>
|
|
668
|
-
|
|
669
|
-
|
|
670
|
-
</code></pre>
|
|
671
|
-
|
|
672
|
-
<h2 id="enabling-logging">Enabling Logging</h2>
|
|
673
|
-
|
|
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> }
|
|
709
|
+
</code></pre></div><h2 id="enabling-logging">Enabling Logging</h2>
|
|
674
710
|
<p>To enable logging, simply set the default values in the <code>config/logging.rb</code> file:</p>
|
|
675
|
-
|
|
676
|
-
<
|
|
677
|
-
|
|
678
|
-
</code></pre>
|
|
679
|
-
|
|
680
|
-
<ul>
|
|
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>
|
|
712
|
+
log_target <span style="color:#e6db74">'stderr'</span>
|
|
713
|
+
</code></pre></div><ul>
|
|
681
714
|
<li><code>log_level</code>
|
|
682
|
-
|
|
683
715
|
<ul>
|
|
684
716
|
<li>You can set the default log level using either numeric or standard Ruby logger levels: 0-5, or DEBUG < INFO < WARN < ERROR < FATAL < UNKNOWN</li>
|
|
685
|
-
</ul
|
|
717
|
+
</ul>
|
|
718
|
+
</li>
|
|
686
719
|
<li><code>log_target</code>
|
|
687
|
-
|
|
688
720
|
<ul>
|
|
689
721
|
<li>This specifies where the logs will be placed. Valid values are nil (disables logging), ‘STDOUT’, ‘STDERR’, or a file path (all as strings).</li>
|
|
690
|
-
</ul></li>
|
|
691
722
|
</ul>
|
|
692
|
-
|
|
723
|
+
</li>
|
|
724
|
+
</ul>
|
|
693
725
|
<h2 id="userspace-config-overrides">Userspace Config Overrides</h2>
|
|
694
|
-
|
|
695
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:#66d9ef">logger</span>:
|
|
729
|
+
<span style="color:#66d9ef">log_level</span>: warn <span style="color:#75715e"># 0-5, or DEBUG < INFO < WARN < ERROR < FATAL < UNKNOWN</span>
|
|
730
|
+
<span style="color:#66d9ef">log_target</span>: stderr <span style="color:#75715e"># STDOUT, STDERR, or a file path</span>
|
|
731
|
+
</code></pre></div>
|
|
696
732
|
|
|
697
|
-
<
|
|
698
|
-
logger:
|
|
699
|
-
log_level: warn # 0-5, or DEBUG < INFO < WARN < ERROR < FATAL < UNKNOWN
|
|
700
|
-
log_target: stderr # STDOUT, STDERR, or a file path
|
|
701
|
-
</code></pre>
|
|
702
|
-
|
|
703
|
-
|
|
704
|
-
<footer class=" footline" >
|
|
733
|
+
<footer class="footline">
|
|
705
734
|
|
|
706
735
|
</footer>
|
|
707
736
|
|
|
708
|
-
|
|
709
737
|
|
|
710
738
|
</div>
|
|
711
739
|
|
|
@@ -1133,20 +1161,19 @@ logger:
|
|
|
1133
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;">
|
|
1134
1162
|
<div style="border: none; box-sizing: content-box; height: 200px; margin: 0px; padding: 0px; width: 200px;"></div>
|
|
1135
1163
|
</div>
|
|
1136
|
-
<script src="/rbcli/js/clipboard.min.js?
|
|
1137
|
-
<script src="/rbcli/js/perfect-scrollbar.min.js?
|
|
1138
|
-
<script src="/rbcli/js/perfect-scrollbar.jquery.min.js?
|
|
1139
|
-
<script src="/rbcli/js/jquery.sticky.js?
|
|
1140
|
-
<script src="/rbcli/js/featherlight.min.js?
|
|
1141
|
-
<script src="/rbcli/js/
|
|
1142
|
-
<script src="/rbcli/js/highlight.pack.js?1561087612"></script>
|
|
1164
|
+
<script src="/rbcli/js/clipboard.min.js?1596148729"></script>
|
|
1165
|
+
<script src="/rbcli/js/perfect-scrollbar.min.js?1596148729"></script>
|
|
1166
|
+
<script src="/rbcli/js/perfect-scrollbar.jquery.min.js?1596148729"></script>
|
|
1167
|
+
<script src="/rbcli/js/jquery.sticky.js?1596148729"></script>
|
|
1168
|
+
<script src="/rbcli/js/featherlight.min.js?1596148729"></script>
|
|
1169
|
+
<script src="/rbcli/js/highlight.pack.js?1596148729"></script>
|
|
1143
1170
|
<script>hljs.initHighlightingOnLoad();</script>
|
|
1144
|
-
<script src="/rbcli/js/modernizr.custom-3.6.0.js?
|
|
1145
|
-
<script src="/rbcli/js/learn.js?
|
|
1146
|
-
<script src="/rbcli/js/hugo-learn.js?
|
|
1171
|
+
<script src="/rbcli/js/modernizr.custom-3.6.0.js?1596148729"></script>
|
|
1172
|
+
<script src="/rbcli/js/learn.js?1596148729"></script>
|
|
1173
|
+
<script src="/rbcli/js/hugo-learn.js?1596148729"></script>
|
|
1147
1174
|
|
|
1148
|
-
<link href="/rbcli/mermaid/mermaid.css?
|
|
1149
|
-
<script src="/rbcli/mermaid/mermaid.js?
|
|
1175
|
+
<link href="/rbcli/mermaid/mermaid.css?1596148729" rel="stylesheet" />
|
|
1176
|
+
<script src="/rbcli/mermaid/mermaid.js?1596148729"></script>
|
|
1150
1177
|
<script>
|
|
1151
1178
|
mermaid.initialize({ startOnLoad: true });
|
|
1152
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.74.3" />
|
|
7
7
|
<meta name="description" content="">
|
|
8
8
|
|
|
9
9
|
|
|
@@ -12,20 +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?1596148729" rel="stylesheet">
|
|
16
|
+
<link href="/rbcli/css/fontawesome-all.min.css?1596148729" rel="stylesheet">
|
|
17
|
+
<link href="/rbcli/css/hybrid.css?1596148729" rel="stylesheet">
|
|
18
|
+
<link href="/rbcli/css/featherlight.min.css?1596148729" rel="stylesheet">
|
|
19
|
+
<link href="/rbcli/css/perfect-scrollbar.min.css?1596148729" rel="stylesheet">
|
|
20
|
+
<link href="/rbcli/css/auto-complete.css?1596148729" rel="stylesheet">
|
|
21
|
+
<link href="/rbcli/css/atom-one-dark-reasonable.css?1596148729" rel="stylesheet">
|
|
22
|
+
<link href="/rbcli/css/theme.css?1596148729" rel="stylesheet">
|
|
23
|
+
<link href="/rbcli/css/hugo-theme.css?1596148729" rel="stylesheet">
|
|
24
|
+
|
|
25
|
+
<link href="/rbcli/css/theme-blue.css?1596148729" rel="stylesheet">
|
|
24
26
|
|
|
25
|
-
<link href="/rbcli/css/theme-blue.css?1561087612" rel="stylesheet">
|
|
26
27
|
|
|
27
28
|
|
|
28
|
-
<script src="/rbcli/js/jquery-3.3.1.min.js?
|
|
29
|
+
<script src="/rbcli/js/jquery-3.3.1.min.js?1596148729"></script>
|
|
29
30
|
|
|
30
31
|
<style>
|
|
31
32
|
:root #header + #content > #left > #rlblock_left{
|
|
@@ -54,14 +55,14 @@
|
|
|
54
55
|
<span data-search-clear=""><i class="fas fa-times"></i></span>
|
|
55
56
|
</div>
|
|
56
57
|
|
|
57
|
-
<script type="text/javascript" src="/rbcli/js/lunr.min.js?
|
|
58
|
-
<script type="text/javascript" src="/rbcli/js/auto-complete.js?
|
|
58
|
+
<script type="text/javascript" src="/rbcli/js/lunr.min.js?1596148729"></script>
|
|
59
|
+
<script type="text/javascript" src="/rbcli/js/auto-complete.js?1596148729"></script>
|
|
59
60
|
<script type="text/javascript">
|
|
60
61
|
|
|
61
62
|
var baseurl = "https:\/\/akhoury6.github.io\/rbcli\/";
|
|
62
63
|
|
|
63
64
|
</script>
|
|
64
|
-
<script type="text/javascript" src="/rbcli/js/search.js?
|
|
65
|
+
<script type="text/javascript" src="/rbcli/js/search.js?1596148729"></script>
|
|
65
66
|
|
|
66
67
|
|
|
67
68
|
</div>
|
|
@@ -74,6 +75,8 @@
|
|
|
74
75
|
|
|
75
76
|
|
|
76
77
|
|
|
78
|
+
|
|
79
|
+
|
|
77
80
|
|
|
78
81
|
|
|
79
82
|
|
|
@@ -96,6 +99,8 @@
|
|
|
96
99
|
|
|
97
100
|
|
|
98
101
|
|
|
102
|
+
|
|
103
|
+
|
|
99
104
|
|
|
100
105
|
|
|
101
106
|
|
|
@@ -121,6 +126,8 @@
|
|
|
121
126
|
|
|
122
127
|
|
|
123
128
|
|
|
129
|
+
|
|
130
|
+
|
|
124
131
|
|
|
125
132
|
|
|
126
133
|
|
|
@@ -140,6 +147,8 @@
|
|
|
140
147
|
|
|
141
148
|
|
|
142
149
|
|
|
150
|
+
|
|
151
|
+
|
|
143
152
|
|
|
144
153
|
|
|
145
154
|
|
|
@@ -159,6 +168,8 @@
|
|
|
159
168
|
|
|
160
169
|
|
|
161
170
|
|
|
171
|
+
|
|
172
|
+
|
|
162
173
|
|
|
163
174
|
|
|
164
175
|
|
|
@@ -178,6 +189,8 @@
|
|
|
178
189
|
|
|
179
190
|
|
|
180
191
|
|
|
192
|
+
|
|
193
|
+
|
|
181
194
|
|
|
182
195
|
|
|
183
196
|
|
|
@@ -197,6 +210,8 @@
|
|
|
197
210
|
|
|
198
211
|
|
|
199
212
|
|
|
213
|
+
|
|
214
|
+
|
|
200
215
|
|
|
201
216
|
|
|
202
217
|
|
|
@@ -223,6 +238,8 @@
|
|
|
223
238
|
|
|
224
239
|
|
|
225
240
|
|
|
241
|
+
|
|
242
|
+
|
|
226
243
|
|
|
227
244
|
|
|
228
245
|
|
|
@@ -248,6 +265,8 @@
|
|
|
248
265
|
|
|
249
266
|
|
|
250
267
|
|
|
268
|
+
|
|
269
|
+
|
|
251
270
|
|
|
252
271
|
|
|
253
272
|
|
|
@@ -267,6 +286,8 @@
|
|
|
267
286
|
|
|
268
287
|
|
|
269
288
|
|
|
289
|
+
|
|
290
|
+
|
|
270
291
|
|
|
271
292
|
|
|
272
293
|
|
|
@@ -286,6 +307,8 @@
|
|
|
286
307
|
|
|
287
308
|
|
|
288
309
|
|
|
310
|
+
|
|
311
|
+
|
|
289
312
|
|
|
290
313
|
|
|
291
314
|
|
|
@@ -305,6 +328,8 @@
|
|
|
305
328
|
|
|
306
329
|
|
|
307
330
|
|
|
331
|
+
|
|
332
|
+
|
|
308
333
|
|
|
309
334
|
|
|
310
335
|
|
|
@@ -324,6 +349,8 @@
|
|
|
324
349
|
|
|
325
350
|
|
|
326
351
|
|
|
352
|
+
|
|
353
|
+
|
|
327
354
|
|
|
328
355
|
|
|
329
356
|
|
|
@@ -343,6 +370,8 @@
|
|
|
343
370
|
|
|
344
371
|
|
|
345
372
|
|
|
373
|
+
|
|
374
|
+
|
|
346
375
|
|
|
347
376
|
|
|
348
377
|
|
|
@@ -362,6 +391,8 @@
|
|
|
362
391
|
|
|
363
392
|
|
|
364
393
|
|
|
394
|
+
|
|
395
|
+
|
|
365
396
|
|
|
366
397
|
|
|
367
398
|
|
|
@@ -381,6 +412,8 @@
|
|
|
381
412
|
|
|
382
413
|
|
|
383
414
|
|
|
415
|
+
|
|
416
|
+
|
|
384
417
|
|
|
385
418
|
|
|
386
419
|
|
|
@@ -400,6 +433,8 @@
|
|
|
400
433
|
|
|
401
434
|
|
|
402
435
|
|
|
436
|
+
|
|
437
|
+
|
|
403
438
|
|
|
404
439
|
|
|
405
440
|
|
|
@@ -426,6 +461,8 @@
|
|
|
426
461
|
|
|
427
462
|
|
|
428
463
|
|
|
464
|
+
|
|
465
|
+
|
|
429
466
|
|
|
430
467
|
|
|
431
468
|
|
|
@@ -451,6 +488,8 @@
|
|
|
451
488
|
|
|
452
489
|
|
|
453
490
|
|
|
491
|
+
|
|
492
|
+
|
|
454
493
|
|
|
455
494
|
|
|
456
495
|
|
|
@@ -470,6 +509,8 @@
|
|
|
470
509
|
|
|
471
510
|
|
|
472
511
|
|
|
512
|
+
|
|
513
|
+
|
|
473
514
|
|
|
474
515
|
|
|
475
516
|
|
|
@@ -489,6 +530,8 @@
|
|
|
489
530
|
|
|
490
531
|
|
|
491
532
|
|
|
533
|
+
|
|
534
|
+
|
|
492
535
|
|
|
493
536
|
|
|
494
537
|
|
|
@@ -508,6 +551,8 @@
|
|
|
508
551
|
|
|
509
552
|
|
|
510
553
|
|
|
554
|
+
|
|
555
|
+
|
|
511
556
|
|
|
512
557
|
|
|
513
558
|
|
|
@@ -534,6 +579,8 @@
|
|
|
534
579
|
|
|
535
580
|
|
|
536
581
|
|
|
582
|
+
|
|
583
|
+
|
|
537
584
|
|
|
538
585
|
|
|
539
586
|
|
|
@@ -585,7 +632,6 @@
|
|
|
585
632
|
|
|
586
633
|
|
|
587
634
|
|
|
588
|
-
|
|
589
635
|
<section id="body">
|
|
590
636
|
<div id="overlay"></div>
|
|
591
637
|
<div class="padding highlightable">
|
|
@@ -619,9 +665,9 @@
|
|
|
619
665
|
|
|
620
666
|
<a href='/rbcli/'></a> > <a href='/rbcli/advanced/'>Advanced</a> > Remote Execution
|
|
621
667
|
|
|
622
|
-
|
|
668
|
+
|
|
623
669
|
|
|
624
|
-
|
|
670
|
+
|
|
625
671
|
|
|
626
672
|
|
|
627
673
|
|
|
@@ -631,13 +677,10 @@
|
|
|
631
677
|
<div class="progress">
|
|
632
678
|
<div class="wrapper">
|
|
633
679
|
<nav id="TableOfContents">
|
|
634
|
-
<ul>
|
|
635
|
-
<li>
|
|
636
|
-
<
|
|
637
|
-
|
|
638
|
-
<li><a href="#usage">Usage</a></li>
|
|
639
|
-
</ul></li>
|
|
640
|
-
</ul>
|
|
680
|
+
<ul>
|
|
681
|
+
<li><a href="#configuration">Configuration</a></li>
|
|
682
|
+
<li><a href="#usage">Usage</a></li>
|
|
683
|
+
</ul>
|
|
641
684
|
</nav>
|
|
642
685
|
</div>
|
|
643
686
|
</div>
|
|
@@ -661,65 +704,42 @@
|
|
|
661
704
|
|
|
662
705
|
|
|
663
706
|
|
|
664
|
-
|
|
665
|
-
|
|
666
|
-
|
|
667
707
|
<p>RBCli can be configured to execute commands on a remote machine via SSH instead of locally.</p>
|
|
668
|
-
|
|
669
708
|
<p>Currently, only <code>script</code> and <code>extern</code> commands are supported.</p>
|
|
670
|
-
|
|
671
709
|
<h2 id="configuration">Configuration</h2>
|
|
672
|
-
|
|
673
710
|
<p>To allow remote execution, go to <code>config/general.rb</code> and change the following line to <code>true</code>:</p>
|
|
674
|
-
|
|
675
|
-
|
|
676
|
-
|
|
677
|
-
|
|
678
|
-
<p>Then, for each command that you would like to enable remote execution for, add the following directive to the command class declaration:</p>
|
|
679
|
-
|
|
680
|
-
<pre><code class="language-ruby">remote_permitted
|
|
681
|
-
</code></pre>
|
|
682
|
-
|
|
683
|
-
<h2 id="usage">Usage</h2>
|
|
684
|
-
|
|
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>
|
|
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
|
|
714
|
+
</code></pre></div><h2 id="usage">Usage</h2>
|
|
685
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>
|
|
686
|
-
|
|
687
|
-
<
|
|
688
|
-
|
|
689
|
-
|
|
690
|
-
|
|
691
|
-
|
|
692
|
-
<p>Some valid examples are:</p>
|
|
693
|
-
|
|
694
|
-
<pre><code class="language-bash">mytool -r example.com -i myPassword showuserfiles -u MyUser
|
|
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>
|
|
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> <command>
|
|
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
|
|
695
721
|
mytool -r root@server.local -i ~/.ssh/id_rsa update
|
|
696
722
|
mytool -r admin@172.16.0.1:2202 -i ~/.ssh/mykey cleartemp
|
|
697
|
-
</code></pre>
|
|
698
|
-
|
|
699
|
-
<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>
|
|
700
|
-
|
|
701
|
-
<pre><code class="language-bash">$ mytool -h
|
|
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
|
|
702
725
|
A simple command line tool.
|
|
703
|
-
For more information on individual commands, run
|
|
726
|
+
For more information on individual commands, run <span style="color:#e6db74">`</span>mytool <command> -h<span style="color:#e6db74">`</span>.
|
|
704
727
|
|
|
705
728
|
Usage:
|
|
706
|
-
foo [options] command [parameters]
|
|
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>
|
|
707
730
|
|
|
708
731
|
Commands:
|
|
709
732
|
bar TODO: Description goes here
|
|
710
733
|
* baz TODO: Description goes here
|
|
711
734
|
|
|
712
735
|
...
|
|
713
|
-
</code></pre>
|
|
736
|
+
</code></pre></div><p>In this example, the command <code>baz</code> is available for remote execution</p>
|
|
714
737
|
|
|
715
|
-
<p>In this example, the command <code>baz</code> is available for remote execution</p>
|
|
716
738
|
|
|
717
|
-
|
|
718
|
-
<footer class=" footline" >
|
|
739
|
+
<footer class="footline">
|
|
719
740
|
|
|
720
741
|
</footer>
|
|
721
742
|
|
|
722
|
-
|
|
723
743
|
|
|
724
744
|
</div>
|
|
725
745
|
|
|
@@ -1147,20 +1167,19 @@ Commands:
|
|
|
1147
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;">
|
|
1148
1168
|
<div style="border: none; box-sizing: content-box; height: 200px; margin: 0px; padding: 0px; width: 200px;"></div>
|
|
1149
1169
|
</div>
|
|
1150
|
-
<script src="/rbcli/js/clipboard.min.js?
|
|
1151
|
-
<script src="/rbcli/js/perfect-scrollbar.min.js?
|
|
1152
|
-
<script src="/rbcli/js/perfect-scrollbar.jquery.min.js?
|
|
1153
|
-
<script src="/rbcli/js/jquery.sticky.js?
|
|
1154
|
-
<script src="/rbcli/js/featherlight.min.js?
|
|
1155
|
-
<script src="/rbcli/js/
|
|
1156
|
-
<script src="/rbcli/js/highlight.pack.js?1561087612"></script>
|
|
1170
|
+
<script src="/rbcli/js/clipboard.min.js?1596148729"></script>
|
|
1171
|
+
<script src="/rbcli/js/perfect-scrollbar.min.js?1596148729"></script>
|
|
1172
|
+
<script src="/rbcli/js/perfect-scrollbar.jquery.min.js?1596148729"></script>
|
|
1173
|
+
<script src="/rbcli/js/jquery.sticky.js?1596148729"></script>
|
|
1174
|
+
<script src="/rbcli/js/featherlight.min.js?1596148729"></script>
|
|
1175
|
+
<script src="/rbcli/js/highlight.pack.js?1596148729"></script>
|
|
1157
1176
|
<script>hljs.initHighlightingOnLoad();</script>
|
|
1158
|
-
<script src="/rbcli/js/modernizr.custom-3.6.0.js?
|
|
1159
|
-
<script src="/rbcli/js/learn.js?
|
|
1160
|
-
<script src="/rbcli/js/hugo-learn.js?
|
|
1177
|
+
<script src="/rbcli/js/modernizr.custom-3.6.0.js?1596148729"></script>
|
|
1178
|
+
<script src="/rbcli/js/learn.js?1596148729"></script>
|
|
1179
|
+
<script src="/rbcli/js/hugo-learn.js?1596148729"></script>
|
|
1161
1180
|
|
|
1162
|
-
<link href="/rbcli/mermaid/mermaid.css?
|
|
1163
|
-
<script src="/rbcli/mermaid/mermaid.js?
|
|
1181
|
+
<link href="/rbcli/mermaid/mermaid.css?1596148729" rel="stylesheet" />
|
|
1182
|
+
<script src="/rbcli/mermaid/mermaid.js?1596148729"></script>
|
|
1164
1183
|
<script>
|
|
1165
1184
|
mermaid.initialize({ startOnLoad: true });
|
|
1166
1185
|
</script>
|