371 lines
18 KiB
HTML
371 lines
18 KiB
HTML
|
|
|
|
<!DOCTYPE html>
|
|
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
|
|
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
|
|
<head>
|
|
<meta charset="utf-8">
|
|
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
|
|
<title>composer.cli.cmdline — Lorax 29.6 documentation</title>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
|
|
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
|
|
<link rel="index" title="Index" href="../../../genindex.html" />
|
|
<link rel="search" title="Search" href="../../../search.html" />
|
|
|
|
|
|
<script src="../../../_static/js/modernizr.min.js"></script>
|
|
|
|
</head>
|
|
|
|
<body class="wy-body-for-nav">
|
|
|
|
|
|
<div class="wy-grid-for-nav">
|
|
|
|
|
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
|
<div class="wy-side-scroll">
|
|
<div class="wy-side-nav-search">
|
|
|
|
|
|
|
|
<a href="../../../index.html" class="icon icon-home"> Lorax
|
|
|
|
|
|
|
|
</a>
|
|
|
|
|
|
|
|
|
|
<div class="version">
|
|
29.6
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div role="search">
|
|
<form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">
|
|
<input type="text" name="q" placeholder="Search docs" />
|
|
<input type="hidden" name="check_keywords" value="yes" />
|
|
<input type="hidden" name="area" value="default" />
|
|
</form>
|
|
</div>
|
|
|
|
|
|
</div>
|
|
|
|
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../../intro.html">Introduction to Lorax</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../../intro.html#before-lorax">Before Lorax</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../../lorax.html">Lorax</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../../livemedia-creator.html">livemedia-creator</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../../lorax-composer.html">lorax-composer</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../../composer-cli.html">composer-cli</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../../product-images.html">Product and Updates Images</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="../../../modules.html">src</a></li>
|
|
</ul>
|
|
|
|
|
|
|
|
</div>
|
|
</div>
|
|
</nav>
|
|
|
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
|
|
|
|
|
<nav class="wy-nav-top" aria-label="top navigation">
|
|
|
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
|
<a href="../../../index.html">Lorax</a>
|
|
|
|
</nav>
|
|
|
|
|
|
<div class="wy-nav-content">
|
|
|
|
<div class="rst-content">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div role="navigation" aria-label="breadcrumbs navigation">
|
|
|
|
<ul class="wy-breadcrumbs">
|
|
|
|
<li><a href="../../../index.html">Docs</a> »</li>
|
|
|
|
<li><a href="../../index.html">Module code</a> »</li>
|
|
|
|
<li><a href="../cli.html">composer.cli</a> »</li>
|
|
|
|
<li>composer.cli.cmdline</li>
|
|
|
|
|
|
<li class="wy-breadcrumbs-aside">
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
|
|
<hr/>
|
|
</div>
|
|
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
|
<div itemprop="articleBody">
|
|
|
|
<h1>Source code for composer.cli.cmdline</h1><div class="highlight"><pre>
|
|
<span></span><span class="c1">#</span>
|
|
<span class="c1"># Copyright (C) 2018 Red Hat, Inc.</span>
|
|
<span class="c1">#</span>
|
|
<span class="c1"># This program is free software; you can redistribute it and/or modify</span>
|
|
<span class="c1"># it under the terms of the GNU General Public License as published by</span>
|
|
<span class="c1"># the Free Software Foundation; either version 2 of the License, or</span>
|
|
<span class="c1"># (at your option) any later version.</span>
|
|
<span class="c1">#</span>
|
|
<span class="c1"># This program is distributed in the hope that it will be useful,</span>
|
|
<span class="c1"># but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
|
|
<span class="c1"># MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span>
|
|
<span class="c1"># GNU General Public License for more details.</span>
|
|
<span class="c1">#</span>
|
|
<span class="c1"># You should have received a copy of the GNU General Public License</span>
|
|
<span class="c1"># along with this program. If not, see <http://www.gnu.org/licenses/>.</span>
|
|
<span class="c1">#</span>
|
|
<span class="kn">import</span> <span class="nn">os</span>
|
|
<span class="kn">import</span> <span class="nn">sys</span>
|
|
<span class="kn">import</span> <span class="nn">argparse</span>
|
|
|
|
<span class="kn">from</span> <span class="nn">composer</span> <span class="k">import</span> <span class="n">vernum</span>
|
|
|
|
<span class="n">VERSION</span> <span class="o">=</span> <span class="s2">"</span><span class="si">{0}</span><span class="s2">-</span><span class="si">{1}</span><span class="s2">"</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">basename</span><span class="p">(</span><span class="n">sys</span><span class="o">.</span><span class="n">argv</span><span class="p">[</span><span class="mi">0</span><span class="p">]),</span> <span class="n">vernum</span><span class="p">)</span>
|
|
|
|
<span class="c1"># Documentation for the commands</span>
|
|
<span class="n">epilog</span> <span class="o">=</span> <span class="s2">"""</span>
|
|
<span class="s2">compose start <BLUEPRINT> <TYPE></span>
|
|
<span class="s2"> Start a compose using the selected blueprint and output type.</span>
|
|
|
|
<span class="s2">compose types</span>
|
|
<span class="s2"> List the supported output types.</span>
|
|
|
|
<span class="s2">compose status</span>
|
|
<span class="s2"> List the status of all running and finished composes.</span>
|
|
|
|
<span class="s2">compose log <UUID> [<SIZE>]</span>
|
|
<span class="s2"> Show the last SIZE kB of the compose log.</span>
|
|
|
|
<span class="s2">compose cancel <UUID></span>
|
|
<span class="s2"> Cancel a running compose and delete any intermediate results.</span>
|
|
|
|
<span class="s2">compose delete <UUID,...></span>
|
|
<span class="s2"> Delete the listed compose results.</span>
|
|
|
|
<span class="s2">compose info <UUID></span>
|
|
<span class="s2"> Show detailed information on the compose.</span>
|
|
|
|
<span class="s2">compose metadata <UUID></span>
|
|
<span class="s2"> Download the metadata use to create the compose to <uuid>-metadata.tar</span>
|
|
|
|
<span class="s2">compose logs <UUID></span>
|
|
<span class="s2"> Download the compose logs to <uuid>-logs.tar</span>
|
|
|
|
<span class="s2">compose results <UUID></span>
|
|
<span class="s2"> Download all of the compose results; metadata, logs, and image to <uuid>.tar</span>
|
|
|
|
<span class="s2">compose image <UUID></span>
|
|
<span class="s2"> Download the output image from the compose. Filename depends on the type.</span>
|
|
|
|
<span class="s2">blueprints list</span>
|
|
<span class="s2"> List the names of the available blueprints.</span>
|
|
|
|
<span class="s2">blueprints show <BLUEPRINT,...></span>
|
|
<span class="s2"> Display the blueprint in TOML format.</span>
|
|
|
|
<span class="s2">blueprints changes <BLUEPRINT,...></span>
|
|
<span class="s2"> Display the changes for each blueprint.</span>
|
|
|
|
<span class="s2">blueprints diff <BLUEPRINT> <FROM-COMMIT> <TO-COMMIT></span>
|
|
<span class="s2"> Display the differences between 2 versions of a blueprint.</span>
|
|
<span class="s2"> FROM-COMMIT can be a commit hash or NEWEST</span>
|
|
<span class="s2"> TO-COMMIT can be a commit hash, NEWEST, or WORKSPACE</span>
|
|
|
|
<span class="s2">blueprints save <BLUEPRINT,...></span>
|
|
<span class="s2"> Save the blueprint to a file, <BLUEPRINT>.toml</span>
|
|
|
|
<span class="s2">blueprints delete <BLUEPRINT></span>
|
|
<span class="s2"> Delete a blueprint from the server</span>
|
|
|
|
<span class="s2">blueprints depsolve <BLUEPRINT,...></span>
|
|
<span class="s2"> Display the packages needed to install the blueprint.</span>
|
|
|
|
<span class="s2">blueprints push <BLUEPRINT></span>
|
|
<span class="s2"> Push a blueprint TOML file to the server.</span>
|
|
|
|
<span class="s2">blueprints freeze <BLUEPRINT,...></span>
|
|
<span class="s2"> Display the frozen blueprint's modules and packages.</span>
|
|
|
|
<span class="s2">blueprints freeze show <BLUEPRINT,...></span>
|
|
<span class="s2"> Display the frozen blueprint in TOML format.</span>
|
|
|
|
<span class="s2">blueprints freeze save <BLUEPRINT,...></span>
|
|
<span class="s2"> Save the frozen blueprint to a file, <blueprint-name>.frozen.toml.</span>
|
|
|
|
<span class="s2">blueprints tag <BLUEPRINT></span>
|
|
<span class="s2"> Tag the most recent blueprint commit as a release.</span>
|
|
|
|
<span class="s2">blueprints undo <BLUEPRINT> <COMMIT></span>
|
|
<span class="s2"> Undo changes to a blueprint by reverting to the selected commit.</span>
|
|
|
|
<span class="s2">blueprints workspace <BLUEPRINT></span>
|
|
<span class="s2"> Push the blueprint TOML to the temporary workspace storage.</span>
|
|
|
|
<span class="s2">modules list</span>
|
|
<span class="s2"> List the available modules.</span>
|
|
|
|
<span class="s2">projects list</span>
|
|
<span class="s2"> List the available projects.</span>
|
|
|
|
<span class="s2">projects info <PROJECT,...></span>
|
|
<span class="s2"> Show details about the listed projects.</span>
|
|
|
|
<span class="s2">sources list</span>
|
|
<span class="s2"> List the available sources</span>
|
|
|
|
<span class="s2">sources info <SOURCE-NAME,...></span>
|
|
<span class="s2"> Details about the source.</span>
|
|
|
|
<span class="s2">sources add <SOURCE.TOML></span>
|
|
<span class="s2"> Add a package source to the server.</span>
|
|
|
|
<span class="s2">sources change <SOURCE.TOML></span>
|
|
<span class="s2"> Change an existing source</span>
|
|
|
|
<span class="s2">sources delete <SOURCE-NAME></span>
|
|
<span class="s2"> Delete a package source.</span>
|
|
<span class="s2">"""</span>
|
|
|
|
<div class="viewcode-block" id="composer_cli_parser"><a class="viewcode-back" href="../../../composer.cli.html#composer.cli.cmdline.composer_cli_parser">[docs]</a><span class="k">def</span> <span class="nf">composer_cli_parser</span><span class="p">():</span>
|
|
<span class="sd">""" Return the ArgumentParser for composer-cli"""</span>
|
|
|
|
<span class="n">parser</span> <span class="o">=</span> <span class="n">argparse</span><span class="o">.</span><span class="n">ArgumentParser</span><span class="p">(</span><span class="n">description</span><span class="o">=</span><span class="s2">"Lorax Composer commandline tool"</span><span class="p">,</span>
|
|
<span class="n">epilog</span><span class="o">=</span><span class="n">epilog</span><span class="p">,</span>
|
|
<span class="n">formatter_class</span><span class="o">=</span><span class="n">argparse</span><span class="o">.</span><span class="n">RawDescriptionHelpFormatter</span><span class="p">,</span>
|
|
<span class="n">fromfile_prefix_chars</span><span class="o">=</span><span class="s2">"@"</span><span class="p">)</span>
|
|
|
|
<span class="n">parser</span><span class="o">.</span><span class="n">add_argument</span><span class="p">(</span><span class="s2">"-j"</span><span class="p">,</span> <span class="s2">"--json"</span><span class="p">,</span> <span class="n">action</span><span class="o">=</span><span class="s2">"store_true"</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span>
|
|
<span class="n">help</span><span class="o">=</span><span class="s2">"Output the raw JSON response instead of the normal output."</span><span class="p">)</span>
|
|
<span class="n">parser</span><span class="o">.</span><span class="n">add_argument</span><span class="p">(</span><span class="s2">"-s"</span><span class="p">,</span> <span class="s2">"--socket"</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="s2">"/run/weldr/api.socket"</span><span class="p">,</span> <span class="n">metavar</span><span class="o">=</span><span class="s2">"SOCKET"</span><span class="p">,</span>
|
|
<span class="n">help</span><span class="o">=</span><span class="s2">"Path to the socket file to listen on"</span><span class="p">)</span>
|
|
<span class="n">parser</span><span class="o">.</span><span class="n">add_argument</span><span class="p">(</span><span class="s2">"--log"</span><span class="p">,</span> <span class="n">dest</span><span class="o">=</span><span class="s2">"logfile"</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="s2">"./composer-cli.log"</span><span class="p">,</span> <span class="n">metavar</span><span class="o">=</span><span class="s2">"LOG"</span><span class="p">,</span>
|
|
<span class="n">help</span><span class="o">=</span><span class="s2">"Path to logfile (./composer-cli.log)"</span><span class="p">)</span>
|
|
<span class="n">parser</span><span class="o">.</span><span class="n">add_argument</span><span class="p">(</span><span class="s2">"-a"</span><span class="p">,</span> <span class="s2">"--api"</span><span class="p">,</span> <span class="n">dest</span><span class="o">=</span><span class="s2">"api_version"</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="s2">"0"</span><span class="p">,</span> <span class="n">metavar</span><span class="o">=</span><span class="s2">"APIVER"</span><span class="p">,</span>
|
|
<span class="n">help</span><span class="o">=</span><span class="s2">"API Version to use"</span><span class="p">)</span>
|
|
<span class="n">parser</span><span class="o">.</span><span class="n">add_argument</span><span class="p">(</span><span class="s2">"--test"</span><span class="p">,</span> <span class="n">dest</span><span class="o">=</span><span class="s2">"testmode"</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="nb">type</span><span class="o">=</span><span class="nb">int</span><span class="p">,</span> <span class="n">metavar</span><span class="o">=</span><span class="s2">"TESTMODE"</span><span class="p">,</span>
|
|
<span class="n">help</span><span class="o">=</span><span class="s2">"Pass test mode to compose. 1=Mock compose with fail. 2=Mock compose with finished."</span><span class="p">)</span>
|
|
<span class="n">parser</span><span class="o">.</span><span class="n">add_argument</span><span class="p">(</span><span class="s2">"-V"</span><span class="p">,</span> <span class="n">action</span><span class="o">=</span><span class="s2">"store_true"</span><span class="p">,</span> <span class="n">dest</span><span class="o">=</span><span class="s2">"showver"</span><span class="p">,</span>
|
|
<span class="n">help</span><span class="o">=</span><span class="s2">"show program's version number and exit"</span><span class="p">)</span>
|
|
|
|
<span class="c1"># Commands are implemented by parsing the remaining arguments outside of argparse</span>
|
|
<span class="n">parser</span><span class="o">.</span><span class="n">add_argument</span><span class="p">(</span><span class="s1">'args'</span><span class="p">,</span> <span class="n">nargs</span><span class="o">=</span><span class="n">argparse</span><span class="o">.</span><span class="n">REMAINDER</span><span class="p">)</span>
|
|
|
|
<span class="k">return</span> <span class="n">parser</span></div>
|
|
</pre></div>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<footer>
|
|
|
|
|
|
<hr/>
|
|
|
|
<div role="contentinfo">
|
|
<p>
|
|
© Copyright 2018, Red Hat, Inc..
|
|
|
|
</p>
|
|
</div>
|
|
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
|
|
|
</footer>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</section>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<script type="text/javascript">
|
|
var DOCUMENTATION_OPTIONS = {
|
|
URL_ROOT:'../../../',
|
|
VERSION:'29.6',
|
|
LANGUAGE:'None',
|
|
COLLAPSE_INDEX:false,
|
|
FILE_SUFFIX:'.html',
|
|
HAS_SOURCE: true,
|
|
SOURCELINK_SUFFIX: '.txt'
|
|
};
|
|
</script>
|
|
<script type="text/javascript" src="../../../_static/jquery.js"></script>
|
|
<script type="text/javascript" src="../../../_static/underscore.js"></script>
|
|
<script type="text/javascript" src="../../../_static/doctools.js"></script>
|
|
|
|
|
|
|
|
|
|
|
|
<script type="text/javascript" src="../../../_static/js/theme.js"></script>
|
|
|
|
|
|
<script type="text/javascript">
|
|
jQuery(function () {
|
|
SphinxRtdTheme.Navigation.enable(true);
|
|
});
|
|
</script>
|
|
|
|
</body>
|
|
</html> |