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
data/docs/index.xml
CHANGED
|
@@ -4,205 +4,135 @@
|
|
|
4
4
|
<title>RBCli Documentation</title>
|
|
5
5
|
<link>https://akhoury6.github.io/rbcli/</link>
|
|
6
6
|
<description>Recent content on RBCli Documentation</description>
|
|
7
|
-
<generator>Hugo
|
|
7
|
+
<generator>Hugo 0.125.1</generator>
|
|
8
8
|
<language>en-us</language>
|
|
9
|
-
<lastBuildDate>Thu, 20 Jun 2019 15:
|
|
9
|
+
<lastBuildDate>Thu, 20 Jun 2019 15:07:21 -0400</lastBuildDate>
|
|
10
|
+
<atom:link href="https://akhoury6.github.io/rbcli/index.xml" rel="self" type="application/rss+xml" />
|
|
10
11
|
<item>
|
|
11
12
|
<title>Contribution Guide</title>
|
|
12
13
|
<link>https://akhoury6.github.io/rbcli/development/contributing/</link>
|
|
13
14
|
<pubDate>Thu, 20 Jun 2019 15:07:21 -0400</pubDate>
|
|
14
|
-
|
|
15
15
|
<guid>https://akhoury6.github.io/rbcli/development/contributing/</guid>
|
|
16
|
-
<description>Contributing to RBCli is the same as most open source projects
|
|
17
|
-
Fork the repository Create your own branch Submit a pull request when ready That&rsquo;s all there is to it! We&rsquo;ve also kept our acceptance criteria pretty simple, as you&rsquo;ll see below. Feel free to submit a pull request even if you don&rsquo;t meet it if you would like your code or feature to be reviewed first; we do want to be mindful of your time and will review submissions before they are polished.</description>
|
|
16
|
+
<description>Contributing to RBCli is the same as most open source projects:
Fork the repository Create your own branch Submit a pull request when ready That&rsquo;s all there is to it! We&rsquo;ve also kept our acceptance criteria pretty simple, as you&rsquo;ll see below. Feel free to submit a pull request even if you don&rsquo;t meet it if you would like your code or feature to be reviewed first; we do want to be mindful of your time and will review submissions before they are polished.</description>
|
|
18
17
|
</item>
|
|
19
|
-
|
|
20
18
|
<item>
|
|
21
19
|
<title>Getting Started</title>
|
|
22
20
|
<link>https://akhoury6.github.io/rbcli/tutorial/10-getting_started/</link>
|
|
23
21
|
<pubDate>Thu, 20 Jun 2019 15:07:21 -0400</pubDate>
|
|
24
|
-
|
|
25
22
|
<guid>https://akhoury6.github.io/rbcli/tutorial/10-getting_started/</guid>
|
|
26
|
-
<description>Welcome to the RBCli getting started tutorial! In this tutorial we&rsquo;re going to cover the basics of RBCli and get a simple application up and running. It should take you between 30-60 minutes to complete, depending on your skill level with Ruby
|
|
27
|
-
As you go throught the tutorial, you can either use the Next and Back buttons on the page to navigate, or use the menu directly.
|
|
28
|
-
Supported Ruby Versions You&rsquo;ll need Ruby installed before you can use RBCli.</description>
|
|
23
|
+
<description>Welcome to the RBCli getting started tutorial! In this tutorial we&rsquo;re going to cover the basics of RBCli and get a simple application up and running. It should take you between 30-60 minutes to complete, depending on your skill level with Ruby.
As you go throught the tutorial, you can either use the Next and Back buttons on the page to navigate, or use the menu directly.
Supported Ruby Versions You&rsquo;ll need Ruby installed before you can use RBCli.</description>
|
|
29
24
|
</item>
|
|
30
|
-
|
|
31
25
|
<item>
|
|
32
26
|
<title>License Info</title>
|
|
33
27
|
<link>https://akhoury6.github.io/rbcli/development/license/</link>
|
|
34
28
|
<pubDate>Thu, 20 Jun 2019 15:07:21 -0400</pubDate>
|
|
35
|
-
|
|
36
29
|
<guid>https://akhoury6.github.io/rbcli/development/license/</guid>
|
|
37
30
|
<description>How RBCli is Licensed We want to help the developer community build tooling faster and with less work. That&rsquo;s why RBCli was built. And let&rsquo;s face it - most of us aren&rsquo;t lawyers, and don&rsquo;t want to worry about legal fine print when building awesome software. That&rsquo;s why RBCli is released under the GPLv3 License. So you&rsquo;re free to use RBCli as you see fit to write free software. If you wish to use RBCli in a commercial offering, please contact me at andrew@blacknex.</description>
|
|
38
31
|
</item>
|
|
39
|
-
|
|
40
32
|
<item>
|
|
41
33
|
<title>The Project Layout</title>
|
|
42
34
|
<link>https://akhoury6.github.io/rbcli/tutorial/20-project_layout/</link>
|
|
43
35
|
<pubDate>Thu, 20 Jun 2019 15:07:21 -0400</pubDate>
|
|
44
|
-
|
|
45
36
|
<guid>https://akhoury6.github.io/rbcli/tutorial/20-project_layout/</guid>
|
|
46
|
-
<description>Now we will learn about what an RBCli project looks like and how to start using it.
|
|
47
|
-
Project Initialization Types RBCli can initialize a tool in three different modes:
|
|
48
|
-
Project Mode (default) Mini Mode Micro Mode Project Mode If you&rsquo;ve been following along with the tutorial, you&rsquo;ve already seen Project Mode. An RBCli Project consists of several folders, each of which has a specific function. The RBCli framework handles loading and parsing the code automatically.</description>
|
|
37
|
+
<description>Now we will learn about what an RBCli project looks like and how to start using it.
Project Initialization Types RBCli can initialize a tool in three different modes:
Project Mode (default) Mini Mode Micro Mode Project Mode If you&rsquo;ve been following along with the tutorial, you&rsquo;ve already seen Project Mode. An RBCli Project consists of several folders, each of which has a specific function. The RBCli framework handles loading and parsing the code automatically.</description>
|
|
49
38
|
</item>
|
|
50
|
-
|
|
51
39
|
<item>
|
|
52
40
|
<title>Code of Conduct</title>
|
|
53
41
|
<link>https://akhoury6.github.io/rbcli/development/code_of_conduct/</link>
|
|
54
42
|
<pubDate>Thu, 20 Jun 2019 15:07:21 -0400</pubDate>
|
|
55
|
-
|
|
56
43
|
<guid>https://akhoury6.github.io/rbcli/development/code_of_conduct/</guid>
|
|
57
|
-
<description>The Contributor Covenant Code of Conduct
|
|
58
|
-
Our Pledge In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
|
|
59
|
-
Our Standards Examples of behavior that contributes to creating a positive environment include:</description>
|
|
44
|
+
<description>The Contributor Covenant Code of Conduct
Our Pledge In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
Our Standards Examples of behavior that contributes to creating a positive environment include:</description>
|
|
60
45
|
</item>
|
|
61
|
-
|
|
62
46
|
<item>
|
|
63
47
|
<title>Your First Command</title>
|
|
64
48
|
<link>https://akhoury6.github.io/rbcli/tutorial/30-your_first_command/</link>
|
|
65
49
|
<pubDate>Thu, 20 Jun 2019 15:07:21 -0400</pubDate>
|
|
66
|
-
|
|
67
50
|
<guid>https://akhoury6.github.io/rbcli/tutorial/30-your_first_command/</guid>
|
|
68
|
-
<description>Creating the Command Creating the command is straightforward
|
|
69
|
-
rbcli command --name=list #or rbcli command -n list And there you have it! Now you can try out your command by typing:
|
|
70
|
-
./exe/mytool list Congrats! You should now see a generic output listing the values of several variables. We&rsquo;ll get into what they mean in a bit, but first, let&rsquo;s make the tool&rsquo;s execution a bit easier.
|
|
71
|
-
Now that you know your way around a project, its time to create your first command!</description>
|
|
51
|
+
<description>Creating the Command Creating the command is straightforward:
rbcli command --name=list #or rbcli command -n list And there you have it! Now you can try out your command by typing:
./exe/mytool list Congrats! You should now see a generic output listing the values of several variables. We&rsquo;ll get into what they mean in a bit, but first, let&rsquo;s make the tool&rsquo;s execution a bit easier.
Now that you know your way around a project, its time to create your first command!</description>
|
|
72
52
|
</item>
|
|
73
|
-
|
|
74
53
|
<item>
|
|
75
54
|
<title>Options, Parameters, and Arguments</title>
|
|
76
55
|
<link>https://akhoury6.github.io/rbcli/tutorial/40-options_parameters_and_arguments/</link>
|
|
77
56
|
<pubDate>Thu, 20 Jun 2019 15:07:21 -0400</pubDate>
|
|
78
|
-
|
|
79
57
|
<guid>https://akhoury6.github.io/rbcli/tutorial/40-options_parameters_and_arguments/</guid>
|
|
80
|
-
<description>If you&rsquo;re already an experienced coder, you can jump to the last section of this document, the Simplified Reference (TLDR)
|
|
81
|
-
Command Line Structure In the previous section, you saw two parts of the RBCli command line structure - the executable followed by the command. However, RBCli is capable of more complex interaction. The structure is as follows:
|
|
82
|
-
toolname [options] command [parameters] argument1 argument2... Options are command line parameters such as -f, or --force.</description>
|
|
58
|
+
<description>If you&rsquo;re already an experienced coder, you can jump to the last section of this document, the Simplified Reference (TLDR)
Command Line Structure In the previous section, you saw two parts of the RBCli command line structure - the executable followed by the command. However, RBCli is capable of more complex interaction. The structure is as follows:
toolname [options] command [parameters] argument1 argument2... Options are command line parameters such as -f, or --force.</description>
|
|
83
59
|
</item>
|
|
84
|
-
|
|
85
60
|
<item>
|
|
86
61
|
<title>Publishing Your Application</title>
|
|
87
62
|
<link>https://akhoury6.github.io/rbcli/tutorial/50-publishing/</link>
|
|
88
63
|
<pubDate>Thu, 20 Jun 2019 15:07:21 -0400</pubDate>
|
|
89
|
-
|
|
90
64
|
<guid>https://akhoury6.github.io/rbcli/tutorial/50-publishing/</guid>
|
|
91
|
-
<description>RBCli creates projects designed to be easily distributed via either source control or as a gem. We&rsquo;ll go over both methods.
|
|
92
|
-
Common Tasks Regardless of where you are publishing, certain tasks need to be accomplished. Namely, preparing the gemspec and the README.
|
|
93
|
-
In both files the items that need changing are pretty obvious &ndash; you&rsquo;ll need to fill out your name, email, etc, and replace the placeholder text in the README with something useful to your users.</description>
|
|
65
|
+
<description>RBCli creates projects designed to be easily distributed via either source control or as a gem. We&rsquo;ll go over both methods.
Common Tasks Regardless of where you are publishing, certain tasks need to be accomplished. Namely, preparing the gemspec and the README.
In both files the items that need changing are pretty obvious &ndash; you&rsquo;ll need to fill out your name, email, etc, and replace the placeholder text in the README with something useful to your users.</description>
|
|
94
66
|
</item>
|
|
95
|
-
|
|
96
67
|
<item>
|
|
97
68
|
<title>Changelog</title>
|
|
98
69
|
<link>https://akhoury6.github.io/rbcli/development/changelog/</link>
|
|
99
70
|
<pubDate>Thu, 20 Jun 2019 15:07:21 -0400</pubDate>
|
|
100
|
-
|
|
101
71
|
<guid>https://akhoury6.github.io/rbcli/development/changelog/</guid>
|
|
102
|
-
<description>0.3.
|
|
72
|
+
<description>0.3.3 (April 24, 2024) Improvements Tested with Ruby 3.3.0 Updated dependencies for Ruby 3.3.0 Updated dependnecies for Sekeleton projects Added a bundler/inline gemfile on mini and micro skeleton projects to simplify their use Replaced deprecated Trollop gem with its replacement, ManageIQ/Optimist Bugfixes Updated deprecated ERB call for skeleton generation to use new format 0.3.2 (October 28, 2023) Bugfixes Replaced several calls to the deprecated .exists? method with .exist? for compatibility with Ruby 3.</description>
|
|
103
73
|
</item>
|
|
104
|
-
|
|
105
74
|
<item>
|
|
106
75
|
<title>Automatic Updates</title>
|
|
107
76
|
<link>https://akhoury6.github.io/rbcli/advanced/automatic_updates/</link>
|
|
108
77
|
<pubDate>Thu, 20 Jun 2019 15:07:21 -0400</pubDate>
|
|
109
|
-
|
|
110
78
|
<guid>https://akhoury6.github.io/rbcli/advanced/automatic_updates/</guid>
|
|
111
|
-
<description>RBCli can automatically notify users when an update is available. If force_update is set (see below), RBCli can halt execution until the user updates their application.
|
|
112
|
-
Two sources are currently supported: Github (including Enterprise) and RubyGems.
|
|
113
|
-
GitHub Update Check The GitHub update check works best when paired with GitHub&rsquo;s best practices on releases, where new releases are tagged on master with the format vX.X.X. See Github&rsquo;s release documentation to learn more.</description>
|
|
79
|
+
<description>RBCli can automatically notify users when an update is available. If force_update is set (see below), RBCli can halt execution until the user updates their application.
Two sources are currently supported: Github (including Enterprise) and RubyGems.
GitHub Update Check The GitHub update check works best when paired with GitHub&rsquo;s best practices on releases, where new releases are tagged on master with the format vX.X.X. See Github&rsquo;s release documentation to learn more.</description>
|
|
114
80
|
</item>
|
|
115
|
-
|
|
116
81
|
<item>
|
|
117
82
|
<title>Command Types</title>
|
|
118
83
|
<link>https://akhoury6.github.io/rbcli/advanced/command_types/</link>
|
|
119
84
|
<pubDate>Thu, 20 Jun 2019 15:07:21 -0400</pubDate>
|
|
120
|
-
|
|
121
85
|
<guid>https://akhoury6.github.io/rbcli/advanced/command_types/</guid>
|
|
122
|
-
<description>RBCli has three different command types:
|
|
123
|
-
Standard Commands (Ruby-based) Scripted Commands (Ruby+Bash based) External Commands (Wrapping a 3rd party application) This document is provided to be a reference. If you would like an in-depth tutorial, please see Your First Command.
|
|
124
|
-
General Command Structure Commands in RBCli are created by subclassing Rbcli::Command. All commands share a certain common structure:
|
|
125
|
-
class List &lt; Rbcli::Command # Declare a new command by subclassing Rbcli::Command description &#39;TODO: Description goes here&#39; # (Required) Short description for the global help usage &lt;&lt;-EOF TODO: Usage text goes here EOF # (Required) Long description for the command-specific help parameter :force, &#39;Force testing&#39;, type: :boolean, default: false, required: false # (Optional, Multiple) Add a command-specific CLI parameter.</description>
|
|
86
|
+
<description>RBCli has three different command types:
Standard Commands (Ruby-based) Scripted Commands (Ruby+Bash based) External Commands (Wrapping a 3rd party application) This document is provided to be a reference. If you would like an in-depth tutorial, please see Your First Command.
General Command Structure Commands in RBCli are created by subclassing Rbcli::Command. All commands share a certain common structure:
class List &lt; Rbcli::Command # Declare a new command by subclassing Rbcli::Command description &#39;TODO: Description goes here&#39; # (Required) Short description for the global help usage &lt;&lt;-EOF TODO: Usage text goes here EOF # (Required) Long description for the command-specific help parameter :force, &#39;Force testing&#39;, type: :boolean, default: false, required: false # (Optional, Multiple) Add a command-specific CLI parameter.</description>
|
|
126
87
|
</item>
|
|
127
|
-
|
|
128
88
|
<item>
|
|
129
89
|
<title>Distributed State and Locking</title>
|
|
130
90
|
<link>https://akhoury6.github.io/rbcli/advanced/distributed_state_locking/</link>
|
|
131
91
|
<pubDate>Thu, 20 Jun 2019 15:07:21 -0400</pubDate>
|
|
132
|
-
|
|
133
92
|
<guid>https://akhoury6.github.io/rbcli/advanced/distributed_state_locking/</guid>
|
|
134
|
-
<description>Distributed Locking allows a Remote State to be shared among multiple users of the application to make writes appear atomic between sessions. To use it, simply set the locking: parameter to true when enabling remote state
|
|
135
|
-
This is how locking works:
|
|
136
|
-
The application attempts to acquire a lock on the remote state when you first access it If the backend is locked by a different application, wait and try again If it succeeds, the lock is held and refreshed periodically When the application exits, the lock is released If the application does not refresh its lock, or fails to release it when it exits, the lock will automatically expire within 60 seconds If another application steals the lock (unlikely but possible), and the application tries to save data, a StandardError will be thrown You can manually attempt to lock/unlock by calling Rbcli.</description>
|
|
93
|
+
<description>Distributed Locking allows a Remote State to be shared among multiple users of the application to make writes appear atomic between sessions. To use it, simply set the locking: parameter to true when enabling remote state.
This is how locking works:
The application attempts to acquire a lock on the remote state when you first access it If the backend is locked by a different application, wait and try again If it succeeds, the lock is held and refreshed periodically When the application exits, the lock is released If the application does not refresh its lock, or fails to release it when it exits, the lock will automatically expire within 60 seconds If another application steals the lock (unlikely but possible), and the application tries to save data, a StandardError will be thrown You can manually attempt to lock/unlock by calling Rbcli.</description>
|
|
137
94
|
</item>
|
|
138
|
-
|
|
139
95
|
<item>
|
|
140
96
|
<title>Execution Hooks</title>
|
|
141
97
|
<link>https://akhoury6.github.io/rbcli/advanced/hooks/</link>
|
|
142
98
|
<pubDate>Thu, 20 Jun 2019 15:07:21 -0400</pubDate>
|
|
143
|
-
|
|
144
99
|
<guid>https://akhoury6.github.io/rbcli/advanced/hooks/</guid>
|
|
145
|
-
<description>RBCli provides you with hooks that can be used to have code execute at certain places in the execution chain. These hooks are optional, and do not have to be defined for your application to run.
|
|
146
|
-
All hooks will be created in the hooks/ folder in your project.
|
|
147
|
-
The Defailt Action Hook The Default hook is called when a user calls your application without providing a command. If the hook is not provided, the application will automatically display the help text (the same as running it with -h).</description>
|
|
100
|
+
<description>RBCli provides you with hooks that can be used to have code execute at certain places in the execution chain. These hooks are optional, and do not have to be defined for your application to run.
All hooks will be created in the hooks/ folder in your project.
The Defailt Action Hook The Default hook is called when a user calls your application without providing a command. If the hook is not provided, the application will automatically display the help text (the same as running it with -h).</description>
|
|
148
101
|
</item>
|
|
149
|
-
|
|
150
102
|
<item>
|
|
151
103
|
<title>Interactive Commands</title>
|
|
152
104
|
<link>https://akhoury6.github.io/rbcli/advanced/interactive_commands/</link>
|
|
153
105
|
<pubDate>Thu, 20 Jun 2019 15:07:21 -0400</pubDate>
|
|
154
|
-
|
|
155
106
|
<guid>https://akhoury6.github.io/rbcli/advanced/interactive_commands/</guid>
|
|
156
|
-
<description>Why interactive commands? When catering to an audience of users who are not accustomed to scripting, you may want to prompt them for the information directly (the typical CS-101 &lsquo;puts&rsquo; and &lsquo;gets&rsquo; pattern). This can be a lot more straightforward than having to read the help texts of your tool, and trying multiple times to enter all of the required data
|
|
157
|
-
Of course, we want to make sure that scripting with the tool still works well (headless interaction).</description>
|
|
107
|
+
<description>Why interactive commands? When catering to an audience of users who are not accustomed to scripting, you may want to prompt them for the information directly (the typical CS-101 &lsquo;puts&rsquo; and &lsquo;gets&rsquo; pattern). This can be a lot more straightforward than having to read the help texts of your tool, and trying multiple times to enter all of the required data.
Of course, we want to make sure that scripting with the tool still works well (headless interaction).</description>
|
|
158
108
|
</item>
|
|
159
|
-
|
|
160
109
|
<item>
|
|
161
110
|
<title>Logging</title>
|
|
162
111
|
<link>https://akhoury6.github.io/rbcli/advanced/logging/</link>
|
|
163
112
|
<pubDate>Thu, 20 Jun 2019 15:07:21 -0400</pubDate>
|
|
164
|
-
|
|
165
113
|
<guid>https://akhoury6.github.io/rbcli/advanced/logging/</guid>
|
|
166
|
-
<description>Logging with RBCli is straightforward - it looks at the config file for logging settings, and instantiates a single, globally accessible Logger object. You can access it within a standard command like this:
|
|
167
|
-
Rbcli::log.info { &#39;These logs can go to STDERR, STDOUT, or a file&#39; } Enabling Logging To enable logging, simply set the default values in the config/logging.rb file:
|
|
168
|
-
log_level :info log_target &#39;stderr&#39; log_level You can set the default log level using either numeric or standard Ruby logger levels: 0-5, or DEBUG &lt; INFO &lt; WARN &lt; ERROR &lt; FATAL &lt; UNKNOWN log_target This specifies where the logs will be placed.</description>
|
|
114
|
+
<description>Logging with RBCli is straightforward - it looks at the config file for logging settings, and instantiates a single, globally accessible Logger object. You can access it within a standard command like this:
Rbcli::log.info { &#39;These logs can go to STDERR, STDOUT, or a file&#39; } Enabling Logging To enable logging, simply set the default values in the config/logging.rb file:
log_level :info log_target &#39;stderr&#39; log_level You can set the default log level using either numeric or standard Ruby logger levels: 0-5, or DEBUG &lt; INFO &lt; WARN &lt; ERROR &lt; FATAL &lt; UNKNOWN log_target This specifies where the logs will be placed.</description>
|
|
169
115
|
</item>
|
|
170
|
-
|
|
171
116
|
<item>
|
|
172
117
|
<title>Remote Execution</title>
|
|
173
118
|
<link>https://akhoury6.github.io/rbcli/advanced/remote_execution/</link>
|
|
174
119
|
<pubDate>Thu, 20 Jun 2019 15:07:21 -0400</pubDate>
|
|
175
|
-
|
|
176
120
|
<guid>https://akhoury6.github.io/rbcli/advanced/remote_execution/</guid>
|
|
177
|
-
<description>RBCli can be configured to execute commands on a remote machine via SSH instead of locally.
|
|
178
|
-
Currently, only script and extern commands are supported.
|
|
179
|
-
Configuration To allow remote execution, go to config/general.rb and change the following line to true:
|
|
180
|
-
remote_execution permitted: false Then, for each command that you would like to enable remote execution for, add the following directive to the command class declaration:
|
|
181
|
-
remote_permitted Usage Your end users can now execute a command remotely by specifying the connection string and credentials on the command line as follows:</description>
|
|
121
|
+
<description>RBCli can be configured to execute commands on a remote machine via SSH instead of locally.
Currently, only script and extern commands are supported.
Configuration To allow remote execution, go to config/general.rb and change the following line to true:
remote_execution permitted: false Then, for each command that you would like to enable remote execution for, add the following directive to the command class declaration:
remote_permitted Usage Your end users can now execute a command remotely by specifying the connection string and credentials on the command line as follows:</description>
|
|
182
122
|
</item>
|
|
183
|
-
|
|
184
123
|
<item>
|
|
185
124
|
<title>State Storage</title>
|
|
186
125
|
<link>https://akhoury6.github.io/rbcli/advanced/state_storage/</link>
|
|
187
126
|
<pubDate>Thu, 20 Jun 2019 15:07:21 -0400</pubDate>
|
|
188
|
-
|
|
189
127
|
<guid>https://akhoury6.github.io/rbcli/advanced/state_storage/</guid>
|
|
190
|
-
<description>RBCli supports both local and remote state storage. This is done by synchronizing a Hash with either the local disk or a remote database.
|
|
191
|
-
Local State RBCli&rsquo;s local state storage gives you access to a hash that is automatically persisted to disk when changes are made.
|
|
192
|
-
Configuration You can configure it in config/storage.rb.
|
|
193
|
-
local_state &#39;/var/mytool/localstate&#39;, force_creation: true, halt_on_error: true There are three parameters to configure it with:
|
|
194
|
-
The path as a string (self-explanatory) force_creation This will attempt to create the path and file if it does not exist (equivalent to an mkdir -p and touch in linux) halt_on_error RBCli&rsquo;s default behavior is to raise an exception if the file can not be created, read, or updated at any point in time If this is set to false, RBCli will silence any errors pertaining to file access and will fall back to whatever data is available.</description>
|
|
128
|
+
<description>RBCli supports both local and remote state storage. This is done by synchronizing a Hash with either the local disk or a remote database.
Local State RBCli&rsquo;s local state storage gives you access to a hash that is automatically persisted to disk when changes are made.
Configuration You can configure it in config/storage.rb.
local_state &#39;/var/mytool/localstate&#39;, force_creation: true, halt_on_error: true There are three parameters to configure it with:
The path as a string (self-explanatory) force_creation This will attempt to create the path and file if it does not exist (equivalent to an mkdir -p and touch in linux) halt_on_error RBCli&rsquo;s default behavior is to raise an exception if the file can not be created, read, or updated at any point in time If this is set to false, RBCli will silence any errors pertaining to file access and will fall back to whatever data is available.</description>
|
|
195
129
|
</item>
|
|
196
|
-
|
|
197
130
|
<item>
|
|
198
131
|
<title>User Configuration Files</title>
|
|
199
132
|
<link>https://akhoury6.github.io/rbcli/advanced/user_config_files/</link>
|
|
200
133
|
<pubDate>Thu, 20 Jun 2019 15:07:21 -0400</pubDate>
|
|
201
|
-
|
|
202
134
|
<guid>https://akhoury6.github.io/rbcli/advanced/user_config_files/</guid>
|
|
203
|
-
<description>RBCli provides built-in support for creating and managing userspace configuration files. It does this through two chains: the defaults chain and the user chain.
|
|
204
|
-
Defaults chain The defaults chain allows you to specify sane defaults for your CLI tool throughout your code. This gives you the ability to declare configuration alongside the code, and allows RBCli to generate a user config automatically given your defaults. There are two ways to set them:</description>
|
|
135
|
+
<description>RBCli provides built-in support for creating and managing userspace configuration files. It does this through two chains: the defaults chain and the user chain.
Defaults chain The defaults chain allows you to specify sane defaults for your CLI tool throughout your code. This gives you the ability to declare configuration alongside the code, and allows RBCli to generate a user config automatically given your defaults. There are two ways to set them:</description>
|
|
205
136
|
</item>
|
|
206
|
-
|
|
207
137
|
</channel>
|
|
208
138
|
</rss>
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
<head>
|
|
4
4
|
<meta charset="utf-8">
|
|
5
5
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
6
|
-
<meta name="generator" content="Hugo 0.
|
|
6
|
+
<meta name="generator" content="Hugo 0.125.1">
|
|
7
7
|
<meta name="description" content="">
|
|
8
8
|
|
|
9
9
|
|
|
@@ -12,21 +12,21 @@
|
|
|
12
12
|
<title>Quick Reference :: 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>
|
|
@@ -81,7 +81,7 @@
|
|
|
81
81
|
|
|
82
82
|
|
|
83
83
|
<li data-nav-id="/rbcli/quick_reference/" title="Quick Reference" class="dd-item
|
|
84
|
-
|
|
84
|
+
|
|
85
85
|
active
|
|
86
86
|
|
|
87
87
|
">
|
|
@@ -721,10 +721,10 @@
|
|
|
721
721
|
|
|
722
722
|
<h2 id="installation">Installation</h2>
|
|
723
723
|
<p>RBCli is available on rubygems.org. You can add it to your application’s <code>Gemfile</code> or <code>gemspec</code>, or install it manually by running:</p>
|
|
724
|
-
<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-bash" data-lang="bash">gem install rbcli
|
|
725
|
-
</code></pre></div><p>Then, <code>cd</code> to the folder you’d like to create your project under and run:</p>
|
|
726
|
-
<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 init -n mytool -d <span style="color:#e6db74">"A simple CLI tool"</span>
|
|
727
|
-
</code></pre></div><p>Or, for a single-file tool without any folder/gem tructure, run <code>rbcli init -t mini -n <projectname></code> or <code>rbcli init -t micro -n <projectname></code>.</p>
|
|
724
|
+
<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span>gem install rbcli
|
|
725
|
+
</span></span></code></pre></div><p>Then, <code>cd</code> to the folder you’d like to create your project under and run:</p>
|
|
726
|
+
<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 init -n mytool -d <span style="color:#e6db74">"A simple CLI tool"</span>
|
|
727
|
+
</span></span></code></pre></div><p>Or, for a single-file tool without any folder/gem tructure, run <code>rbcli init -t mini -n <projectname></code> or <code>rbcli init -t micro -n <projectname></code>.</p>
|
|
728
728
|
<h2 id="creating-a-command">Creating a command</h2>
|
|
729
729
|
<p>There are three types of commands: standard, scripted, and external.</p>
|
|
730
730
|
<ul>
|
|
@@ -734,12 +734,12 @@
|
|
|
734
734
|
</ul>
|
|
735
735
|
<h3 id="standard-commands">Standard Commands</h3>
|
|
736
736
|
<p>To create a new command called <code>foo</code>, run:</p>
|
|
737
|
-
<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-bash" data-lang="bash">rbcli command -n foo
|
|
738
|
-
</code></pre></div><p>You will now find the command code in <code>application/commands/list.rb</code>. Edit the <code>action</code> block to write your coode.</p>
|
|
737
|
+
<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span>rbcli command -n foo
|
|
738
|
+
</span></span></code></pre></div><p>You will now find the command code in <code>application/commands/list.rb</code>. Edit the <code>action</code> block to write your coode.</p>
|
|
739
739
|
<h3 id="scripted-commands">Scripted Commands</h3>
|
|
740
740
|
<p>To create a new scripted command called <code>bar</code>, run:</p>
|
|
741
|
-
<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 bar
|
|
742
|
-
</code></pre></div><p>You will then find two new files:</p>
|
|
741
|
+
<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 bar
|
|
742
|
+
</span></span></code></pre></div><p>You will then find two new files:</p>
|
|
743
743
|
<ul>
|
|
744
744
|
<li>The command declaration under <code>application/commands/bar.rb</code></li>
|
|
745
745
|
<li>The script code under <code>application/commands/scripts/bar.sh</code></li>
|
|
@@ -747,17 +747,17 @@
|
|
|
747
747
|
<p>Edit the script to write your code.</p>
|
|
748
748
|
<h3 id="external-commands">External Commands</h3>
|
|
749
749
|
<p>To create a new external command called <code>baz</code>, run:</p>
|
|
750
|
-
<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 extern -n baz
|
|
751
|
-
</code></pre></div><p>You will then find the command code in <code>application/commands/baz.rb</code>.</p>
|
|
750
|
+
<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 extern -n baz
|
|
751
|
+
</span></span></code></pre></div><p>You will then find the command code in <code>application/commands/baz.rb</code>.</p>
|
|
752
752
|
<p>Use one of the two provided modes – direct path mode or variable path mode – to provide the path to the external program.</p>
|
|
753
753
|
<h2 id="hooks">Hooks</h2>
|
|
754
754
|
<p>RBCli has several hooks that run at different points in the exectution chain. They can be created via the <code>rbcli</code> command line tool:</p>
|
|
755
|
-
<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-bash" data-lang="bash">rbcli hook --default <span style="color:#75715e"># Runs when no command is provided</span>
|
|
756
|
-
rbcli hook --pre <span style="color:#75715e"># Runs before any command</span>
|
|
757
|
-
rbcli hook --post <span style="color:#75715e"># Runs after any command</span>
|
|
758
|
-
rbcli hook --firstrun <span style="color:#75715e"># Runs the first time a user runs your application. Requires userspace config.</span>
|
|
759
|
-
rbcli hook -dpof <span style="color:#75715e"># Create all hooks at once</span>
|
|
760
|
-
</code></pre></div><h2 id="storage">Storage</h2>
|
|
755
|
+
<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 hook --default <span style="color:#75715e"># Runs when no command is provided</span>
|
|
756
|
+
</span></span><span style="display:flex;"><span>rbcli hook --pre <span style="color:#75715e"># Runs before any command</span>
|
|
757
|
+
</span></span><span style="display:flex;"><span>rbcli hook --post <span style="color:#75715e"># Runs after any command</span>
|
|
758
|
+
</span></span><span style="display:flex;"><span>rbcli hook --firstrun <span style="color:#75715e"># Runs the first time a user runs your application. Requires userspace config.</span>
|
|
759
|
+
</span></span><span style="display:flex;"><span>rbcli hook -dpof <span style="color:#75715e"># Create all hooks at once</span>
|
|
760
|
+
</span></span></code></pre></div><h2 id="storage">Storage</h2>
|
|
761
761
|
<p>RBCli supports both local and remote state storage. This is done by synchronizing a Hash with either the local disk or a remote database.</p>
|
|
762
762
|
<h3 id="local-state">Local State</h3>
|
|
763
763
|
<p>RBCli can provide you with a unique hash that can be persisted to disk on any change to a top-level value.</p>
|
|
@@ -774,22 +774,22 @@ rbcli hook -dpof <span style="color:#75715e"># Create all hooks at once
|
|
|
774
774
|
<p>Users can generate a config file, complete with help text, by running your tool with the <code>--generate-config</code> option.</p>
|
|
775
775
|
<h2 id="logging">Logging</h2>
|
|
776
776
|
<p>RBCli’s logger is configured in <code>config/logging.rb</code>.</p>
|
|
777
|
-
<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-ruby" data-lang="ruby">log_level <span style="color:#e6db74">:info</span>
|
|
778
|
-
log_target <span style="color:#e6db74">'stderr'</span>
|
|
779
|
-
</code></pre></div><p>Then it can be accessed when writing your commands via:</p>
|
|
780
|
-
<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-ruby" data-lang="ruby"><span style="color:#66d9ef">Rbcli</span><span style="color:#f92672">::</span>log<span style="color:#f92672">.</span>info { <span style="color:#e6db74">'These logs can go to STDERR, STDOUT, or a file'</span> }
|
|
781
|
-
</code></pre></div><p>The user will also be able to change the log level and target via their config file, if it is enabled.</p>
|
|
777
|
+
<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>log_level <span style="color:#e6db74">:info</span>
|
|
778
|
+
</span></span><span style="display:flex;"><span>log_target <span style="color:#e6db74">'stderr'</span>
|
|
779
|
+
</span></span></code></pre></div><p>Then it can be accessed when writing your commands via:</p>
|
|
780
|
+
<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-ruby" data-lang="ruby"><span style="display:flex;"><span><span style="color:#66d9ef">Rbcli</span><span style="color:#f92672">::</span>log<span style="color:#f92672">.</span>info { <span style="color:#e6db74">'These logs can go to STDERR, STDOUT, or a file'</span> }
|
|
781
|
+
</span></span></code></pre></div><p>The user will also be able to change the log level and target via their config file, if it is enabled.</p>
|
|
782
782
|
<h2 id="automatic-update-check">Automatic Update Check</h2>
|
|
783
783
|
<p>RBCli can automatically notify users when an update is available. Two sources are currently supported: Github (including Enterprise) and RubyGems.</p>
|
|
784
784
|
<p>You can configure automatic updates in <code>config/autoupdate.rb</code> in your project.</p>
|
|
785
785
|
<h2 id="remote-execution">Remote Execution</h2>
|
|
786
786
|
<p>RBCli can automatically execute script and extern commands on remote machines via SSH. Enable this feature in <code>config/general.rb</code> by changing the following line to <code>true</code>:</p>
|
|
787
|
-
<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-ruby" data-lang="ruby">remote_execution <span style="color:#e6db74">permitted</span>: <span style="color:#66d9ef">false</span>
|
|
788
|
-
</code></pre></div><p>Then for each command you want to enable remote execution for, add the following directive:</p>
|
|
789
|
-
<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-ruby" data-lang="ruby">remote_permitted
|
|
790
|
-
</code></pre></div><p>Users can then execute commands remotly by specifying the connection string and credentials on the command line:</p>
|
|
791
|
-
<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-bash" data-lang="bash">mytool --remote-exec <span style="color:#f92672">[</span>user@<span style="color:#f92672">]</span>host<span style="color:#f92672">[</span>:port<span style="color:#f92672">]</span> --identity <span style="color:#f92672">(</span>/path/to/private/ssh/key or password<span style="color:#f92672">)</span> <command> ...
|
|
792
|
-
</code></pre></div><h2 id="development-and-contributing">Development and Contributing</h2>
|
|
787
|
+
<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-ruby" data-lang="ruby"><span style="display:flex;"><span>remote_execution <span style="color:#e6db74">permitted</span>: <span style="color:#66d9ef">false</span>
|
|
788
|
+
</span></span></code></pre></div><p>Then for each command you want to enable remote execution for, add the following directive:</p>
|
|
789
|
+
<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-ruby" data-lang="ruby"><span style="display:flex;"><span>remote_permitted
|
|
790
|
+
</span></span></code></pre></div><p>Users can then execute commands remotly by specifying the connection string and credentials on the command line:</p>
|
|
791
|
+
<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-bash" data-lang="bash"><span style="display:flex;"><span>mytool --remote-exec <span style="color:#f92672">[</span>user@<span style="color:#f92672">]</span>host<span style="color:#f92672">[</span>:port<span style="color:#f92672">]</span> --identity <span style="color:#f92672">(</span>/path/to/private/ssh/key or password<span style="color:#f92672">)</span> <command> ...
|
|
792
|
+
</span></span></code></pre></div><h2 id="development-and-contributing">Development and Contributing</h2>
|
|
793
793
|
<p>For more information about development and contributing, please see the <a href="https://akhoury6.github.io/rbcli/development/contributing/">Official Development Documentation</a></p>
|
|
794
794
|
<h2 id="license">License</h2>
|
|
795
795
|
<p>The gem is available as open source under the terms of the <a href="https://github.com/akhoury6/rbcli/blob/master/LICENSE.txt">GPLv3</a>.</p>
|
|
@@ -1224,19 +1224,19 @@ log_target <span style="color:#e6db74">'stderr'</span>
|
|
|
1224
1224
|
<div style="left: -1000px; overflow: scroll; position: absolute; top: -1000px; border: none; box-sizing: content-box; height: 200px; margin: 0px; padding: 0px; width: 200px;">
|
|
1225
1225
|
<div style="border: none; box-sizing: content-box; height: 200px; margin: 0px; padding: 0px; width: 200px;"></div>
|
|
1226
1226
|
</div>
|
|
1227
|
-
<script src="/rbcli/js/clipboard.min.js?
|
|
1228
|
-
<script src="/rbcli/js/perfect-scrollbar.min.js?
|
|
1229
|
-
<script src="/rbcli/js/perfect-scrollbar.jquery.min.js?
|
|
1230
|
-
<script src="/rbcli/js/jquery.sticky.js?
|
|
1231
|
-
<script src="/rbcli/js/featherlight.min.js?
|
|
1232
|
-
<script src="/rbcli/js/highlight.pack.js?
|
|
1227
|
+
<script src="/rbcli/js/clipboard.min.js?1713907739"></script>
|
|
1228
|
+
<script src="/rbcli/js/perfect-scrollbar.min.js?1713907739"></script>
|
|
1229
|
+
<script src="/rbcli/js/perfect-scrollbar.jquery.min.js?1713907739"></script>
|
|
1230
|
+
<script src="/rbcli/js/jquery.sticky.js?1713907739"></script>
|
|
1231
|
+
<script src="/rbcli/js/featherlight.min.js?1713907739"></script>
|
|
1232
|
+
<script src="/rbcli/js/highlight.pack.js?1713907739"></script>
|
|
1233
1233
|
<script>hljs.initHighlightingOnLoad();</script>
|
|
1234
|
-
<script src="/rbcli/js/modernizr.custom-3.6.0.js?
|
|
1235
|
-
<script src="/rbcli/js/learn.js?
|
|
1236
|
-
<script src="/rbcli/js/hugo-learn.js?
|
|
1234
|
+
<script src="/rbcli/js/modernizr.custom-3.6.0.js?1713907739"></script>
|
|
1235
|
+
<script src="/rbcli/js/learn.js?1713907739"></script>
|
|
1236
|
+
<script src="/rbcli/js/hugo-learn.js?1713907739"></script>
|
|
1237
1237
|
|
|
1238
|
-
<link href="/rbcli/mermaid/mermaid.css?
|
|
1239
|
-
<script src="/rbcli/mermaid/mermaid.js?
|
|
1238
|
+
<link href="/rbcli/mermaid/mermaid.css?1713907739" rel="stylesheet" />
|
|
1239
|
+
<script src="/rbcli/mermaid/mermaid.js?1713907739"></script>
|
|
1240
1240
|
<script>
|
|
1241
1241
|
mermaid.initialize({ startOnLoad: true });
|
|
1242
1242
|
</script>
|
|
@@ -4,8 +4,9 @@
|
|
|
4
4
|
<title>Quick Reference on RBCli Documentation</title>
|
|
5
5
|
<link>https://akhoury6.github.io/rbcli/quick_reference/</link>
|
|
6
6
|
<description>Recent content in Quick Reference on RBCli Documentation</description>
|
|
7
|
-
<generator>Hugo
|
|
7
|
+
<generator>Hugo 0.125.1</generator>
|
|
8
8
|
<language>en-us</language>
|
|
9
|
-
<lastBuildDate>
|
|
9
|
+
<lastBuildDate></lastBuildDate>
|
|
10
|
+
<atom:link href="https://akhoury6.github.io/rbcli/quick_reference/index.xml" rel="self" type="application/rss+xml" />
|
|
10
11
|
</channel>
|
|
11
12
|
</rss>
|
data/docs/sitemap.xml
CHANGED
|
@@ -46,7 +46,6 @@
|
|
|
46
46
|
</url><url>
|
|
47
47
|
<loc>https://akhoury6.github.io/rbcli/</loc>
|
|
48
48
|
<lastmod>2019-06-20T15:49:49-04:00</lastmod>
|
|
49
|
-
<priority>0</priority>
|
|
50
49
|
</url><url>
|
|
51
50
|
<loc>https://akhoury6.github.io/rbcli/advanced/automatic_updates/</loc>
|
|
52
51
|
<lastmod>2019-06-20T15:07:21-04:00</lastmod>
|
data/docs/tags/index.html
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
<head>
|
|
4
4
|
<meta charset="utf-8">
|
|
5
5
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
6
|
-
<meta name="generator" content="Hugo 0.
|
|
6
|
+
<meta name="generator" content="Hugo 0.125.1">
|
|
7
7
|
<meta name="description" content="">
|
|
8
8
|
|
|
9
9
|
|
|
@@ -12,21 +12,21 @@
|
|
|
12
12
|
<title>Tags :: 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>
|
|
@@ -670,7 +670,7 @@
|
|
|
670
670
|
|
|
671
671
|
<div class="progress">
|
|
672
672
|
<div class="wrapper">
|
|
673
|
-
|
|
673
|
+
<nav id="TableOfContents"></nav>
|
|
674
674
|
</div>
|
|
675
675
|
</div>
|
|
676
676
|
|
|
@@ -1124,19 +1124,19 @@
|
|
|
1124
1124
|
<div style="left: -1000px; overflow: scroll; position: absolute; top: -1000px; border: none; box-sizing: content-box; height: 200px; margin: 0px; padding: 0px; width: 200px;">
|
|
1125
1125
|
<div style="border: none; box-sizing: content-box; height: 200px; margin: 0px; padding: 0px; width: 200px;"></div>
|
|
1126
1126
|
</div>
|
|
1127
|
-
<script src="/rbcli/js/clipboard.min.js?
|
|
1128
|
-
<script src="/rbcli/js/perfect-scrollbar.min.js?
|
|
1129
|
-
<script src="/rbcli/js/perfect-scrollbar.jquery.min.js?
|
|
1130
|
-
<script src="/rbcli/js/jquery.sticky.js?
|
|
1131
|
-
<script src="/rbcli/js/featherlight.min.js?
|
|
1132
|
-
<script src="/rbcli/js/highlight.pack.js?
|
|
1127
|
+
<script src="/rbcli/js/clipboard.min.js?1713907739"></script>
|
|
1128
|
+
<script src="/rbcli/js/perfect-scrollbar.min.js?1713907739"></script>
|
|
1129
|
+
<script src="/rbcli/js/perfect-scrollbar.jquery.min.js?1713907739"></script>
|
|
1130
|
+
<script src="/rbcli/js/jquery.sticky.js?1713907739"></script>
|
|
1131
|
+
<script src="/rbcli/js/featherlight.min.js?1713907739"></script>
|
|
1132
|
+
<script src="/rbcli/js/highlight.pack.js?1713907739"></script>
|
|
1133
1133
|
<script>hljs.initHighlightingOnLoad();</script>
|
|
1134
|
-
<script src="/rbcli/js/modernizr.custom-3.6.0.js?
|
|
1135
|
-
<script src="/rbcli/js/learn.js?
|
|
1136
|
-
<script src="/rbcli/js/hugo-learn.js?
|
|
1134
|
+
<script src="/rbcli/js/modernizr.custom-3.6.0.js?1713907739"></script>
|
|
1135
|
+
<script src="/rbcli/js/learn.js?1713907739"></script>
|
|
1136
|
+
<script src="/rbcli/js/hugo-learn.js?1713907739"></script>
|
|
1137
1137
|
|
|
1138
|
-
<link href="/rbcli/mermaid/mermaid.css?
|
|
1139
|
-
<script src="/rbcli/mermaid/mermaid.js?
|
|
1138
|
+
<link href="/rbcli/mermaid/mermaid.css?1713907739" rel="stylesheet" />
|
|
1139
|
+
<script src="/rbcli/mermaid/mermaid.js?1713907739"></script>
|
|
1140
1140
|
<script>
|
|
1141
1141
|
mermaid.initialize({ startOnLoad: true });
|
|
1142
1142
|
</script>
|
data/docs/tags/index.xml
CHANGED
|
@@ -4,7 +4,8 @@
|
|
|
4
4
|
<title>Tags on RBCli Documentation</title>
|
|
5
5
|
<link>https://akhoury6.github.io/rbcli/tags/</link>
|
|
6
6
|
<description>Recent content in Tags on RBCli Documentation</description>
|
|
7
|
-
<generator>Hugo
|
|
8
|
-
<language>en-us</language
|
|
7
|
+
<generator>Hugo 0.125.1</generator>
|
|
8
|
+
<language>en-us</language>
|
|
9
|
+
<atom:link href="https://akhoury6.github.io/rbcli/tags/index.xml" rel="self" type="application/rss+xml" />
|
|
9
10
|
</channel>
|
|
10
11
|
</rss>
|