229 lines
13 KiB
HTML
229 lines
13 KiB
HTML
<!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>CLI Overview and Command Reference — Common Python Library documentation</title>
|
|
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
|
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
|
<!--[if lt IE 9]>
|
|
<script src="_static/js/html5shiv.min.js"></script>
|
|
<![endif]-->
|
|
|
|
<script data-url_root="./" id="documentation_options" 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 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 add" href="cli.add.html" />
|
|
<link rel="prev" title="CLI Reference" href="cpl_cli.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="Navigation menu">
|
|
<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 current"><a class="current reference internal" href="#">CLI Overview and Command Reference</a><ul>
|
|
<li class="toctree-l3"><a class="reference internal" href="#table-of-contents">Table of Contents</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="#basic-workflow">Basic workflow</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="#cli-command-language-syntax">CLI command-language syntax</a><ul>
|
|
<li class="toctree-l4"><a class="reference internal" href="#relative-paths">Relative paths</a></li>
|
|
<li class="toctree-l4"><a class="reference internal" href="#schematics">Schematics</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l3"><a class="reference internal" href="#command-overview">Command overview</a></li>
|
|
</ul>
|
|
</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"><a class="reference internal" href="cli.help.html">cpl help</a></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>
|
|
<li class="toctree-l1"><a class="reference internal" href="cpl_core.html">API Reference</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="cpl_query.html">Query Reference</a></li>
|
|
</ul>
|
|
|
|
</div>
|
|
</div>
|
|
</nav>
|
|
|
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
|
|
<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="Page 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>CLI Overview and Command Reference</li>
|
|
<li class="wy-breadcrumbs-aside">
|
|
<a href="_sources/cli.overview.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="tex2jax_ignore mathjax_ignore section" id="cli-overview-and-command-reference">
|
|
<h1>CLI Overview and Command Reference<a class="headerlink" href="#cli-overview-and-command-reference" title="Permalink to this headline"></a></h1>
|
|
<div class="section" id="table-of-contents">
|
|
<h2>Table of Contents<a class="headerlink" href="#table-of-contents" title="Permalink to this headline"></a></h2>
|
|
<ol class="simple">
|
|
<li><p><a class="reference external" href="setup#install-the-package">Install CPL</a></p></li>
|
|
<li><p><a class="reference external" href="setup#install-the-cli">Install CPL CLI</a></p></li>
|
|
<li><p><a class="reference external" href="#basic-workflow">Basic workflow</a></p></li>
|
|
<li><p><a class="reference external" href="#cli-command-language-syntax">CLI command-language syntax</a></p></li>
|
|
<li><p><a class="reference external" href="#command-overview">Command overview</a></p></li>
|
|
</ol>
|
|
</div>
|
|
<div class="section" id="basic-workflow">
|
|
<h2>Basic workflow<a class="headerlink" href="#basic-workflow" title="Permalink to this headline"></a></h2>
|
|
<p>To create, build, and serve a new, basic CPL project on a development server, go to the parent directory of your new workspace use the following commands:</p>
|
|
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>cpl new console my-first-project
|
|
<span class="nb">cd</span> my-first-project
|
|
cpl start
|
|
</pre></div>
|
|
</div>
|
|
<p>In the terminal you will the output of the app.</p>
|
|
</div>
|
|
<div class="section" id="cli-command-language-syntax">
|
|
<h2>CLI command-language syntax<a class="headerlink" href="#cli-command-language-syntax" title="Permalink to this headline"></a></h2>
|
|
<p><code class="docutils literal notranslate"><span class="pre">cpl</span></code> commandNameOrAlias requiredArg <code class="docutils literal notranslate"><span class="pre">[optionalsArgs]</span></code></p>
|
|
<ul class="simple">
|
|
<li><p>Most commands, and some options, have aliases. Aliases are shown in the syntax statement for each command.</p></li>
|
|
<li><p>Arguments are not prefixed.</p></li>
|
|
</ul>
|
|
<div class="section" id="relative-paths">
|
|
<h3>Relative paths<a class="headerlink" href="#relative-paths" title="Permalink to this headline"></a></h3>
|
|
<p>Options that specify files can be given as absolute paths, or as paths relative to the current working directory, which is generally either the workspace or project root.</p>
|
|
</div>
|
|
<div class="section" id="schematics">
|
|
<h3>Schematics<a class="headerlink" href="#schematics" title="Permalink to this headline"></a></h3>
|
|
<p>The cpl generate command takes as an argument the artifact to be generated. In addition to any general options, each artifact defines its own options in a schematic. Schematic options are supplied to the command in the same format as immediate command options.</p>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="command-overview">
|
|
<h2>Command overview<a class="headerlink" href="#command-overview" title="Permalink to this headline"></a></h2>
|
|
<table class="colwidths-auto docutils align-default">
|
|
<thead>
|
|
<tr class="row-odd"><th class="head"><p>Command</p></th>
|
|
<th class="text-align:center head"><p>Alias</p></th>
|
|
<th class="text-align:center head"><p>Description</p></th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr class="row-even"><td><p><a class="reference internal" href="cli.add.html"><span class="doc std std-doc">add</span></a></p></td>
|
|
<td class="text-align:center"><p>a or a</p></td>
|
|
<td class="text-align:center"><p>Adds a project reference to given project.</p></td>
|
|
</tr>
|
|
<tr class="row-odd"><td><p><a class="reference internal" href="cli.build.html"><span class="doc std std-doc">build</span></a></p></td>
|
|
<td class="text-align:center"><p>b or B</p></td>
|
|
<td class="text-align:center"><p>Prepares files for publish into an output directory named dist/ at the given output path. Must be executed from within a workspace directory.</p></td>
|
|
</tr>
|
|
<tr class="row-even"><td><p><a class="reference internal" href="cli.generate.html"><span class="doc std std-doc">generate</span></a></p></td>
|
|
<td class="text-align:center"><p>g or G</p></td>
|
|
<td class="text-align:center"><p>Generate a new file.</p></td>
|
|
</tr>
|
|
<tr class="row-odd"><td><p><a class="reference internal" href="cli.help.html"><span class="doc std std-doc">help</span></a></p></td>
|
|
<td class="text-align:center"><p>h or H</p></td>
|
|
<td class="text-align:center"><p>Lists available command and their short descriptions.</p></td>
|
|
</tr>
|
|
<tr class="row-even"><td><p><a class="reference internal" href="cli.install.html"><span class="doc std std-doc">install</span></a></p></td>
|
|
<td class="text-align:center"><p>i or I</p></td>
|
|
<td class="text-align:center"><p>With argument installs packages to project, without argument installs project dependencies.</p></td>
|
|
</tr>
|
|
<tr class="row-odd"><td><p><a class="reference internal" href="cli.new.html"><span class="doc std std-doc">new</span></a></p></td>
|
|
<td class="text-align:center"><p>n or N</p></td>
|
|
<td class="text-align:center"><p>Creates new CPL project.</p></td>
|
|
</tr>
|
|
<tr class="row-even"><td><p><a class="reference internal" href="cli.publish.html"><span class="doc std std-doc">publish</span></a></p></td>
|
|
<td class="text-align:center"><p>p or P</p></td>
|
|
<td class="text-align:center"><p>Prepares files for publish into an output directory named dist/ at the given output path and executes <code class="docutils literal notranslate"><span class="pre">setup.py</span></code>. Must be executed from within a library workspace directory.</p></td>
|
|
</tr>
|
|
<tr class="row-odd"><td><p><a class="reference internal" href="cli.remove.html"><span class="doc std std-doc">remove</span></a></p></td>
|
|
<td class="text-align:center"><p>r or R</p></td>
|
|
<td class="text-align:center"><p>Removes a project from workspace.</p></td>
|
|
</tr>
|
|
<tr class="row-even"><td><p><a class="reference internal" href="cli.start.html"><span class="doc std std-doc">start</span></a></p></td>
|
|
<td class="text-align:center"><p>s or S</p></td>
|
|
<td class="text-align:center"><p>Starts CPL project, restarting on file changes.</p></td>
|
|
</tr>
|
|
<tr class="row-odd"><td><p><a class="reference internal" href="cli.uninstall.html"><span class="doc std std-doc">uninstall</span></a></p></td>
|
|
<td class="text-align:center"><p>ui or UI</p></td>
|
|
<td class="text-align:center"><p>Uninstalls packages from project.</p></td>
|
|
</tr>
|
|
<tr class="row-even"><td><p><a class="reference internal" href="cli.update.html"><span class="doc std std-doc">update</span></a></p></td>
|
|
<td class="text-align:center"><p>u or U</p></td>
|
|
<td class="text-align:center"><p>Update CPL and project dependencies.</p></td>
|
|
</tr>
|
|
<tr class="row-odd"><td><p><a class="reference internal" href="cli.version.html"><span class="doc std std-doc">version</span></a></p></td>
|
|
<td class="text-align:center"><p>v or V</p></td>
|
|
<td class="text-align:center"><p>Outputs CPL CLI version.</p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
|
<a href="cpl_cli.html" class="btn btn-neutral float-left" title="CLI Reference" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
|
<a href="cli.add.html" class="btn btn-neutral float-right" title="cpl add" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></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>
|
|
jQuery(function () {
|
|
SphinxRtdTheme.Navigation.enable(true);
|
|
});
|
|
</script>
|
|
|
|
</body>
|
|
</html> |