rbcli 0.1.10 → 0.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +31 -0
- data/CODE_OF_CONDUCT.md +1 -1
- data/Gemfile.lock +12 -12
- data/LICENSE.txt +674 -21
- data/README.md +80 -443
- data/bin/console +19 -0
- data/bin/setup +20 -0
- data/docs/404.html +639 -0
- data/docs/advanced/automatic_updates/index.html +791 -0
- data/docs/advanced/command_types/index.html +946 -0
- data/docs/advanced/distributed_state_locking/index.html +777 -0
- data/docs/advanced/hooks/index.html +836 -0
- data/docs/advanced/state_storage/index.html +957 -0
- data/docs/advanced/user_config_files/index.html +818 -0
- data/docs/assets/fonts/font-awesome.css +4 -0
- data/docs/assets/fonts/material-icons.css +13 -0
- data/docs/assets/fonts/specimen/FontAwesome.ttf +0 -0
- data/docs/assets/fonts/specimen/FontAwesome.woff +0 -0
- data/docs/assets/fonts/specimen/FontAwesome.woff2 +0 -0
- data/docs/assets/fonts/specimen/MaterialIcons-Regular.ttf +0 -0
- data/docs/assets/fonts/specimen/MaterialIcons-Regular.woff +0 -0
- data/docs/assets/fonts/specimen/MaterialIcons-Regular.woff2 +0 -0
- data/docs/assets/images/favicon.png +0 -0
- data/docs/assets/images/icons/bitbucket.1b09e088.svg +20 -0
- data/docs/assets/images/icons/github.f0b8504a.svg +18 -0
- data/docs/assets/images/icons/gitlab.6dd19c00.svg +38 -0
- data/docs/assets/javascripts/application.a59e2a89.js +1 -0
- data/docs/assets/javascripts/lunr/lunr.da.js +1 -0
- data/docs/assets/javascripts/lunr/lunr.de.js +1 -0
- data/docs/assets/javascripts/lunr/lunr.du.js +1 -0
- data/docs/assets/javascripts/lunr/lunr.es.js +1 -0
- data/docs/assets/javascripts/lunr/lunr.fi.js +1 -0
- data/docs/assets/javascripts/lunr/lunr.fr.js +1 -0
- data/docs/assets/javascripts/lunr/lunr.hu.js +1 -0
- data/docs/assets/javascripts/lunr/lunr.it.js +1 -0
- data/docs/assets/javascripts/lunr/lunr.jp.js +1 -0
- data/docs/assets/javascripts/lunr/lunr.multi.js +1 -0
- data/docs/assets/javascripts/lunr/lunr.no.js +1 -0
- data/docs/assets/javascripts/lunr/lunr.pt.js +1 -0
- data/docs/assets/javascripts/lunr/lunr.ro.js +1 -0
- data/docs/assets/javascripts/lunr/lunr.ru.js +1 -0
- data/docs/assets/javascripts/lunr/lunr.stemmer.support.js +1 -0
- data/docs/assets/javascripts/lunr/lunr.sv.js +1 -0
- data/docs/assets/javascripts/lunr/lunr.tr.js +1 -0
- data/docs/assets/javascripts/lunr/tinyseg.js +1 -0
- data/docs/assets/javascripts/modernizr.1aa3b519.js +1 -0
- data/docs/assets/stylesheets/application-palette.6079476c.css +2 -0
- data/docs/assets/stylesheets/application.ba0fd1a6.css +2 -0
- data/docs/development/code_of_conduct/index.html +883 -0
- data/docs/development/contributing/index.html +744 -0
- data/docs/development/license/index.html +715 -0
- data/docs/imported/changelog/index.html +853 -0
- data/docs/imported/quick_reference/index.html +1057 -0
- data/docs/index.html +732 -0
- data/docs/search/search_index.json +569 -0
- data/docs/sitemap.xml +93 -0
- data/docs/tutorial/10-getting_started/index.html +806 -0
- data/docs/tutorial/20-project_layout/index.html +972 -0
- data/docs/tutorial/30-your_first_command/index.html +906 -0
- data/docs/tutorial/40-options_parameters_and_arguments/index.html +1049 -0
- data/docs/tutorial/50-publishing/index.html +838 -0
- data/docs/whoami/index.html +709 -0
- data/docs-src/docs/advanced/automatic_updates.md +42 -0
- data/docs-src/docs/advanced/command_types.md +144 -0
- data/docs-src/docs/advanced/distributed_state_locking.md +33 -0
- data/docs-src/docs/advanced/hooks.md +65 -0
- data/docs-src/docs/advanced/logging.md +35 -0
- data/docs-src/docs/advanced/state_storage.md +117 -0
- data/docs-src/docs/advanced/user_config_files.md +47 -0
- data/docs-src/docs/development/code_of_conduct.md +74 -0
- data/docs-src/docs/development/contributing.md +49 -0
- data/docs-src/docs/development/license.md +10 -0
- data/docs-src/docs/imported/changelog.md +31 -0
- data/docs-src/docs/imported/quick_reference.md +150 -0
- data/docs-src/docs/index.md +38 -0
- data/docs-src/docs/tutorial/10-getting_started.md +41 -0
- data/docs-src/docs/tutorial/20-project_layout.md +115 -0
- data/docs-src/docs/tutorial/30-your_first_command.md +126 -0
- data/docs-src/docs/tutorial/40-options_parameters_and_arguments.md +251 -0
- data/docs-src/docs/tutorial/50-publishing.md +47 -0
- data/docs-src/docs/whoami.md +28 -0
- data/docs-src/makesite.sh +14 -0
- data/docs-src/mkdocs.yml +76 -0
- data/docs-src/runsite.sh +3 -0
- data/exe/rbcli +76 -5
- data/lib/rbcli/autoupdate/autoupdate.rb +24 -4
- data/lib/rbcli/autoupdate/gem_updater.rb +23 -2
- data/lib/rbcli/autoupdate/github_updater.rb +22 -1
- data/lib/rbcli/configuration/config.rb +22 -1
- data/lib/rbcli/configuration/configurate.rb +24 -2
- data/lib/rbcli/engine/command.rb +26 -6
- data/lib/rbcli/engine/load_project.rb +29 -3
- data/lib/rbcli/engine/parser.rb +25 -4
- data/lib/rbcli/logging/logging.rb +21 -0
- data/lib/rbcli/scriptwrapping/scriptwrapper.rb +30 -11
- data/lib/rbcli/stateful_systems/configuratestorage.rb +20 -0
- data/lib/rbcli/stateful_systems/state_storage.rb +20 -0
- data/lib/rbcli/stateful_systems/storagetypes/localstate.rb +20 -0
- data/lib/rbcli/stateful_systems/storagetypes/remote_state_connectors/dynamodb.rb +20 -0
- data/lib/rbcli/stateful_systems/storagetypes/remotestate_dynamodb.rb +20 -0
- data/lib/rbcli/util/hash_deep_symbolize.rb +43 -22
- data/lib/rbcli/util/string_colorize.rb +20 -0
- data/lib/rbcli/version.rb +21 -1
- data/lib/rbcli-tool/generators.rb +20 -0
- data/lib/rbcli-tool/mdless_fix.rb +20 -0
- data/lib/rbcli-tool/project.rb +27 -2
- data/lib/rbcli-tool/util.rb +20 -0
- data/lib/rbcli-tool.rb +20 -0
- data/lib/rbcli.rb +20 -0
- data/lib-sh/lib-rbcli.sh +19 -0
- data/rbcli.gemspec +22 -3
- data/skeletons/project/CODE_OF_CONDUCT.md +1 -1
- data/skeletons/project/README.md +17 -2
- data/skeletons/project/application/commands/command.erb +10 -8
- data/skeletons/project/application/commands/script.erb +3 -1
- data/skeletons/project/application/commands/scripts/script.sh +2 -2
- data/skeletons/project/application/options.rb +12 -3
- data/skeletons/project/config/autoupdate.rb +5 -2
- data/skeletons/project/config/storage.rb +7 -6
- data/skeletons/project/config/userspace.rb +6 -1
- data/skeletons/project/exe/executable +1 -1
- data/skeletons/project/lib/.keep +0 -0
- data/skeletons/project/untitled.gemspec +4 -4
- data/skeletons/project/{default_user_configs → userconf}/user_defaults.yml +0 -0
- metadata +85 -9
- data/examples/defaults.yml +0 -4
- data/examples/myscript.sh +0 -23
- data/examples/mytool +0 -95
@@ -0,0 +1,883 @@
|
|
1
|
+
|
2
|
+
|
3
|
+
|
4
|
+
|
5
|
+
<!DOCTYPE html>
|
6
|
+
<html lang="en" class="no-js">
|
7
|
+
<head>
|
8
|
+
|
9
|
+
<meta charset="utf-8">
|
10
|
+
<meta name="viewport" content="width=device-width,initial-scale=1">
|
11
|
+
<meta http-equiv="x-ua-compatible" content="ie=edge">
|
12
|
+
|
13
|
+
<meta name="description" content="Description">
|
14
|
+
|
15
|
+
|
16
|
+
|
17
|
+
<meta name="author" content="Andrew Khoury">
|
18
|
+
|
19
|
+
|
20
|
+
<meta name="lang:clipboard.copy" content="Copy to clipboard">
|
21
|
+
|
22
|
+
<meta name="lang:clipboard.copied" content="Copied to clipboard">
|
23
|
+
|
24
|
+
<meta name="lang:search.language" content="en">
|
25
|
+
|
26
|
+
<meta name="lang:search.pipeline.stopwords" content="True">
|
27
|
+
|
28
|
+
<meta name="lang:search.pipeline.trimmer" content="True">
|
29
|
+
|
30
|
+
<meta name="lang:search.result.none" content="No matching documents">
|
31
|
+
|
32
|
+
<meta name="lang:search.result.one" content="1 matching document">
|
33
|
+
|
34
|
+
<meta name="lang:search.result.other" content="# matching documents">
|
35
|
+
|
36
|
+
<meta name="lang:search.tokenizer" content="[\s\-]+">
|
37
|
+
|
38
|
+
<link rel="shortcut icon" href="../../assets/images/favicon.png">
|
39
|
+
<meta name="generator" content="mkdocs-0.17.5, mkdocs-material-2.9.2">
|
40
|
+
|
41
|
+
|
42
|
+
|
43
|
+
<title>Code of Conduct - RBCli Documentation</title>
|
44
|
+
|
45
|
+
|
46
|
+
|
47
|
+
<link rel="stylesheet" href="../../assets/stylesheets/application.ba0fd1a6.css">
|
48
|
+
|
49
|
+
|
50
|
+
|
51
|
+
|
52
|
+
<script src="../../assets/javascripts/modernizr.1aa3b519.js"></script>
|
53
|
+
|
54
|
+
|
55
|
+
<link href="https://fonts.gstatic.com" rel="preconnect" crossorigin>
|
56
|
+
|
57
|
+
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,400,400i,700|Roboto+Mono">
|
58
|
+
<style>body,input{font-family:"Roboto","Helvetica Neue",Helvetica,Arial,sans-serif}code,kbd,pre{font-family:"Roboto Mono","Courier New",Courier,monospace}</style>
|
59
|
+
|
60
|
+
|
61
|
+
<link rel="stylesheet" href="../../assets/fonts/material-icons.css">
|
62
|
+
|
63
|
+
|
64
|
+
</head>
|
65
|
+
|
66
|
+
<body dir="ltr">
|
67
|
+
|
68
|
+
<svg class="md-svg">
|
69
|
+
<defs>
|
70
|
+
|
71
|
+
|
72
|
+
<svg xmlns="http://www.w3.org/2000/svg" width="416" height="448"
|
73
|
+
viewBox="0 0 416 448" id="__github">
|
74
|
+
<path fill="currentColor" d="M160 304q0 10-3.125 20.5t-10.75 19-18.125
|
75
|
+
8.5-18.125-8.5-10.75-19-3.125-20.5 3.125-20.5 10.75-19 18.125-8.5
|
76
|
+
18.125 8.5 10.75 19 3.125 20.5zM320 304q0 10-3.125 20.5t-10.75
|
77
|
+
19-18.125 8.5-18.125-8.5-10.75-19-3.125-20.5 3.125-20.5 10.75-19
|
78
|
+
18.125-8.5 18.125 8.5 10.75 19 3.125 20.5zM360
|
79
|
+
304q0-30-17.25-51t-46.75-21q-10.25 0-48.75 5.25-17.75 2.75-39.25
|
80
|
+
2.75t-39.25-2.75q-38-5.25-48.75-5.25-29.5 0-46.75 21t-17.25 51q0 22 8
|
81
|
+
38.375t20.25 25.75 30.5 15 35 7.375 37.25 1.75h42q20.5 0
|
82
|
+
37.25-1.75t35-7.375 30.5-15 20.25-25.75 8-38.375zM416 260q0 51.75-15.25
|
83
|
+
82.75-9.5 19.25-26.375 33.25t-35.25 21.5-42.5 11.875-42.875 5.5-41.75
|
84
|
+
1.125q-19.5 0-35.5-0.75t-36.875-3.125-38.125-7.5-34.25-12.875-30.25-20.25-21.5-28.75q-15.5-30.75-15.5-82.75
|
85
|
+
0-59.25 34-99-6.75-20.5-6.75-42.5 0-29 12.75-54.5 27 0 47.5 9.875t47.25
|
86
|
+
30.875q36.75-8.75 77.25-8.75 37 0 70 8 26.25-20.5
|
87
|
+
46.75-30.25t47.25-9.75q12.75 25.5 12.75 54.5 0 21.75-6.75 42 34 40 34
|
88
|
+
99.5z" />
|
89
|
+
</svg>
|
90
|
+
|
91
|
+
</defs>
|
92
|
+
</svg>
|
93
|
+
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
|
94
|
+
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
|
95
|
+
<label class="md-overlay" data-md-component="overlay" for="__drawer"></label>
|
96
|
+
|
97
|
+
<a href="#contributor-covenant-code-of-conduct" tabindex="1" class="md-skip">
|
98
|
+
Skip to content
|
99
|
+
</a>
|
100
|
+
|
101
|
+
|
102
|
+
<header class="md-header" data-md-component="header">
|
103
|
+
<nav class="md-header-nav md-grid">
|
104
|
+
<div class="md-flex">
|
105
|
+
<div class="md-flex__cell md-flex__cell--shrink">
|
106
|
+
<a href="../.." title="RBCli Documentation" class="md-header-nav__button md-logo">
|
107
|
+
|
108
|
+
<i class="md-icon">devices</i>
|
109
|
+
|
110
|
+
</a>
|
111
|
+
</div>
|
112
|
+
<div class="md-flex__cell md-flex__cell--shrink">
|
113
|
+
<label class="md-icon md-icon--menu md-header-nav__button" for="__drawer"></label>
|
114
|
+
</div>
|
115
|
+
<div class="md-flex__cell md-flex__cell--stretch">
|
116
|
+
<div class="md-flex__ellipsis md-header-nav__title" data-md-component="title">
|
117
|
+
|
118
|
+
|
119
|
+
<span class="md-header-nav__topic">
|
120
|
+
RBCli Documentation
|
121
|
+
</span>
|
122
|
+
<span class="md-header-nav__topic">
|
123
|
+
Code of Conduct
|
124
|
+
</span>
|
125
|
+
|
126
|
+
|
127
|
+
</div>
|
128
|
+
</div>
|
129
|
+
<div class="md-flex__cell md-flex__cell--shrink">
|
130
|
+
|
131
|
+
|
132
|
+
<label class="md-icon md-icon--search md-header-nav__button" for="__search"></label>
|
133
|
+
|
134
|
+
<div class="md-search" data-md-component="search" role="dialog">
|
135
|
+
<label class="md-search__overlay" for="__search"></label>
|
136
|
+
<div class="md-search__inner" role="search">
|
137
|
+
<form class="md-search__form" name="search">
|
138
|
+
<input type="text" class="md-search__input" name="query" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="query" data-md-state="active">
|
139
|
+
<label class="md-icon md-search__icon" for="__search"></label>
|
140
|
+
<button type="reset" class="md-icon md-search__icon" data-md-component="reset" tabindex="-1">
|
141
|
+

