Automatic documentation update

.buildinfo

@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 3d7915a38f22880b7d89fc949a3adb31
+config: 66becb2ff4da6681bc4c7e6a7ceb2ddb
 tags: 645f666f9bcd5a90fca523b33c5a78b7

_sources/changelog.md.txt

@@ -5,6 +5,22 @@
 Any changes which are committed, but not yet present in a released version,
 should appear here.
 
+New Features:
+
+- The `yo list` command now has a completely configurable table.
+  - Columns may be specified as a list in the config file (`list_columns`)
+  - An alternative list may be specified via `yo list -C a,b,c`
+  - Columns can be added to the end of the table with `yo list -x Column`
+
+## 1.5.1 - Tue, Apr 9, 2024
+
+Another tiny release, which I configure a "bugfix release".
+
+Fixes:
+
+- Fixed a crash with `yo nmi`
+- Added `--ad` option to `yo launch` which was a bit of an oversight
+
 ## 1.5.0 - Mon, Feb 5, 2024
 
 This is a very tiny release with just three changes.

_sources/guide/configuration.rst.txt

@@ -378,6 +378,16 @@ to this list.
 You can also use this to include other people's instances in your list, if for
 example you would like to monitor and help a direct report with their instances.
 
+``list_columns``
+~~~~~~~~~~~~~~~~
+
+(String, Optional) A string containing a comma-separated list of columns to
+include in the output of :ref:`yo_list`. The list of available columns can be
+viewed in the documentation for ``-x`` in :ref:`yo_list`.
+
+You can override this on the command line with ``yo list -C Col1,Col2`` and you
+can extend the list on the command line with ``yo list -x Col1``.
+
 .. _instance profiles:
 
 Instance Profiles

_static/documentation_options.js

