rbcli 0.3.2 → 0.3.3
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +12 -0
- data/Gemfile.lock +19 -5
- data/docs/404.html +9 -9
- data/docs/advanced/automatic_updates/index.html +30 -30
- data/docs/advanced/command_types/index.html +78 -78
- data/docs/advanced/distributed_state_locking/index.html +30 -30
- data/docs/advanced/hooks/index.html +42 -42
- data/docs/advanced/index.html +27 -27
- data/docs/advanced/index.xml +12 -50
- data/docs/advanced/interactive_commands/index.html +35 -35
- data/docs/advanced/logging/index.html +36 -36
- data/docs/advanced/remote_execution/index.html +51 -51
- data/docs/advanced/state_storage/index.html +34 -34
- data/docs/advanced/user_config_files/index.html +30 -30
- data/docs/categories/index.html +27 -27
- data/docs/categories/index.xml +3 -2
- data/docs/development/changelog/index.html +91 -60
- data/docs/development/code_of_conduct/index.html +27 -27
- data/docs/development/contributing/index.html +40 -40
- data/docs/development/index.html +27 -27
- data/docs/development/index.xml +6 -16
- data/docs/development/license/index.html +26 -26
- data/docs/index.html +26 -26
- data/docs/index.json +15 -15
- data/docs/index.xml +20 -90
- data/docs/quick_reference/index.html +54 -54
- data/docs/quick_reference/index.xml +3 -2
- data/docs/sitemap.xml +0 -1
- data/docs/tags/index.html +27 -27
- data/docs/tags/index.xml +3 -2
- data/docs/tutorial/10-getting_started/index.html +33 -33
- data/docs/tutorial/20-project_layout/index.html +55 -55
- data/docs/tutorial/30-your_first_command/index.html +90 -90
- data/docs/tutorial/40-options_parameters_and_arguments/index.html +167 -167
- data/docs/tutorial/50-publishing/index.html +30 -30
- data/docs/tutorial/index.html +27 -27
- data/docs/tutorial/index.xml +8 -28
- data/docs/whoami/index.html +28 -28
- data/docs/whoami/index.xml +3 -2
- data/docs-src/.hugo_build.lock +0 -0
- data/docs-src/content/development/changelog.md +20 -0
- data/docs-src/makesite.sh +4 -4
- data/lib/rbcli/engine/command.rb +1 -1
- data/lib/rbcli/engine/parser.rb +9 -7
- data/lib/rbcli/util/optimist.rb +1063 -0
- data/lib/rbcli/version.rb +1 -1
- data/lib/rbcli-tool/util.rb +1 -1
- data/rbcli.gemspec +7 -3
- data/skeletons/micro/executable +6 -1
- data/skeletons/mini/executable +6 -1
- data/skeletons/project/untitled.gemspec +4 -4
- metadata +9 -8
- data/lib/rbcli/util/trollop.rb +0 -1050
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 311cc2ee8071d0215510745a5e3556a1df74624ea1ed488bf9c4b533cba7e5ff
|
|
4
|
+
data.tar.gz: c7e956dbffb760f247d23d05550b28f95bfe9af3cee73613f8279e2a407e4959
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 8f7520427ae2c8f8966994174fa5942b4b3fa71e52b6a4f1386e3e0188ec991fe69b6bd37798aa44381ad36fd6f7a1551c755b0729755a9676c151be8f70be27
|
|
7
|
+
data.tar.gz: d7dc70b3ebad0ff9978a6a937489902a9ca74a62816f019833abb3e218b3699f898c76a69c3fd32010b6460802a7cabb59b693f62a6625243527aba82880b662
|
data/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,17 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## 0.3.3 (April 24, 2024)
|
|
4
|
+
|
|
5
|
+
### Improvements
|
|
6
|
+
* Tested with Ruby 3.3.0
|
|
7
|
+
* Updated dependencies for Ruby 3.3.0
|
|
8
|
+
* Updated dependnecies for Sekeleton projects
|
|
9
|
+
* Added a `bundler/inline` gemfile on mini and micro skeleton projects to simplify their use
|
|
10
|
+
* Replaced deprecated Trollop gem with its replacement, [ManageIQ/Optimist](https://github.com/ManageIQ/optimist)
|
|
11
|
+
|
|
12
|
+
### Bugfixes
|
|
13
|
+
* Updated deprecated ERB call for skeleton generation to use new format
|
|
14
|
+
|
|
3
15
|
## 0.3.2 (October 28, 2023)
|
|
4
16
|
|
|
5
17
|
### Bugfixes
|
data/Gemfile.lock
CHANGED
|
@@ -1,15 +1,15 @@
|
|
|
1
1
|
PATH
|
|
2
2
|
remote: .
|
|
3
3
|
specs:
|
|
4
|
-
rbcli (0.3.
|
|
4
|
+
rbcli (0.3.3)
|
|
5
5
|
aws-sdk-dynamodb (~> 1)
|
|
6
6
|
colorize (~> 1)
|
|
7
7
|
deep_merge (~> 1)
|
|
8
8
|
macaddr (~> 1)
|
|
9
|
-
mdless (~>
|
|
9
|
+
mdless (~> 2)
|
|
10
10
|
net-scp (~> 4)
|
|
11
11
|
net-ssh (~> 7)
|
|
12
|
-
octokit (~>
|
|
12
|
+
octokit (~> 8)
|
|
13
13
|
rufus-scheduler (~> 3)
|
|
14
14
|
|
|
15
15
|
GEM
|
|
@@ -46,16 +46,24 @@ GEM
|
|
|
46
46
|
jmespath (1.6.2)
|
|
47
47
|
macaddr (1.7.2)
|
|
48
48
|
systemu (~> 2.6.5)
|
|
49
|
-
mdless (1.
|
|
49
|
+
mdless (2.1.42)
|
|
50
|
+
redcarpet (~> 3.6)
|
|
51
|
+
rouge (~> 4.2)
|
|
52
|
+
tty-screen (~> 0.8)
|
|
53
|
+
tty-spinner (~> 0.8)
|
|
54
|
+
tty-which (~> 0.5)
|
|
50
55
|
net-scp (4.0.0)
|
|
51
56
|
net-ssh (>= 2.6.5, < 8.0.0)
|
|
52
57
|
net-ssh (7.2.0)
|
|
53
|
-
octokit (
|
|
58
|
+
octokit (8.1.0)
|
|
59
|
+
base64
|
|
54
60
|
faraday (>= 1, < 3)
|
|
55
61
|
sawyer (~> 0.9)
|
|
56
62
|
public_suffix (5.0.3)
|
|
57
63
|
raabro (1.4.0)
|
|
58
64
|
rake (13.0.6)
|
|
65
|
+
redcarpet (3.6.0)
|
|
66
|
+
rouge (4.2.1)
|
|
59
67
|
ruby2_keywords (0.0.5)
|
|
60
68
|
rufus-scheduler (3.9.1)
|
|
61
69
|
fugit (~> 1.1, >= 1.1.6)
|
|
@@ -63,10 +71,16 @@ GEM
|
|
|
63
71
|
addressable (>= 2.3.5)
|
|
64
72
|
faraday (>= 0.17.3, < 3)
|
|
65
73
|
systemu (2.6.5)
|
|
74
|
+
tty-cursor (0.7.1)
|
|
75
|
+
tty-screen (0.8.2)
|
|
76
|
+
tty-spinner (0.9.3)
|
|
77
|
+
tty-cursor (~> 0.7)
|
|
78
|
+
tty-which (0.5.0)
|
|
66
79
|
tzinfo (2.0.6)
|
|
67
80
|
concurrent-ruby (~> 1.0)
|
|
68
81
|
|
|
69
82
|
PLATFORMS
|
|
83
|
+
arm64-darwin-23
|
|
70
84
|
x86_64-darwin-23
|
|
71
85
|
|
|
72
86
|
DEPENDENCIES
|
data/docs/404.html
CHANGED
|
@@ -9,15 +9,15 @@
|
|
|
9
9
|
<title>404 Page not found</title>
|
|
10
10
|
|
|
11
11
|
|
|
12
|
-
<link href="/rbcli/css/nucleus.css?
|
|
13
|
-
<link href="/rbcli/css/fontawesome-all.min.css?
|
|
14
|
-
<link href="/rbcli/css/hybrid.css?
|
|
15
|
-
<link href="/rbcli/css/featherlight.min.css?
|
|
16
|
-
<link href="/rbcli/css/perfect-scrollbar.min.css?
|
|
17
|
-
<link href="/rbcli/css/theme.css?
|
|
18
|
-
<link href="/rbcli/css/hugo-theme.css?
|
|
12
|
+
<link href="/rbcli/css/nucleus.css?1713907739" rel="stylesheet">
|
|
13
|
+
<link href="/rbcli/css/fontawesome-all.min.css?1713907739" rel="stylesheet">
|
|
14
|
+
<link href="/rbcli/css/hybrid.css?1713907739" rel="stylesheet">
|
|
15
|
+
<link href="/rbcli/css/featherlight.min.css?1713907739" rel="stylesheet">
|
|
16
|
+
<link href="/rbcli/css/perfect-scrollbar.min.css?1713907739" rel="stylesheet">
|
|
17
|
+
<link href="/rbcli/css/theme.css?1713907739" rel="stylesheet">
|
|
18
|
+
<link href="/rbcli/css/hugo-theme.css?1713907739" rel="stylesheet">
|
|
19
19
|
|
|
20
|
-
<link href="/rbcli/css/theme-blue.css?
|
|
20
|
+
<link href="/rbcli/css/theme-blue.css?1713907739" rel="stylesheet">
|
|
21
21
|
|
|
22
22
|
<style>
|
|
23
23
|
:root #header + #content > #left > #rlblock_left {
|
|
@@ -49,7 +49,7 @@
|
|
|
49
49
|
<p>Woops. Looks like this page doesn't exist ¯\_(ツ)_/¯.</p>
|
|
50
50
|
<p></p>
|
|
51
51
|
<p><a href='/rbcli/'>Go to homepage</a></p>
|
|
52
|
-
<p><img src='/
|
|
52
|
+
<p><img src='/images/gopher-404.jpg' style="width:50%" alt="Page not found!"></p>
|
|
53
53
|
</div>
|
|
54
54
|
</div>
|
|
55
55
|
|
|
@@ -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.125.1">
|
|
7
7
|
<meta name="description" content="">
|
|
8
8
|
|
|
9
9
|
|
|
@@ -12,21 +12,21 @@
|
|
|
12
12
|
<title>Automatic Updates :: 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?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?
|
|
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?
|
|
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?
|
|
59
|
-
<script type="text/javascript" src="/rbcli/js/auto-complete.js?
|
|
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?
|
|
65
|
+
<script type="text/javascript" src="/rbcli/js/search.js?1713907739"></script>
|
|
66
66
|
|
|
67
67
|
|
|
68
68
|
</div>
|
|
@@ -709,16 +709,16 @@
|
|
|
709
709
|
<h2 id="github-update-check">GitHub Update Check</h2>
|
|
710
710
|
<p>The GitHub update check works best when paired with GitHub’s best practices on releases, where new releases are tagged on master with the format <strong>vX.X.X</strong>. See <a href="https://help.github.com/articles/creating-releases/">Github’s release documentation</a> to learn more.</p>
|
|
711
711
|
<p>RBCli will check your github repo’s tags and compare that version number with one specified in your application at <code>config/version.rb</code>.</p>
|
|
712
|
-
<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-ruby" data-lang="ruby">autoupdate <span style="color:#e6db74">github_repo</span>: <span style="color:#e6db74">'<your_user>/<your_repo>'</span>, <span style="color:#e6db74">access_token</span>: <span style="color:#66d9ef">nil</span>, <span style="color:#e6db74">enterprise_hostname</span>: <span style="color:#66d9ef">nil</span>, <span style="color:#e6db74">force_update</span>: <span style="color:#66d9ef">false</span>, <span style="color:#e6db74">message</span>: <span style="color:#66d9ef">nil</span>
|
|
713
|
-
</code></pre></div><p>The <code>github_repo</code> should point to the repo using the <code>user/repo</code> syntax.</p>
|
|
712
|
+
<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-ruby" data-lang="ruby"><span style="display:flex;"><span>autoupdate <span style="color:#e6db74">github_repo</span>: <span style="color:#e6db74">'<your_user>/<your_repo>'</span>, <span style="color:#e6db74">access_token</span>: <span style="color:#66d9ef">nil</span>, <span style="color:#e6db74">enterprise_hostname</span>: <span style="color:#66d9ef">nil</span>, <span style="color:#e6db74">force_update</span>: <span style="color:#66d9ef">false</span>, <span style="color:#e6db74">message</span>: <span style="color:#66d9ef">nil</span>
|
|
713
|
+
</span></span></code></pre></div><p>The <code>github_repo</code> should point to the repo using the <code>user/repo</code> syntax.</p>
|
|
714
714
|
<p>The <code>access_token</code> can be overridden by the user via their config file, so it can be left as <code>nil</code> if you enable <a href="/rbcli/advanced/user_config_files/">Userspace Configuration</a>. The token is not needed at all if using a public repo. For instructions on generating a new access token, see <a href="https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/">here</a>.</p>
|
|
715
715
|
<p>The <code>enterprise_hostname</code> setting allows you to point RBCli at a local GitHub Enterprise server.</p>
|
|
716
716
|
<p>Setting <code>force_update: true</code> will halt execution if an update is available, forcing the user to update.</p>
|
|
717
717
|
<p>The <code>message</code> parameter allows setting a custom message that will be displayed when an update is available. Leaving it as <code>nil</code> will use the default message provided by RBCli.</p>
|
|
718
718
|
<h2 id="rubygemsorg-update-check">Rubygems.org Update Check</h2>
|
|
719
719
|
<p>The Rubygems update check will check if there is a new published version of the gem on Rubygems.org. The latest published version is compared to the version number you configured RBCli with.</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-ruby" data-lang="ruby">autoupdate <span style="color:#e6db74">gem</span>: <span style="color:#e6db74">'<your_gem>'</span>, <span style="color:#e6db74">force_update</span>: <span style="color:#66d9ef">false</span>, <span style="color:#e6db74">message</span>: <span style="color:#66d9ef">nil</span>
|
|
721
|
-
</code></pre></div><p>The <code>gem</code> parameter should simply state the name of the gem.</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-ruby" data-lang="ruby"><span style="display:flex;"><span>autoupdate <span style="color:#e6db74">gem</span>: <span style="color:#e6db74">'<your_gem>'</span>, <span style="color:#e6db74">force_update</span>: <span style="color:#66d9ef">false</span>, <span style="color:#e6db74">message</span>: <span style="color:#66d9ef">nil</span>
|
|
721
|
+
</span></span></code></pre></div><p>The <code>gem</code> parameter should simply state the name of the gem.</p>
|
|
722
722
|
<p>Setting <code>force_update: true</code> will halt execution if an update is available, forcing the user to update.</p>
|
|
723
723
|
<p>The <code>message</code> parameter allows setting a custom message that will be displayed when an update is available. Leaving it as <code>nil</code> will use the default message provided by RBCli.</p>
|
|
724
724
|
|
|
@@ -1151,19 +1151,19 @@
|
|
|
1151
1151
|
<div style="left: -1000px; overflow: scroll; position: absolute; top: -1000px; border: none; box-sizing: content-box; height: 200px; margin: 0px; padding: 0px; width: 200px;">
|
|
1152
1152
|
<div style="border: none; box-sizing: content-box; height: 200px; margin: 0px; padding: 0px; width: 200px;"></div>
|
|
1153
1153
|
</div>
|
|
1154
|
-
<script src="/rbcli/js/clipboard.min.js?
|
|
1155
|
-
<script src="/rbcli/js/perfect-scrollbar.min.js?
|
|
1156
|
-
<script src="/rbcli/js/perfect-scrollbar.jquery.min.js?
|
|
1157
|
-
<script src="/rbcli/js/jquery.sticky.js?
|
|
1158
|
-
<script src="/rbcli/js/featherlight.min.js?
|
|
1159
|
-
<script src="/rbcli/js/highlight.pack.js?
|
|
1154
|
+
<script src="/rbcli/js/clipboard.min.js?1713907739"></script>
|
|
1155
|
+
<script src="/rbcli/js/perfect-scrollbar.min.js?1713907739"></script>
|
|
1156
|
+
<script src="/rbcli/js/perfect-scrollbar.jquery.min.js?1713907739"></script>
|
|
1157
|
+
<script src="/rbcli/js/jquery.sticky.js?1713907739"></script>
|
|
1158
|
+
<script src="/rbcli/js/featherlight.min.js?1713907739"></script>
|
|
1159
|
+
<script src="/rbcli/js/highlight.pack.js?1713907739"></script>
|
|
1160
1160
|
<script>hljs.initHighlightingOnLoad();</script>
|
|
1161
|
-
<script src="/rbcli/js/modernizr.custom-3.6.0.js?
|
|
1162
|
-
<script src="/rbcli/js/learn.js?
|
|
1163
|
-
<script src="/rbcli/js/hugo-learn.js?
|
|
1161
|
+
<script src="/rbcli/js/modernizr.custom-3.6.0.js?1713907739"></script>
|
|
1162
|
+
<script src="/rbcli/js/learn.js?1713907739"></script>
|
|
1163
|
+
<script src="/rbcli/js/hugo-learn.js?1713907739"></script>
|
|
1164
1164
|
|
|
1165
|
-
<link href="/rbcli/mermaid/mermaid.css?
|
|
1166
|
-
<script src="/rbcli/mermaid/mermaid.js?
|
|
1165
|
+
<link href="/rbcli/mermaid/mermaid.css?1713907739" rel="stylesheet" />
|
|
1166
|
+
<script src="/rbcli/mermaid/mermaid.js?1713907739"></script>
|
|
1167
1167
|
<script>
|
|
1168
1168
|
mermaid.initialize({ startOnLoad: true });
|
|
1169
1169
|
</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.125.1">
|
|
7
7
|
<meta name="description" content="">
|
|
8
8
|
|
|
9
9
|
|
|
@@ -12,21 +12,21 @@
|
|
|
12
12
|
<title>Command Types :: 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?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?
|
|
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?
|
|
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?
|
|
59
|
-
<script type="text/javascript" src="/rbcli/js/auto-complete.js?
|
|
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?
|
|
65
|
+
<script type="text/javascript" src="/rbcli/js/search.js?1713907739"></script>
|
|
66
66
|
|
|
67
67
|
|
|
68
68
|
</div>
|
|
@@ -720,17 +720,17 @@
|
|
|
720
720
|
<p>This document is provided to be a reference. If you would like an in-depth tutorial, please see <a href="/rbcli/tutorial/30-your_first_command/">Your First Command</a>.</p>
|
|
721
721
|
<h2 id="general-command-structure">General Command Structure</h2>
|
|
722
722
|
<p>Commands in RBCli are created by subclassing <code>Rbcli::Command</code>. All commands share a certain common structure:</p>
|
|
723
|
-
<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">List</span> <span style="color:#f92672"><</span> <span style="color:#66d9ef">Rbcli</span><span style="color:#f92672">::</span><span style="color:#66d9ef">Command</span> <span style="color:#75715e"># Declare a new command by subclassing Rbcli::Command</span>
|
|
724
|
-
description <span style="color:#e6db74">'TODO: Description goes here'</span> <span style="color:#75715e"># (Required) Short description for the global help</span>
|
|
725
|
-
usage <span style="color:#e6db74"><<-EOF
|
|
726
|
-
</span><span style="color:#e6db74"></span><span style="color:#e6db74">TODO</span>: <span style="color:#66d9ef">Usage</span> text goes here
|
|
727
|
-
|
|
728
|
-
parameter <span style="color:#e6db74">:force</span>, <span style="color:#e6db74">'Force testing'</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">required</span>: <span style="color:#66d9ef">false</span> <span style="color:#75715e"># (Optional, Multiple) Add a command-specific CLI parameter. Can be called multiple times</span>
|
|
729
|
-
|
|
730
|
-
config_default <span style="color:#e6db74">:myopt2</span>, <span style="color:#e6db74">description</span>: <span style="color:#e6db74">'My Option #2'</span>, <span style="color:#e6db74">default</span>: <span style="color:#e6db74">'Default Value Here'</span> <span style="color:#75715e"># (Optional, Multiple) Specify an individual configuration parameter and set a default value. These will also be included in generated user config.</span>
|
|
731
|
-
<span style="color:#75715e"># Alternatively, you can simply create a yaml file in the `default_user_configs` directory in your project that specifies the default values of all options</span>
|
|
732
|
-
|
|
733
|
-
</code></pre></div><ul>
|
|
723
|
+
<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-ruby" data-lang="ruby"><span style="display:flex;"><span><span style="color:#66d9ef">class</span> <span style="color:#a6e22e">List</span> <span style="color:#f92672"><</span> <span style="color:#66d9ef">Rbcli</span><span style="color:#f92672">::</span><span style="color:#66d9ef">Command</span> <span style="color:#75715e"># Declare a new command by subclassing Rbcli::Command</span>
|
|
724
|
+
</span></span><span style="display:flex;"><span> description <span style="color:#e6db74">'TODO: Description goes here'</span> <span style="color:#75715e"># (Required) Short description for the global help</span>
|
|
725
|
+
</span></span><span style="display:flex;"><span> usage <span style="color:#e6db74"><<-EOF
|
|
726
|
+
</span></span></span><span style="display:flex;"><span><span style="color:#e6db74"></span><span style="color:#e6db74">TODO</span>: <span style="color:#66d9ef">Usage</span> text goes here
|
|
727
|
+
</span></span><span style="display:flex;"><span><span style="color:#66d9ef">EOF</span> <span style="color:#75715e"># (Required) Long description for the command-specific help</span>
|
|
728
|
+
</span></span><span style="display:flex;"><span> parameter <span style="color:#e6db74">:force</span>, <span style="color:#e6db74">'Force testing'</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">required</span>: <span style="color:#66d9ef">false</span> <span style="color:#75715e"># (Optional, Multiple) Add a command-specific CLI parameter. Can be called multiple times</span>
|
|
729
|
+
</span></span><span style="display:flex;"><span>
|
|
730
|
+
</span></span><span style="display:flex;"><span> config_default <span style="color:#e6db74">:myopt2</span>, <span style="color:#e6db74">description</span>: <span style="color:#e6db74">'My Option #2'</span>, <span style="color:#e6db74">default</span>: <span style="color:#e6db74">'Default Value Here'</span> <span style="color:#75715e"># (Optional, Multiple) Specify an individual configuration parameter and set a default value. These will also be included in generated user config.</span>
|
|
731
|
+
</span></span><span style="display:flex;"><span> <span style="color:#75715e"># Alternatively, you can simply create a yaml file in the `default_user_configs` directory in your project that specifies the default values of all options</span>
|
|
732
|
+
</span></span><span style="display:flex;"><span><span style="color:#66d9ef">end</span>
|
|
733
|
+
</span></span></code></pre></div><ul>
|
|
734
734
|
<li><code>description</code>
|
|
735
735
|
<ul>
|
|
736
736
|
<li>A short description of the command, which will appear in the top-level help (when the user runs <code>mytool -h</code>).</li>
|
|
@@ -754,58 +754,58 @@
|
|
|
754
754
|
</ul>
|
|
755
755
|
<h2 id="standard-commands">Standard Commands</h2>
|
|
756
756
|
<p>Standard commands are written as ruby code. To create a standard command called <code>list</code>, run:</p>
|
|
757
|
-
<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 command --name<span style="color:#f92672">=</span>list
|
|
758
|
-
|
|
759
|
-
rbcli command -n list
|
|
760
|
-
</code></pre></div><p>A standard command can be identified by the presence of an <code>action</code> block in the definition:</p>
|
|
761
|
-
<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">List</span> <span style="color:#f92672"><</span> <span style="color:#66d9ef">Rbcli</span><span style="color:#f92672">::</span><span style="color:#66d9ef">Command</span>
|
|
762
|
-
action <span style="color:#66d9ef">do</span> <span style="color:#f92672">|</span>params, args, global_opts, config<span style="color:#f92672">|</span>
|
|
763
|
-
<span style="color:#75715e"># Code goes here</span>
|
|
764
|
-
<span style="color:#66d9ef">end</span>
|
|
765
|
-
|
|
766
|
-
</code></pre></div><p>Your application’s <strong>parameters</strong>, <strong>arguments</strong>, <strong>options</strong>, and <strong>config</strong> are available in the variables passed into the block. For more information on these, see <a href="/rbcli/tutorial/40-options_parameters_and_arguments/">Options, Parameters, and Arguments</a>.</p>
|
|
757
|
+
<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>rbcli command --name<span style="color:#f92672">=</span>list
|
|
758
|
+
</span></span><span style="display:flex;"><span><span style="color:#75715e">#or</span>
|
|
759
|
+
</span></span><span style="display:flex;"><span>rbcli command -n list
|
|
760
|
+
</span></span></code></pre></div><p>A standard command can be identified by the presence of an <code>action</code> block in the definition:</p>
|
|
761
|
+
<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-ruby" data-lang="ruby"><span style="display:flex;"><span><span style="color:#66d9ef">class</span> <span style="color:#a6e22e">List</span> <span style="color:#f92672"><</span> <span style="color:#66d9ef">Rbcli</span><span style="color:#f92672">::</span><span style="color:#66d9ef">Command</span>
|
|
762
|
+
</span></span><span style="display:flex;"><span> action <span style="color:#66d9ef">do</span> <span style="color:#f92672">|</span>params, args, global_opts, config<span style="color:#f92672">|</span>
|
|
763
|
+
</span></span><span style="display:flex;"><span> <span style="color:#75715e"># Code goes here</span>
|
|
764
|
+
</span></span><span style="display:flex;"><span> <span style="color:#66d9ef">end</span>
|
|
765
|
+
</span></span><span style="display:flex;"><span><span style="color:#66d9ef">end</span>
|
|
766
|
+
</span></span></code></pre></div><p>Your application’s <strong>parameters</strong>, <strong>arguments</strong>, <strong>options</strong>, and <strong>config</strong> are available in the variables passed into the block. For more information on these, see <a href="/rbcli/tutorial/40-options_parameters_and_arguments/">Options, Parameters, and Arguments</a>.</p>
|
|
767
767
|
<h2 id="scripted-commands">Scripted Commands</h2>
|
|
768
768
|
<p>Scripted commands are part Ruby, part Bash scripting. They are a good choice to use if you feel something might be easier or more performant to script with Bash, or if you already have a Bash script you’d like to use in your project. You can create one with:</p>
|
|
769
|
-
<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 script -n list
|
|
770
|
-
</code></pre></div><p>This will create two files in your RBCli project: a Ruby file with the common command declaration (see <a href="#general-command-structure">General Command Structure</a>), and a bash script in the folder <code>application/commands/scripts/</code>.</p>
|
|
769
|
+
<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>rbcli script -n list
|
|
770
|
+
</span></span></code></pre></div><p>This will create two files in your RBCli project: a Ruby file with the common command declaration (see <a href="#general-command-structure">General Command Structure</a>), and a bash script in the folder <code>application/commands/scripts/</code>.</p>
|
|
771
771
|
<p>You can tell a command is a script by the line:</p>
|
|
772
|
-
<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">List</span> <span style="color:#f92672"><</span> <span style="color:#66d9ef">Rbcli</span><span style="color:#f92672">::</span><span style="color:#66d9ef">Command</span>
|
|
773
|
-
script
|
|
774
|
-
|
|
775
|
-
</code></pre></div><p>RBCli will pass along your applications config and CLI parameters through JSON environment variables. To make things easy, a Bash library is provided that makes retrieving and parsing these variables easy. It is already imported when you generate the command, with the line:</p>
|
|
776
|
-
<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">source <span style="color:#66d9ef">$(</span>echo <span style="color:#66d9ef">$(</span>cd <span style="color:#e6db74">"</span><span style="color:#66d9ef">$(</span>dirname <span style="color:#66d9ef">$(</span>gem which rbcli<span style="color:#66d9ef">))</span><span style="color:#e6db74">/../lib-sh"</span> <span style="color:#f92672">&&</span> pwd<span style="color:#66d9ef">)</span>/lib-rbcli.sh<span style="color:#66d9ef">)</span>
|
|
777
|
-
</code></pre></div><p>This will find the library which is stored on the system as part of the RBCli gem.</p>
|
|
772
|
+
<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-ruby" data-lang="ruby"><span style="display:flex;"><span><span style="color:#66d9ef">class</span> <span style="color:#a6e22e">List</span> <span style="color:#f92672"><</span> <span style="color:#66d9ef">Rbcli</span><span style="color:#f92672">::</span><span style="color:#66d9ef">Command</span>
|
|
773
|
+
</span></span><span style="display:flex;"><span> script
|
|
774
|
+
</span></span><span style="display:flex;"><span><span style="color:#66d9ef">end</span>
|
|
775
|
+
</span></span></code></pre></div><p>RBCli will pass along your applications config and CLI parameters through JSON environment variables. To make things easy, a Bash library is provided that makes retrieving and parsing these variables easy. It is already imported when you generate the command, with the line:</p>
|
|
776
|
+
<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>source <span style="color:#66d9ef">$(</span>echo <span style="color:#66d9ef">$(</span>cd <span style="color:#e6db74">"</span><span style="color:#66d9ef">$(</span>dirname <span style="color:#66d9ef">$(</span>gem which rbcli<span style="color:#66d9ef">))</span><span style="color:#e6db74">/../lib-sh"</span> <span style="color:#f92672">&&</span> pwd<span style="color:#66d9ef">)</span>/lib-rbcli.sh<span style="color:#66d9ef">)</span>
|
|
777
|
+
</span></span></code></pre></div><p>This will find the library which is stored on the system as part of the RBCli gem.</p>
|
|
778
778
|
<p>You can then retrieve the values present in your variables like such:</p>
|
|
779
|
-
<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 params
|
|
780
|
-
rbcli args
|
|
781
|
-
rbcli global_opts
|
|
782
|
-
rbcli config
|
|
783
|
-
rbcli myvars
|
|
784
|
-
|
|
785
|
-
echo <span style="color:#e6db74">"Usage Examples:"</span>
|
|
786
|
-
echo <span style="color:#e6db74">"Log Level: </span><span style="color:#66d9ef">$(</span>rbcli config .logger.log_level<span style="color:#66d9ef">)</span><span style="color:#e6db74">"</span>
|
|
787
|
-
echo <span style="color:#e6db74">"Log Target: </span><span style="color:#66d9ef">$(</span>rbcli config .logger.log_target<span style="color:#66d9ef">)</span><span style="color:#e6db74">"</span>
|
|
788
|
-
echo <span style="color:#e6db74">"First Argument (if passed): </span><span style="color:#66d9ef">$(</span>rbcli args .<span style="color:#f92672">[</span>0<span style="color:#f92672">]</span><span style="color:#66d9ef">)</span><span style="color:#e6db74">"</span>
|
|
789
|
-
</code></pre></div><p>For your convenience, the script will have all the instructions needed there. For more instructions on how to use JQ syntax to parse values, see the <a href="https://stedolan.github.io/jq/manual/">JQ documentation</a>.</p>
|
|
779
|
+
<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>rbcli params
|
|
780
|
+
</span></span><span style="display:flex;"><span>rbcli args
|
|
781
|
+
</span></span><span style="display:flex;"><span>rbcli global_opts
|
|
782
|
+
</span></span><span style="display:flex;"><span>rbcli config
|
|
783
|
+
</span></span><span style="display:flex;"><span>rbcli myvars
|
|
784
|
+
</span></span><span style="display:flex;"><span>
|
|
785
|
+
</span></span><span style="display:flex;"><span>echo <span style="color:#e6db74">"Usage Examples:"</span>
|
|
786
|
+
</span></span><span style="display:flex;"><span>echo <span style="color:#e6db74">"Log Level: </span><span style="color:#66d9ef">$(</span>rbcli config .logger.log_level<span style="color:#66d9ef">)</span><span style="color:#e6db74">"</span>
|
|
787
|
+
</span></span><span style="display:flex;"><span>echo <span style="color:#e6db74">"Log Target: </span><span style="color:#66d9ef">$(</span>rbcli config .logger.log_target<span style="color:#66d9ef">)</span><span style="color:#e6db74">"</span>
|
|
788
|
+
</span></span><span style="display:flex;"><span>echo <span style="color:#e6db74">"First Argument (if passed): </span><span style="color:#66d9ef">$(</span>rbcli args .<span style="color:#f92672">[</span>0<span style="color:#f92672">]</span><span style="color:#66d9ef">)</span><span style="color:#e6db74">"</span>
|
|
789
|
+
</span></span></code></pre></div><p>For your convenience, the script will have all the instructions needed there. For more instructions on how to use JQ syntax to parse values, see the <a href="https://stedolan.github.io/jq/manual/">JQ documentation</a>.</p>
|
|
790
790
|
<h2 id="external-commands">External Commands</h2>
|
|
791
791
|
<p>External Commands are used to wrap 3rd party applications. RBCli accomplishes this by allowing you to set environment variables and command line parameters based on your input variables.</p>
|
|
792
792
|
<p>RBCli provides this feature through the <code>extern</code> keyword. It provides two modes – <strong>direct path</strong> and <strong>variable path</strong> – which work similarly.</p>
|
|
793
793
|
<h3 id="direct-path-mode">Direct Path Mode</h3>
|
|
794
794
|
<p>Direct path mode is the simpler mode of the two External Command modes. It allows you to provide a specific command with environment variables set, though it does not allow using RBCli parameters, arguments, options, and config.</p>
|
|
795
|
-
<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">List</span> <span style="color:#f92672"><</span> <span style="color:#66d9ef">Rbcli</span><span style="color:#f92672">::</span><span style="color:#66d9ef">Command</span>
|
|
796
|
-
|
|
797
|
-
|
|
798
|
-
</code></pre></div><p>Here, we supply a string to run the command. We can optioanlly provide environment variables which will be set for the external application.</p>
|
|
795
|
+
<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-ruby" data-lang="ruby"><span style="display:flex;"><span><span style="color:#66d9ef">class</span> <span style="color:#a6e22e">List</span> <span style="color:#f92672"><</span> <span style="color:#66d9ef">Rbcli</span><span style="color:#f92672">::</span><span style="color:#66d9ef">Command</span>
|
|
796
|
+
</span></span><span style="display:flex;"><span> extern <span style="color:#e6db74">path</span>: <span style="color:#e6db74">'path/to/application'</span>, <span style="color:#e6db74">envvars</span>: {<span style="color:#e6db74">MYVAR</span>: <span style="color:#e6db74">'some_value'</span>} <span style="color:#75715e"># (Required) Runs a given application, with optional environment variables, when the user runs the command.</span>
|
|
797
|
+
</span></span><span style="display:flex;"><span><span style="color:#66d9ef">end</span>
|
|
798
|
+
</span></span></code></pre></div><p>Here, we supply a string to run the command. We can optioanlly provide environment variables which will be set for the external application.</p>
|
|
799
799
|
<h3 id="variable-path-mode">Variable Path Mode</h3>
|
|
800
800
|
<p>Variable Path mode works the same as Direct Path Mode, only instead of providing a string we provide a block that returns a string (which will be the command executed). This allows us to generate different commands based on the CLI parameters that the user passed, or pass configuration as CLI parameters to the external application:</p>
|
|
801
|
-
<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">Test</span> <span style="color:#f92672"><</span> <span style="color:#66d9ef">Rbcli</span><span style="color:#f92672">::</span><span style="color:#66d9ef">Command</span>
|
|
802
|
-
extern <span style="color:#e6db74">envvars</span>: {<span style="color:#e6db74">MY_OTHER_VAR</span>: <span style="color:#e6db74">'another_value'</span>} <span style="color:#66d9ef">do</span> <span style="color:#f92672">|</span>params, args, global_opts, config<span style="color:#f92672">|</span> <span style="color:#75715e"># Alternate usage. Supplying a block instead of a path allows us to modify the command based on the arguments and configuration supplied by the user. This allows passing config settings as command line arguments to external applications. The block must return a string, which is the command to be executed.</span>
|
|
803
|
-
cmd <span style="color:#f92672">=</span> <span style="color:#e6db74">'/path/to/application'</span>
|
|
804
|
-
cmd <span style="color:#f92672">+=</span> <span style="color:#e6db74">' --test-script foo --ignore-errors'</span> <span style="color:#66d9ef">if</span> params<span style="color:#f92672">[</span><span style="color:#e6db74">:force</span><span style="color:#f92672">]</span>
|
|
805
|
-
cmd
|
|
806
|
-
<span style="color:#66d9ef">end</span>
|
|
807
|
-
|
|
808
|
-
</code></pre></div><p><strong>NOTE</strong>: Passing user-supplied data as part of the command string may be a security risk (example: <code>/path/to/application --name #{params[:name]}</code>). It is highly recommended to provide the fixed strings yourself, and only select which strings are used based on the variables provided. This is demonstrated in the example above.</p>
|
|
801
|
+
<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-ruby" data-lang="ruby"><span style="display:flex;"><span><span style="color:#66d9ef">class</span> <span style="color:#a6e22e">Test</span> <span style="color:#f92672"><</span> <span style="color:#66d9ef">Rbcli</span><span style="color:#f92672">::</span><span style="color:#66d9ef">Command</span>
|
|
802
|
+
</span></span><span style="display:flex;"><span> extern <span style="color:#e6db74">envvars</span>: {<span style="color:#e6db74">MY_OTHER_VAR</span>: <span style="color:#e6db74">'another_value'</span>} <span style="color:#66d9ef">do</span> <span style="color:#f92672">|</span>params, args, global_opts, config<span style="color:#f92672">|</span> <span style="color:#75715e"># Alternate usage. Supplying a block instead of a path allows us to modify the command based on the arguments and configuration supplied by the user. This allows passing config settings as command line arguments to external applications. The block must return a string, which is the command to be executed.</span>
|
|
803
|
+
</span></span><span style="display:flex;"><span> cmd <span style="color:#f92672">=</span> <span style="color:#e6db74">'/path/to/application'</span>
|
|
804
|
+
</span></span><span style="display:flex;"><span> cmd <span style="color:#f92672">+=</span> <span style="color:#e6db74">' --test-script foo --ignore-errors'</span> <span style="color:#66d9ef">if</span> params<span style="color:#f92672">[</span><span style="color:#e6db74">:force</span><span style="color:#f92672">]</span>
|
|
805
|
+
</span></span><span style="display:flex;"><span> cmd
|
|
806
|
+
</span></span><span style="display:flex;"><span> <span style="color:#66d9ef">end</span>
|
|
807
|
+
</span></span><span style="display:flex;"><span><span style="color:#66d9ef">end</span>
|
|
808
|
+
</span></span></code></pre></div><p><strong>NOTE</strong>: Passing user-supplied data as part of the command string may be a security risk (example: <code>/path/to/application --name #{params[:name]}</code>). It is highly recommended to provide the fixed strings yourself, and only select which strings are used based on the variables provided. This is demonstrated in the example above.</p>
|
|
809
809
|
|
|
810
810
|
|
|
811
811
|
<footer class="footline">
|
|
@@ -1239,19 +1239,19 @@ echo <span style="color:#e6db74">"First Argument (if passed): </span><span s
|
|
|
1239
1239
|
<div style="left: -1000px; overflow: scroll; position: absolute; top: -1000px; border: none; box-sizing: content-box; height: 200px; margin: 0px; padding: 0px; width: 200px;">
|
|
1240
1240
|
<div style="border: none; box-sizing: content-box; height: 200px; margin: 0px; padding: 0px; width: 200px;"></div>
|
|
1241
1241
|
</div>
|
|
1242
|
-
<script src="/rbcli/js/clipboard.min.js?
|
|
1243
|
-
<script src="/rbcli/js/perfect-scrollbar.min.js?
|
|
1244
|
-
<script src="/rbcli/js/perfect-scrollbar.jquery.min.js?
|
|
1245
|
-
<script src="/rbcli/js/jquery.sticky.js?
|
|
1246
|
-
<script src="/rbcli/js/featherlight.min.js?
|
|
1247
|
-
<script src="/rbcli/js/highlight.pack.js?
|
|
1242
|
+
<script src="/rbcli/js/clipboard.min.js?1713907739"></script>
|
|
1243
|
+
<script src="/rbcli/js/perfect-scrollbar.min.js?1713907739"></script>
|
|
1244
|
+
<script src="/rbcli/js/perfect-scrollbar.jquery.min.js?1713907739"></script>
|
|
1245
|
+
<script src="/rbcli/js/jquery.sticky.js?1713907739"></script>
|
|
1246
|
+
<script src="/rbcli/js/featherlight.min.js?1713907739"></script>
|
|
1247
|
+
<script src="/rbcli/js/highlight.pack.js?1713907739"></script>
|
|
1248
1248
|
<script>hljs.initHighlightingOnLoad();</script>
|
|
1249
|
-
<script src="/rbcli/js/modernizr.custom-3.6.0.js?
|
|
1250
|
-
<script src="/rbcli/js/learn.js?
|
|
1251
|
-
<script src="/rbcli/js/hugo-learn.js?
|
|
1249
|
+
<script src="/rbcli/js/modernizr.custom-3.6.0.js?1713907739"></script>
|
|
1250
|
+
<script src="/rbcli/js/learn.js?1713907739"></script>
|
|
1251
|
+
<script src="/rbcli/js/hugo-learn.js?1713907739"></script>
|
|
1252
1252
|
|
|
1253
|
-
<link href="/rbcli/mermaid/mermaid.css?
|
|
1254
|
-
<script src="/rbcli/mermaid/mermaid.js?
|
|
1253
|
+
<link href="/rbcli/mermaid/mermaid.css?1713907739" rel="stylesheet" />
|
|
1254
|
+
<script src="/rbcli/mermaid/mermaid.js?1713907739"></script>
|
|
1255
1255
|
<script>
|
|
1256
1256
|
mermaid.initialize({ startOnLoad: true });
|
|
1257
1257
|
</script>
|