|
142
|
+
</button>
|
143
|
+
</form>
|
144
|
+
<div class="md-search__output">
|
145
|
+
<div class="md-search__scrollwrap" data-md-scrollfix>
|
146
|
+
<div class="md-search-result" data-md-component="result">
|
147
|
+
<div class="md-search-result__meta">
|
148
|
+
Type to start searching
|
149
|
+
</div>
|
150
|
+
<ol class="md-search-result__list"></ol>
|
151
|
+
</div>
|
152
|
+
</div>
|
153
|
+
</div>
|
154
|
+
</div>
|
155
|
+
</div>
|
156
|
+
|
157
|
+
|
158
|
+
</div>
|
159
|
+
|
160
|
+
<div class="md-flex__cell md-flex__cell--shrink">
|
161
|
+
<div class="md-header-nav__source">
|
162
|
+
|
163
|
+
|
164
|
+
|
165
|
+
|
166
|
+
|
167
|
+
|
168
|
+
<a href="https://github.com/akhoury6/rbcli/" title="Go to repository" class="md-source" data-md-source="github">
|
169
|
+
|
170
|
+
<div class="md-source__icon">
|
171
|
+
<svg viewBox="0 0 24 24" width="24" height="24">
|
172
|
+
<use xlink:href="#__github" width="24" height="24"></use>
|
173
|
+
</svg>
|
174
|
+
</div>
|
175
|
+
|
176
|
+
<div class="md-source__repository">
|
177
|
+
GitHub
|
178
|
+
</div>
|
179
|
+
</a>
|
180
|
+
|
181
|
+
</div>
|
182
|
+
</div>
|
183
|
+
|
184
|
+
</div>
|
185
|
+
</nav>
|
186
|
+
</header>
|
187
|
+
|
188
|
+
<div class="md-container">
|
189
|
+
|
190
|
+
|
191
|
+
|
192
|
+
|
193
|
+
|
194
|
+
|
195
|
+
|
196
|
+
|
197
|
+
<nav class="md-tabs md-tabs--active" data-md-component="tabs">
|
198
|
+
<div class="md-tabs__inner md-grid">
|
199
|
+
<ul class="md-tabs__list">
|
200
|
+
|
201
|
+
|
202
|
+
<li class="md-tabs__item">
|
203
|
+
|
204
|
+
<a href="../.." title="Home" class="md-tabs__link">
|
205
|
+
Home
|
206
|
+
</a>
|
207
|
+
|
208
|
+
</li>
|
209
|
+
|
210
|
+
|
211
|
+
|
212
|
+
|
213
|
+
|
214
|
+
|
215
|
+
|
216
|
+
<li class="md-tabs__item">
|
217
|
+
|
218
|
+
<a href="../../tutorial/10-getting_started/" title="Tutorial" class="md-tabs__link">
|
219
|
+
Tutorial
|
220
|
+
</a>
|
221
|
+
|
222
|
+
</li>
|
223
|
+
|
224
|
+
|
225
|
+
|
226
|
+
|
227
|
+
|
228
|
+
|
229
|
+
<li class="md-tabs__item">
|
230
|
+
|
231
|
+
<a href="../../advanced/command_types/" title="Advanced Features" class="md-tabs__link">
|
232
|
+
Advanced Features
|
233
|
+
</a>
|
234
|
+
|
235
|
+
</li>
|
236
|
+
|
237
|
+
|
238
|
+
|
239
|
+
|
240
|
+
|
241
|
+
|
242
|
+
<li class="md-tabs__item">
|
243
|
+
|
244
|
+
<a href="../contributing/" title="Development" class="md-tabs__link md-tabs__link--active">
|
245
|
+
Development
|
246
|
+
</a>
|
247
|
+
|
248
|
+
</li>
|
249
|
+
|
250
|
+
|
251
|
+
|
252
|
+
|
253
|
+
|
254
|
+
</ul>
|
255
|
+
</div>
|
256
|
+
</nav>
|
257
|
+
|
258
|
+
<main class="md-main">
|
259
|
+
<div class="md-main__inner md-grid" data-md-component="container">
|
260
|
+
|
261
|
+
|
262
|
+
<div class="md-sidebar md-sidebar--primary" data-md-component="navigation">
|
263
|
+
<div class="md-sidebar__scrollwrap">
|
264
|
+
<div class="md-sidebar__inner">
|
265
|
+
<nav class="md-nav md-nav--primary" data-md-level="0">
|
266
|
+
<label class="md-nav__title md-nav__title--site" for="__drawer">
|
267
|
+
<span class="md-nav__button md-logo">
|
268
|
+
|
269
|
+
<i class="md-icon">devices</i>
|
270
|
+
|
271
|
+
</span>
|
272
|
+
RBCli Documentation
|
273
|
+
</label>
|
274
|
+
|
275
|
+
<div class="md-nav__source">
|
276
|
+
|
277
|
+
|
278
|
+
|
279
|
+
|
280
|
+
|
281
|
+
|
282
|
+
<a href="https://github.com/akhoury6/rbcli/" title="Go to repository" class="md-source" data-md-source="github">
|
283
|
+
|
284
|
+
<div class="md-source__icon">
|
285
|
+
<svg viewBox="0 0 24 24" width="24" height="24">
|
286
|
+
<use xlink:href="#__github" width="24" height="24"></use>
|
287
|
+
</svg>
|
288
|
+
</div>
|
289
|
+
|
290
|
+
<div class="md-source__repository">
|
291
|
+
GitHub
|
292
|
+
</div>
|
293
|
+
</a>
|
294
|
+
|
295
|
+
</div>
|
296
|
+
|
297
|
+
<ul class="md-nav__list" data-md-scrollfix>
|
298
|
+
|
299
|
+
|
300
|
+
|
301
|
+
|
302
|
+
|
303
|
+
|
304
|
+
<li class="md-nav__item">
|
305
|
+
<a href="../.." title="Home" class="md-nav__link">
|
306
|
+
Home
|
307
|
+
</a>
|
308
|
+
</li>
|
309
|
+
|
310
|
+
|
311
|
+
|
312
|
+
|
313
|
+
|
314
|
+
|
315
|
+
|
316
|
+
<li class="md-nav__item">
|
317
|
+
<a href="../../imported/quick_reference/" title="Quick Reference" class="md-nav__link">
|
318
|
+
Quick Reference
|
319
|
+
</a>
|
320
|
+
</li>
|
321
|
+
|
322
|
+
|
323
|
+
|
324
|
+
|
325
|
+
|
326
|
+
|
327
|
+
|
328
|
+
<li class="md-nav__item md-nav__item--nested">
|
329
|
+
|
330
|
+
<input class="md-toggle md-nav__toggle" data-md-toggle="nav-3" type="checkbox" id="nav-3">
|
331
|
+
|
332
|
+
<label class="md-nav__link" for="nav-3">
|
333
|
+
Tutorial
|
334
|
+
</label>
|
335
|
+
<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
|
336
|
+
<label class="md-nav__title" for="nav-3">
|
337
|
+
Tutorial
|
338
|
+
</label>
|
339
|
+
<ul class="md-nav__list" data-md-scrollfix>
|
340
|
+
|
341
|
+
|
342
|
+
|
343
|
+
|
344
|
+
|
345
|
+
|
346
|
+
|
347
|
+
<li class="md-nav__item">
|
348
|
+
<a href="../../tutorial/10-getting_started/" title="Getting Started" class="md-nav__link">
|
349
|
+
Getting Started
|
350
|
+
</a>
|
351
|
+
</li>
|
352
|
+
|
353
|
+
|
354
|
+
|
355
|
+
|
356
|
+
|
357
|
+
|
358
|
+
|
359
|
+
<li class="md-nav__item">
|
360
|
+
<a href="../../tutorial/20-project_layout/" title="The Project Layout" class="md-nav__link">
|
361
|
+
The Project Layout
|
362
|
+
</a>
|
363
|
+
</li>
|
364
|
+
|
365
|
+
|
366
|
+
|
367
|
+
|
368
|
+
|
369
|
+
|
370
|
+
|
371
|
+
<li class="md-nav__item">
|
372
|
+
<a href="../../tutorial/30-your_first_command/" title="Your First Command" class="md-nav__link">
|
373
|
+
Your First Command
|
374
|
+
</a>
|
375
|
+
</li>
|
376
|
+
|
377
|
+
|
378
|
+
|
379
|
+
|
380
|
+
|
381
|
+
|
382
|
+
|
383
|
+
<li class="md-nav__item">
|
384
|
+
<a href="../../tutorial/40-options_parameters_and_arguments/" title="Options, Parameters, and Arguments" class="md-nav__link">
|
385
|
+
Options, Parameters, and Arguments
|
386
|
+
</a>
|
387
|
+
</li>
|
388
|
+
|
389
|
+
|
390
|
+
|
391
|
+
|
392
|
+
|
393
|
+
|
394
|
+
|
395
|
+
<li class="md-nav__item">
|
396
|
+
<a href="../../tutorial/50-publishing/" title="Publishing and Distribution" class="md-nav__link">
|
397
|
+
Publishing and Distribution
|
398
|
+
</a>
|
399
|
+
</li>
|
400
|
+
|
401
|
+
|
402
|
+
</ul>
|
403
|
+
</nav>
|
404
|
+
</li>
|
405
|
+
|
406
|
+
|
407
|
+
|
408
|
+
|
409
|
+
|
410
|
+
|
411
|
+
|
412
|
+
<li class="md-nav__item md-nav__item--nested">
|
413
|
+
|
414
|
+
<input class="md-toggle md-nav__toggle" data-md-toggle="nav-4" type="checkbox" id="nav-4">
|
415
|
+
|
416
|
+
<label class="md-nav__link" for="nav-4">
|
417
|
+
Advanced Features
|
418
|
+
</label>
|
419
|
+
<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
|
420
|
+
<label class="md-nav__title" for="nav-4">
|
421
|
+
Advanced Features
|
422
|
+
</label>
|
423
|
+
<ul class="md-nav__list" data-md-scrollfix>
|
424
|
+
|
425
|
+
|
426
|
+
|
427
|
+
|
428
|
+
|
429
|
+
|
430
|
+
|
431
|
+
<li class="md-nav__item">
|
432
|
+
<a href="../../advanced/command_types/" title="Command Types" class="md-nav__link">
|
433
|
+
Command Types
|
434
|
+
</a>
|
435
|
+
</li>
|
436
|
+
|
437
|
+
|
438
|
+
|
439
|
+
|
440
|
+
|
441
|
+
|
442
|
+
|
443
|
+
<li class="md-nav__item">
|
444
|
+
<a href="../../advanced/user_config_files/" title="User Config Files" class="md-nav__link">
|
445
|
+
User Config Files
|
446
|
+
</a>
|
447
|
+
</li>
|
448
|
+
|
449
|
+
|
450
|
+
|
451
|
+
|
452
|
+
|
453
|
+
|
454
|
+
|
455
|
+
<li class="md-nav__item">
|
456
|
+
<a href="../../advanced/hooks/" title="Hooks" class="md-nav__link">
|
457
|
+
Hooks
|
458
|
+
</a>
|
459
|
+
</li>
|
460
|
+
|
461
|
+
|
462
|
+
|
463
|
+
|
464
|
+
|
465
|
+
|
466
|
+
|
467
|
+
<li class="md-nav__item">
|
468
|
+
<a href="../../advanced/automatic_updates/" title="Automatic Updates" class="md-nav__link">
|
469
|
+
Automatic Updates
|
470
|
+
</a>
|
471
|
+
</li>
|
472
|
+
|
473
|
+
|
474
|
+
|
475
|
+
|
476
|
+
|
477
|
+
|
478
|
+
|
479
|
+
<li class="md-nav__item">
|
480
|
+
<a href="../../advanced/state_storage/" title="State Storage" class="md-nav__link">
|
481
|
+
State Storage
|
482
|
+
</a>
|
483
|
+
</li>
|
484
|
+
|
485
|
+
|
486
|
+
|
487
|
+
|
488
|
+
|
489
|
+
|
490
|
+
|
491
|
+
<li class="md-nav__item">
|
492
|
+
<a href="../../advanced/distributed_state_locking/" title="Distributed State Locking" class="md-nav__link">
|
493
|
+
Distributed State Locking
|
494
|
+
</a>
|
495
|
+
</li>
|
496
|
+
|
497
|
+
|
498
|
+
</ul>
|
499
|
+
</nav>
|
500
|
+
</li>
|
501
|
+
|
502
|
+
|
503
|
+
|
504
|
+
|
505
|
+
|
506
|
+
|
507
|
+
|
508
|
+
|
509
|
+
|
510
|
+
<li class="md-nav__item md-nav__item--active md-nav__item--nested">
|
511
|
+
|
512
|
+
<input class="md-toggle md-nav__toggle" data-md-toggle="nav-5" type="checkbox" id="nav-5" checked>
|
513
|
+
|
514
|
+
<label class="md-nav__link" for="nav-5">
|
515
|
+
Development
|
516
|
+
</label>
|
517
|
+
<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
|
518
|
+
<label class="md-nav__title" for="nav-5">
|
519
|
+
Development
|
520
|
+
</label>
|
521
|
+
<ul class="md-nav__list" data-md-scrollfix>
|
522
|
+
|
523
|
+
|
524
|
+
|
525
|
+
|
526
|
+
|
527
|
+
|
528
|
+
|
529
|
+
<li class="md-nav__item">
|
530
|
+
<a href="../contributing/" title="Contribution Guide" class="md-nav__link">
|
531
|
+
Contribution Guide
|
532
|
+
</a>
|
533
|
+
</li>
|
534
|
+
|
535
|
+
|
536
|
+
|
537
|
+
|
538
|
+
|
539
|
+
|
540
|
+
|
541
|
+
<li class="md-nav__item">
|
542
|
+
<a href="../license/" title="License Info" class="md-nav__link">
|
543
|
+
License Info
|
544
|
+
</a>
|
545
|
+
</li>
|
546
|
+
|
547
|
+
|
548
|
+
|
549
|
+
|
550
|
+
|
551
|
+
|
552
|
+
|
553
|
+
|
554
|
+
|
555
|
+
<li class="md-nav__item md-nav__item--active">
|
556
|
+
|
557
|
+
<input class="md-toggle md-nav__toggle" data-md-toggle="toc" type="checkbox" id="__toc">
|
558
|
+
|
559
|
+
|
560
|
+
|
561
|
+
|
562
|
+
<label class="md-nav__link md-nav__link--active" for="__toc">
|
563
|
+
Code of Conduct
|
564
|
+
</label>
|
565
|
+
|
566
|
+
<a href="./" title="Code of Conduct" class="md-nav__link md-nav__link--active">
|
567
|
+
Code of Conduct
|
568
|
+
</a>
|
569
|
+
|
570
|
+
|
571
|
+
<nav class="md-nav md-nav--secondary">
|
572
|
+
|
573
|
+
|
574
|
+
|
575
|
+
|
576
|
+
|
577
|
+
<label class="md-nav__title" for="__toc">Table of contents</label>
|
578
|
+
<ul class="md-nav__list" data-md-scrollfix>
|
579
|
+
|
580
|
+
<li class="md-nav__item">
|
581
|
+
<a href="#our-pledge" title="Our Pledge" class="md-nav__link">
|
582
|
+
Our Pledge
|
583
|
+
</a>
|
584
|
+
|
585
|
+
</li>
|
586
|
+
|
587
|
+
<li class="md-nav__item">
|
588
|
+
<a href="#our-standards" title="Our Standards" class="md-nav__link">
|
589
|
+
Our Standards
|
590
|
+
</a>
|
591
|
+
|
592
|
+
</li>
|
593
|
+
|
594
|
+
<li class="md-nav__item">
|
595
|
+
<a href="#our-responsibilities" title="Our Responsibilities" class="md-nav__link">
|
596
|
+
Our Responsibilities
|
597
|
+
</a>
|
598
|
+
|
599
|
+
</li>
|
600
|
+
|
601
|
+
<li class="md-nav__item">
|
602
|
+
<a href="#scope" title="Scope" class="md-nav__link">
|
603
|
+
Scope
|
604
|
+
</a>
|
605
|
+
|
606
|
+
</li>
|
607
|
+
|
608
|
+
<li class="md-nav__item">
|
609
|
+
<a href="#enforcement" title="Enforcement" class="md-nav__link">
|
610
|
+
Enforcement
|
611
|
+
</a>
|
612
|
+
|
613
|
+
</li>
|
614
|
+
|
615
|
+
<li class="md-nav__item">
|
616
|
+
<a href="#attribution" title="Attribution" class="md-nav__link">
|
617
|
+
Attribution
|
618
|
+
</a>
|
619
|
+
|
620
|
+
</li>
|
621
|
+
|
622
|
+
|
623
|
+
|
624
|
+
|
625
|
+
|
626
|
+
</ul>
|
627
|
+
|
628
|
+
</nav>
|
629
|
+
|
630
|
+
</li>
|
631
|
+
|
632
|
+
|
633
|
+
|
634
|
+
|
635
|
+
|
636
|
+
|
637
|
+
|
638
|
+
<li class="md-nav__item">
|
639
|
+
<a href="../../imported/changelog/" title="Changelog" class="md-nav__link">
|
640
|
+
Changelog
|
641
|
+
</a>
|
642
|
+
</li>
|
643
|
+
|
644
|
+
|
645
|
+
</ul>
|
646
|
+
</nav>
|
647
|
+
</li>
|
648
|
+
|
649
|
+
|
650
|
+
|
651
|
+
|
652
|
+
|
653
|
+
|
654
|
+
|
655
|
+
<li class="md-nav__item">
|
656
|
+
<a href="../../whoami/" title="$ whoami" class="md-nav__link">
|
657
|
+
$ whoami
|
658
|
+
</a>
|
659
|
+
</li>
|
660
|
+
|
661
|
+
|
662
|
+
</ul>
|
663
|
+
</nav>
|
664
|
+
</div>
|
665
|
+
</div>
|
666
|
+
</div>
|
667
|
+
|
668
|
+
|
669
|
+
<div class="md-sidebar md-sidebar--secondary" data-md-component="toc">
|
670
|
+
<div class="md-sidebar__scrollwrap">
|
671
|
+
<div class="md-sidebar__inner">
|
672
|
+
|
673
|
+
<nav class="md-nav md-nav--secondary">
|
674
|
+
|
675
|
+
|
676
|
+
|
677
|
+
|
678
|
+
|
679
|
+
<label class="md-nav__title" for="__toc">Table of contents</label>
|
680
|
+
<ul class="md-nav__list" data-md-scrollfix>
|
681
|
+
|
682
|
+
<li class="md-nav__item">
|
683
|
+
<a href="#our-pledge" title="Our Pledge" class="md-nav__link">
|
684
|
+
Our Pledge
|
685
|
+
</a>
|
686
|
+
|
687
|
+
</li>
|
688
|
+
|
689
|
+
<li class="md-nav__item">
|
690
|
+
<a href="#our-standards" title="Our Standards" class="md-nav__link">
|
691
|
+
Our Standards
|
692
|
+
</a>
|
693
|
+
|
694
|
+
</li>
|
695
|
+
|
696
|
+
<li class="md-nav__item">
|
697
|
+
<a href="#our-responsibilities" title="Our Responsibilities" class="md-nav__link">
|
698
|
+
Our Responsibilities
|
699
|
+
</a>
|
700
|
+
|
701
|
+
</li>
|
702
|
+
|
703
|
+
<li class="md-nav__item">
|
704
|
+
<a href="#scope" title="Scope" class="md-nav__link">
|
705
|
+
Scope
|
706
|
+
</a>
|
707
|
+
|
708
|
+
</li>
|
709
|
+
|
710
|
+
<li class="md-nav__item">
|
711
|
+
<a href="#enforcement" title="Enforcement" class="md-nav__link">
|
712
|
+
Enforcement
|
713
|
+
</a>
|
714
|
+
|
715
|
+
</li>
|
716
|
+
|
717
|
+
<li class="md-nav__item">
|
718
|
+
<a href="#attribution" title="Attribution" class="md-nav__link">
|
719
|
+
Attribution
|
720
|
+
</a>
|
721
|
+
|
722
|
+
</li>
|
723
|
+
|
724
|
+
|
725
|
+
|
726
|
+
|
727
|
+
|
728
|
+
</ul>
|
729
|
+
|
730
|
+
</nav>
|
731
|
+
</div>
|
732
|
+
</div>
|
733
|
+
</div>
|
734
|
+
|
735
|
+
|
736
|
+
<div class="md-content">
|
737
|
+
<article class="md-content__inner md-typeset">
|
738
|
+
|
739
|
+
|
740
|
+
|
741
|
+
<h1 id="contributor-covenant-code-of-conduct">Contributor Covenant Code of Conduct</h1>
|
742
|
+
<h2 id="our-pledge">Our Pledge</h2>
|
743
|
+
<p>In the interest of fostering an open and welcoming environment, we as
|
744
|
+
contributors and maintainers pledge to making participation in our project and
|
745
|
+
our community a harassment-free experience for everyone, regardless of age, body
|
746
|
+
size, disability, ethnicity, gender identity and expression, level of experience,
|
747
|
+
nationality, personal appearance, race, religion, or sexual identity and
|
748
|
+
orientation.</p>
|
749
|
+
<h2 id="our-standards">Our Standards</h2>
|
750
|
+
<p>Examples of behavior that contributes to creating a positive environment
|
751
|
+
include:</p>
|
752
|
+
<ul>
|
753
|
+
<li>Using welcoming and inclusive language</li>
|
754
|
+
<li>Being respectful of differing viewpoints and experiences</li>
|
755
|
+
<li>Gracefully accepting constructive criticism</li>
|
756
|
+
<li>Focusing on what is best for the community</li>
|
757
|
+
<li>Showing empathy towards other community members</li>
|
758
|
+
</ul>
|
759
|
+
<p>Examples of unacceptable behavior by participants include:</p>
|
760
|
+
<ul>
|
761
|
+
<li>The use of sexualized language or imagery and unwelcome sexual attention or
|
762
|
+
advances</li>
|
763
|
+
<li>Trolling, insulting/derogatory comments, and personal or political attacks</li>
|
764
|
+
<li>Public or private harassment</li>
|
765
|
+
<li>Publishing others' private information, such as a physical or electronic
|
766
|
+
address, without explicit permission</li>
|
767
|
+
<li>Other conduct which could reasonably be considered inappropriate in a
|
768
|
+
professional setting</li>
|
769
|
+
</ul>
|
770
|
+
<h2 id="our-responsibilities">Our Responsibilities</h2>
|
771
|
+
<p>Project maintainers are responsible for clarifying the standards of acceptable
|
772
|
+
behavior and are expected to take appropriate and fair corrective action in
|
773
|
+
response to any instances of unacceptable behavior.</p>
|
774
|
+
<p>Project maintainers have the right and responsibility to remove, edit, or
|
775
|
+
reject comments, commits, code, wiki edits, issues, and other contributions
|
776
|
+
that are not aligned to this Code of Conduct, or to ban temporarily or
|
777
|
+
permanently any contributor for other behaviors that they deem inappropriate,
|
778
|
+
threatening, offensive, or harmful.</p>
|
779
|
+
<h2 id="scope">Scope</h2>
|
780
|
+
<p>This Code of Conduct applies both within project spaces and in public spaces
|
781
|
+
when an individual is representing the project or its community. Examples of
|
782
|
+
representing a project or community include using an official project e-mail
|
783
|
+
address, posting via an official social media account, or acting as an appointed
|
784
|
+
representative at an online or offline event. Representation of a project may be
|
785
|
+
further defined and clarified by project maintainers.</p>
|
786
|
+
<h2 id="enforcement">Enforcement</h2>
|
787
|
+
<p>Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
788
|
+
reported by contacting the project team at andrew@blacknex.us. All
|
789
|
+
complaints will be reviewed and investigated and will result in a response that
|
790
|
+
is deemed necessary and appropriate to the circumstances. The project team is
|
791
|
+
obligated to maintain confidentiality with regard to the reporter of an incident.
|
792
|
+
Further details of specific enforcement policies may be posted separately.</p>
|
793
|
+
<p>Project maintainers who do not follow or enforce the Code of Conduct in good
|
794
|
+
faith may face temporary or permanent repercussions as determined by other
|
795
|
+
members of the project's leadership.</p>
|
796
|
+
<h2 id="attribution">Attribution</h2>
|
797
|
+
<p>This Code of Conduct is adapted from the <a href="http://contributor-covenant.org">Contributor Covenant</a>, version 1.4,
|
798
|
+
available at <a href="http://contributor-covenant.org/version/1/4/">http://contributor-covenant.org/version/1/4</a></p>
|
799
|
+
|
800
|
+
|
801
|
+
|
802
|
+
|
803
|
+
|
804
|
+
|
805
|
+
|
806
|
+
|
807
|
+
|
808
|
+
</article>
|
809
|
+
</div>
|
810
|
+
</div>
|
811
|
+
</main>
|
812
|
+
|
813
|
+
|
814
|
+
<footer class="md-footer">
|
815
|
+
|
816
|
+
<div class="md-footer-nav">
|
817
|
+
<nav class="md-footer-nav__inner md-grid">
|
818
|
+
|
819
|
+
<a href="../license/" title="License Info" class="md-flex md-footer-nav__link md-footer-nav__link--prev" rel="prev">
|
820
|
+
<div class="md-flex__cell md-flex__cell--shrink">
|
821
|
+
<i class="md-icon md-icon--arrow-back md-footer-nav__button"></i>
|
822
|
+
</div>
|
823
|
+
<div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title">
|
824
|
+
<span class="md-flex__ellipsis">
|
825
|
+
<span class="md-footer-nav__direction">
|
826
|
+
Previous
|
827
|
+
</span>
|
828
|
+
License Info
|
829
|
+
</span>
|
830
|
+
</div>
|
831
|
+
</a>
|
832
|
+
|
833
|
+
|
834
|
+
<a href="../../imported/changelog/" title="Changelog" class="md-flex md-footer-nav__link md-footer-nav__link--next" rel="next">
|
835
|
+
<div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title">
|
836
|
+
<span class="md-flex__ellipsis">
|
837
|
+
<span class="md-footer-nav__direction">
|
838
|
+
Next
|
839
|
+
</span>
|
840
|
+
Changelog
|
841
|
+
</span>
|
842
|
+
</div>
|
843
|
+
<div class="md-flex__cell md-flex__cell--shrink">
|
844
|
+
<i class="md-icon md-icon--arrow-forward md-footer-nav__button"></i>
|
845
|
+
</div>
|
846
|
+
</a>
|
847
|
+
|
848
|
+
</nav>
|
849
|
+
</div>
|
850
|
+
|
851
|
+
<div class="md-footer-meta md-typeset">
|
852
|
+
<div class="md-footer-meta__inner md-grid">
|
853
|
+
<div class="md-footer-copyright">
|
854
|
+
|
855
|
+
<div class="md-footer-copyright__highlight">
|
856
|
+
Copyright © 2018 Andrew Khoury
|
857
|
+
</div>
|
858
|
+
|
859
|
+
powered by
|
860
|
+
<a href="https://www.mkdocs.org">MkDocs</a>
|
861
|
+
and
|
862
|
+
<a href="https://squidfunk.github.io/mkdocs-material/">
|
863
|
+
Material for MkDocs</a>
|
864
|
+
</div>
|
865
|
+
|
866
|
+
|
867
|
+
|
868
|
+
</div>
|
869
|
+
</div>
|
870
|
+
</footer>
|
871
|
+
|
872
|
+
</div>
|
873
|
+
|
874
|
+
<script src="../../assets/javascripts/application.a59e2a89.js"></script>
|
875
|
+
|
876
|
+
<script>app.initialize({version:"0.17.5",url:{base:"../.."}})</script>
|
877
|
+
|
878
|
+
|
879
|
+
|
880
|
+
|
881
|
+
|
882
|
+
</body>
|
883
|
+
</html>
|