rbcli 0.3.0 → 0.3.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +9 -0
- data/Gemfile.lock +43 -25
- 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/lib/rbcli/engine/command.rb +2 -1
- data/lib/rbcli/version.rb +1 -1
- data/rbcli.gemspec +4 -4
- data/skeletons/project/application/commands/scripts/script.sh +6 -1
- data/skeletons/project/untitled.gemspec +3 -3
- metadata +14 -14
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 2b09f31e66da303b96ae807e17c69e324485ad53f8c9fde04ed525f766e9a79b
|
|
4
|
+
data.tar.gz: 76002def4a6b65dc5de898ce50e4a1c307999d4170560c7267d89289d3bc4dff
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 660f735a38b1e19d1123a98f48b907a2c3a51a8b181787d5967f98a0e30abe6573bb331aea652630ad65972e979ca4bc0566062308f52a027cc789b7e2eff60c
|
|
7
|
+
data.tar.gz: 80f40fc851e6dd94b1422db62590824d0e7cc4151172d4f35ccacebd03f5515cd2c1207520d4bfd9c7535d862c3a6db2fd92caaaf2526e3da160addba5f4d413
|
data/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,14 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## 0.3.1 (October 19, 2021)
|
|
4
|
+
|
|
5
|
+
### Bugfixes
|
|
6
|
+
|
|
7
|
+
* Fixed prompt for option value to ignore nil defaults instead of displaying an empty string
|
|
8
|
+
* Skeleton script command `script.sh` updated to function correctly when development mode is enabled
|
|
9
|
+
* Updated Github Pages links to point to `github.io` instead of `github.com` which are being deprecated
|
|
10
|
+
* Updated dependencies, closing the security hole of the gem `addressable <= 1.7.0`
|
|
11
|
+
|
|
3
12
|
## 0.3 (July 31, 2020)
|
|
4
13
|
|
|
5
14
|
### Improvements
|
data/Gemfile.lock
CHANGED
|
@@ -1,74 +1,92 @@
|
|
|
1
1
|
PATH
|
|
2
2
|
remote: .
|
|
3
3
|
specs:
|
|
4
|
-
rbcli (0.3.
|
|
5
|
-
aws-sdk-dynamodb (~> 1.
|
|
4
|
+
rbcli (0.3.1)
|
|
5
|
+
aws-sdk-dynamodb (~> 1.64)
|
|
6
6
|
colorize (~> 0.8)
|
|
7
7
|
deep_merge (~> 1.2)
|
|
8
8
|
macaddr (~> 1.7)
|
|
9
9
|
mdless (~> 1.0)
|
|
10
10
|
net-scp (~> 3.0)
|
|
11
11
|
net-ssh (~> 6.1)
|
|
12
|
-
octokit (~> 4.
|
|
13
|
-
rufus-scheduler (~> 3.
|
|
12
|
+
octokit (~> 4.21)
|
|
13
|
+
rufus-scheduler (~> 3.8)
|
|
14
14
|
|
|
15
15
|
GEM
|
|
16
16
|
remote: https://rubygems.org/
|
|
17
17
|
specs:
|
|
18
|
-
addressable (2.
|
|
18
|
+
addressable (2.8.0)
|
|
19
19
|
public_suffix (>= 2.0.2, < 5.0)
|
|
20
|
-
aws-eventstream (1.
|
|
21
|
-
aws-partitions (1.
|
|
22
|
-
aws-sdk-core (3.
|
|
20
|
+
aws-eventstream (1.2.0)
|
|
21
|
+
aws-partitions (1.516.0)
|
|
22
|
+
aws-sdk-core (3.121.2)
|
|
23
23
|
aws-eventstream (~> 1, >= 1.0.2)
|
|
24
24
|
aws-partitions (~> 1, >= 1.239.0)
|
|
25
25
|
aws-sigv4 (~> 1.1)
|
|
26
26
|
jmespath (~> 1.0)
|
|
27
|
-
aws-sdk-dynamodb (1.
|
|
28
|
-
aws-sdk-core (~> 3, >= 3.
|
|
27
|
+
aws-sdk-dynamodb (1.64.0)
|
|
28
|
+
aws-sdk-core (~> 3, >= 3.121.2)
|
|
29
29
|
aws-sigv4 (~> 1.1)
|
|
30
|
-
aws-sigv4 (1.
|
|
30
|
+
aws-sigv4 (1.4.0)
|
|
31
31
|
aws-eventstream (~> 1, >= 1.0.2)
|
|
32
32
|
colorize (0.8.1)
|
|
33
|
+
concurrent-ruby (1.1.9)
|
|
33
34
|
deep_merge (1.2.1)
|
|
34
|
-
et-orbi (1.2.
|
|
35
|
+
et-orbi (1.2.5)
|
|
35
36
|
tzinfo
|
|
36
|
-
faraday (1.0
|
|
37
|
+
faraday (1.8.0)
|
|
38
|
+
faraday-em_http (~> 1.0)
|
|
39
|
+
faraday-em_synchrony (~> 1.0)
|
|
40
|
+
faraday-excon (~> 1.1)
|
|
41
|
+
faraday-httpclient (~> 1.0.1)
|
|
42
|
+
faraday-net_http (~> 1.0)
|
|
43
|
+
faraday-net_http_persistent (~> 1.1)
|
|
44
|
+
faraday-patron (~> 1.0)
|
|
45
|
+
faraday-rack (~> 1.0)
|
|
37
46
|
multipart-post (>= 1.2, < 3)
|
|
38
|
-
|
|
47
|
+
ruby2_keywords (>= 0.0.4)
|
|
48
|
+
faraday-em_http (1.0.0)
|
|
49
|
+
faraday-em_synchrony (1.0.0)
|
|
50
|
+
faraday-excon (1.1.0)
|
|
51
|
+
faraday-httpclient (1.0.1)
|
|
52
|
+
faraday-net_http (1.0.1)
|
|
53
|
+
faraday-net_http_persistent (1.2.0)
|
|
54
|
+
faraday-patron (1.0.0)
|
|
55
|
+
faraday-rack (1.0.0)
|
|
56
|
+
fugit (1.5.2)
|
|
39
57
|
et-orbi (~> 1.1, >= 1.1.8)
|
|
40
|
-
raabro (~> 1.
|
|
58
|
+
raabro (~> 1.4)
|
|
41
59
|
jmespath (1.4.0)
|
|
42
60
|
macaddr (1.7.2)
|
|
43
61
|
systemu (~> 2.6.5)
|
|
44
|
-
mdless (1.0.
|
|
62
|
+
mdless (1.0.27)
|
|
45
63
|
multipart-post (2.1.1)
|
|
46
64
|
net-scp (3.0.0)
|
|
47
65
|
net-ssh (>= 2.6.5, < 7.0.0)
|
|
48
66
|
net-ssh (6.1.0)
|
|
49
|
-
octokit (4.
|
|
67
|
+
octokit (4.21.0)
|
|
50
68
|
faraday (>= 0.9)
|
|
51
69
|
sawyer (~> 0.8.0, >= 0.5.3)
|
|
52
|
-
public_suffix (4.0.
|
|
53
|
-
raabro (1.
|
|
70
|
+
public_suffix (4.0.6)
|
|
71
|
+
raabro (1.4.0)
|
|
54
72
|
rake (13.0.1)
|
|
55
|
-
|
|
73
|
+
ruby2_keywords (0.0.5)
|
|
74
|
+
rufus-scheduler (3.8.0)
|
|
56
75
|
fugit (~> 1.1, >= 1.1.6)
|
|
57
76
|
sawyer (0.8.2)
|
|
58
77
|
addressable (>= 2.3.5)
|
|
59
78
|
faraday (> 0.8, < 2.0)
|
|
60
79
|
systemu (2.6.5)
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
thread_safe (~> 0.1)
|
|
80
|
+
tzinfo (2.0.4)
|
|
81
|
+
concurrent-ruby (~> 1.0)
|
|
64
82
|
|
|
65
83
|
PLATFORMS
|
|
66
84
|
ruby
|
|
67
85
|
|
|
68
86
|
DEPENDENCIES
|
|
69
|
-
bundler (~> 2.
|
|
87
|
+
bundler (~> 2.2)
|
|
70
88
|
rake (~> 13.0)
|
|
71
89
|
rbcli!
|
|
72
90
|
|
|
73
91
|
BUNDLED WITH
|
|
74
|
-
2.
|
|
92
|
+
2.2.29
|
data/README.md
CHANGED
|
@@ -216,8 +216,8 @@ The gem is available as open source under the terms of the [GPLv3][license_text]
|
|
|
216
216
|
[You can find the Official Documentation for RBCli Here.][documentation_home]
|
|
217
217
|
|
|
218
218
|
|
|
219
|
-
[documentation_home]: https://akhoury6.github.
|
|
220
|
-
[documentation_development]: https://akhoury6.github.
|
|
219
|
+
[documentation_home]: https://akhoury6.github.io/rbcli
|
|
220
|
+
[documentation_development]: https://akhoury6.github.io/rbcli/development/contributing/
|
|
221
221
|
[documentation_whoami]: https://akhoury6.github.io/rbcli/whoami/
|
|
222
222
|
[license_text]: https://github.com/akhoury6/rbcli/blob/master/LICENSE.txt
|
|
223
223
|
[changelog]: https://github.com/akhoury6/rbcli/blob/master/CHANGELOG.md
|
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?1634703589" rel="stylesheet">
|
|
13
|
+
<link href="/rbcli/css/fontawesome-all.min.css?1634703589" rel="stylesheet">
|
|
14
|
+
<link href="/rbcli/css/hybrid.css?1634703589" rel="stylesheet">
|
|
15
|
+
<link href="/rbcli/css/featherlight.min.css?1634703589" rel="stylesheet">
|
|
16
|
+
<link href="/rbcli/css/perfect-scrollbar.min.css?1634703589" rel="stylesheet">
|
|
17
|
+
<link href="/rbcli/css/theme.css?1634703589" rel="stylesheet">
|
|
18
|
+
<link href="/rbcli/css/hugo-theme.css?1634703589" rel="stylesheet">
|
|
19
19
|
|
|
20
|
-
<link href="/rbcli/css/theme-blue.css?
|
|
20
|
+
<link href="/rbcli/css/theme-blue.css?1634703589" rel="stylesheet">
|
|
21
21
|
|
|
22
22
|
<style>
|
|
23
23
|
:root #header + #content > #left > #rlblock_left {
|
|
@@ -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>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?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,7 +709,7 @@
|
|
|
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 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>
|
|
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
713
|
</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>
|
|
@@ -717,7 +717,7 @@
|
|
|
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 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>
|
|
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
721
|
</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>
|
|
@@ -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?1634703589"></script>
|
|
1155
|
+
<script src="/rbcli/js/perfect-scrollbar.min.js?1634703589"></script>
|
|
1156
|
+
<script src="/rbcli/js/perfect-scrollbar.jquery.min.js?1634703589"></script>
|
|
1157
|
+
<script src="/rbcli/js/jquery.sticky.js?1634703589"></script>
|
|
1158
|
+
<script src="/rbcli/js/featherlight.min.js?1634703589"></script>
|
|
1159
|
+
<script src="/rbcli/js/highlight.pack.js?1634703589"></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?1634703589"></script>
|
|
1162
|
+
<script src="/rbcli/js/learn.js?1634703589"></script>
|
|
1163
|
+
<script src="/rbcli/js/hugo-learn.js?1634703589"></script>
|
|
1164
1164
|
|
|
1165
|
-
<link href="/rbcli/mermaid/mermaid.css?
|
|
1166
|
-
<script src="/rbcli/mermaid/mermaid.js?
|
|
1165
|
+
<link href="/rbcli/mermaid/mermaid.css?1634703589" rel="stylesheet" />
|
|
1166
|
+
<script src="/rbcli/mermaid/mermaid.js?1634703589"></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.88.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?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>
|
|
@@ -720,7 +720,7 @@
|
|
|
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 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>
|
|
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
724
|
description <span style="color:#e6db74">'TODO: Description goes here'</span> <span style="color:#75715e"># (Required) Short description for the global help</span>
|
|
725
725
|
usage <span style="color:#e6db74"><<-EOF
|
|
726
726
|
</span><span style="color:#e6db74"></span><span style="color:#e6db74">TODO</span>: <span style="color:#66d9ef">Usage</span> text goes here
|
|
@@ -754,11 +754,11 @@
|
|
|
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 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
|
|
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
758
|
<span style="color:#75715e">#or</span>
|
|
759
759
|
rbcli command -n list
|
|
760
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 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>
|
|
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
762
|
action <span style="color:#66d9ef">do</span> <span style="color:#f92672">|</span>params, args, global_opts, config<span style="color:#f92672">|</span>
|
|
763
763
|
<span style="color:#75715e"># Code goes here</span>
|
|
764
764
|
<span style="color:#66d9ef">end</span>
|
|
@@ -766,17 +766,17 @@ rbcli command -n list
|
|
|
766
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>
|
|
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 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
|
|
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
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>
|
|
771
771
|
<p>You can tell a command is a script by the line:</p>
|
|
772
|
-
<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">List</span> <span style="color:#f92672"><</span> <span style="color:#66d9ef">Rbcli</span><span style="color:#f92672">::</span><span style="color:#66d9ef">Command</span>
|
|
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
773
|
script
|
|
774
774
|
<span style="color:#66d9ef">end</span>
|
|
775
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 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>
|
|
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
777
|
</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 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
|
|
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
780
|
rbcli args
|
|
781
781
|
rbcli global_opts
|
|
782
782
|
rbcli config
|
|
@@ -792,13 +792,13 @@ echo <span style="color:#e6db74">"First Argument (if passed): </span><span s
|
|
|
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 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>
|
|
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
796
|
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
797
|
<span style="color:#66d9ef">end</span>
|
|
798
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>
|
|
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 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>
|
|
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
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
803
|
cmd <span style="color:#f92672">=</span> <span style="color:#e6db74">'/path/to/application'</span>
|
|
804
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>
|
|
@@ -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?1634703589"></script>
|
|
1243
|
+
<script src="/rbcli/js/perfect-scrollbar.min.js?1634703589"></script>
|
|
1244
|
+
<script src="/rbcli/js/perfect-scrollbar.jquery.min.js?1634703589"></script>
|
|
1245
|
+
<script src="/rbcli/js/jquery.sticky.js?1634703589"></script>
|
|
1246
|
+
<script src="/rbcli/js/featherlight.min.js?1634703589"></script>
|
|
1247
|
+
<script src="/rbcli/js/highlight.pack.js?1634703589"></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?1634703589"></script>
|
|
1250
|
+
<script src="/rbcli/js/learn.js?1634703589"></script>
|
|
1251
|
+
<script src="/rbcli/js/hugo-learn.js?1634703589"></script>
|
|
1252
1252
|
|
|
1253
|
-
<link href="/rbcli/mermaid/mermaid.css?
|
|
1254
|
-
<script src="/rbcli/mermaid/mermaid.js?
|
|
1253
|
+
<link href="/rbcli/mermaid/mermaid.css?1634703589" rel="stylesheet" />
|
|
1254
|
+
<script src="/rbcli/mermaid/mermaid.js?1634703589"></script>
|
|
1255
1255
|
<script>
|
|
1256
1256
|
mermaid.initialize({ startOnLoad: true });
|
|
1257
1257
|
</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>Distributed State and Locking :: 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>
|
|
@@ -716,9 +716,9 @@
|
|
|
716
716
|
</ol>
|
|
717
717
|
<h2 id="manual-locking">Manual Locking</h2>
|
|
718
718
|
<p>Remember: all state in Rbcli is lazy-loaded. Therefore, RBCli wll only attempt to lock the data when you first try to access it. If you need to make sure that the data is locked before executing a block of code, use:</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-ruby" data-lang="ruby"><span style="color:#66d9ef">Rbcli</span><span style="color:#f92672">.</span>remote_state<span style="color:#f92672">.</span>refresh
|
|
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-ruby" data-lang="ruby"><span style="color:#66d9ef">Rbcli</span><span style="color:#f92672">.</span>remote_state<span style="color:#f92672">.</span>refresh
|
|
720
720
|
</code></pre></div><p>to force the lock and retrieve the latest data. You can force an unlock by calling:</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-ruby" data-lang="ruby"><span style="color:#66d9ef">Rbcli</span><span style="color:#f92672">.</span>remote_state<span style="color:#f92672">.</span>disconnect
|
|
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-ruby" data-lang="ruby"><span style="color:#66d9ef">Rbcli</span><span style="color:#f92672">.</span>remote_state<span style="color:#f92672">.</span>disconnect
|
|
722
722
|
</code></pre></div><p>Even if you do not want to store any data, you can leverage manual locking to control access to a different shared resource, such as a stateful API. For example, if you write a cloud deployment toolkit, you can ensure that only one user is attempting to modify a deployment at any given time.</p>
|
|
723
723
|
|
|
724
724
|
|
|
@@ -1153,19 +1153,19 @@
|
|
|
1153
1153
|
<div style="left: -1000px; overflow: scroll; position: absolute; top: -1000px; border: none; box-sizing: content-box; height: 200px; margin: 0px; padding: 0px; width: 200px;">
|
|
1154
1154
|
<div style="border: none; box-sizing: content-box; height: 200px; margin: 0px; padding: 0px; width: 200px;"></div>
|
|
1155
1155
|
</div>
|
|
1156
|
-
<script src="/rbcli/js/clipboard.min.js?
|
|
1157
|
-
<script src="/rbcli/js/perfect-scrollbar.min.js?
|
|
1158
|
-
<script src="/rbcli/js/perfect-scrollbar.jquery.min.js?
|
|
1159
|
-
<script src="/rbcli/js/jquery.sticky.js?
|
|
1160
|
-
<script src="/rbcli/js/featherlight.min.js?
|
|
1161
|
-
<script src="/rbcli/js/highlight.pack.js?
|
|
1156
|
+
<script src="/rbcli/js/clipboard.min.js?1634703589"></script>
|
|
1157
|
+
<script src="/rbcli/js/perfect-scrollbar.min.js?1634703589"></script>
|
|
1158
|
+
<script src="/rbcli/js/perfect-scrollbar.jquery.min.js?1634703589"></script>
|
|
1159
|
+
<script src="/rbcli/js/jquery.sticky.js?1634703589"></script>
|
|
1160
|
+
<script src="/rbcli/js/featherlight.min.js?1634703589"></script>
|
|
1161
|
+
<script src="/rbcli/js/highlight.pack.js?1634703589"></script>
|
|
1162
1162
|
<script>hljs.initHighlightingOnLoad();</script>
|
|
1163
|
-
<script src="/rbcli/js/modernizr.custom-3.6.0.js?
|
|
1164
|
-
<script src="/rbcli/js/learn.js?
|
|
1165
|
-
<script src="/rbcli/js/hugo-learn.js?
|
|
1163
|
+
<script src="/rbcli/js/modernizr.custom-3.6.0.js?1634703589"></script>
|
|
1164
|
+
<script src="/rbcli/js/learn.js?1634703589"></script>
|
|
1165
|
+
<script src="/rbcli/js/hugo-learn.js?1634703589"></script>
|
|
1166
1166
|
|
|
1167
|
-
<link href="/rbcli/mermaid/mermaid.css?
|
|
1168
|
-
<script src="/rbcli/mermaid/mermaid.js?
|
|
1167
|
+
<link href="/rbcli/mermaid/mermaid.css?1634703589" rel="stylesheet" />
|
|
1168
|
+
<script src="/rbcli/mermaid/mermaid.js?1634703589"></script>
|
|
1169
1169
|
<script>
|
|
1170
1170
|
mermaid.initialize({ startOnLoad: true });
|
|
1171
1171
|
</script>
|