rbcli 0.2.11 → 0.2.12
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.rakeTasks +7 -0
- data/.rbenv-gemsets +1 -0
- data/CHANGELOG.md +22 -0
- data/Gemfile.lock +25 -24
- data/README.md +2 -2
- data/docs-src/archetypes/default.md +6 -0
- data/docs-src/config.toml +37 -0
- data/docs-src/{docs/index.md → content/_index.md} +4 -4
- data/docs-src/content/advanced/_index.md +11 -0
- data/docs-src/{docs → content}/advanced/automatic_updates.md +6 -2
- data/docs-src/{docs → content}/advanced/command_types.md +8 -4
- data/docs-src/{docs → content}/advanced/distributed_state_locking.md +6 -2
- data/docs-src/{docs → content}/advanced/hooks.md +6 -2
- data/docs-src/{docs → content}/advanced/interactive_commands.md +5 -1
- data/docs-src/{docs → content}/advanced/logging.md +6 -2
- data/docs-src/{docs → content}/advanced/remote_execution.md +5 -1
- data/docs-src/{docs → content}/advanced/state_storage.md +6 -3
- data/docs-src/{docs → content}/advanced/user_config_files.md +5 -1
- data/docs-src/content/development/_index.md +11 -0
- data/docs-src/{docs/imported → content/development}/changelog.md +58 -6
- data/docs-src/{docs → content}/development/code_of_conduct.md +8 -1
- data/docs-src/{docs → content}/development/contributing.md +16 -1
- data/docs-src/{docs → content}/development/license.md +9 -2
- data/docs-src/{docs/imported/quick_reference.md → content/quick_reference/_index.md} +8 -1
- data/docs-src/{docs → content}/tutorial/10-getting_started.md +7 -1
- data/docs-src/{docs → content}/tutorial/20-project_layout.md +10 -2
- data/docs-src/{docs → content}/tutorial/30-your_first_command.md +10 -4
- data/docs-src/{docs → content}/tutorial/40-options_parameters_and_arguments.md +9 -3
- data/docs-src/{docs → content}/tutorial/50-publishing.md +9 -3
- data/docs-src/content/tutorial/_index.md +11 -0
- data/docs-src/{docs/whoami.md → content/whoami/_index.md} +11 -5
- data/docs-src/layouts/partials/logo.html +3 -0
- data/docs-src/makesite.sh +33 -7
- data/docs-src/mkdocs-archived.tar.gz +0 -0
- data/docs-src/runsite.sh +6 -1
- data/docs-src/themes/hugo-theme-learn/.editorconfig +16 -0
- data/docs-src/themes/hugo-theme-learn/.gitignore +3 -0
- data/docs-src/themes/hugo-theme-learn/.grenrc.yml +25 -0
- data/docs-src/themes/hugo-theme-learn/CHANGELOG.md +154 -0
- data/docs-src/themes/hugo-theme-learn/LICENSE.md +22 -0
- data/docs-src/themes/hugo-theme-learn/README.md +60 -0
- data/docs-src/themes/hugo-theme-learn/archetypes/chapter.md +13 -0
- data/docs-src/themes/hugo-theme-learn/archetypes/default.md +7 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/LICENSE.md +20 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/config.toml +75 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/_index.en.md +41 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/_index.fr.md +43 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/basics/_index.en.md +12 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/basics/_index.fr.md +12 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/basics/configuration/_index.en.md +58 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/basics/configuration/_index.fr.md +54 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/basics/installation/_index.en.md +102 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/basics/installation/_index.fr.md +100 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/basics/installation/images/chapter.png +0 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/basics/requirements/_index.en.md +11 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/basics/requirements/_index.fr.md +11 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/basics/requirements/images/magic.gif +0 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/basics/style-customization/_index.en.md +194 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/basics/style-customization/_index.fr.md +194 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/basics/style-customization/images/blue-variant.png +0 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/basics/style-customization/images/green-variant.png +0 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/basics/style-customization/images/red-variant.png +0 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/cont/_index.en.md +12 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/cont/_index.fr.md +12 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/cont/archetypes.en.md +57 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/cont/archetypes.fr.md +57 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/cont/i18n/_index.en.md +78 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/cont/i18n/_index.fr.md +78 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/cont/i18n/images/i18n-menu.gif +0 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/cont/icons.en.md +41 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/cont/markdown.en.md +665 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/cont/markdown.fr.md +666 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/cont/menushortcuts.en.md +109 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/cont/menushortcuts.fr.md +109 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/cont/pages/_index.en.md +166 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/cont/pages/_index.fr.md +146 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/cont/pages/images/frontmatter-icon.png +0 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/cont/pages/images/pages-chapter.png +0 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/cont/pages/images/pages-default.png +0 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/cont/tags.en.md +39 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/cont/tags.fr.md +40 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/credits.en.md +28 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/credits.fr.md +28 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/_index.en.md +16 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/_index.fr.md +16 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/attachments.en.files/BachGavotteShort.mp3 +0 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/attachments.en.files/Carroll_AliceAuPaysDesMerveilles.pdf +0 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/attachments.en.files/adivorciarsetoca00cape.pdf +0 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/attachments.en.files/hugo.png +0 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/attachments.en.files/movieselectricsheep-flock-244-32500-2.mp4 +0 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/attachments.en.md +85 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/attachments.fr.files/BachGavotteShort.mp3 +0 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/attachments.fr.files/Carroll_AliceAuPaysDesMerveilles.pdf +0 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/attachments.fr.files/adivorciarsetoca00cape.pdf +0 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/attachments.fr.files/hugo.png +0 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/attachments.fr.files/movieselectricsheep-flock-244-32500-2.mp4 +0 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/attachments.fr.md +85 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/button.en.md +16 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/button.fr.md +16 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/children/_index.en.md +45 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/children/_index.fr.md +45 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/children/children-1/_index.en.md +6 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/children/children-1/_index.fr.md +6 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/children/children-1/children-1-1/_index.en.md +6 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/children/children-1/children-1-1/_index.fr.md +6 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/children/children-1/children-1-1/children-1-1-1/_index.en.md +6 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/children/children-1/children-1-1/children-1-1-1/_index.fr.md +6 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/_index.en.md +6 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/_index.fr.md +6 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/children-1-1-1-1-1/_index.en.md +6 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/children-1-1-1-1-1/_index.fr.md +6 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/children/children-2/_index.en.md +11 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/children/children-2/_index.fr.md +11 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/children/children-2/test3.en.md +6 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/children/children-2/test3.fr.md +6 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/children/children-3/_index.en.md +6 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/children/children-3/_index.fr.md +6 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/children/children-4/_index.en.md +7 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/children/children-4/_index.fr.md +7 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/children/test.en.md +6 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/children/test.fr.md +6 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/expand.en.md +45 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/expand.fr.md +45 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/mermaid.en.md +283 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/mermaid.fr.md +283 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/notice.en.md +62 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/notice.fr.md +62 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/siteparam.en.md +23 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/shortcodes/siteparam.fr.md +23 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/showcase.en.md +10 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/content/showcase.fr.md +11 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/layouts/partials/custom-footer.html +10 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/layouts/partials/logo.html +39 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/layouts/partials/menu-footer.html +14 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/layouts/shortcodes/ghcontributors.html +31 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/static/css/theme-mine.css +104 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/static/fonts/monogramos-webfont.eot +0 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/static/fonts/monogramos-webfont.svg +237 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/static/fonts/monogramos-webfont.ttf +0 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/static/fonts/monogramos-webfont.woff +0 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/static/fonts/monogramos-webfont.woff2 +0 -0
- data/docs-src/themes/hugo-theme-learn/exampleSite/static/images/showcase/tat.png +0 -0
- data/docs-src/themes/hugo-theme-learn/i18n/en.toml +26 -0
- data/docs-src/themes/hugo-theme-learn/i18n/es.toml +26 -0
- data/docs-src/themes/hugo-theme-learn/i18n/fr.toml +26 -0
- data/docs-src/themes/hugo-theme-learn/i18n/id.toml +26 -0
- data/docs-src/themes/hugo-theme-learn/i18n/nl.toml +26 -0
- data/docs-src/themes/hugo-theme-learn/i18n/pt.toml +26 -0
- data/docs-src/themes/hugo-theme-learn/i18n/tr.toml +26 -0
- data/docs-src/themes/hugo-theme-learn/images/screenshot.png +0 -0
- data/docs-src/themes/hugo-theme-learn/images/tn.png +0 -0
- data/docs-src/themes/hugo-theme-learn/layouts/404.html +56 -0
- data/docs-src/themes/hugo-theme-learn/layouts/_default/list.html +22 -0
- data/docs-src/themes/hugo-theme-learn/layouts/_default/single.html +13 -0
- data/docs-src/themes/hugo-theme-learn/layouts/index.html +31 -0
- data/docs-src/themes/hugo-theme-learn/layouts/index.json +12 -0
- data/docs-src/themes/hugo-theme-learn/layouts/partials/custom-comments.html +3 -0
- data/docs-src/themes/hugo-theme-learn/layouts/partials/custom-footer.html +5 -0
- data/docs-src/themes/hugo-theme-learn/layouts/partials/custom-header.html +5 -0
- data/docs-src/themes/hugo-theme-learn/layouts/partials/favicon.html +1 -0
- data/docs-src/themes/hugo-theme-learn/layouts/partials/footer.html +78 -0
- data/docs-src/themes/hugo-theme-learn/layouts/partials/header.html +109 -0
- data/docs-src/themes/hugo-theme-learn/layouts/partials/logo.html +19 -0
- data/docs-src/themes/hugo-theme-learn/layouts/partials/menu-footer.html +1 -0
- data/docs-src/themes/hugo-theme-learn/layouts/partials/menu.html +150 -0
- data/docs-src/themes/hugo-theme-learn/layouts/partials/meta.html +2 -0
- data/docs-src/themes/hugo-theme-learn/layouts/partials/search.html +16 -0
- data/docs-src/themes/hugo-theme-learn/layouts/partials/tags.html +7 -0
- data/docs-src/themes/hugo-theme-learn/layouts/partials/toc.html +5 -0
- data/docs-src/themes/hugo-theme-learn/layouts/shortcodes/attachments.html +36 -0
- data/docs-src/themes/hugo-theme-learn/layouts/shortcodes/button.html +14 -0
- data/docs-src/themes/hugo-theme-learn/layouts/shortcodes/children.html +101 -0
- data/docs-src/themes/hugo-theme-learn/layouts/shortcodes/expand.html +17 -0
- data/docs-src/themes/hugo-theme-learn/layouts/shortcodes/mermaid.html +2 -0
- data/docs-src/themes/hugo-theme-learn/layouts/shortcodes/notice.html +2 -0
- data/docs-src/themes/hugo-theme-learn/layouts/shortcodes/ref.html +14 -0
- data/docs-src/themes/hugo-theme-learn/layouts/shortcodes/relref.html +14 -0
- data/docs-src/themes/hugo-theme-learn/layouts/shortcodes/siteparam.html +7 -0
- data/docs-src/themes/hugo-theme-learn/netlify.toml +24 -0
- data/docs-src/themes/hugo-theme-learn/static/css/atom-one-dark-reasonable.css +77 -0
- data/docs-src/themes/hugo-theme-learn/static/css/auto-complete.css +47 -0
- data/docs-src/themes/hugo-theme-learn/static/css/featherlight.min.css +8 -0
- data/docs-src/themes/hugo-theme-learn/static/css/fontawesome-all.min.css +1 -0
- data/docs-src/themes/hugo-theme-learn/static/css/hugo-theme.css +254 -0
- data/docs-src/themes/hugo-theme-learn/static/css/hybrid.css +102 -0
- data/docs-src/themes/hugo-theme-learn/static/css/nucleus.css +615 -0
- data/docs-src/themes/hugo-theme-learn/static/css/perfect-scrollbar.min.css +2 -0
- data/docs-src/themes/hugo-theme-learn/static/css/tags.css +49 -0
- data/docs-src/themes/hugo-theme-learn/static/css/theme-blue.css +111 -0
- data/docs-src/themes/hugo-theme-learn/static/css/theme-green.css +111 -0
- data/docs-src/themes/hugo-theme-learn/static/css/theme-red.css +111 -0
- data/docs-src/themes/hugo-theme-learn/static/css/theme.css +1132 -0
- data/docs-src/themes/hugo-theme-learn/static/fonts/Inconsolata.eot +0 -0
- data/docs-src/themes/hugo-theme-learn/static/fonts/Inconsolata.svg +359 -0
- data/docs-src/themes/hugo-theme-learn/static/fonts/Inconsolata.ttf +0 -0
- data/docs-src/themes/hugo-theme-learn/static/fonts/Inconsolata.woff +0 -0
- data/docs-src/themes/hugo-theme-learn/static/fonts/Novecentosanswide-Normal-webfont.eot +0 -0
- data/docs-src/themes/hugo-theme-learn/static/fonts/Novecentosanswide-Normal-webfont.svg +1019 -0
- data/docs-src/themes/hugo-theme-learn/static/fonts/Novecentosanswide-Normal-webfont.ttf +0 -0
- data/docs-src/themes/hugo-theme-learn/static/fonts/Novecentosanswide-Normal-webfont.woff +0 -0
- data/docs-src/themes/hugo-theme-learn/static/fonts/Novecentosanswide-Normal-webfont.woff2 +0 -0
- data/docs-src/themes/hugo-theme-learn/static/fonts/Novecentosanswide-UltraLight-webfont.eot +0 -0
- data/docs-src/themes/hugo-theme-learn/static/fonts/Novecentosanswide-UltraLight-webfont.svg +918 -0
- data/docs-src/themes/hugo-theme-learn/static/fonts/Novecentosanswide-UltraLight-webfont.ttf +0 -0
- data/docs-src/themes/hugo-theme-learn/static/fonts/Novecentosanswide-UltraLight-webfont.woff +0 -0
- data/docs-src/themes/hugo-theme-learn/static/fonts/Novecentosanswide-UltraLight-webfont.woff2 +0 -0
- data/docs-src/themes/hugo-theme-learn/static/fonts/Work_Sans_200.eot +0 -0
- data/docs-src/themes/hugo-theme-learn/static/fonts/Work_Sans_200.svg +332 -0
- data/docs-src/themes/hugo-theme-learn/static/fonts/Work_Sans_200.ttf +0 -0
- data/docs-src/themes/hugo-theme-learn/static/fonts/Work_Sans_200.woff +0 -0
- data/docs-src/themes/hugo-theme-learn/static/fonts/Work_Sans_200.woff2 +0 -0
- data/docs-src/themes/hugo-theme-learn/static/fonts/Work_Sans_300.eot +0 -0
- data/docs-src/themes/hugo-theme-learn/static/fonts/Work_Sans_300.svg +331 -0
- data/docs-src/themes/hugo-theme-learn/static/fonts/Work_Sans_300.ttf +0 -0
- data/docs-src/themes/hugo-theme-learn/static/fonts/Work_Sans_300.woff +0 -0
- data/docs-src/themes/hugo-theme-learn/static/fonts/Work_Sans_300.woff2 +0 -0
- data/docs-src/themes/hugo-theme-learn/static/fonts/Work_Sans_500.eot +0 -0
- data/docs-src/themes/hugo-theme-learn/static/fonts/Work_Sans_500.svg +333 -0
- data/docs-src/themes/hugo-theme-learn/static/fonts/Work_Sans_500.ttf +0 -0
- data/docs-src/themes/hugo-theme-learn/static/fonts/Work_Sans_500.woff +0 -0
- data/docs-src/themes/hugo-theme-learn/static/fonts/Work_Sans_500.woff2 +0 -0
- data/docs-src/themes/hugo-theme-learn/static/images/clippy.svg +1 -0
- data/docs-src/themes/hugo-theme-learn/static/images/favicon.png +0 -0
- data/docs-src/themes/hugo-theme-learn/static/images/gopher-404.jpg +0 -0
- data/docs-src/themes/hugo-theme-learn/static/js/auto-complete.js +223 -0
- data/docs-src/themes/hugo-theme-learn/static/js/clipboard.min.js +7 -0
- data/docs-src/themes/hugo-theme-learn/static/js/featherlight.min.js +9 -0
- data/docs-src/themes/hugo-theme-learn/static/js/highlight.pack.js +3 -0
- data/docs-src/themes/hugo-theme-learn/static/js/html5shiv-printshiv.min.js +4 -0
- data/docs-src/themes/hugo-theme-learn/static/js/hugo-learn.js +91 -0
- data/docs-src/themes/hugo-theme-learn/static/js/jquery-3.3.1.min.js +2 -0
- data/docs-src/themes/hugo-theme-learn/static/js/jquery.sticky.js +288 -0
- data/docs-src/themes/hugo-theme-learn/static/js/learn.js +459 -0
- data/docs-src/themes/hugo-theme-learn/static/js/lunr.min.js +6 -0
- data/docs-src/themes/hugo-theme-learn/static/js/modernizr.custom-3.6.0.js +3 -0
- data/docs-src/themes/hugo-theme-learn/static/js/perfect-scrollbar.jquery.min.js +2 -0
- data/docs-src/themes/hugo-theme-learn/static/js/perfect-scrollbar.min.js +2 -0
- data/docs-src/themes/hugo-theme-learn/static/js/search.js +93 -0
- data/docs-src/themes/hugo-theme-learn/static/mermaid/mermaid.css +277 -0
- data/docs-src/themes/hugo-theme-learn/static/mermaid/mermaid.dark.css +278 -0
- data/docs-src/themes/hugo-theme-learn/static/mermaid/mermaid.forest.css +356 -0
- data/docs-src/themes/hugo-theme-learn/static/mermaid/mermaid.js +8 -0
- data/docs-src/themes/hugo-theme-learn/static/webfonts/fa-brands-400.eot +0 -0
- data/docs-src/themes/hugo-theme-learn/static/webfonts/fa-brands-400.svg +1260 -0
- data/docs-src/themes/hugo-theme-learn/static/webfonts/fa-brands-400.ttf +0 -0
- data/docs-src/themes/hugo-theme-learn/static/webfonts/fa-brands-400.woff +0 -0
- data/docs-src/themes/hugo-theme-learn/static/webfonts/fa-brands-400.woff2 +0 -0
- data/docs-src/themes/hugo-theme-learn/static/webfonts/fa-regular-400.eot +0 -0
- data/docs-src/themes/hugo-theme-learn/static/webfonts/fa-regular-400.svg +471 -0
- data/docs-src/themes/hugo-theme-learn/static/webfonts/fa-regular-400.ttf +0 -0
- data/docs-src/themes/hugo-theme-learn/static/webfonts/fa-regular-400.woff +0 -0
- data/docs-src/themes/hugo-theme-learn/static/webfonts/fa-regular-400.woff2 +0 -0
- data/docs-src/themes/hugo-theme-learn/static/webfonts/fa-solid-900.eot +0 -0
- data/docs-src/themes/hugo-theme-learn/static/webfonts/fa-solid-900.svg +2763 -0
- data/docs-src/themes/hugo-theme-learn/static/webfonts/fa-solid-900.ttf +0 -0
- data/docs-src/themes/hugo-theme-learn/static/webfonts/fa-solid-900.woff +0 -0
- data/docs-src/themes/hugo-theme-learn/static/webfonts/fa-solid-900.woff2 +0 -0
- data/docs-src/themes/hugo-theme-learn/theme.toml +21 -0
- data/docs-src/themes/hugo-theme-learn/wercker.yml +16 -0
- data/docs/404.html +54 -670
- data/docs/advanced/automatic_updates/index.html +962 -635
- data/docs/advanced/command_types/index.html +1021 -736
- data/docs/advanced/distributed_state_locking/index.html +957 -622
- data/docs/advanced/hooks/index.html +968 -661
- data/docs/advanced/index.html +1099 -0
- data/docs/advanced/index.xml +117 -0
- data/docs/advanced/interactive_commands/index.html +960 -636
- data/docs/advanced/logging/index.html +963 -639
- data/docs/advanced/remote_execution/index.html +959 -634
- data/docs/advanced/state_storage/index.html +1049 -764
- data/docs/advanced/user_config_files/index.html +981 -649
- data/docs/categories/index.html +1094 -0
- data/docs/categories/index.xml +14 -0
- data/docs/css/atom-one-dark-reasonable.css +77 -0
- data/docs/css/auto-complete.css +47 -0
- data/docs/css/featherlight.min.css +8 -0
- data/docs/css/fontawesome-all.min.css +1 -0
- data/docs/css/hugo-theme.css +254 -0
- data/docs/css/hybrid.css +102 -0
- data/docs/css/nucleus.css +615 -0
- data/docs/css/perfect-scrollbar.min.css +2 -0
- data/docs/css/tags.css +49 -0
- data/docs/css/theme-blue.css +111 -0
- data/docs/css/theme-green.css +111 -0
- data/docs/css/theme-red.css +111 -0
- data/docs/css/theme.css +1132 -0
- data/docs/development/changelog/index.html +1368 -0
- data/docs/development/code_of_conduct/index.html +969 -687
- data/docs/development/contributing/index.html +993 -587
- data/docs/development/index.html +1099 -0
- data/docs/development/index.xml +54 -0
- data/docs/development/license/index.html +959 -579
- data/docs/fonts/Inconsolata.eot +0 -0
- data/docs/fonts/Inconsolata.svg +359 -0
- data/docs/fonts/Inconsolata.ttf +0 -0
- data/docs/fonts/Inconsolata.woff +0 -0
- data/docs/fonts/Novecentosanswide-Normal-webfont.eot +0 -0
- data/docs/fonts/Novecentosanswide-Normal-webfont.svg +1019 -0
- data/docs/fonts/Novecentosanswide-Normal-webfont.ttf +0 -0
- data/docs/fonts/Novecentosanswide-Normal-webfont.woff +0 -0
- data/docs/fonts/Novecentosanswide-Normal-webfont.woff2 +0 -0
- data/docs/fonts/Novecentosanswide-UltraLight-webfont.eot +0 -0
- data/docs/fonts/Novecentosanswide-UltraLight-webfont.svg +918 -0
- data/docs/fonts/Novecentosanswide-UltraLight-webfont.ttf +0 -0
- data/docs/fonts/Novecentosanswide-UltraLight-webfont.woff +0 -0
- data/docs/fonts/Novecentosanswide-UltraLight-webfont.woff2 +0 -0
- data/docs/fonts/Work_Sans_200.eot +0 -0
- data/docs/fonts/Work_Sans_200.svg +332 -0
- data/docs/fonts/Work_Sans_200.ttf +0 -0
- data/docs/fonts/Work_Sans_200.woff +0 -0
- data/docs/fonts/Work_Sans_200.woff2 +0 -0
- data/docs/fonts/Work_Sans_300.eot +0 -0
- data/docs/fonts/Work_Sans_300.svg +331 -0
- data/docs/fonts/Work_Sans_300.ttf +0 -0
- data/docs/fonts/Work_Sans_300.woff +0 -0
- data/docs/fonts/Work_Sans_300.woff2 +0 -0
- data/docs/fonts/Work_Sans_500.eot +0 -0
- data/docs/fonts/Work_Sans_500.svg +333 -0
- data/docs/fonts/Work_Sans_500.ttf +0 -0
- data/docs/fonts/Work_Sans_500.woff +0 -0
- data/docs/fonts/Work_Sans_500.woff2 +0 -0
- data/docs/images/clippy.svg +1 -0
- data/docs/images/favicon.png +0 -0
- data/docs/images/gopher-404.jpg +0 -0
- data/docs/imported/changelog/index.html +1208 -1020
- data/docs/imported/index.html +1191 -0
- data/docs/imported/index.xml +23 -0
- data/docs/index.html +907 -591
- data/docs/index.json +183 -0
- data/docs/index.xml +212 -0
- data/docs/js/auto-complete.js +223 -0
- data/docs/js/clipboard.min.js +7 -0
- data/docs/js/featherlight.min.js +9 -0
- data/docs/js/highlight.pack.js +3 -0
- data/docs/js/html5shiv-printshiv.min.js +4 -0
- data/docs/js/hugo-learn.js +91 -0
- data/docs/js/jquery-3.3.1.min.js +2 -0
- data/docs/js/jquery.sticky.js +288 -0
- data/docs/js/learn.js +459 -0
- data/docs/js/lunr.min.js +6 -0
- data/docs/js/modernizr.custom-3.6.0.js +3 -0
- data/docs/js/perfect-scrollbar.jquery.min.js +2 -0
- data/docs/js/perfect-scrollbar.min.js +2 -0
- data/docs/js/search.js +93 -0
- data/docs/mermaid/mermaid.css +277 -0
- data/docs/mermaid/mermaid.dark.css +278 -0
- data/docs/mermaid/mermaid.forest.css +356 -0
- data/docs/mermaid/mermaid.js +8 -0
- data/docs/quick_reference/index.html +1279 -0
- data/docs/quick_reference/index.xml +15 -0
- data/docs/sitemap.xml +135 -107
- data/docs/tags/index.html +1094 -0
- data/docs/tags/index.xml +14 -0
- data/docs/tutorial/10-getting_started/index.html +960 -649
- data/docs/tutorial/20-project_layout/index.html +1059 -778
- data/docs/tutorial/30-your_first_command/index.html +1040 -729
- data/docs/tutorial/40-options_parameters_and_arguments/index.html +1151 -868
- data/docs/tutorial/50-publishing/index.html +969 -676
- data/docs/tutorial/index.html +1099 -0
- data/docs/tutorial/index.xml +71 -0
- data/docs/webfonts/fa-brands-400.eot +0 -0
- data/docs/webfonts/fa-brands-400.svg +1260 -0
- data/docs/webfonts/fa-brands-400.ttf +0 -0
- data/docs/webfonts/fa-brands-400.woff +0 -0
- data/docs/webfonts/fa-brands-400.woff2 +0 -0
- data/docs/webfonts/fa-regular-400.eot +0 -0
- data/docs/webfonts/fa-regular-400.svg +471 -0
- data/docs/webfonts/fa-regular-400.ttf +0 -0
- data/docs/webfonts/fa-regular-400.woff +0 -0
- data/docs/webfonts/fa-regular-400.woff2 +0 -0
- data/docs/webfonts/fa-solid-900.eot +0 -0
- data/docs/webfonts/fa-solid-900.svg +2763 -0
- data/docs/webfonts/fa-solid-900.ttf +0 -0
- data/docs/webfonts/fa-solid-900.woff +0 -0
- data/docs/webfonts/fa-solid-900.woff2 +0 -0
- data/docs/whoami/index.html +947 -567
- data/docs/whoami/index.xml +15 -0
- data/exe/rbcli +1 -0
- data/lib/rbcli-tool/project.rb +6 -2
- data/lib/rbcli/version.rb +1 -1
- data/rbcli.gemspec +1 -1
- data/skeletons/project/.rakeTasks +7 -0
- data/skeletons/project/exe/executable +1 -3
- data/skeletons/project/lib/lib.erb +7 -0
- data/skeletons/project/untitled.gemspec +13 -15
- metadata +356 -65
- data/docs-src/mkdocs.yml +0 -79
- data/docs/assets/fonts/font-awesome.css +0 -4
- data/docs/assets/fonts/material-icons.css +0 -13
- 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 +0 -20
- data/docs/assets/images/icons/github.f0b8504a.svg +0 -18
- data/docs/assets/images/icons/gitlab.6dd19c00.svg +0 -38
- data/docs/assets/javascripts/application.583bbe55.js +0 -1
- data/docs/assets/javascripts/lunr/lunr.da.js +0 -1
- data/docs/assets/javascripts/lunr/lunr.de.js +0 -1
- data/docs/assets/javascripts/lunr/lunr.du.js +0 -1
- data/docs/assets/javascripts/lunr/lunr.es.js +0 -1
- data/docs/assets/javascripts/lunr/lunr.fi.js +0 -1
- data/docs/assets/javascripts/lunr/lunr.fr.js +0 -1
- data/docs/assets/javascripts/lunr/lunr.hu.js +0 -1
- data/docs/assets/javascripts/lunr/lunr.it.js +0 -1
- data/docs/assets/javascripts/lunr/lunr.jp.js +0 -1
- data/docs/assets/javascripts/lunr/lunr.multi.js +0 -1
- data/docs/assets/javascripts/lunr/lunr.no.js +0 -1
- data/docs/assets/javascripts/lunr/lunr.pt.js +0 -1
- data/docs/assets/javascripts/lunr/lunr.ro.js +0 -1
- data/docs/assets/javascripts/lunr/lunr.ru.js +0 -1
- data/docs/assets/javascripts/lunr/lunr.stemmer.support.js +0 -1
- data/docs/assets/javascripts/lunr/lunr.sv.js +0 -1
- data/docs/assets/javascripts/lunr/lunr.tr.js +0 -1
- data/docs/assets/javascripts/lunr/tinyseg.js +0 -1
- data/docs/assets/javascripts/modernizr.1aa3b519.js +0 -1
- data/docs/assets/stylesheets/application-palette.22915126.css +0 -1176
- data/docs/assets/stylesheets/application.451f80e5.css +0 -2552
- data/docs/imported/quick_reference/index.html +0 -1120
- data/docs/search/search_index.json +0 -1
- data/docs/sitemap.xml.gz +0 -0
- data/skeletons/project/lib/.keep +0 -0
@@ -1,854 +1,1186 @@
|
|
1
|
+
<!DOCTYPE html>
|
2
|
+
<html lang="en" class="js csstransforms3d">
|
3
|
+
<head>
|
4
|
+
<meta charset="utf-8">
|
5
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
6
|
+
<meta name="generator" content="Hugo 0.55.6" />
|
7
|
+
<meta name="description" content="">
|
1
8
|
|
2
9
|
|
10
|
+
<link rel="icon" href="/rbcli/images/favicon.png" type="image/png">
|
3
11
|
|
12
|
+
<title>User Configuration Files :: RBCli Documentation</title>
|
4
13
|
|
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-1.0.3, mkdocs-material-3.0.4">
|
40
|
-
|
41
|
-
|
42
|
-
|
43
|
-
<title>User Config Files - RBCli Documentation</title>
|
44
|
-
|
45
14
|
|
15
|
+
<link href="/rbcli/css/nucleus.css?1561087612" rel="stylesheet">
|
16
|
+
<link href="/rbcli/css/fontawesome-all.min.css?1561087612" rel="stylesheet">
|
17
|
+
<link href="/rbcli/css/hybrid.css?1561087612" rel="stylesheet">
|
18
|
+
<link href="/rbcli/css/featherlight.min.css?1561087612" rel="stylesheet">
|
19
|
+
<link href="/rbcli/css/perfect-scrollbar.min.css?1561087612" rel="stylesheet">
|
20
|
+
<link href="/rbcli/css/auto-complete.css?1561087612" rel="stylesheet">
|
21
|
+
<link href="/rbcli/css/atom-one-dark-reasonable.css?1561087612" rel="stylesheet">
|
22
|
+
<link href="/rbcli/css/theme.css?1561087612" rel="stylesheet">
|
23
|
+
<link href="/rbcli/css/hugo-theme.css?1561087612" rel="stylesheet">
|
46
24
|
|
47
|
-
<link
|
48
|
-
|
49
|
-
|
50
|
-
|
51
|
-
|
52
|
-
<script src="../../assets/javascripts/modernizr.1aa3b519.js"></script>
|
25
|
+
<link href="/rbcli/css/theme-blue.css?1561087612" rel="stylesheet">
|
53
26
|
|
54
|
-
|
55
|
-
|
56
|
-
|
57
|
-
|
58
|
-
|
27
|
+
|
28
|
+
<script src="/rbcli/js/jquery-3.3.1.min.js?1561087612"></script>
|
29
|
+
|
30
|
+
<style>
|
31
|
+
:root #header + #content > #left > #rlblock_left{
|
32
|
+
display:none !important;
|
33
|
+
}
|
59
34
|
|
35
|
+
</style>
|
60
36
|
|
61
|
-
|
37
|
+
</head>
|
38
|
+
<body class="" data-url="/rbcli/advanced/user_config_files/">
|
39
|
+
<nav id="sidebar" class="">
|
40
|
+
|
41
|
+
|
42
|
+
|
43
|
+
<div id="header-wrapper">
|
44
|
+
<div id="header">
|
45
|
+
<a id="logo" href="https://akhoury6.github.io/rbcli/" style="font-size: 40px">
|
46
|
+
<span class="fas fa-terminal"></span> 𝚁𝙱𝙲𝚕𝚒
|
47
|
+
</a>
|
48
|
+
|
49
|
+
</div>
|
62
50
|
|
51
|
+
<div class="searchbox">
|
52
|
+
<label for="search-by"><i class="fas fa-search"></i></label>
|
53
|
+
<input data-search-input id="search-by" type="search" placeholder="Search...">
|
54
|
+
<span data-search-clear=""><i class="fas fa-times"></i></span>
|
55
|
+
</div>
|
56
|
+
|
57
|
+
<script type="text/javascript" src="/rbcli/js/lunr.min.js?1561087612"></script>
|
58
|
+
<script type="text/javascript" src="/rbcli/js/auto-complete.js?1561087612"></script>
|
59
|
+
<script type="text/javascript">
|
63
60
|
|
64
|
-
|
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="../../#configuration-files" tabindex="1" class="md-skip">
|
98
|
-
Skip to content
|
99
|
-
</a>
|
61
|
+
var baseurl = "https:\/\/akhoury6.github.io\/rbcli\/";
|
100
62
|
|
63
|
+
</script>
|
64
|
+
<script type="text/javascript" src="/rbcli/js/search.js?1561087612"></script>
|
65
|
+
|
101
66
|
|
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
|
-
User Config Files
|
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
67
|
</div>
|
155
|
-
|
156
|
-
|
68
|
+
|
69
|
+
<div class="highlightable">
|
70
|
+
<ul class="topics">
|
71
|
+
|
157
72
|
|
158
|
-
|
159
|
-
|
160
|
-
<div class="md-flex__cell md-flex__cell--shrink">
|
161
|
-
<div class="md-header-nav__source">
|
162
|
-
|
73
|
+
|
74
|
+
|
163
75
|
|
164
76
|
|
77
|
+
|
78
|
+
|
79
|
+
|
80
|
+
<li data-nav-id="/rbcli/quick_reference/" title="Quick Reference" class="dd-item
|
81
|
+
|
82
|
+
|
83
|
+
|
84
|
+
">
|
85
|
+
<a href="/rbcli/quick_reference/">
|
86
|
+
Quick Reference
|
87
|
+
|
88
|
+
</a>
|
89
|
+
|
90
|
+
|
91
|
+
</li>
|
165
92
|
|
93
|
+
|
166
94
|
|
95
|
+
|
96
|
+
|
167
97
|
|
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
98
|
|
181
|
-
|
182
|
-
|
183
|
-
|
184
|
-
</div>
|
185
|
-
</nav>
|
186
|
-
</header>
|
99
|
+
|
100
|
+
|
187
101
|
|
188
|
-
<
|
189
|
-
|
102
|
+
<li data-nav-id="/rbcli/tutorial/" title="Tutorial" class="dd-item
|
190
103
|
|
191
|
-
|
192
|
-
|
193
104
|
|
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
105
|
|
202
|
-
|
203
|
-
|
204
|
-
|
205
|
-
|
106
|
+
">
|
107
|
+
<a href="/rbcli/tutorial/">
|
108
|
+
Tutorial
|
109
|
+
|
206
110
|
</a>
|
207
|
-
|
208
|
-
</li>
|
209
|
-
|
210
111
|
|
211
|
-
|
212
112
|
|
113
|
+
<ul>
|
114
|
+
|
115
|
+
|
116
|
+
|
117
|
+
|
213
118
|
|
119
|
+
|
120
|
+
|
121
|
+
|
122
|
+
|
123
|
+
|
124
|
+
|
214
125
|
|
215
|
-
|
216
|
-
|
217
|
-
|
218
|
-
<
|
219
|
-
|
126
|
+
|
127
|
+
<li data-nav-id="/rbcli/tutorial/10-getting_started/" title="Getting Started" class="dd-item ">
|
128
|
+
<a href="/rbcli/tutorial/10-getting_started/">
|
129
|
+
<b>1. </b>Getting Started
|
130
|
+
|
220
131
|
</a>
|
221
|
-
|
222
132
|
</li>
|
133
|
+
|
223
134
|
|
135
|
+
|
224
136
|
|
225
|
-
|
226
|
-
|
227
|
-
|
137
|
+
|
138
|
+
|
139
|
+
|
140
|
+
|
141
|
+
|
142
|
+
|
143
|
+
|
228
144
|
|
229
|
-
|
230
|
-
|
231
|
-
<a href="
|
232
|
-
|
145
|
+
|
146
|
+
<li data-nav-id="/rbcli/tutorial/20-project_layout/" title="The Project Layout" class="dd-item ">
|
147
|
+
<a href="/rbcli/tutorial/20-project_layout/">
|
148
|
+
<b>2. </b>The Project Layout
|
149
|
+
|
233
150
|
</a>
|
234
|
-
|
235
151
|
</li>
|
152
|
+
|
236
153
|
|
154
|
+
|
237
155
|
|
238
|
-
|
239
|
-
|
240
|
-
|
156
|
+
|
157
|
+
|
158
|
+
|
159
|
+
|
160
|
+
|
161
|
+
|
162
|
+
|
241
163
|
|
242
|
-
|
243
|
-
|
244
|
-
<a href="
|
245
|
-
|
164
|
+
|
165
|
+
<li data-nav-id="/rbcli/tutorial/30-your_first_command/" title="Your First Command" class="dd-item ">
|
166
|
+
<a href="/rbcli/tutorial/30-your_first_command/">
|
167
|
+
<b>3. </b>Your First Command
|
168
|
+
|
246
169
|
</a>
|
247
|
-
|
248
170
|
</li>
|
171
|
+
|
249
172
|
|
173
|
+
|
250
174
|
|
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">
|
175
|
+
|
260
176
|
|
261
177
|
|
262
|
-
|
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
|
-
<a href="../.." title="RBCli Documentation" class="md-nav__button md-logo">
|
268
|
-
|
269
|
-
<i class="md-icon">devices</i>
|
270
|
-
|
271
|
-
</a>
|
272
|
-
RBCli Documentation
|
273
|
-
</label>
|
274
|
-
|
275
|
-
<div class="md-nav__source">
|
276
|
-
|
178
|
+
|
277
179
|
|
278
180
|
|
181
|
+
|
279
182
|
|
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
183
|
|
290
|
-
|
291
|
-
|
292
|
-
|
293
|
-
|
294
|
-
|
295
|
-
</
|
184
|
+
<li data-nav-id="/rbcli/tutorial/40-options_parameters_and_arguments/" title="Options, Parameters, and Arguments" class="dd-item ">
|
185
|
+
<a href="/rbcli/tutorial/40-options_parameters_and_arguments/">
|
186
|
+
<b>4. </b>Options, Parameters, and Arguments
|
187
|
+
|
188
|
+
</a>
|
189
|
+
</li>
|
190
|
+
|
296
191
|
|
297
|
-
|
298
|
-
|
299
|
-
|
300
|
-
|
301
|
-
|
192
|
+
|
302
193
|
|
194
|
+
|
195
|
+
|
196
|
+
|
197
|
+
|
303
198
|
|
304
|
-
<li class="md-nav__item">
|
305
|
-
<a href="../.." title="Home" class="md-nav__link">
|
306
|
-
Home
|
307
|
-
</a>
|
308
|
-
</li>
|
309
199
|
|
200
|
+
|
201
|
+
|
310
202
|
|
311
|
-
|
312
|
-
|
313
|
-
|
314
|
-
|
203
|
+
<li data-nav-id="/rbcli/tutorial/50-publishing/" title="Publishing Your Application" class="dd-item ">
|
204
|
+
<a href="/rbcli/tutorial/50-publishing/">
|
205
|
+
<b>5. </b>Publishing Your Application
|
206
|
+
|
207
|
+
</a>
|
208
|
+
</li>
|
209
|
+
|
210
|
+
|
211
|
+
|
315
212
|
|
316
|
-
|
317
|
-
|
318
|
-
|
319
|
-
|
320
|
-
|
213
|
+
|
214
|
+
|
215
|
+
|
216
|
+
</ul>
|
217
|
+
|
218
|
+
</li>
|
219
|
+
|
220
|
+
|
321
221
|
|
322
|
-
|
323
|
-
|
324
|
-
|
325
|
-
|
222
|
+
|
223
|
+
|
326
224
|
|
327
225
|
|
328
|
-
|
329
|
-
|
330
|
-
<input class="md-toggle md-nav__toggle" data-md-toggle="nav-3" type="checkbox" id="nav-3">
|
226
|
+
|
227
|
+
|
331
228
|
|
332
|
-
<
|
333
|
-
|
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>
|
229
|
+
<li data-nav-id="/rbcli/advanced/" title="Advanced" class="dd-item
|
230
|
+
parent
|
340
231
|
|
341
232
|
|
233
|
+
">
|
234
|
+
<a href="/rbcli/advanced/">
|
235
|
+
Advanced
|
342
236
|
|
237
|
+
</a>
|
238
|
+
|
239
|
+
|
240
|
+
<ul>
|
343
241
|
|
344
242
|
|
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
243
|
|
356
244
|
|
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
245
|
|
366
246
|
|
367
|
-
|
368
|
-
|
369
|
-
|
247
|
+
|
248
|
+
|
370
249
|
|
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
250
|
|
251
|
+
|
252
|
+
|
253
|
+
|
254
|
+
<li data-nav-id="/rbcli/advanced/automatic_updates/" title="Automatic Updates" class="dd-item ">
|
255
|
+
<a href="/rbcli/advanced/automatic_updates/">
|
256
|
+
Automatic Updates
|
377
257
|
|
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>
|
258
|
+
</a>
|
259
|
+
</li>
|
260
|
+
|
261
|
+
|
262
|
+
|
388
263
|
|
389
|
-
|
390
|
-
|
391
|
-
|
264
|
+
|
392
265
|
|
266
|
+
|
267
|
+
|
393
268
|
|
394
269
|
|
395
|
-
|
396
|
-
|
397
|
-
Publishing and Distribution
|
398
|
-
</a>
|
399
|
-
</li>
|
400
|
-
|
401
|
-
|
402
|
-
</ul>
|
403
|
-
</nav>
|
404
|
-
</li>
|
405
|
-
|
270
|
+
|
271
|
+
|
406
272
|
|
407
|
-
|
408
|
-
|
409
|
-
|
410
|
-
|
273
|
+
<li data-nav-id="/rbcli/advanced/command_types/" title="Command Types" class="dd-item ">
|
274
|
+
<a href="/rbcli/advanced/command_types/">
|
275
|
+
Command Types
|
276
|
+
|
277
|
+
</a>
|
278
|
+
</li>
|
279
|
+
|
411
280
|
|
281
|
+
|
282
|
+
|
283
|
+
|
284
|
+
|
285
|
+
|
286
|
+
|
412
287
|
|
413
288
|
|
414
|
-
|
415
|
-
|
416
|
-
<input class="md-toggle md-nav__toggle" data-md-toggle="nav-4" type="checkbox" id="nav-4" checked>
|
289
|
+
|
290
|
+
|
417
291
|
|
418
|
-
|
419
|
-
|
420
|
-
|
421
|
-
<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
|
422
|
-
<label class="md-nav__title" for="nav-4">
|
423
|
-
Advanced Features
|
424
|
-
</label>
|
425
|
-
<ul class="md-nav__list" data-md-scrollfix>
|
292
|
+
<li data-nav-id="/rbcli/advanced/distributed_state_locking/" title="Distributed State and Locking" class="dd-item ">
|
293
|
+
<a href="/rbcli/advanced/distributed_state_locking/">
|
294
|
+
Distributed State and Locking
|
426
295
|
|
427
|
-
|
428
|
-
|
429
|
-
|
296
|
+
</a>
|
297
|
+
</li>
|
298
|
+
|
299
|
+
|
300
|
+
|
301
|
+
|
302
|
+
|
430
303
|
|
304
|
+
|
305
|
+
|
431
306
|
|
432
307
|
|
433
|
-
|
434
|
-
|
435
|
-
|
436
|
-
|
437
|
-
|
438
|
-
|
308
|
+
|
309
|
+
|
310
|
+
|
311
|
+
<li data-nav-id="/rbcli/advanced/hooks/" title="Execution Hooks" class="dd-item ">
|
312
|
+
<a href="/rbcli/advanced/hooks/">
|
313
|
+
Execution Hooks
|
439
314
|
|
440
|
-
|
441
|
-
|
442
|
-
|
443
|
-
|
315
|
+
</a>
|
316
|
+
</li>
|
317
|
+
|
444
318
|
|
319
|
+
|
445
320
|
|
321
|
+
|
322
|
+
|
323
|
+
|
324
|
+
|
446
325
|
|
447
|
-
|
448
|
-
|
449
|
-
<input class="md-toggle md-nav__toggle" data-md-toggle="toc" type="checkbox" id="__toc">
|
450
|
-
|
451
|
-
|
452
|
-
|
453
|
-
|
454
|
-
<label class="md-nav__link md-nav__link--active" for="__toc">
|
455
|
-
User Config Files
|
456
|
-
</label>
|
457
|
-
|
458
|
-
<a href="./" title="User Config Files" class="md-nav__link md-nav__link--active">
|
459
|
-
User Config Files
|
460
|
-
</a>
|
461
|
-
|
462
|
-
|
463
|
-
<nav class="md-nav md-nav--secondary">
|
464
|
-
|
326
|
+
|
327
|
+
|
465
328
|
|
466
329
|
|
330
|
+
<li data-nav-id="/rbcli/advanced/interactive_commands/" title="Interactive Commands" class="dd-item ">
|
331
|
+
<a href="/rbcli/advanced/interactive_commands/">
|
332
|
+
Interactive Commands
|
333
|
+
|
334
|
+
</a>
|
335
|
+
</li>
|
336
|
+
|
467
337
|
|
338
|
+
|
339
|
+
|
340
|
+
|
341
|
+
|
342
|
+
|
343
|
+
|
344
|
+
|
345
|
+
|
346
|
+
|
468
347
|
|
469
|
-
<label class="md-nav__title" for="__toc">Table of contents</label>
|
470
|
-
<ul class="md-nav__list" data-md-scrollfix>
|
471
|
-
|
472
|
-
<li class="md-nav__item">
|
473
|
-
<a href="#defaults-chain" title="Defaults chain" class="md-nav__link">
|
474
|
-
Defaults chain
|
475
|
-
</a>
|
476
|
-
|
477
|
-
</li>
|
478
|
-
|
479
|
-
<li class="md-nav__item">
|
480
|
-
<a href="#user-chain" title="User chain" class="md-nav__link">
|
481
|
-
User chain
|
482
|
-
</a>
|
483
|
-
|
484
|
-
</li>
|
485
|
-
|
486
|
-
|
487
|
-
|
488
|
-
|
489
|
-
|
490
|
-
</ul>
|
491
|
-
|
492
|
-
</nav>
|
493
348
|
|
494
|
-
|
495
|
-
|
349
|
+
<li data-nav-id="/rbcli/advanced/logging/" title="Logging" class="dd-item ">
|
350
|
+
<a href="/rbcli/advanced/logging/">
|
351
|
+
Logging
|
496
352
|
|
497
|
-
|
498
|
-
|
499
|
-
|
353
|
+
</a>
|
354
|
+
</li>
|
355
|
+
|
356
|
+
|
357
|
+
|
500
358
|
|
359
|
+
|
360
|
+
|
361
|
+
|
362
|
+
|
501
363
|
|
502
|
-
<li class="md-nav__item">
|
503
|
-
<a href="../hooks/" title="Hooks" class="md-nav__link">
|
504
|
-
Hooks
|
505
|
-
</a>
|
506
|
-
</li>
|
507
364
|
|
365
|
+
|
366
|
+
|
367
|
+
|
368
|
+
<li data-nav-id="/rbcli/advanced/remote_execution/" title="Remote Execution" class="dd-item ">
|
369
|
+
<a href="/rbcli/advanced/remote_execution/">
|
370
|
+
Remote Execution
|
508
371
|
|
509
|
-
|
510
|
-
|
511
|
-
|
372
|
+
</a>
|
373
|
+
</li>
|
374
|
+
|
375
|
+
|
376
|
+
|
512
377
|
|
378
|
+
|
379
|
+
|
380
|
+
|
381
|
+
|
513
382
|
|
514
|
-
<li class="md-nav__item">
|
515
|
-
<a href="../logging/" title="Logging" class="md-nav__link">
|
516
|
-
Logging
|
517
|
-
</a>
|
518
|
-
</li>
|
519
383
|
|
384
|
+
|
385
|
+
|
386
|
+
|
387
|
+
<li data-nav-id="/rbcli/advanced/state_storage/" title="State Storage" class="dd-item ">
|
388
|
+
<a href="/rbcli/advanced/state_storage/">
|
389
|
+
State Storage
|
520
390
|
|
521
|
-
|
522
|
-
|
523
|
-
|
391
|
+
</a>
|
392
|
+
</li>
|
393
|
+
|
394
|
+
|
395
|
+
|
524
396
|
|
397
|
+
|
398
|
+
|
399
|
+
|
400
|
+
|
525
401
|
|
526
|
-
<li class="md-nav__item">
|
527
|
-
<a href="../automatic_updates/" title="Automatic Updates" class="md-nav__link">
|
528
|
-
Automatic Updates
|
529
|
-
</a>
|
530
|
-
</li>
|
531
402
|
|
403
|
+
|
404
|
+
|
405
|
+
|
406
|
+
<li data-nav-id="/rbcli/advanced/user_config_files/" title="User Configuration Files" class="dd-item active">
|
407
|
+
<a href="/rbcli/advanced/user_config_files/">
|
408
|
+
User Configuration Files
|
532
409
|
|
410
|
+
</a>
|
411
|
+
</li>
|
412
|
+
|
413
|
+
|
414
|
+
|
415
|
+
|
416
|
+
|
533
417
|
|
418
|
+
|
419
|
+
</ul>
|
420
|
+
|
421
|
+
</li>
|
422
|
+
|
423
|
+
|
424
|
+
|
534
425
|
|
535
426
|
|
536
427
|
|
537
428
|
|
538
|
-
|
539
|
-
|
540
|
-
|
541
|
-
|
542
|
-
|
543
|
-
|
429
|
+
|
430
|
+
|
431
|
+
|
432
|
+
<li data-nav-id="/rbcli/development/" title="Development" class="dd-item
|
433
|
+
|
544
434
|
|
435
|
+
|
436
|
+
">
|
437
|
+
<a href="/rbcli/development/">
|
438
|
+
Development
|
545
439
|
|
440
|
+
</a>
|
441
|
+
|
442
|
+
|
443
|
+
<ul>
|
546
444
|
|
547
445
|
|
548
|
-
|
549
|
-
|
550
|
-
<li class="md-nav__item">
|
551
|
-
<a href="../distributed_state_locking/" title="Distributed State Locking" class="md-nav__link">
|
552
|
-
Distributed State Locking
|
553
|
-
</a>
|
554
|
-
</li>
|
555
|
-
|
556
|
-
|
557
446
|
|
558
447
|
|
448
|
+
|
559
449
|
|
450
|
+
|
451
|
+
|
560
452
|
|
561
453
|
|
562
|
-
|
563
|
-
|
564
|
-
|
565
|
-
|
566
|
-
|
567
|
-
|
454
|
+
|
455
|
+
|
456
|
+
|
457
|
+
<li data-nav-id="/rbcli/development/contributing/" title="Contribution Guide" class="dd-item ">
|
458
|
+
<a href="/rbcli/development/contributing/">
|
459
|
+
Contribution Guide
|
568
460
|
|
569
|
-
|
570
|
-
|
571
|
-
|
461
|
+
</a>
|
462
|
+
</li>
|
463
|
+
|
464
|
+
|
465
|
+
|
572
466
|
|
467
|
+
|
468
|
+
|
469
|
+
|
470
|
+
|
573
471
|
|
574
|
-
<li class="md-nav__item">
|
575
|
-
<a href="../interactive_commands/" title="Interactive Commands" class="md-nav__link">
|
576
|
-
Interactive Commands
|
577
|
-
</a>
|
578
|
-
</li>
|
579
472
|
|
473
|
+
|
474
|
+
|
475
|
+
|
476
|
+
<li data-nav-id="/rbcli/development/license/" title="License Info" class="dd-item ">
|
477
|
+
<a href="/rbcli/development/license/">
|
478
|
+
License Info
|
580
479
|
|
581
|
-
|
582
|
-
</
|
583
|
-
|
480
|
+
</a>
|
481
|
+
</li>
|
482
|
+
|
483
|
+
|
484
|
+
|
584
485
|
|
585
|
-
|
586
|
-
|
587
|
-
|
588
|
-
|
486
|
+
|
487
|
+
|
488
|
+
|
489
|
+
|
589
490
|
|
590
491
|
|
591
|
-
|
592
|
-
|
593
|
-
<input class="md-toggle md-nav__toggle" data-md-toggle="nav-5" type="checkbox" id="nav-5">
|
492
|
+
|
493
|
+
|
594
494
|
|
595
|
-
|
596
|
-
|
597
|
-
|
598
|
-
<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
|
599
|
-
<label class="md-nav__title" for="nav-5">
|
600
|
-
Development
|
601
|
-
</label>
|
602
|
-
<ul class="md-nav__list" data-md-scrollfix>
|
495
|
+
<li data-nav-id="/rbcli/development/code_of_conduct/" title="Code of Conduct" class="dd-item ">
|
496
|
+
<a href="/rbcli/development/code_of_conduct/">
|
497
|
+
Code of Conduct
|
603
498
|
|
604
|
-
|
605
|
-
|
606
|
-
|
607
|
-
|
499
|
+
</a>
|
500
|
+
</li>
|
501
|
+
|
502
|
+
|
503
|
+
|
608
504
|
|
505
|
+
|
506
|
+
|
507
|
+
|
508
|
+
|
609
509
|
|
610
|
-
<li class="md-nav__item">
|
611
|
-
<a href="../../development/contributing/" title="Contribution Guide" class="md-nav__link">
|
612
|
-
Contribution Guide
|
613
|
-
</a>
|
614
|
-
</li>
|
615
510
|
|
511
|
+
|
512
|
+
|
513
|
+
|
514
|
+
<li data-nav-id="/rbcli/development/changelog/" title="Changelog" class="dd-item ">
|
515
|
+
<a href="/rbcli/development/changelog/">
|
516
|
+
Changelog
|
616
517
|
|
518
|
+
</a>
|
519
|
+
</li>
|
520
|
+
|
521
|
+
|
522
|
+
|
523
|
+
|
524
|
+
|
617
525
|
|
526
|
+
|
527
|
+
</ul>
|
528
|
+
|
529
|
+
</li>
|
530
|
+
|
531
|
+
|
532
|
+
|
618
533
|
|
619
534
|
|
620
535
|
|
621
536
|
|
622
|
-
|
623
|
-
|
624
|
-
|
625
|
-
|
626
|
-
</li>
|
627
|
-
|
537
|
+
|
538
|
+
|
539
|
+
|
540
|
+
<li data-nav-id="/rbcli/whoami/" title="My Letter To You" class="dd-item
|
628
541
|
|
542
|
+
|
543
|
+
|
544
|
+
">
|
545
|
+
<a href="/rbcli/whoami/">
|
546
|
+
My Letter To You
|
629
547
|
|
630
|
-
|
631
|
-
|
632
|
-
|
548
|
+
</a>
|
549
|
+
|
550
|
+
|
551
|
+
</li>
|
552
|
+
|
553
|
+
|
633
554
|
|
634
|
-
|
635
|
-
|
636
|
-
|
637
|
-
</a>
|
638
|
-
</li>
|
555
|
+
|
556
|
+
|
557
|
+
</ul>
|
639
558
|
|
640
|
-
|
559
|
+
|
560
|
+
|
561
|
+
<section id="shortcuts">
|
562
|
+
<h3>More</h3>
|
563
|
+
<ul>
|
641
564
|
|
565
|
+
<li>
|
566
|
+
<a class="padding" href="https://github.com/akhoury6/rbcli"><i class='fab fa-github'></i> Github repo</a>
|
567
|
+
</li>
|
642
568
|
|
569
|
+
<li>
|
570
|
+
<a class="padding" href="https://rubygems.org/gems/rbcli"><i class='far fa-gem'></i> Rubygems</a>
|
571
|
+
</li>
|
643
572
|
|
573
|
+
</ul>
|
574
|
+
</section>
|
575
|
+
|
644
576
|
|
577
|
+
|
578
|
+
<section id="footer">
|
579
|
+
<p>Built with <a href="https://github.com/matcornic/hugo-theme-learn"><i class="fas fa-heart"></i></a> from <a href="https://getgrav.org">Grav</a> and <a href="https://gohugo.io/">Hugo</a></p>
|
645
580
|
|
646
|
-
|
647
|
-
|
648
|
-
|
649
|
-
</a>
|
650
|
-
</li>
|
581
|
+
</section>
|
582
|
+
</div>
|
583
|
+
</nav>
|
651
584
|
|
652
|
-
|
653
|
-
</ul>
|
654
|
-
</nav>
|
655
|
-
</li>
|
656
585
|
|
657
|
-
|
658
|
-
|
659
|
-
|
660
|
-
|
661
586
|
|
662
587
|
|
663
|
-
<li class="md-nav__item">
|
664
|
-
<a href="../../whoami/" title="whoami" class="md-nav__link">
|
665
|
-
whoami
|
666
|
-
</a>
|
667
|
-
</li>
|
668
588
|
|
669
|
-
|
670
|
-
|
671
|
-
|
672
|
-
|
673
|
-
|
674
|
-
|
589
|
+
<section id="body">
|
590
|
+
<div id="overlay"></div>
|
591
|
+
<div class="padding highlightable">
|
592
|
+
|
593
|
+
<div>
|
594
|
+
<div id="top-bar">
|
595
|
+
|
596
|
+
|
597
|
+
<div id="breadcrumbs" itemscope="" itemtype="http://data-vocabulary.org/Breadcrumb">
|
598
|
+
<span id="sidebar-toggle-span">
|
599
|
+
<a href="#" id="sidebar-toggle" data-sidebar-toggle="">
|
600
|
+
<i class="fas fa-bars"></i>
|
601
|
+
</a>
|
602
|
+
</span>
|
603
|
+
|
604
|
+
<span id="toc-menu"><i class="fas fa-list-alt"></i></span>
|
605
|
+
|
606
|
+
<span class="links">
|
607
|
+
|
608
|
+
|
609
|
+
|
610
|
+
|
611
|
+
|
675
612
|
|
676
613
|
|
677
|
-
|
678
|
-
|
679
|
-
|
680
|
-
|
681
|
-
|
682
|
-
|
683
|
-
|
684
|
-
|
685
|
-
|
686
|
-
|
687
|
-
|
688
|
-
|
689
|
-
|
690
|
-
|
691
|
-
|
692
|
-
Defaults chain
|
693
|
-
</a>
|
694
|
-
|
695
|
-
</li>
|
696
|
-
|
697
|
-
<li class="md-nav__item">
|
698
|
-
<a href="#user-chain" title="User chain" class="md-nav__link">
|
699
|
-
User chain
|
700
|
-
</a>
|
701
|
-
|
702
|
-
</li>
|
703
|
-
|
704
|
-
|
705
|
-
|
706
|
-
|
707
|
-
|
708
|
-
</ul>
|
709
|
-
|
710
|
-
</nav>
|
711
|
-
</div>
|
614
|
+
|
615
|
+
|
616
|
+
|
617
|
+
|
618
|
+
|
619
|
+
|
620
|
+
<a href='/rbcli/'></a> > <a href='/rbcli/advanced/'>Advanced</a> > User Configuration Files
|
621
|
+
|
622
|
+
|
623
|
+
|
624
|
+
|
625
|
+
|
626
|
+
|
627
|
+
|
628
|
+
</span>
|
712
629
|
</div>
|
630
|
+
|
631
|
+
<div class="progress">
|
632
|
+
<div class="wrapper">
|
633
|
+
<nav id="TableOfContents">
|
634
|
+
<ul>
|
635
|
+
<li>
|
636
|
+
<ul>
|
637
|
+
<li><a href="#defaults-chain">Defaults chain</a></li>
|
638
|
+
<li><a href="#user-chain">User chain</a></li>
|
639
|
+
</ul></li>
|
640
|
+
</ul>
|
641
|
+
</nav>
|
642
|
+
</div>
|
643
|
+
</div>
|
644
|
+
|
645
|
+
|
713
646
|
</div>
|
647
|
+
</div>
|
714
648
|
|
649
|
+
<div id="head-tags">
|
650
|
+
|
651
|
+
</div>
|
652
|
+
|
653
|
+
<div id="body-inner">
|
715
654
|
|
716
|
-
|
717
|
-
<article class="md-content__inner md-typeset">
|
655
|
+
<h1>
|
718
656
|
|
719
|
-
|
720
|
-
|
721
|
-
|
657
|
+
User Configuration Files
|
658
|
+
</h1>
|
659
|
+
|
660
|
+
|
661
|
+
|
662
|
+
|
663
|
+
|
664
|
+
|
665
|
+
|
666
|
+
|
722
667
|
<p>RBCli provides built-in support for creating and managing userspace configuration files. It does this through two chains: the <strong>defaults chain</strong> and the <strong>user chain</strong>.</p>
|
668
|
+
|
723
669
|
<h2 id="defaults-chain">Defaults chain</h2>
|
670
|
+
|
724
671
|
<p>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:</p>
|
672
|
+
|
673
|
+
<ul>
|
674
|
+
<li>YAML Files
|
675
|
+
|
725
676
|
<ul>
|
726
|
-
<li>YAML Files<ul>
|
727
677
|
<li>You can store your defaults in one or more YAML files and RBCli will import and combine them. Note that when generating the user config, RBCli will use the YAML text as-is, so comments are transferred as well. This allows you to write descriptions for the options directly in the file that the user can see.</li>
|
728
678
|
<li>This is good for tools with large or complex configuration that needs user documentation written inline</li>
|
729
679
|
<li>These YAML files should be placed in the <code>userconf/</code> directory in your project and they will automatically be loaded</li>
|
730
|
-
</ul>
|
731
|
-
|
732
|
-
|
733
|
-
<
|
680
|
+
</ul></li>
|
681
|
+
<li>DSL Statements
|
682
|
+
|
683
|
+
<ul>
|
684
|
+
<li>In the DSL, you can specify options individually by providing a name, description, and default value</li>
|
734
685
|
<li>This is good for simpler configuration, as the descriptions provided are written out as comments in the generated user config</li>
|
735
686
|
<li>You can put global configuration options in <code>config/userspace.rb</code></li>
|
736
687
|
<li>Command-specific confiugration can be placed in the command declarations in <code>application/commands/*.rb</code></li>
|
688
|
+
</ul></li>
|
737
689
|
</ul>
|
738
|
-
|
739
|
-
</ul>
|
690
|
+
|
740
691
|
<p>DSL statements appear in both of the above locations as the following:</p>
|
741
|
-
|
692
|
+
|
693
|
+
<pre><code class="language-ruby">config_default :name, description: '<description_help_text>', default: '<default_value>'
|
742
694
|
</code></pre>
|
743
695
|
|
744
696
|
<h2 id="user-chain">User chain</h2>
|
745
|
-
|
697
|
+
|
698
|
+
<p>The user chain has two functions: generating and loading configuration from a YAML file on the end user’s machine.</p>
|
699
|
+
|
746
700
|
<p>Rbcli will determine the correct location to locate the user configuration based on two factors:</p>
|
701
|
+
|
747
702
|
<ol>
|
748
703
|
<li>The default location set in <code>config/userspace.rb</code></li>
|
749
704
|
<li>The location specified on the command line using the <code>--config-file=<filename></code> option (overrides #1)</li>
|
750
705
|
</ol>
|
706
|
+
|
751
707
|
<p>To configure the default location, edit <code>config/userspace.rb</code>:</p>
|
752
|
-
|
708
|
+
|
709
|
+
<pre><code class="language-ruby">config_userfile '~/.mytool', merge_defaults: true, required: false
|
753
710
|
</code></pre>
|
754
711
|
|
755
712
|
<ul>
|
756
|
-
<li><code>path/to/config/file</code
|
757
|
-
|
758
|
-
|
759
|
-
</li>
|
760
|
-
|
713
|
+
<li><code>path/to/config/file</code>
|
714
|
+
|
715
|
+
<ul>
|
716
|
+
<li>Self explanatory. Recommended locations are a dotfile in the user’s home directory, or a file under <code>/etc</code> such as <code>/etc/mytool/userconf.yaml</code></li>
|
717
|
+
</ul></li>
|
718
|
+
<li><code>merge_defaults</code>
|
719
|
+
|
720
|
+
<ul>
|
761
721
|
<li>If set to <code>true</code>, default settings override user settings. If set to <code>false</code>, default settings are not loaded at all and the user is required to have all values specified in their config.</li>
|
762
|
-
</ul>
|
763
|
-
|
764
|
-
|
722
|
+
</ul></li>
|
723
|
+
<li><code>required</code>
|
724
|
+
|
725
|
+
<ul>
|
765
726
|
<li>If set to <code>true</code> the application will not run if the file does not exist. A message will be displayed to the user to run your application with the <code>--generate-config</code> option to generate the file given your specified defaults.</li>
|
727
|
+
</ul></li>
|
766
728
|
</ul>
|
767
|
-
|
768
|
-
</
|
769
|
-
|
729
|
+
|
730
|
+
<p>Users can generate configs by running <code>yourclitool --generate-config</code>. This will generate a config file at the tool’s default location specified in the DSL. This location can be overridden via the <code>--config-file=<filename></code> option.</p>
|
731
|
+
|
732
|
+
|
733
|
+
<footer class=" footline" >
|
734
|
+
|
735
|
+
</footer>
|
736
|
+
|
737
|
+
|
738
|
+
|
739
|
+
</div>
|
740
|
+
|
741
|
+
|
742
|
+
</div>
|
743
|
+
|
744
|
+
<div id="navigation">
|
745
|
+
|
746
|
+
|
747
|
+
|
748
|
+
|
749
|
+
|
750
|
+
|
770
751
|
|
771
|
-
|
752
|
+
|
753
|
+
|
772
754
|
|
773
|
-
|
774
|
-
|
775
755
|
|
776
756
|
|
757
|
+
|
758
|
+
|
759
|
+
|
760
|
+
|
761
|
+
|
777
762
|
|
778
|
-
|
779
|
-
|
780
|
-
|
781
|
-
|
782
|
-
|
783
|
-
|
763
|
+
|
764
|
+
|
765
|
+
|
766
|
+
|
767
|
+
|
768
|
+
|
769
|
+
|
770
|
+
|
771
|
+
|
772
|
+
|
773
|
+
|
774
|
+
|
775
|
+
|
776
|
+
|
777
|
+
|
778
|
+
|
779
|
+
|
780
|
+
|
784
781
|
|
785
|
-
|
786
|
-
|
787
|
-
|
788
|
-
|
782
|
+
|
783
|
+
|
784
|
+
|
785
|
+
|
786
|
+
|
787
|
+
|
788
|
+
|
789
|
+
|
790
|
+
|
791
|
+
|
792
|
+
|
793
|
+
|
794
|
+
|
795
|
+
|
796
|
+
|
797
|
+
|
798
|
+
|
799
|
+
|
800
|
+
|
801
|
+
|
802
|
+
|
803
|
+
|
804
|
+
|
805
|
+
|
806
|
+
|
807
|
+
|
808
|
+
|
809
|
+
|
789
810
|
|
790
|
-
|
791
|
-
|
792
|
-
|
793
|
-
|
794
|
-
|
795
|
-
|
796
|
-
|
797
|
-
|
798
|
-
|
799
|
-
|
800
|
-
|
801
|
-
|
802
|
-
|
811
|
+
|
812
|
+
|
813
|
+
|
814
|
+
|
815
|
+
|
816
|
+
|
817
|
+
|
818
|
+
|
819
|
+
|
820
|
+
|
821
|
+
|
822
|
+
|
823
|
+
|
824
|
+
|
825
|
+
|
803
826
|
|
827
|
+
|
828
|
+
|
829
|
+
|
830
|
+
|
831
|
+
|
832
|
+
|
833
|
+
|
834
|
+
|
835
|
+
|
836
|
+
|
837
|
+
|
838
|
+
|
839
|
+
|
840
|
+
|
841
|
+
|
804
842
|
|
805
|
-
|
806
|
-
|
807
|
-
|
808
|
-
|
809
|
-
|
810
|
-
|
811
|
-
|
812
|
-
|
813
|
-
|
814
|
-
|
815
|
-
|
816
|
-
|
817
|
-
|
843
|
+
|
844
|
+
|
845
|
+
|
846
|
+
|
847
|
+
|
848
|
+
|
849
|
+
|
850
|
+
|
851
|
+
|
852
|
+
|
853
|
+
|
854
|
+
|
855
|
+
|
856
|
+
|
857
|
+
|
818
858
|
|
819
|
-
|
820
|
-
|
821
|
-
|
822
|
-
|
823
|
-
|
824
|
-
|
859
|
+
|
860
|
+
|
861
|
+
|
862
|
+
|
863
|
+
|
864
|
+
|
865
|
+
|
866
|
+
|
867
|
+
|
868
|
+
|
869
|
+
|
870
|
+
|
871
|
+
|
872
|
+
|
873
|
+
|
825
874
|
|
826
|
-
|
827
|
-
|
828
|
-
</div>
|
875
|
+
|
876
|
+
|
829
877
|
|
830
|
-
|
831
|
-
|
832
|
-
|
833
|
-
|
834
|
-
|
835
|
-
|
836
|
-
|
878
|
+
|
879
|
+
|
880
|
+
|
881
|
+
|
882
|
+
|
883
|
+
|
884
|
+
|
885
|
+
|
886
|
+
|
887
|
+
|
888
|
+
|
889
|
+
|
890
|
+
|
891
|
+
|
892
|
+
|
893
|
+
|
894
|
+
|
895
|
+
|
896
|
+
|
897
|
+
|
898
|
+
|
899
|
+
|
900
|
+
|
901
|
+
|
902
|
+
|
903
|
+
|
904
|
+
|
905
|
+
|
906
|
+
|
907
|
+
|
908
|
+
|
909
|
+
|
837
910
|
|
838
|
-
|
839
|
-
|
840
|
-
|
841
|
-
|
842
|
-
|
911
|
+
|
912
|
+
|
913
|
+
|
914
|
+
|
915
|
+
|
916
|
+
|
917
|
+
|
918
|
+
|
919
|
+
|
920
|
+
|
921
|
+
|
922
|
+
|
923
|
+
|
924
|
+
|
925
|
+
|
926
|
+
|
927
|
+
|
928
|
+
|
929
|
+
|
930
|
+
|
931
|
+
|
932
|
+
|
933
|
+
|
934
|
+
|
935
|
+
|
936
|
+
|
937
|
+
|
938
|
+
|
939
|
+
|
940
|
+
|
941
|
+
|
942
|
+
|
943
|
+
|
944
|
+
|
945
|
+
|
946
|
+
|
947
|
+
|
948
|
+
|
949
|
+
|
950
|
+
|
951
|
+
|
952
|
+
|
953
|
+
|
954
|
+
|
955
|
+
|
956
|
+
|
957
|
+
|
958
|
+
|
959
|
+
|
960
|
+
|
961
|
+
|
962
|
+
|
963
|
+
|
964
|
+
|
965
|
+
|
966
|
+
|
967
|
+
|
968
|
+
|
969
|
+
|
970
|
+
|
971
|
+
|
972
|
+
|
973
|
+
|
974
|
+
|
975
|
+
|
976
|
+
|
977
|
+
|
978
|
+
|
979
|
+
|
980
|
+
|
981
|
+
|
982
|
+
|
983
|
+
|
984
|
+
|
985
|
+
|
986
|
+
|
987
|
+
|
988
|
+
|
989
|
+
|
990
|
+
|
991
|
+
|
992
|
+
|
993
|
+
|
994
|
+
|
995
|
+
|
996
|
+
|
997
|
+
|
998
|
+
|
999
|
+
|
1000
|
+
|
1001
|
+
|
1002
|
+
|
1003
|
+
|
1004
|
+
|
1005
|
+
|
1006
|
+
|
1007
|
+
|
1008
|
+
|
1009
|
+
|
1010
|
+
|
1011
|
+
|
1012
|
+
|
1013
|
+
|
1014
|
+
|
1015
|
+
|
1016
|
+
|
1017
|
+
|
1018
|
+
|
1019
|
+
|
1020
|
+
|
1021
|
+
|
1022
|
+
|
1023
|
+
|
1024
|
+
|
1025
|
+
|
1026
|
+
|
1027
|
+
|
1028
|
+
|
1029
|
+
|
1030
|
+
|
1031
|
+
|
1032
|
+
|
1033
|
+
|
1034
|
+
|
1035
|
+
|
1036
|
+
|
1037
|
+
|
1038
|
+
|
1039
|
+
|
1040
|
+
|
1041
|
+
|
1042
|
+
|
1043
|
+
|
1044
|
+
|
1045
|
+
|
1046
|
+
|
1047
|
+
|
1048
|
+
|
1049
|
+
|
1050
|
+
|
1051
|
+
|
1052
|
+
|
1053
|
+
|
1054
|
+
|
1055
|
+
|
1056
|
+
|
1057
|
+
|
1058
|
+
|
1059
|
+
|
1060
|
+
|
1061
|
+
|
1062
|
+
|
1063
|
+
|
1064
|
+
|
1065
|
+
|
1066
|
+
|
1067
|
+
|
1068
|
+
|
1069
|
+
|
1070
|
+
|
1071
|
+
|
1072
|
+
|
1073
|
+
|
1074
|
+
|
1075
|
+
|
1076
|
+
|
1077
|
+
|
1078
|
+
|
1079
|
+
|
1080
|
+
|
1081
|
+
|
1082
|
+
|
1083
|
+
|
1084
|
+
|
1085
|
+
|
1086
|
+
|
1087
|
+
|
1088
|
+
|
1089
|
+
|
1090
|
+
|
1091
|
+
|
1092
|
+
|
1093
|
+
|
1094
|
+
|
1095
|
+
|
1096
|
+
|
1097
|
+
|
1098
|
+
|
1099
|
+
|
1100
|
+
|
1101
|
+
|
1102
|
+
|
1103
|
+
|
1104
|
+
|
1105
|
+
|
1106
|
+
|
1107
|
+
|
1108
|
+
|
1109
|
+
|
1110
|
+
|
1111
|
+
|
1112
|
+
|
1113
|
+
|
1114
|
+
|
1115
|
+
|
1116
|
+
|
1117
|
+
|
1118
|
+
|
1119
|
+
|
1120
|
+
|
1121
|
+
|
1122
|
+
|
1123
|
+
|
1124
|
+
|
1125
|
+
|
1126
|
+
|
1127
|
+
|
1128
|
+
|
1129
|
+
|
1130
|
+
|
1131
|
+
|
1132
|
+
|
1133
|
+
|
1134
|
+
|
1135
|
+
|
1136
|
+
|
1137
|
+
|
1138
|
+
|
1139
|
+
|
1140
|
+
|
1141
|
+
|
1142
|
+
|
1143
|
+
|
1144
|
+
|
1145
|
+
|
1146
|
+
|
1147
|
+
|
1148
|
+
|
1149
|
+
|
1150
|
+
|
1151
|
+
|
1152
|
+
<a class="nav nav-prev" href="/rbcli/advanced/state_storage/" title="State Storage"> <i class="fa fa-chevron-left"></i></a>
|
1153
|
+
|
1154
|
+
|
1155
|
+
<a class="nav nav-next" href="/rbcli/development/" title="Development" style="margin-right: 0px;"><i class="fa fa-chevron-right"></i></a>
|
1156
|
+
|
1157
|
+
|
843
1158
|
</div>
|
1159
|
+
|
1160
|
+
</section>
|
844
1161
|
|
845
|
-
|
846
|
-
|
847
|
-
|
848
|
-
|
849
|
-
|
850
|
-
|
851
|
-
|
1162
|
+
<div style="left: -1000px; overflow: scroll; position: absolute; top: -1000px; border: none; box-sizing: content-box; height: 200px; margin: 0px; padding: 0px; width: 200px;">
|
1163
|
+
<div style="border: none; box-sizing: content-box; height: 200px; margin: 0px; padding: 0px; width: 200px;"></div>
|
1164
|
+
</div>
|
1165
|
+
<script src="/rbcli/js/clipboard.min.js?1561087612"></script>
|
1166
|
+
<script src="/rbcli/js/perfect-scrollbar.min.js?1561087612"></script>
|
1167
|
+
<script src="/rbcli/js/perfect-scrollbar.jquery.min.js?1561087612"></script>
|
1168
|
+
<script src="/rbcli/js/jquery.sticky.js?1561087612"></script>
|
1169
|
+
<script src="/rbcli/js/featherlight.min.js?1561087612"></script>
|
1170
|
+
<script src="/rbcli/js/html5shiv-printshiv.min.js?1561087612"></script>
|
1171
|
+
<script src="/rbcli/js/highlight.pack.js?1561087612"></script>
|
1172
|
+
<script>hljs.initHighlightingOnLoad();</script>
|
1173
|
+
<script src="/rbcli/js/modernizr.custom-3.6.0.js?1561087612"></script>
|
1174
|
+
<script src="/rbcli/js/learn.js?1561087612"></script>
|
1175
|
+
<script src="/rbcli/js/hugo-learn.js?1561087612"></script>
|
1176
|
+
|
1177
|
+
<link href="/rbcli/mermaid/mermaid.css?1561087612" rel="stylesheet" />
|
1178
|
+
<script src="/rbcli/mermaid/mermaid.js?1561087612"></script>
|
1179
|
+
<script>
|
1180
|
+
mermaid.initialize({ startOnLoad: true });
|
1181
|
+
</script>
|
852
1182
|
|
1183
|
+
|
853
1184
|
</body>
|
854
|
-
</html>
|
1185
|
+
</html>
|
1186
|
+
|