@@ -1,5 +1,5 @@
 const DOCUMENTATION_OPTIONS = {
-    VERSION: 'v1.5.0',
+    VERSION: 'v1.5.1',
     LANGUAGE: 'en',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',

changelog.html

@@ -5,10 +5,10 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
-    <title>Changelog &#8212; yo v1.5.0 documentation</title>
+    <title>Changelog &#8212; yo v1.5.1 documentation</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=4f649999" />
     <link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=039e1c02" />
-    <script src="_static/documentation_options.js?v=1b13bd6b"></script>
+    <script src="_static/documentation_options.js?v=bf6b3972"></script>
     <script src="_static/doctools.js?v=888ff710"></script>
     <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <link rel="icon" href="_static/yo.png"/>
@@ -37,6 +37,25 @@ <h1>Changelog<a class="headerlink" href="#changelog" title="Link to this heading
 <h2>Unreleased<a class="headerlink" href="#unreleased" title="Link to this heading">¶</a></h2>
 <p>Any changes which are committed, but not yet present in a released version,
 should appear here.</p>
+<p>New Features:</p>
+<ul class="simple">
+<li><p>The <code class="docutils literal notranslate"><span class="pre">yo</span> <span class="pre">list</span></code> command now has a completely configurable table.</p>
+<ul>
+<li><p>Columns may be specified as a list in the config file (<code class="docutils literal notranslate"><span class="pre">list_columns</span></code>)</p></li>
+<li><p>An alternative list may be specified via <code class="docutils literal notranslate"><span class="pre">yo</span> <span class="pre">list</span> <span class="pre">-C</span> <span class="pre">a,b,c</span></code></p></li>
+<li><p>Columns can be added to the end of the table with <code class="docutils literal notranslate"><span class="pre">yo</span> <span class="pre">list</span> <span class="pre">-x</span> <span class="pre">Column</span></code></p></li>
+</ul>
+</li>
+</ul>
+</section>
+<section id="tue-apr-9-2024">
+<h2>1.5.1 - Tue, Apr 9, 2024<a class="headerlink" href="#tue-apr-9-2024" title="Link to this heading">¶</a></h2>
+<p>Another tiny release, which I configure a “bugfix release”.</p>
+<p>Fixes:</p>
+<ul class="simple">
+<li><p>Fixed a crash with <code class="docutils literal notranslate"><span class="pre">yo</span> <span class="pre">nmi</span></code></p></li>
+<li><p>Added <code class="docutils literal notranslate"><span class="pre">--ad</span></code> option to <code class="docutils literal notranslate"><span class="pre">yo</span> <span class="pre">launch</span></code> which was a bit of an oversight</p></li>
+</ul>
 </section>
 <section id="mon-feb-5-2024">
 <h2>1.5.0 - Mon, Feb 5, 2024<a class="headerlink" href="#mon-feb-5-2024" title="Link to this heading">¶</a></h2>

cmds/cmd00.html

@@ -5,10 +5,10 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
-    <title>Basic Commands &#8212; yo v1.5.0 documentation</title>
+    <title>Basic Commands &#8212; yo v1.5.1 documentation</title>
     <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=4f649999" />
     <link rel="stylesheet" type="text/css" href="../_static/alabaster.css?v=039e1c02" />
-    <script src="../_static/documentation_options.js?v=1b13bd6b"></script>
+    <script src="../_static/documentation_options.js?v=bf6b3972"></script>
     <script src="../_static/doctools.js?v=888ff710"></script>
     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
     <link rel="icon" href="../_static/yo.png"/>
@@ -51,8 +51,8 @@ <h1>Basic Commands<a class="headerlink" href="#basic-commands" title="Link to th
 wait until the instance is ready, but not connect via SSH.</p>
 </div></blockquote>
 </p>
-<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">usage</span><span class="p">:</span> <span class="n">yo</span> <span class="n">launch</span> <span class="p">[</span><span class="o">-</span><span class="n">h</span><span class="p">]</span> <span class="p">[</span><span class="o">--</span><span class="n">name</span> <span class="n">NAME</span><span class="p">]</span> <span class="p">[</span><span class="o">--</span><span class="n">os</span> <span class="n">OS</span> <span class="o">|</span> <span class="o">--</span><span class="n">image</span> <span class="n">IMAGE</span> <span class="o">|</span> <span class="o">--</span><span class="n">volume</span> <span class="n">VOLUME</span><span class="p">]</span> <span class="p">[</span><span class="o">--</span><span class="n">shape</span> <span class="n">SHAPE</span><span class="p">]</span> <span class="p">[</span><span class="o">--</span><span class="n">boot</span><span class="o">-</span><span class="n">volume</span><span class="o">-</span><span class="n">size</span><span class="o">-</span><span class="n">gbs</span> <span class="n">BOOT_VOLUME_SIZE_GBS</span><span class="p">]</span> <span class="p">[</span><span class="o">--</span><span class="n">mem</span> <span class="n">MEM</span><span class="p">]</span> <span class="p">[</span><span class="o">--</span><span class="n">cpu</span> <span class="n">CPU</span><span class="p">]</span> <span class="p">[</span><span class="o">--</span><span class="n">wait</span><span class="p">]</span> <span class="p">[</span><span class="o">--</span><span class="n">wait</span><span class="o">-</span><span class="n">ssh</span><span class="p">]</span> <span class="p">[</span><span class="o">--</span><span class="n">ssh</span><span class="p">]</span> <span class="p">[</span><span class="o">--</span><span class="n">exact</span><span class="o">-</span><span class="n">name</span><span class="p">]</span> <span class="p">[</span><span class="o">--</span><span class="n">no</span><span class="o">-</span><span class="n">exact</span><span class="o">-</span><span class="n">name</span><span class="p">]</span> <span class="p">[</span><span class="o">--</span><span class="n">dry</span><span class="o">-</span><span class="n">run</span><span class="p">]</span> <span class="p">[</span><span class="o">--</span><span class="n">profile</span> <span class="n">PROFILE</span><span class="p">]</span> <span class="p">[</span><span class="o">--</span><span class="n">task</span> <span class="n">TASKS</span><span class="p">]</span>
-                 <span class="p">[</span><span class="o">--</span><span class="n">load</span><span class="o">-</span><span class="n">image</span> <span class="p">{</span><span class="n">UNIQUE</span><span class="p">,</span><span class="n">LATEST</span><span class="p">}]</span> <span class="p">[</span><span class="o">--</span><span class="n">username</span> <span class="n">USERNAME</span><span class="p">]</span>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">usage</span><span class="p">:</span> <span class="n">yo</span> <span class="n">launch</span> <span class="p">[</span><span class="o">-</span><span class="n">h</span><span class="p">]</span> <span class="p">[</span><span class="o">--</span><span class="n">name</span> <span class="n">NAME</span><span class="p">]</span> <span class="p">[</span><span class="o">--</span><span class="n">os</span> <span class="n">OS</span> <span class="o">|</span> <span class="o">--</span><span class="n">image</span> <span class="n">IMAGE</span> <span class="o">|</span> <span class="o">--</span><span class="n">volume</span> <span class="n">VOLUME</span><span class="p">]</span> <span class="p">[</span><span class="o">--</span><span class="n">shape</span> <span class="n">SHAPE</span><span class="p">]</span> <span class="p">[</span><span class="o">--</span><span class="n">boot</span><span class="o">-</span><span class="n">volume</span><span class="o">-</span><span class="n">size</span><span class="o">-</span><span class="n">gbs</span> <span class="n">BOOT_VOLUME_SIZE_GBS</span><span class="p">]</span> <span class="p">[</span><span class="o">--</span><span class="n">mem</span> <span class="n">MEM</span><span class="p">]</span> <span class="p">[</span><span class="o">--</span><span class="n">cpu</span> <span class="n">CPU</span><span class="p">]</span> <span class="p">[</span><span class="o">--</span><span class="n">ad</span> <span class="n">AD</span><span class="p">]</span> <span class="p">[</span><span class="o">--</span><span class="n">wait</span><span class="p">]</span> <span class="p">[</span><span class="o">--</span><span class="n">wait</span><span class="o">-</span><span class="n">ssh</span><span class="p">]</span> <span class="p">[</span><span class="o">--</span><span class="n">ssh</span><span class="p">]</span> <span class="p">[</span><span class="o">--</span><span class="n">exact</span><span class="o">-</span><span class="n">name</span><span class="p">]</span> <span class="p">[</span><span class="o">--</span><span class="n">no</span><span class="o">-</span><span class="n">exact</span><span class="o">-</span><span class="n">name</span><span class="p">]</span> <span class="p">[</span><span class="o">--</span><span class="n">dry</span><span class="o">-</span><span class="n">run</span><span class="p">]</span> <span class="p">[</span><span class="o">--</span><span class="n">profile</span> <span class="n">PROFILE</span><span class="p">]</span>
+                 <span class="p">[</span><span class="o">--</span><span class="n">task</span> <span class="n">TASKS</span><span class="p">]</span> <span class="p">[</span><span class="o">--</span><span class="n">load</span><span class="o">-</span><span class="n">image</span> <span class="p">{</span><span class="n">UNIQUE</span><span class="p">,</span><span class="n">LATEST</span><span class="p">}]</span> <span class="p">[</span><span class="o">--</span><span class="n">username</span> <span class="n">USERNAME</span><span class="p">]</span>
 </pre></div>
 </div>
 <section id="named-arguments">
@@ -82,6 +82,9 @@ <h3>Named Arguments<a class="headerlink" href="#named-arguments" title="Link to
 <dt><kbd>--cpu</kbd></dt>
 <dd><p>Specify the amount of CPUs</p>
 </dd>
+<dt><kbd>--ad</kbd></dt>
+<dd><p>Specify the availability domain (overrides instance profile)</p>
+</dd>
 <dt><kbd>--wait, -w</kbd></dt>
 <dd><p>Wait for the instance to start running</p>
 <p>Default: False</p>
@@ -137,7 +140,7 @@ <h3>Named Arguments<a class="headerlink" href="#named-arguments" title="Link to
 terminate, etc) unless you change your “yo.resource_filtering” configuration.</p>
 </div></blockquote>
 </p>
