RubyGems - rbcli - Versions diffs - 0.2.10 → 0.3.1 - Mend

rbcli 0.2.10 → 0.3.1

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.

Files changed (444) hide show

data/docs/imported/quick_reference/index.html DELETED Viewed

@@ -1,1120 +0,0 @@
-<!DOCTYPE html>
-<html lang="en" class="no-js">
-  <head>
-      <meta charset="utf-8">
-      <meta name="viewport" content="width=device-width,initial-scale=1">
-      <meta http-equiv="x-ua-compatible" content="ie=edge">
-        <meta name="description" content="Description">
-        <meta name="author" content="Andrew Khoury">
-        <meta name="lang:clipboard.copy" content="Copy to clipboard">
-        <meta name="lang:clipboard.copied" content="Copied to clipboard">
-        <meta name="lang:search.language" content="en">
-        <meta name="lang:search.pipeline.stopwords" content="True">
-        <meta name="lang:search.pipeline.trimmer" content="True">
-        <meta name="lang:search.result.none" content="No matching documents">
-        <meta name="lang:search.result.one" content="1 matching document">
-        <meta name="lang:search.result.other" content="# matching documents">
-        <meta name="lang:search.tokenizer" content="[\s\-]+">
-      <link rel="shortcut icon" href="../../assets/images/favicon.png">
-      <meta name="generator" content="mkdocs-1.0.3, mkdocs-material-3.0.4">
-        <title>Quick Reference - RBCli Documentation</title>
-      <link rel="stylesheet" href="../../assets/stylesheets/application.451f80e5.css">
-      <script src="../../assets/javascripts/modernizr.1aa3b519.js"></script>
-        <link href="https://fonts.gstatic.com" rel="preconnect" crossorigin>
-        <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,400,400i,700|Roboto+Mono">
-        <style>body,input{font-family:"Roboto","Helvetica Neue",Helvetica,Arial,sans-serif}code,kbd,pre{font-family:"Roboto Mono","Courier New",Courier,monospace}</style>
-    <link rel="stylesheet" href="../../assets/fonts/material-icons.css">
-  </head>
-    <body dir="ltr">
-    <svg class="md-svg">
-      <defs>
-          <svg xmlns="http://www.w3.org/2000/svg" width="416" height="448"
-    viewBox="0 0 416 448" id="__github">
-  <path fill="currentColor" d="M160 304q0 10-3.125 20.5t-10.75 19-18.125
-        8.5-18.125-8.5-10.75-19-3.125-20.5 3.125-20.5 10.75-19 18.125-8.5
-        18.125 8.5 10.75 19 3.125 20.5zM320 304q0 10-3.125 20.5t-10.75
-        19-18.125 8.5-18.125-8.5-10.75-19-3.125-20.5 3.125-20.5 10.75-19
-        18.125-8.5 18.125 8.5 10.75 19 3.125 20.5zM360
-        304q0-30-17.25-51t-46.75-21q-10.25 0-48.75 5.25-17.75 2.75-39.25
-        2.75t-39.25-2.75q-38-5.25-48.75-5.25-29.5 0-46.75 21t-17.25 51q0 22 8
-        38.375t20.25 25.75 30.5 15 35 7.375 37.25 1.75h42q20.5 0
-        37.25-1.75t35-7.375 30.5-15 20.25-25.75 8-38.375zM416 260q0 51.75-15.25
-        82.75-9.5 19.25-26.375 33.25t-35.25 21.5-42.5 11.875-42.875 5.5-41.75
-        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
-        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
-        30.875q36.75-8.75 77.25-8.75 37 0 70 8 26.25-20.5
-        46.75-30.25t47.25-9.75q12.75 25.5 12.75 54.5 0 21.75-6.75 42 34 40 34
-        99.5z" />
-</svg>
-      </defs>
-    </svg>
-    <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
-    <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
-    <label class="md-overlay" data-md-component="overlay" for="__drawer"></label>
-      <a href="../../#quick-reference" tabindex="1" class="md-skip">
-        Skip to content
-      </a>
-      <header class="md-header" data-md-component="header">
-  <nav class="md-header-nav md-grid">
-    <div class="md-flex">
-      <div class="md-flex__cell md-flex__cell--shrink">
-        <a href="../.." title="RBCli Documentation" class="md-header-nav__button md-logo">
-            <i class="md-icon">devices</i>
-        </a>
-      </div>
-      <div class="md-flex__cell md-flex__cell--shrink">
-        <label class="md-icon md-icon--menu md-header-nav__button" for="__drawer"></label>
-      </div>
-      <div class="md-flex__cell md-flex__cell--stretch">
-        <div class="md-flex__ellipsis md-header-nav__title" data-md-component="title">
-              <span class="md-header-nav__topic">
-                RBCli Documentation
-              </span>
-              <span class="md-header-nav__topic">
-                Quick Reference
-              </span>
-        </div>
-      </div>
-      <div class="md-flex__cell md-flex__cell--shrink">
-            <label class="md-icon md-icon--search md-header-nav__button" for="__search"></label>
-<div class="md-search" data-md-component="search" role="dialog">
-  <label class="md-search__overlay" for="__search"></label>
-  <div class="md-search__inner" role="search">
-    <form class="md-search__form" name="search">
-      <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">
-      <label class="md-icon md-search__icon" for="__search"></label>
-      <button type="reset" class="md-icon md-search__icon" data-md-component="reset" tabindex="-1">
-        &#xE5CD;
-      </button>
-    </form>
-    <div class="md-search__output">
-      <div class="md-search__scrollwrap" data-md-scrollfix>
-        <div class="md-search-result" data-md-component="result">
-          <div class="md-search-result__meta">
-            Type to start searching
-          </div>
-          <ol class="md-search-result__list"></ol>
-        </div>
-      </div>
-    </div>
-  </div>
-</div>
-      </div>
-        <div class="md-flex__cell md-flex__cell--shrink">
-          <div class="md-header-nav__source">
-  <a href="https://github.com/akhoury6/rbcli/" title="Go to repository" class="md-source" data-md-source="github">
-      <div class="md-source__icon">
-        <svg viewBox="0 0 24 24" width="24" height="24">
-          <use xlink:href="#__github" width="24" height="24"></use>
-        </svg>
-      </div>
-    <div class="md-source__repository">
-      GitHub
-    </div>
-  </a>
-          </div>
-        </div>
-    </div>
-  </nav>
-</header>
-    <div class="md-container">
-<nav class="md-tabs" data-md-component="tabs">
-  <div class="md-tabs__inner md-grid">
-    <ul class="md-tabs__list">
-  <li class="md-tabs__item">
-      <a href="../.." title="Home" class="md-tabs__link md-tabs__link--active">
-        Home
-      </a>
-  </li>
-    <li class="md-tabs__item">
-        <a href="../../tutorial/10-getting_started/" title="Tutorial" class="md-tabs__link">
-          Tutorial
-        </a>
-    </li>
-    <li class="md-tabs__item">
-        <a href="../../advanced/command_types/" title="Advanced Features" class="md-tabs__link">
-          Advanced Features
-        </a>
-    </li>
-    <li class="md-tabs__item">
-        <a href="../../development/contributing/" title="Development" class="md-tabs__link">
-          Development
-        </a>
-    </li>
-    </ul>
-  </div>
-</nav>
-      <main class="md-main">
-        <div class="md-main__inner md-grid" data-md-component="container">
-              <div class="md-sidebar md-sidebar--primary" data-md-component="navigation">
-                <div class="md-sidebar__scrollwrap">
-                  <div class="md-sidebar__inner">
-                    <nav class="md-nav md-nav--primary" data-md-level="0">
-  <label class="md-nav__title md-nav__title--site" for="__drawer">
-    <a href="../.." title="RBCli Documentation" class="md-nav__button md-logo">
-        <i class="md-icon">devices</i>
-    </a>
-    RBCli Documentation
-  </label>
-    <div class="md-nav__source">
-  <a href="https://github.com/akhoury6/rbcli/" title="Go to repository" class="md-source" data-md-source="github">
-      <div class="md-source__icon">
-        <svg viewBox="0 0 24 24" width="24" height="24">
-          <use xlink:href="#__github" width="24" height="24"></use>
-        </svg>
-      </div>
-    <div class="md-source__repository">
-      GitHub
-    </div>
-  </a>
-    </div>
-  <ul class="md-nav__list" data-md-scrollfix>
-  <li class="md-nav__item">
-    <a href="../.." title="Home" class="md-nav__link">
-      Home
-    </a>
-  </li>
-  <li class="md-nav__item md-nav__item--active">
-    <input class="md-toggle md-nav__toggle" data-md-toggle="toc" type="checkbox" id="__toc">
-      <label class="md-nav__link md-nav__link--active" for="__toc">
-        Quick Reference
-      </label>
-    <a href="./" title="Quick Reference" class="md-nav__link md-nav__link--active">
-      Quick Reference
-    </a>
-<nav class="md-nav md-nav--secondary">
-    <label class="md-nav__title" for="__toc">Table of contents</label>
-    <ul class="md-nav__list" data-md-scrollfix>
-        <li class="md-nav__item">
-  <a href="#installation" title="Installation" class="md-nav__link">
-    Installation
-  </a>
-</li>
-        <li class="md-nav__item">
-  <a href="#creating-a-command" title="Creating a command" class="md-nav__link">
-    Creating a command
-  </a>
-    <nav class="md-nav">
-      <ul class="md-nav__list">
-          <li class="md-nav__item">
-  <a href="#standard-commands" title="Standard Commands" class="md-nav__link">
-    Standard Commands
-  </a>
-</li>
-          <li class="md-nav__item">
-  <a href="#scripted-commands" title="Scripted Commands" class="md-nav__link">
-    Scripted Commands
-  </a>
-</li>
-          <li class="md-nav__item">
-  <a href="#external-commands" title="External Commands" class="md-nav__link">
-    External Commands
-  </a>
-</li>
-      </ul>
-    </nav>
-</li>
-        <li class="md-nav__item">
-  <a href="#hooks" title="Hooks" class="md-nav__link">
-    Hooks
-  </a>
-</li>
-        <li class="md-nav__item">
-  <a href="#storage" title="Storage" class="md-nav__link">
-    Storage
-  </a>
-    <nav class="md-nav">
-      <ul class="md-nav__list">
-          <li class="md-nav__item">
-  <a href="#local-state" title="Local State" class="md-nav__link">
-    Local State
-  </a>
-</li>
-          <li class="md-nav__item">
-  <a href="#remote-state" title="Remote State" class="md-nav__link">
-    Remote State
-  </a>
-</li>
-      </ul>
-    </nav>
-</li>
-        <li class="md-nav__item">
-  <a href="#userspace-configuration-files" title="Userspace Configuration Files" class="md-nav__link">
-    Userspace Configuration Files
-  </a>
-</li>
-        <li class="md-nav__item">
-  <a href="#logging" title="Logging" class="md-nav__link">
-    Logging
-  </a>
-</li>
-        <li class="md-nav__item">
-  <a href="#automatic-update-check" title="Automatic Update Check" class="md-nav__link">
-    Automatic Update Check
-  </a>
-</li>
-        <li class="md-nav__item">
-  <a href="#remote-execution" title="Remote Execution" class="md-nav__link">
-    Remote Execution
-  </a>
-</li>
-        <li class="md-nav__item">
-  <a href="#development-and-contributing" title="Development and Contributing" class="md-nav__link">
-    Development and Contributing
-  </a>
-</li>
-        <li class="md-nav__item">
-  <a href="#license" title="License" class="md-nav__link">
-    License
-  </a>
-</li>
-        <li class="md-nav__item">
-  <a href="#full-documentation" title="Full Documentation" class="md-nav__link">
-    Full Documentation
-  </a>
-</li>
-    </ul>
-</nav>
-  </li>
-  <li class="md-nav__item md-nav__item--nested">
-      <input class="md-toggle md-nav__toggle" data-md-toggle="nav-3" type="checkbox" id="nav-3">
-    <label class="md-nav__link" for="nav-3">
-      Tutorial
-    </label>
-    <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
-      <label class="md-nav__title" for="nav-3">
-        Tutorial
-      </label>
-      <ul class="md-nav__list" data-md-scrollfix>
-  <li class="md-nav__item">
-    <a href="../../tutorial/10-getting_started/" title="Getting Started" class="md-nav__link">
-      Getting Started
-    </a>
-  </li>
-  <li class="md-nav__item">
-    <a href="../../tutorial/20-project_layout/" title="The Project Layout" class="md-nav__link">
-      The Project Layout
-    </a>
-  </li>
-  <li class="md-nav__item">
-    <a href="../../tutorial/30-your_first_command/" title="Your First Command" class="md-nav__link">
-      Your First Command
-    </a>
-  </li>
-  <li class="md-nav__item">
-    <a href="../../tutorial/40-options_parameters_and_arguments/" title="Options, Parameters, and Arguments" class="md-nav__link">
-      Options, Parameters, and Arguments
-    </a>
-  </li>
-  <li class="md-nav__item">
-    <a href="../../tutorial/50-publishing/" title="Publishing and Distribution" class="md-nav__link">
-      Publishing and Distribution
-    </a>
-  </li>
-      </ul>
-    </nav>
-  </li>
-  <li class="md-nav__item md-nav__item--nested">
-      <input class="md-toggle md-nav__toggle" data-md-toggle="nav-4" type="checkbox" id="nav-4">
-    <label class="md-nav__link" for="nav-4">
-      Advanced Features
-    </label>
-    <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
-      <label class="md-nav__title" for="nav-4">
-        Advanced Features
-      </label>
-      <ul class="md-nav__list" data-md-scrollfix>
-  <li class="md-nav__item">
-    <a href="../../advanced/command_types/" title="Command Types" class="md-nav__link">
-      Command Types
-    </a>
-  </li>
-  <li class="md-nav__item">
-    <a href="../../advanced/user_config_files/" title="User Config Files" class="md-nav__link">
-      User Config Files
-    </a>
-  </li>
-  <li class="md-nav__item">
-    <a href="../../advanced/hooks/" title="Hooks" class="md-nav__link">
-      Hooks
-    </a>
-  </li>
-  <li class="md-nav__item">
-    <a href="../../advanced/logging/" title="Logging" class="md-nav__link">
-      Logging
-    </a>
-  </li>
-  <li class="md-nav__item">
-    <a href="../../advanced/automatic_updates/" title="Automatic Updates" class="md-nav__link">
-      Automatic Updates
-    </a>
-  </li>
-  <li class="md-nav__item">
-    <a href="../../advanced/state_storage/" title="State Storage" class="md-nav__link">
-      State Storage
-    </a>
-  </li>
-  <li class="md-nav__item">
-    <a href="../../advanced/distributed_state_locking/" title="Distributed State Locking" class="md-nav__link">
-      Distributed State Locking
-    </a>
-  </li>
-  <li class="md-nav__item">
-    <a href="../../advanced/remote_execution/" title="Remote Execution" class="md-nav__link">
-      Remote Execution
-    </a>
-  </li>
-  <li class="md-nav__item">
-    <a href="../../advanced/interactive_commands/" title="Interactive Commands" class="md-nav__link">
-      Interactive Commands
-    </a>
-  </li>
-      </ul>
-    </nav>
-  </li>
-  <li class="md-nav__item md-nav__item--nested">
-      <input class="md-toggle md-nav__toggle" data-md-toggle="nav-5" type="checkbox" id="nav-5">
-    <label class="md-nav__link" for="nav-5">
-      Development
-    </label>
-    <nav class="md-nav" data-md-component="collapsible" data-md-level="1">
-      <label class="md-nav__title" for="nav-5">
-        Development
-      </label>
-      <ul class="md-nav__list" data-md-scrollfix>
-  <li class="md-nav__item">
-    <a href="../../development/contributing/" title="Contribution Guide" class="md-nav__link">
-      Contribution Guide
-    </a>
-  </li>
-  <li class="md-nav__item">
-    <a href="../../development/license/" title="License Info" class="md-nav__link">
-      License Info
-    </a>
-  </li>
-  <li class="md-nav__item">
-    <a href="../../development/code_of_conduct/" title="Code of Conduct" class="md-nav__link">
-      Code of Conduct
-    </a>
-  </li>
-  <li class="md-nav__item">
-    <a href="../changelog/" title="Changelog" class="md-nav__link">
-      Changelog
-    </a>
-  </li>
-      </ul>
-    </nav>
-  </li>
-  <li class="md-nav__item">
-    <a href="../../whoami/" title="whoami" class="md-nav__link">
-      whoami
-    </a>
-  </li>
-  </ul>
-</nav>
-                  </div>
-                </div>
-              </div>
-              <div class="md-sidebar md-sidebar--secondary" data-md-component="toc">
-                <div class="md-sidebar__scrollwrap">
-                  <div class="md-sidebar__inner">
-<nav class="md-nav md-nav--secondary">
-    <label class="md-nav__title" for="__toc">Table of contents</label>
-    <ul class="md-nav__list" data-md-scrollfix>
-        <li class="md-nav__item">
-  <a href="#installation" title="Installation" class="md-nav__link">
-    Installation
-  </a>
-</li>
-        <li class="md-nav__item">
-  <a href="#creating-a-command" title="Creating a command" class="md-nav__link">
-    Creating a command
-  </a>
-    <nav class="md-nav">
-      <ul class="md-nav__list">
-          <li class="md-nav__item">
-  <a href="#standard-commands" title="Standard Commands" class="md-nav__link">
-    Standard Commands
-  </a>
-</li>
-          <li class="md-nav__item">
-  <a href="#scripted-commands" title="Scripted Commands" class="md-nav__link">
-    Scripted Commands
-  </a>
-</li>
-          <li class="md-nav__item">
-  <a href="#external-commands" title="External Commands" class="md-nav__link">
-    External Commands
-  </a>
-</li>
-      </ul>
-    </nav>
-</li>
-        <li class="md-nav__item">
-  <a href="#hooks" title="Hooks" class="md-nav__link">
-    Hooks
-  </a>
-</li>
-        <li class="md-nav__item">
-  <a href="#storage" title="Storage" class="md-nav__link">
-    Storage
-  </a>
-    <nav class="md-nav">
-      <ul class="md-nav__list">
-          <li class="md-nav__item">
-  <a href="#local-state" title="Local State" class="md-nav__link">
-    Local State
-  </a>
-</li>
-          <li class="md-nav__item">
-  <a href="#remote-state" title="Remote State" class="md-nav__link">
-    Remote State
-  </a>
-</li>
-      </ul>
-    </nav>
-</li>
-        <li class="md-nav__item">
-  <a href="#userspace-configuration-files" title="Userspace Configuration Files" class="md-nav__link">
-    Userspace Configuration Files
-  </a>
-</li>
-        <li class="md-nav__item">
-  <a href="#logging" title="Logging" class="md-nav__link">
-    Logging
-  </a>
-</li>
-        <li class="md-nav__item">
-  <a href="#automatic-update-check" title="Automatic Update Check" class="md-nav__link">
-    Automatic Update Check
-  </a>
-</li>
-        <li class="md-nav__item">
-  <a href="#remote-execution" title="Remote Execution" class="md-nav__link">
-    Remote Execution
-  </a>
-</li>
-        <li class="md-nav__item">
-  <a href="#development-and-contributing" title="Development and Contributing" class="md-nav__link">
-    Development and Contributing
-  </a>
-</li>
-        <li class="md-nav__item">
-  <a href="#license" title="License" class="md-nav__link">
-    License
-  </a>
-</li>
-        <li class="md-nav__item">
-  <a href="#full-documentation" title="Full Documentation" class="md-nav__link">
-    Full Documentation
-  </a>
-</li>
-    </ul>
-</nav>
-                  </div>
-                </div>
-              </div>
-          <div class="md-content">
-            <article class="md-content__inner md-typeset">
-                <h1 id="quick-reference">Quick Reference</h1>
-<h2 id="installation">Installation</h2>
-<p>RBCli is available on rubygems.org. You can add it to your application's <code>Gemfile</code> or <code>gemspec</code>, or install it manually by running:</p>
-<pre><code class="bash">gem install rbcli
-</code></pre>
-<p>Then, <code>cd</code> to the folder you'd like to create your project under and run:</p>
-<pre><code class="bash">rbcli init -n mytool -d &quot;A simple CLI tool&quot;
-</code></pre>
-<p>Or, for a single-file tool without any folder/gem tructure, run <code>rbcli init -t mini -n &lt;projectname&gt;</code> or <code>rbcli init -t micro -n &lt;projectname&gt;</code>.</p>
-<h2 id="creating-a-command">Creating a command</h2>
-<p>There are three types of commands: standard, scripted, and external.</p>
-<ul>
-<li><strong>Standard</strong> commands let you code the command directly in Ruby</li>
-<li><strong>Scripted</strong> commands provide you with a bash script, where all of the parsed information (params, options, args, and config) is shared</li>
-<li><strong>External</strong> commands let you wrap 3rd party applications directly</li>
-</ul>
-<h3 id="standard-commands">Standard Commands</h3>
-<p>To create a new command called <code>foo</code>, run:</p>
-<pre><code class="bash">rbcli command -n foo
-</code></pre>
-<p>You will now find the command code in <code>application/commands/list.rb</code>. Edit the <code>action</code> block to write your coode.</p>
-<h3 id="scripted-commands">Scripted Commands</h3>
-<p>To create a new scripted command called <code>bar</code>, run:</p>
-<pre><code class="bash">rbcli script -n bar
-</code></pre>
-<p>You will then find two new files:</p>
-<ul>
-<li>The command declaration under <code>application/commands/bar.rb</code></li>
-<li>The script code under <code>application/commands/scripts/bar.sh</code></li>
-</ul>
-<p>Edit the script to write your code.</p>
-<h3 id="external-commands">External Commands</h3>
-<p>To create a new external command called <code>baz</code>, run:</p>
-<pre><code class="bash">rbcli extern -n baz
-</code></pre>
-<p>You will then find the command code in <code>application/commands/baz.rb</code>.</p>
-<p>Use one of the two provided modes -- direct path mode or variable path mode -- to provide the path to the external program.</p>
-<h2 id="hooks">Hooks</h2>
-<p>RBCli has several hooks that run at different points in the exectution chain. They can be created via the <code>rbcli</code> command line tool:</p>
-<pre><code class="bash">rbcli hook --default      # Runs when no command is provided
-rbcli hook --pre          # Runs before any command
-rbcli hook --post         # Runs after any command
-rbcli hook --firstrun     # Runs the first time a user runs your application. Requires userspace config.
-rbcli hook -dpof          # Create all hooks at once
-</code></pre>
-<h2 id="storage">Storage</h2>
-<p>RBCli supports both local and remote state storage. This is done by synchronizing a Hash with either the local disk or a remote database.</p>
-<h3 id="local-state">Local State</h3>
-<p>RBCli can provide you with a unique hash that can be persisted to disk on any change to a top-level value.</p>
-<p>Enable local state in <code>config/storage.rb</code>.</p>
-<p>Then access it in your Standard Commands with <code>Rbcli.local_state[:yourkeyhere]</code>.</p>
-<h3 id="remote-state">Remote State</h3>
-<p>Similar to the Local State above, RBCli can provide you with a unique hash that can be persisted to a remote storage location.</p>
-<p>Currently only AWS DynamoDB is supported, and credentials will be required for each user.</p>
-<p>Enable remote state in <code>config/storage.rb</code>.</p>
-<p>Then access it in your Standard Commands with <code>Rbcli.remote_state[:yourkeyhere]</code>.</p>
-<h2 id="userspace-configuration-files">Userspace Configuration Files</h2>
-<p>RBCli provides an easy mechanism to generate and read configuration files from your users. You set the default values and help text with the <strong>defaults chain</strong>, and leverage the <strong>user chain</strong> to read them.</p>
-<p>You can set defaults either by placing a YAML file in the <code>userconf/</code> folder or by specifying individual options in <code>application/options.rb</code> (global) or <code>application/command/*.rb</code> (command-specific).</p>
-<p>Users can generate a config file, complete with help text, by running your tool with the <code>--generate-config</code> option.</p>
-<h2 id="logging">Logging</h2>
-<p>RBCli's logger is configured in <code>config/logging.rb</code>.</p>
-<pre><code class="ruby">log_level :info
-log_target 'stderr'
-</code></pre>
-<p>Then it can be accessed when writing your commands via:</p>
-<pre><code class="ruby">Rbcli::log.info { 'These logs can go to STDERR, STDOUT, or a file' }
-</code></pre>
-<p>The user will also be able to change the log level and target via their config file, if it is enabled.</p>
-<h2 id="automatic-update-check">Automatic Update Check</h2>
-<p>RBCli can automatically notify users when an update is available. Two sources are currently supported: Github (including Enterprise) and RubyGems.</p>
-<p>You can configure automatic updates in <code>config/autoupdate.rb</code> in your project.</p>
-<h2 id="remote-execution">Remote Execution</h2>
-<p>RBCli can automatically execute script and extern commands on remote machines via SSH. Enable this feature in <code>config/general.rb</code> by changing the following line to <code>true</code>:</p>
-<pre><code class="ruby">remote_execution permitted: false
-</code></pre>
-<p>Then for each command you want to enable remote execution for, add the following directive:</p>
-<pre><code class="ruby">remote_permitted
-</code></pre>
-<p>Users can then execute commands remotly by specifying the connection string and credentials on the command line:</p>
-<pre><code class="bash">mytool --remote-exec [user@]host[:port] --identity (/path/to/private/ssh/key or password) &lt;command&gt; ...
-</code></pre>
-<h2 id="development-and-contributing">Development and Contributing</h2>
-<p>For more information about development and contributing, please see the <a href="https://akhoury6.github.com/rbcli/development/contributing/">Official Development Documentation</a></p>
-<h2 id="license">License</h2>
-<p>The gem is available as open source under the terms of the <a href="https://github.com/akhoury6/rbcli/blob/master/LICENSE.txt">GPLv3</a>.</p>
-<h2 id="full-documentation">Full Documentation</h2>
-<p><a href="https://akhoury6.github.com/rbcli">You can find the Official Documentation for RBCli Here.</a></p>
-            </article>
-          </div>
-        </div>
-      </main>
-<footer class="md-footer">
-    <div class="md-footer-nav">
-      <nav class="md-footer-nav__inner md-grid">
-          <a href="../.." title="Home" class="md-flex md-footer-nav__link md-footer-nav__link--prev" rel="prev">
-            <div class="md-flex__cell md-flex__cell--shrink">
-              <i class="md-icon md-icon--arrow-back md-footer-nav__button"></i>
-            </div>
-            <div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title">
-              <span class="md-flex__ellipsis">
-                <span class="md-footer-nav__direction">
-                  Previous
-                </span>
-                Home
-              </span>
-            </div>
-          </a>
-          <a href="../../tutorial/10-getting_started/" title="Getting Started" class="md-flex md-footer-nav__link md-footer-nav__link--next" rel="next">
-            <div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title">
-              <span class="md-flex__ellipsis">
-                <span class="md-footer-nav__direction">
-                  Next
-                </span>
-                Getting Started
-              </span>
-            </div>
-            <div class="md-flex__cell md-flex__cell--shrink">
-              <i class="md-icon md-icon--arrow-forward md-footer-nav__button"></i>
-            </div>
-          </a>
-      </nav>
-    </div>
-  <div class="md-footer-meta md-typeset">
-    <div class="md-footer-meta__inner md-grid">
-      <div class="md-footer-copyright">
-          <div class="md-footer-copyright__highlight">
-            Copyright © 2018 Andrew Khoury
-          </div>
-        powered by
-        <a href="https://www.mkdocs.org">MkDocs</a>
-        and
-        <a href="https://squidfunk.github.io/mkdocs-material/">
-          Material for MkDocs</a>
-      </div>
-    </div>
-  </div>
-</footer>
-    </div>
-      <script src="../../assets/javascripts/application.583bbe55.js"></script>
-      <script>app.initialize({version:"1.0.3",url:{base:"../.."}})</script>
-  </body>
-</html>