Deployed 4472792 with MkDocs version: 1.6.0

Rules_and_Rulesets/rules/index.html

@@ -852,7 +852,7 @@ <h2 id="orbiter.rules.Rule" class="doc doc-heading">
 
 
       <p>A <code>Rule</code> contains a python function that is evaluated and produces something
-(typically an <a href="../objects">Object</a>) or nothing</p>
+(typically an <a href="../../objects/">Object</a>) or nothing</p>
 <p>A <code>Rule</code> can be created from a decorator
 <div class="highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="gp">&gt;&gt;&gt; </span><span class="nd">@rule</span><span class="p">(</span><span class="n">priority</span><span class="o">=</span><span class="mi">1</span><span class="p">)</span>
 <a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a><span class="gp">... </span><span class="k">def</span> <span class="nf">my_rule</span><span class="p">(</span><span class="n">val</span><span class="p">):</span>
@@ -869,7 +869,7 @@ <h2 id="orbiter.rules.Rule" class="doc doc-heading">
 </code></pre></div></p>
 <div class="admonition tip">
 <p class="admonition-title">Tip</p>
-<p>If the returned value is an <a href="../../objects">Orbiter Object</a>,
+<p>If the returned value is an <a href="../../objects/index.md">Orbiter Object</a>,
 the passed <code>kwargs</code> are saved in a special <code>orbiter_kwargs</code> property</p>
 <div class="highlight"><pre><span></span><code><a id="__codelineno-2-1" name="__codelineno-2-1" href="#__codelineno-2-1"></a><span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">orbiter.objects.dag</span> <span class="kn">import</span> <span class="n">OrbiterDAG</span>
 <a id="__codelineno-2-2" name="__codelineno-2-2" href="#__codelineno-2-2"></a><span class="gp">&gt;&gt;&gt; </span><span class="nd">@rule</span>
@@ -1012,6 +1012,10 @@ <h3 id="orbiter.rules.DAGRule" class="doc doc-heading">
 
 
       <p>A <code>@dag_rule</code> decorator creates a <a class="autorefs autorefs-internal" href="#orbiter.rules.DAGRule"><code>DAGRule</code></a></p>