-<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">usage</span><span class="p">:</span> <span class="n">yo</span> <span class="nb">list</span> <span class="p">[</span><span class="o">-</span><span class="n">h</span><span class="p">]</span> <span class="p">[</span><span class="o">--</span><span class="n">cached</span><span class="p">]</span> <span class="p">[</span><span class="o">--</span><span class="n">ip</span><span class="p">]</span> <span class="p">[</span><span class="o">--</span><span class="n">ad</span><span class="p">]</span> <span class="p">[</span><span class="o">--</span><span class="nb">all</span><span class="p">]</span>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">usage</span><span class="p">:</span> <span class="n">yo</span> <span class="nb">list</span> <span class="p">[</span><span class="o">-</span><span class="n">h</span><span class="p">]</span> <span class="p">[</span><span class="o">--</span><span class="n">cached</span><span class="p">]</span> <span class="p">[</span><span class="o">--</span><span class="n">columns</span> <span class="n">COLUMNS</span><span class="p">]</span> <span class="p">[</span><span class="o">--</span><span class="n">extra</span><span class="o">-</span><span class="n">column</span> <span class="p">{</span><span class="n">Name</span><span class="p">,</span><span class="n">Shape</span><span class="p">,</span><span class="n">CPU</span><span class="p">,</span><span class="n">Mem</span><span class="p">,</span><span class="n">State</span><span class="p">,</span><span class="n">AD</span><span class="p">,</span><span class="n">Created</span><span class="p">,</span><span class="n">IP</span><span class="p">}]</span> <span class="p">[</span><span class="o">--</span><span class="n">ip</span><span class="p">]</span> <span class="p">[</span><span class="o">--</span><span class="n">ad</span><span class="p">]</span> <span class="p">[</span><span class="o">--</span><span class="nb">all</span><span class="p">]</span>
 </pre></div>
 </div>
 <section id="named-arguments">
