2021-05-17 18:32:09 +02:00
|
|
|
|
|
|
|
|
|
|
|
|
|
<!DOCTYPE html>
|
|
|
|
|
<html class="writer-html5" lang="en" >
|
|
|
|
|
<head>
|
|
|
|
|
<meta charset="utf-8" />
|
|
|
|
|
|
|
|
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
|
|
|
|
|
|
|
|
|
<title>cpl help — Common Python Library documentation</title>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
|
|
|
|
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!--[if lt IE 9]>
|
|
|
|
|
<script src="_static/js/html5shiv.min.js"></script>
|
|
|
|
|
<![endif]-->
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
|
|
|
|
<script src="_static/jquery.js"></script>
|
|
|
|
|
<script src="_static/underscore.js"></script>
|
|
|
|
|
<script src="_static/doctools.js"></script>
|
|
|
|
|
|
|
|
|
|
<script type="text/javascript" src="_static/js/theme.js"></script>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<link rel="index" title="Index" href="genindex.html" />
|
|
|
|
|
<link rel="search" title="Search" href="search.html" />
|
|
|
|
|
<link rel="next" title="cpl install" href="cli.install.html" />
|
|
|
|
|
<link rel="prev" title="cpl generate" href="cli.generate.html" />
|
|
|
|
|
</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"> Common Python Library
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</a>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<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 class="current">
|
|
|
|
|
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction to the CPL Docs</a></li>
|
|
|
|
|
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
|
|
|
|
|
<li class="toctree-l1 current"><a class="reference internal" href="cpl_cli.html">CLI Reference</a><ul class="current">
|
|
|
|
|
<li class="toctree-l2"><a class="reference internal" href="cli.overview.html">CLI Overview and Command Reference</a></li>
|
|
|
|
|
<li class="toctree-l2"><a class="reference internal" href="cli.add.html">cpl add</a></li>
|
|
|
|
|
<li class="toctree-l2"><a class="reference internal" href="cli.build.html">cpl build</a></li>
|
|
|
|
|
<li class="toctree-l2"><a class="reference internal" href="cli.generate.html">cpl generate</a></li>
|
|
|
|
|
<li class="toctree-l2 current"><a class="current reference internal" href="#">cpl help</a><ul>
|
|
|
|
|
<li class="toctree-l3"><a class="reference internal" href="#description">Description</a></li>
|
|
|
|
|
<li class="toctree-l3"><a class="reference internal" href="#arguments">Arguments</a></li>
|
|
|
|
|
</ul>
|
|
|
|
|
</li>
|
|
|
|
|
<li class="toctree-l2"><a class="reference internal" href="cli.install.html">cpl install</a></li>
|
|
|
|
|
<li class="toctree-l2"><a class="reference internal" href="cli.new.html">cpl new</a></li>
|
|
|
|
|
<li class="toctree-l2"><a class="reference internal" href="cli.publish.html">cpl publish</a></li>
|
|
|
|
|
<li class="toctree-l2"><a class="reference internal" href="cli.remove.html">cpl remove</a></li>
|
|
|
|
|
<li class="toctree-l2"><a class="reference internal" href="cli.start.html">cpl start</a></li>
|
|
|
|
|
<li class="toctree-l2"><a class="reference internal" href="cli.uninstall.html">cpl uninstall</a></li>
|
|
|
|
|
<li class="toctree-l2"><a class="reference internal" href="cli.update.html">cpl update</a></li>
|
|
|
|
|
<li class="toctree-l2"><a class="reference internal" href="cli.version.html">cpl version</a></li>
|
|
|
|
|
</ul>
|
|
|
|
|
</li>
|
2021-11-01 20:43:25 +01:00
|
|
|
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API Reference</a></li>
|
2021-05-17 18:32:09 +02:00
|
|
|
</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">Common Python Library</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" class="icon icon-home"></a> »</li>
|
|
|
|
|
|
|
|
|
|
<li><a href="cpl_cli.html">CLI Reference</a> »</li>
|
|
|
|
|
|
|
|
|
|
<li>cpl help</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="wy-breadcrumbs-aside">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a href="_sources/cli.help.md.txt" rel="nofollow"> View page source</a>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<hr/>
|
|
|
|
|
</div>
|
|
|
|
|
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
|
|
|
|
<div itemprop="articleBody">
|
|
|
|
|
|
|
|
|
|
<div class="section" id="cpl-help">
|
|
|
|
|
<h1>cpl help<a class="headerlink" href="#cpl-help" title="Permalink to this headline">¶</a></h1>
|
|
|
|
|
<!-- ## Contents
|
|
|
|
|
|
|
|
|
|
- [Description](#description) -->
|
|
|
|
|
<!-- - [Arguments](#arguments) -->
|
|
|
|
|
<p>Lists available command and their short descriptions.</p>
|
|
|
|
|
<p>cpl <strong>help</strong> <em><command></em> <br>
|
|
|
|
|
cpl <strong>h</strong> <em><command></em> <br>
|
|
|
|
|
cpl <strong>H</strong> <em><command></em></p>
|
|
|
|
|
<div class="section" id="description">
|
|
|
|
|
<h2>Description<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2>
|
|
|
|
|
<p>Lists available command and their short descriptions.</p>
|
|
|
|
|
</div>
|
|
|
|
|
<div class="section" id="arguments">
|
|
|
|
|
<h2>Arguments<a class="headerlink" href="#arguments" title="Permalink to this headline">¶</a></h2>
|
|
|
|
|
<table class="colwidths-auto docutils align-default">
|
|
|
|
|
<thead>
|
|
|
|
|
<tr class="row-odd"><th class="head"><p>Argument</p></th>
|
|
|
|
|
<th class="text-align:center head"><p>Description</p></th>
|
|
|
|
|
<th class="text-align:center head"><p>Value type</p></th>
|
|
|
|
|
</tr>
|
|
|
|
|
</thead>
|
|
|
|
|
<tbody>
|
|
|
|
|
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre"><command></span></code></p></td>
|
|
|
|
|
<td class="text-align:center"><p>Shows a help message for this command in the console.</p></td>
|
|
|
|
|
<td class="text-align:center"><p><code class="docutils literal notranslate"><span class="pre">str</span></code></p></td>
|
|
|
|
|
</tr>
|
|
|
|
|
</tbody>
|
|
|
|
|
</table>
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
<footer>
|
|
|
|
|
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
|
|
|
|
<a href="cli.install.html" class="btn btn-neutral float-right" title="cpl install" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
|
|
|
|
<a href="cli.generate.html" class="btn btn-neutral float-left" title="cpl generate" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<hr/>
|
|
|
|
|
|
|
|
|
|
<div role="contentinfo">
|
|
|
|
|
<p>
|
|
|
|
|
© Copyright 2021, Sven Heidemann.
|
|
|
|
|
|
|
|
|
|
</p>
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
|
|
|
|
|
|
|
|
|
<a href="https://github.com/readthedocs/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">
|
|
|
|
|
jQuery(function () {
|
|
|
|
|
SphinxRtdTheme.Navigation.enable(true);
|
|
|
|
|
});
|
|
|
|
|
</script>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</body>
|
|
|
|
|
</html>
|