+<div class="admonition tip">
+<p class="admonition-title">Tip</p>
+<p>A <code>__file</code> key is added to the original input, which is the file path of the input.</p>
+</div>
 <div class="highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="nd">@dag_rule</span>
 <a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a><span class="k">def</span> <span class="nf">foo</span><span class="p">(</span><span class="n">val</span><span class="p">:</span> <span class="nb">dict</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">OrbiterDAG</span> <span class="o">|</span> <span class="kc">None</span><span class="p">:</span>
 <a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a>    <span class="k">if</span> <span class="s1">&#39;id&#39;</span> <span class="ow">in</span> <span class="n">val</span><span class="p">:</span>

cli/index.html

@@ -341,6 +341,15 @@
     <nav class="md-nav" aria-label="orbiter">
       <ul class="md-nav__list">
 
+          <li class="md-nav__item">
+  <a href="#analyze" class="md-nav__link">
+    <span class="md-ellipsis">
+      analyze
+    </span>
+  </a>
+
+</li>
+
           <li class="md-nav__item">
   <a href="#install" class="md-nav__link">
     <span class="md-ellipsis">
@@ -852,10 +861,55 @@ <h2 id="orbiter">orbiter<a class="headerlink" href="#orbiter" title="Permanent l
 </tr>
 </tbody>
 </table>
+<h3 id="analyze">analyze<a class="headerlink" href="#analyze" title="Permanent link">&para;</a></h3>
+<p>Analyze workflows in an <code>INPUT_DIR</code></p>
+<p>Provide a specific ruleset with the <code>--ruleset</code> flag.</p>
+<p>Run <code>orbiter list-rulesets</code> to see available rulesets.</p>
+<p><code>INPUT_DIR</code> defaults to <code>$CWD/workflow</code>.</p>
+<p><strong>Usage:</strong></p>
+<div class="highlight"><pre><span></span><code><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a>orbiter analyze [OPTIONS] INPUT_DIR
+</code></pre></div>
+<p><strong>Options:</strong></p>
+<table>
+<thead>
+<tr>
+<th>Name</th>
+<th>Type</th>
+<th>Description</th>
+<th>Default</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td><code>-r</code>, <code>--ruleset</code></td>
+<td>text</td>
+<td>Qualified name of a TranslationRuleset</td>
+<td>_required</td>
+</tr>
+<tr>
+<td><code>--format</code></td>
+<td>choice (<code>json</code> &#x7C; <code>csv</code> &#x7C; <code>md</code>)</td>
+<td>[optional] format for analysis output</td>
+<td><code>md</code></td>
+</tr>
+<tr>
+<td><code>-o</code>, <code>--output-file</code></td>
+<td>filename</td>
+<td>File to write to, defaults to '-' (stdout)</td>
+<td><code>-</code></td>
+</tr>
+<tr>
+<td><code>--help</code></td>
+<td>boolean</td>
+<td>Show this message and exit.</td>
+<td><code>False</code></td>
+</tr>
+</tbody>
+</table>
 <h3 id="install">install<a class="headerlink" href="#install" title="Permanent link">&para;</a></h3>
 <p>Install a new Translation Ruleset from a repository</p>
 <p><strong>Usage:</strong></p>
-<div class="highlight"><pre><span></span><code><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a>orbiter install [OPTIONS]
+<div class="highlight"><pre><span></span><code><a id="__codelineno-2-1" name="__codelineno-2-1" href="#__codelineno-2-1"></a>orbiter install [OPTIONS]
 </code></pre></div>
 <p><strong>Options:</strong></p>
 <table>
@@ -891,7 +945,7 @@ <h3 id="install">install<a class="headerlink" href="#install" title="Permanent l
 <h3 id="list-rulesets">list-rulesets<a class="headerlink" href="#list-rulesets" title="Permanent link">&para;</a></h3>
 <p>List available Translation Rulesets</p>
 <p><strong>Usage:</strong></p>
-<div class="highlight"><pre><span></span><code><a id="__codelineno-2-1" name="__codelineno-2-1" href="#__codelineno-2-1"></a>orbiter list-rulesets [OPTIONS]
+<div class="highlight"><pre><span></span><code><a id="__codelineno-3-1" name="__codelineno-3-1" href="#__codelineno-3-1"></a>orbiter list-rulesets [OPTIONS]
 </code></pre></div>
 <p><strong>Options:</strong></p>
 <table>
@@ -920,7 +974,7 @@ <h3 id="translate">translate<a class="headerlink" href="#translate" title="Perma
 <p><code>OUTPUT_DIR</code> defaults to <code>$CWD/output</code></p>
 <p>Formats output with Ruff (<a href="https://astral.sh/ruff">https://astral.sh/ruff</a>), by default.</p>
 <p><strong>Usage:</strong></p>
-<div class="highlight"><pre><span></span><code><a id="__codelineno-3-1" name="__codelineno-3-1" href="#__codelineno-3-1"></a>orbiter translate [OPTIONS] INPUT_DIR OUTPUT_DIR
+<div class="highlight"><pre><span></span><code><a id="__codelineno-4-1" name="__codelineno-4-1" href="#__codelineno-4-1"></a>orbiter translate [OPTIONS] INPUT_DIR OUTPUT_DIR
 </code></pre></div>
 <p><strong>Options:</strong></p>
 <table>
@@ -955,7 +1009,7 @@ <h3 id="translate">translate<a class="headerlink" href="#translate" title="Perma
 </table>
 <h2 id="logging">Logging<a class="headerlink" href="#logging" title="Permanent link">&para;</a></h2>
 <p>You can alter the verbosity of the CLI by setting the <code>LOG_LEVEL</code> environment variable. The default is <code>INFO</code>.</p>
-<div class="highlight"><pre><span></span><code><a id="__codelineno-4-1" name="__codelineno-4-1" href="#__codelineno-4-1"></a><span class="nb">export</span><span class="w"> </span><span class="nv">LOG_LEVEL</span><span class="o">=</span>DEBUG
+<div class="highlight"><pre><span></span><code><a id="__codelineno-5-1" name="__codelineno-5-1" href="#__codelineno-5-1"></a><span class="nb">export</span><span class="w"> </span><span class="nv">LOG_LEVEL</span><span class="o">=</span>DEBUG
 </code></pre></div>