RubyGems - rbcli - Versions diffs - 0.3.3 → 0.4.1 - Mend

rbcli 0.3.3 → 0.4.1

Files changed (506) hide show

data/docs/advanced/logging/index.html DELETED Viewed

@@ -1,1184 +0,0 @@
-<!DOCTYPE html>
-<html lang="en" class="js csstransforms3d">
-  <head>
-    <meta charset="utf-8">
-    <meta name="viewport" content="width=device-width, initial-scale=1.0">
-    <meta name="generator" content="Hugo 0.125.1">
-    <meta name="description" content="">
-    <link rel="icon" href="/rbcli/images/favicon.png" type="image/png">
-    <title>Logging :: RBCli Documentation</title>
-    <link href="/rbcli/css/nucleus.css?1713907739" rel="stylesheet">
-    <link href="/rbcli/css/fontawesome-all.min.css?1713907739" rel="stylesheet">
-    <link href="/rbcli/css/hybrid.css?1713907739" rel="stylesheet">
-    <link href="/rbcli/css/featherlight.min.css?1713907739" rel="stylesheet">
-    <link href="/rbcli/css/perfect-scrollbar.min.css?1713907739" rel="stylesheet">
-    <link href="/rbcli/css/auto-complete.css?1713907739" rel="stylesheet">
-    <link href="/rbcli/css/atom-one-dark-reasonable.css?1713907739" rel="stylesheet">
-    <link href="/rbcli/css/theme.css?1713907739" rel="stylesheet">
-    <link href="/rbcli/css/hugo-theme.css?1713907739" rel="stylesheet">
-    <link href="/rbcli/css/theme-blue.css?1713907739" rel="stylesheet">
-    <script src="/rbcli/js/jquery-3.3.1.min.js?1713907739"></script>
-    <style>
-      :root #header + #content > #left > #rlblock_left{
-          display:none !important;
-      }
-    </style>
-  </head>
-  <body class="" data-url="/rbcli/advanced/logging/">
-    <nav id="sidebar" class="">
-  <div id="header-wrapper">
-    <div id="header">
-      <a id="logo" href="https://akhoury6.github.io/rbcli/" style="font-size: 40px">
-  <span class="fas fa-terminal"></span>&nbsp;𝚁𝙱𝙲𝚕𝚒
-</a>
-    </div>
-        <div class="searchbox">
-    <label for="search-by"><i class="fas fa-search"></i></label>
-    <input data-search-input id="search-by" type="search" placeholder="Search...">
-    <span data-search-clear=""><i class="fas fa-times"></i></span>
-</div>
-<script type="text/javascript" src="/rbcli/js/lunr.min.js?1713907739"></script>
-<script type="text/javascript" src="/rbcli/js/auto-complete.js?1713907739"></script>
-<script type="text/javascript">
-        var baseurl = "https:\/\/akhoury6.github.io\/rbcli\/";
-</script>
-<script type="text/javascript" src="/rbcli/js/search.js?1713907739"></script>
-  </div>
-    <div class="highlightable">
-    <ul class="topics">
-    <li data-nav-id="/rbcli/quick_reference/" title="Quick Reference" class="dd-item
-        ">
-      <a href="/rbcli/quick_reference/">
-          Quick Reference
-      </a>
-    </li>
-    <li data-nav-id="/rbcli/tutorial/" title="Tutorial" class="dd-item
-        ">
-      <a href="/rbcli/tutorial/">
-          Tutorial
-      </a>
-        <ul>
-      <li data-nav-id="/rbcli/tutorial/10-getting_started/" title="Getting Started" class="dd-item ">
-        <a href="/rbcli/tutorial/10-getting_started/">
-        <b>1. </b>Getting Started
-        </a>
-    </li>
-      <li data-nav-id="/rbcli/tutorial/20-project_layout/" title="The Project Layout" class="dd-item ">
-        <a href="/rbcli/tutorial/20-project_layout/">
-        <b>2. </b>The Project Layout
-        </a>
-    </li>
-      <li data-nav-id="/rbcli/tutorial/30-your_first_command/" title="Your First Command" class="dd-item ">
-        <a href="/rbcli/tutorial/30-your_first_command/">
-        <b>3. </b>Your First Command
-        </a>
-    </li>
-      <li data-nav-id="/rbcli/tutorial/40-options_parameters_and_arguments/" title="Options, Parameters, and Arguments" class="dd-item ">
-        <a href="/rbcli/tutorial/40-options_parameters_and_arguments/">
-        <b>4. </b>Options, Parameters, and Arguments
-        </a>
-    </li>
-      <li data-nav-id="/rbcli/tutorial/50-publishing/" title="Publishing Your Application" class="dd-item ">
-        <a href="/rbcli/tutorial/50-publishing/">
-        <b>5. </b>Publishing Your Application
-        </a>
-    </li>
-        </ul>
-    </li>
-    <li data-nav-id="/rbcli/advanced/" title="Advanced" class="dd-item
-        parent
-        ">
-      <a href="/rbcli/advanced/">
-          Advanced
-      </a>
-        <ul>
-      <li data-nav-id="/rbcli/advanced/automatic_updates/" title="Automatic Updates" class="dd-item ">
-        <a href="/rbcli/advanced/automatic_updates/">
-        Automatic Updates
-        </a>
-    </li>
-      <li data-nav-id="/rbcli/advanced/command_types/" title="Command Types" class="dd-item ">
-        <a href="/rbcli/advanced/command_types/">
-        Command Types
-        </a>
-    </li>
-      <li data-nav-id="/rbcli/advanced/distributed_state_locking/" title="Distributed State and Locking" class="dd-item ">
-        <a href="/rbcli/advanced/distributed_state_locking/">
-        Distributed State and Locking
-        </a>
-    </li>
-      <li data-nav-id="/rbcli/advanced/hooks/" title="Execution Hooks" class="dd-item ">
-        <a href="/rbcli/advanced/hooks/">
-        Execution Hooks
-        </a>
-    </li>
-      <li data-nav-id="/rbcli/advanced/interactive_commands/" title="Interactive Commands" class="dd-item ">
-        <a href="/rbcli/advanced/interactive_commands/">
-        Interactive Commands
-        </a>
-    </li>
-      <li data-nav-id="/rbcli/advanced/logging/" title="Logging" class="dd-item active">
-        <a href="/rbcli/advanced/logging/">
-        Logging
-        </a>
-    </li>
-      <li data-nav-id="/rbcli/advanced/remote_execution/" title="Remote Execution" class="dd-item ">
-        <a href="/rbcli/advanced/remote_execution/">
-        Remote Execution
-        </a>
-    </li>
-      <li data-nav-id="/rbcli/advanced/state_storage/" title="State Storage" class="dd-item ">
-        <a href="/rbcli/advanced/state_storage/">
-        State Storage
-        </a>
-    </li>
-      <li data-nav-id="/rbcli/advanced/user_config_files/" title="User Configuration Files" class="dd-item ">
-        <a href="/rbcli/advanced/user_config_files/">
-        User Configuration Files
-        </a>
-    </li>
-        </ul>
-    </li>
-    <li data-nav-id="/rbcli/development/" title="Development" class="dd-item
-        ">
-      <a href="/rbcli/development/">
-          Development
-      </a>
-        <ul>
-      <li data-nav-id="/rbcli/development/contributing/" title="Contribution Guide" class="dd-item ">
-        <a href="/rbcli/development/contributing/">
-        Contribution Guide
-        </a>
-    </li>
-      <li data-nav-id="/rbcli/development/license/" title="License Info" class="dd-item ">
-        <a href="/rbcli/development/license/">
-        License Info
-        </a>
-    </li>
-      <li data-nav-id="/rbcli/development/code_of_conduct/" title="Code of Conduct" class="dd-item ">
-        <a href="/rbcli/development/code_of_conduct/">
-        Code of Conduct
-        </a>
-    </li>
-      <li data-nav-id="/rbcli/development/changelog/" title="Changelog" class="dd-item ">
-        <a href="/rbcli/development/changelog/">
-        Changelog
-        </a>
-    </li>
-        </ul>
-    </li>
-    <li data-nav-id="/rbcli/whoami/" title="My Letter To You" class="dd-item
-        ">
-      <a href="/rbcli/whoami/">
-          My Letter To You
-      </a>
-    </li>
-    </ul>
-      <section id="shortcuts">
-        <h3>More</h3>
-        <ul>
-              <li>
-                  <a class="padding" href="https://github.com/akhoury6/rbcli"><i class='fab fa-github'></i> Github repo</a>
-              </li>
-              <li>
-                  <a class="padding" href="https://rubygems.org/gems/rbcli"><i class='far fa-gem'></i> Rubygems</a>
-              </li>
-        </ul>
-      </section>
-    <section id="footer">
-      <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>
-    </section>
-  </div>
-</nav>
-        <section id="body">
-        <div id="overlay"></div>
-        <div class="padding highlightable">
-              <div>
-                <div id="top-bar">
-                <div id="breadcrumbs" itemscope="" itemtype="http://data-vocabulary.org/Breadcrumb">
-                    <span id="sidebar-toggle-span">
-                        <a href="#" id="sidebar-toggle" data-sidebar-toggle="">
-                          <i class="fas fa-bars"></i>
-                        </a>
-                    </span>
-                  <span id="toc-menu"><i class="fas fa-list-alt"></i></span>
-                  <span class="links">
-            <a href='/rbcli/'></a> > <a href='/rbcli/advanced/'>Advanced</a> > Logging
-                  </span>
-                </div>
-                    <div class="progress">
-    <div class="wrapper">
-<nav id="TableOfContents">
-  <ul>
-    <li><a href="#enabling-logging">Enabling Logging</a></li>
-    <li><a href="#userspace-config-overrides">Userspace Config Overrides</a></li>
-  </ul>
-</nav>
-    </div>
-</div>
-              </div>
-            </div>
-        <div id="head-tags">
-        </div>
-        <div id="body-inner">
-            <h1>
-              Logging
-            </h1>
-<p>Logging with RBCli is straightforward - it looks at the config file for logging settings, and instantiates a single, globally accessible <a href="https://ruby-doc.org/stdlib-2.4.0/libdoc/logger/rdoc/Logger.html">Logger</a> object. You can access it within a standard command like this:</p>
-<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-ruby" data-lang="ruby"><span style="display:flex;"><span><span style="color:#66d9ef">Rbcli</span><span style="color:#f92672">::</span>log<span style="color:#f92672">.</span>info { <span style="color:#e6db74">&#39;These logs can go to STDERR, STDOUT, or a file&#39;</span> }
-</span></span></code></pre></div><h2 id="enabling-logging">Enabling Logging</h2>
-<p>To enable logging, simply set the default values in the <code>config/logging.rb</code> file:</p>
-<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-ruby" data-lang="ruby"><span style="display:flex;"><span>log_level <span style="color:#e6db74">:info</span>
-</span></span><span style="display:flex;"><span>log_target <span style="color:#e6db74">&#39;stderr&#39;</span>
-</span></span></code></pre></div><ul>
-<li><code>log_level</code>
-<ul>
-<li>You can set the default log level using either numeric or standard Ruby logger levels: 0-5, or DEBUG &lt; INFO &lt; WARN &lt; ERROR &lt; FATAL &lt; UNKNOWN</li>
-</ul>
-</li>
-<li><code>log_target</code>
-<ul>
-<li>This specifies where the logs will be placed. Valid values are nil (disables logging), &lsquo;STDOUT&rsquo;, &lsquo;STDERR&rsquo;, or a file path (all as strings).</li>
-</ul>
-</li>
-</ul>
-<h2 id="userspace-config-overrides">Userspace Config Overrides</h2>
-<p>If <a href="/rbcli/advanced/user_config_files/">Userspace Configuration</a> is enabled, these options will also be present in the user&rsquo;s config file to override defaults:</p>
-<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-yaml" data-lang="yaml"><span style="display:flex;"><span><span style="color:#75715e"># Log Settings</span>
-</span></span><span style="display:flex;"><span><span style="color:#f92672">logger</span>:
-</span></span><span style="display:flex;"><span>  <span style="color:#f92672">log_level</span>: <span style="color:#ae81ff">warn             </span> <span style="color:#75715e"># 0-5, or DEBUG &lt; INFO &lt; WARN &lt; ERROR &lt; FATAL &lt; UNKNOWN</span>
-</span></span><span style="display:flex;"><span>  <span style="color:#f92672">log_target</span>: <span style="color:#ae81ff">stderr          </span> <span style="color:#75715e"># STDOUT, STDERR, or a file path</span>
-</span></span></code></pre></div>
-<footer class="footline">
-</footer>
-        </div>
-      </div>
-    <div id="navigation">
-			<a class="nav nav-prev" href="/rbcli/advanced/interactive_commands/" title="Interactive Commands"> <i class="fa fa-chevron-left"></i></a>
-			<a class="nav nav-next" href="/rbcli/advanced/remote_execution/" title="Remote Execution" style="margin-right: 0px;"><i class="fa fa-chevron-right"></i></a>
-    </div>
-    </section>
-    <div style="left: -1000px; overflow: scroll; position: absolute; top: -1000px; border: none; box-sizing: content-box; height: 200px; margin: 0px; padding: 0px; width: 200px;">
-      <div style="border: none; box-sizing: content-box; height: 200px; margin: 0px; padding: 0px; width: 200px;"></div>
-    </div>
-    <script src="/rbcli/js/clipboard.min.js?1713907739"></script>
-    <script src="/rbcli/js/perfect-scrollbar.min.js?1713907739"></script>
-    <script src="/rbcli/js/perfect-scrollbar.jquery.min.js?1713907739"></script>
-    <script src="/rbcli/js/jquery.sticky.js?1713907739"></script>
-    <script src="/rbcli/js/featherlight.min.js?1713907739"></script>
-    <script src="/rbcli/js/highlight.pack.js?1713907739"></script>
-    <script>hljs.initHighlightingOnLoad();</script>
-    <script src="/rbcli/js/modernizr.custom-3.6.0.js?1713907739"></script>
-    <script src="/rbcli/js/learn.js?1713907739"></script>
-    <script src="/rbcli/js/hugo-learn.js?1713907739"></script>
-    <link href="/rbcli/mermaid/mermaid.css?1713907739" rel="stylesheet" />
-    <script src="/rbcli/mermaid/mermaid.js?1713907739"></script>
-    <script>
-        mermaid.initialize({ startOnLoad: true });
-    </script>
-  </body>
-</html>