@@ -147,12 +150,20 @@ <h3>Named Arguments<a class="headerlink" href="#named-arguments" title="Link to
 <dd><p>avoid loading and calling OCI if possible (list may beout of date)</p>
 <p>Default: False</p>
 </dd>
+<dt><kbd>--columns, -C</kbd></dt>
+<dd><p>specify all columns in the table</p>
+</dd>
+<dt><kbd>--extra-column, -x</kbd></dt>
+<dd><p>Possible choices: Name, Shape, CPU, Mem, State, AD, Created, IP</p>
+<p>add a column to the table</p>
+<p>Default: []</p>
+</dd>
 <dt><kbd>--ip, -i</kbd></dt>
-<dd><p>include IP addresses (this may require calling the API)</p>
+<dd><p>include IP addresses column (alias for: -x IP)</p>
 <p>Default: False</p>
 </dd>
 <dt><kbd>--ad</kbd></dt>
-<dd><p>display the availability domain column</p>
+<dd><p>display the availability domain column (alias for: -x AD)</p>
 <p>Default: False</p>
 </dd>
 <dt><kbd>--all, -a</kbd></dt>

cmds/cmd01.html

@@ -5,10 +5,10 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
-    <title>Instance Management &#8212; yo v1.5.0 documentation</title>
+    <title>Instance Management &#8212; yo v1.5.1 documentation</title>
     <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=4f649999" />
     <link rel="stylesheet" type="text/css" href="../_static/alabaster.css?v=039e1c02" />
-    <script src="../_static/documentation_options.js?v=1b13bd6b"></script>
+    <script src="../_static/documentation_options.js?v=bf6b3972"></script>
     <script src="../_static/doctools.js?v=888ff710"></script>
     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
     <link rel="icon" href="../_static/yo.png"/>

cmds/cmd02.html

@@ -5,10 +5,10 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
-    <title>Instance Communication &amp; Interaction &#8212; yo v1.5.0 documentation</title>
+    <title>Instance Communication &amp; Interaction &#8212; yo v1.5.1 documentation</title>
     <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=4f649999" />
     <link rel="stylesheet" type="text/css" href="../_static/alabaster.css?v=039e1c02" />
-    <script src="../_static/documentation_options.js?v=1b13bd6b"></script>
+    <script src="../_static/documentation_options.js?v=bf6b3972"></script>
     <script src="../_static/doctools.js?v=888ff710"></script>
     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
     <link rel="icon" href="../_static/yo.png"/>

cmds/cmd03.html

@@ -5,10 +5,10 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
-    <title>Task Management Commands &#8212; yo v1.5.0 documentation</title>
+    <title>Task Management Commands &#8212; yo v1.5.1 documentation</title>
     <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=4f649999" />
     <link rel="stylesheet" type="text/css" href="../_static/alabaster.css?v=039e1c02" />
-    <script src="../_static/documentation_options.js?v=1b13bd6b"></script>
+    <script src="../_static/documentation_options.js?v=bf6b3972"></script>
     <script src="../_static/doctools.js?v=888ff710"></script>
     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
     <link rel="icon" href="../_static/yo.png"/>

cmds/cmd04.html

@@ -5,10 +5,10 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
-    <title>Volume Management Commands &#8212; yo v1.5.0 documentation</title>
+    <title>Volume Management Commands &#8212; yo v1.5.1 documentation</title>
     <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=4f649999" />
     <link rel="stylesheet" type="text/css" href="../_static/alabaster.css?v=039e1c02" />
-    <script src="../_static/documentation_options.js?v=1b13bd6b"></script>
+    <script src="../_static/documentation_options.js?v=bf6b3972"></script>
     <script src="../_static/doctools.js?v=888ff710"></script>
     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
     <link rel="icon" href="../_static/yo.png"/>

cmds/cmd05.html

@@ -5,10 +5,10 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
-    <title>Informative Commands &#8212; yo v1.5.0 documentation</title>
+    <title>Informative Commands &#8212; yo v1.5.1 documentation</title>
     <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=4f649999" />
     <link rel="stylesheet" type="text/css" href="../_static/alabaster.css?v=039e1c02" />
-    <script src="../_static/documentation_options.js?v=1b13bd6b"></script>
+    <script src="../_static/documentation_options.js?v=bf6b3972"></script>
     <script src="../_static/doctools.js?v=888ff710"></script>
     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
     <link rel="icon" href="../_static/yo.png"/>