Skip to content

[AUTO] Update CLI doc #3110

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

[AUTO] Update CLI doc #3110

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3e75b59
Update api docs
viniciusdc Oct 1, 2025
b92f72c
Merge branch 'main' into auto_cli_doc_update
viniciusdc Oct 2, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 6 additions & 33 deletions docs-sphinx/cli.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,12 @@ <h2>nebari<a class="headerlink" href="#nebari" title="Link to this heading">¶</
<dd><p>Nebari version number</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-nebari-l">
<span id="cmdoption-nebari-log-level"></span><span class="sig-name descname"><span class="pre">-l</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--log-level</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;log_level&gt;</span></span><a class="headerlink" href="#cmdoption-nebari-l" title="Link to this definition">¶</a></dt>
<dd><p>Set logging level (trace, debug, info, warning, error, critical)</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-nebari-import-plugin">
<span class="sig-name descname"><span class="pre">--import-plugin</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;plugins&gt;</span></span><a class="headerlink" href="#cmdoption-nebari-import-plugin" title="Link to this definition">¶</a></dt>
Expand Down Expand Up @@ -91,17 +97,6 @@ <h3>deploy<a class="headerlink" href="#nebari-deploy" title="Link to this headin
<dd><p><strong>Required</strong> nebari configuration yaml file path</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-nebari-deploy-o">
<span id="cmdoption-nebari-deploy-output"></span><span class="sig-name descname"><span class="pre">-o</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--output</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;output_directory&gt;</span></span><a class="headerlink" href="#cmdoption-nebari-deploy-o" title="Link to this definition">¶</a></dt>
<dd><p>output directory</p>
<dl class="field-list simple">
<dt class="field-odd">Default<span class="colon">:</span></dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">'./'</span></code></p>
</dd>
</dl>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-nebari-deploy-dns-provider">
<span class="sig-name descname"><span class="pre">--dns-provider</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;dns_provider&gt;</span></span><a class="headerlink" href="#cmdoption-nebari-deploy-dns-provider" title="Link to this definition">¶</a></dt>
Expand Down Expand Up @@ -177,17 +172,6 @@ <h3>destroy<a class="headerlink" href="#nebari-destroy" title="Link to this head
<dd><p><strong>Required</strong> nebari configuration file path</p>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-nebari-destroy-o">
<span id="cmdoption-nebari-destroy-output"></span><span class="sig-name descname"><span class="pre">-o</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--output</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;output_directory&gt;</span></span><a class="headerlink" href="#cmdoption-nebari-destroy-o" title="Link to this definition">¶</a></dt>
<dd><p>output directory</p>
<dl class="field-list simple">
<dt class="field-odd">Default<span class="colon">:</span></dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">'./'</span></code></p>
</dd>
</dl>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-nebari-destroy-disable-render">
<span class="sig-name descname"><span class="pre">--disable-render</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-nebari-destroy-disable-render" title="Link to this definition">¶</a></dt>
Expand Down Expand Up @@ -551,17 +535,6 @@ <h3>render<a class="headerlink" href="#nebari-render" title="Link to this headin
</pre></div>
</div>
<p class="rubric">Options</p>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-nebari-render-o">
<span id="cmdoption-nebari-render-output"></span><span class="sig-name descname"><span class="pre">-o</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--output</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;output_directory&gt;</span></span><a class="headerlink" href="#cmdoption-nebari-render-o" title="Link to this definition">¶</a></dt>
<dd><p>output directory</p>
<dl class="field-list simple">
<dt class="field-odd">Default<span class="colon">:</span></dt>
<dd class="field-odd"><p><code class="docutils literal notranslate"><span class="pre">'./'</span></code></p>
</dd>
</dl>
</dd></dl>

<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-nebari-render-c">
<span id="cmdoption-nebari-render-config"></span><span class="sig-name descname"><span class="pre">-c</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--config</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;config_filename&gt;</span></span><a class="headerlink" href="#cmdoption-nebari-render-c" title="Link to this definition">¶</a></dt>
Expand Down