diff options
Diffstat (limited to 'public/docs/Usage/CLI/index.html')
| -rw-r--r-- | public/docs/Usage/CLI/index.html | 860 |
1 files changed, 860 insertions, 0 deletions
diff --git a/public/docs/Usage/CLI/index.html b/public/docs/Usage/CLI/index.html new file mode 100644 index 0000000..b89e230 --- /dev/null +++ b/public/docs/Usage/CLI/index.html @@ -0,0 +1,860 @@ + + + + +<!doctype html> +<html lang="en" class="no-js"> + <head> + + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width,initial-scale=1"> + <meta http-equiv="x-ua-compatible" content="ie=edge"> + + + + + <meta name="lang:clipboard.copy" content="Copy to clipboard"> + + <meta name="lang:clipboard.copied" content="Copied to clipboard"> + + <meta name="lang:search.language" content="en"> + + <meta name="lang:search.pipeline.stopwords" content="True"> + + <meta name="lang:search.pipeline.trimmer" content="True"> + + <meta name="lang:search.result.none" content="No matching documents"> + + <meta name="lang:search.result.one" content="1 matching document"> + + <meta name="lang:search.result.other" content="# matching documents"> + + <meta name="lang:search.tokenizer" content="[\s\-]+"> + + <link rel="shortcut icon" href="../../assets/images/favicon.png"> + <meta name="generator" content="mkdocs-1.0.4, mkdocs-material-4.4.2"> + + + + <title>CLI - Luxcena Neo Documentation</title> + + + + <link rel="stylesheet" href="../../assets/stylesheets/application.30686662.css"> + + + + + <script src="../../assets/javascripts/modernizr.74668098.js"></script> + + + + <link href="https://fonts.gstatic.com" rel="preconnect" crossorigin> + <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,400,400i,700|Roboto+Mono&display=fallback"> + <style>body,input{font-family:"Roboto","Helvetica Neue",Helvetica,Arial,sans-serif}code,kbd,pre{font-family:"Roboto Mono","Courier New",Courier,monospace}</style> + + + <link rel="stylesheet" href="../../assets/fonts/material-icons.css"> + + + <link rel="stylesheet" href="../../assets/luxcena-colors.css"> + + + + + + </head> + + <body dir="ltr"> + + <svg class="md-svg"> + <defs> + + + </defs> + </svg> + <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off"> + <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off"> + <label class="md-overlay" data-md-component="overlay" for="__drawer"></label> + + <a href="#command-line-interface" tabindex="1" class="md-skip"> + Skip to content + </a> + + + <header class="md-header" data-md-component="header"> + <nav class="md-header-nav md-grid"> + <div class="md-flex"> + <div class="md-flex__cell md-flex__cell--shrink"> + <a href="../.." title="Luxcena Neo Documentation" class="md-header-nav__button md-logo"> + + <i class="md-icon"></i> + + </a> + </div> + <div class="md-flex__cell md-flex__cell--shrink"> + <label class="md-icon md-icon--menu md-header-nav__button" for="__drawer"></label> + </div> + <div class="md-flex__cell md-flex__cell--stretch"> + <div class="md-flex__ellipsis md-header-nav__title" data-md-component="title"> + + <span class="md-header-nav__topic"> + Luxcena Neo Documentation + </span> + <span class="md-header-nav__topic"> + + CLI + + </span> + + </div> + </div> + <div class="md-flex__cell md-flex__cell--shrink"> + + <label class="md-icon md-icon--search md-header-nav__button" for="__search"></label> + +<div class="md-search" data-md-component="search" role="dialog"> + <label class="md-search__overlay" for="__search"></label> + <div class="md-search__inner" role="search"> + <form class="md-search__form" name="search"> + <input type="text" class="md-search__input" name="query" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="query" data-md-state="active"> + <label class="md-icon md-search__icon" for="__search"></label> + <button type="reset" class="md-icon md-search__icon" data-md-component="reset" tabindex="-1"> +  + </button> + </form> + <div class="md-search__output"> + <div class="md-search__scrollwrap" data-md-scrollfix> + <div class="md-search-result" data-md-component="result"> + <div class="md-search-result__meta"> + Type to start searching + </div> + <ol class="md-search-result__list"></ol> + </div> + </div> + </div> + </div> +</div> + + </div> + + </div> + </nav> +</header> + + <div class="md-container"> + + + + + <main class="md-main" role="main"> + <div class="md-main__inner md-grid" data-md-component="container"> + + + <div class="md-sidebar md-sidebar--primary" data-md-component="navigation"> + <div class="md-sidebar__scrollwrap"> + <div class="md-sidebar__inner"> + <nav class="md-nav md-nav--primary" data-md-level="0"> + <label class="md-nav__title md-nav__title--site" for="__drawer"> + <a href="../.." title="Luxcena Neo Documentation" class="md-nav__button md-logo"> + + <i class="md-icon"></i> + + </a> + Luxcena Neo Documentation + </label> + + <ul class="md-nav__list" data-md-scrollfix> + + + + + + + <li class="md-nav__item"> + <a href="../.." title="Introduction" class="md-nav__link"> + Introduction + </a> + </li> + + + + + + + + <li class="md-nav__item"> + <a href="../../FuturePlan/" title="Plan for the future" class="md-nav__link"> + Plan for the future + </a> + </li> + + + + + + + + + + <li class="md-nav__item md-nav__item--active md-nav__item--nested"> + + <input class="md-toggle md-nav__toggle" data-md-toggle="nav-3" type="checkbox" id="nav-3" checked> + + <label class="md-nav__link" for="nav-3"> + Usage + </label> + <nav class="md-nav" data-md-component="collapsible" data-md-level="1"> + <label class="md-nav__title" for="nav-3"> + Usage + </label> + <ul class="md-nav__list" data-md-scrollfix> + + + + + + + + <li class="md-nav__item"> + <a href="../Install/" title="Install" class="md-nav__link"> + Install + </a> + </li> + + + + + + + + <li class="md-nav__item"> + <a href="../Configuration/" title="Configuration" class="md-nav__link"> + Configuration + </a> + </li> + + + + + + + + + + <li class="md-nav__item md-nav__item--active"> + + <input class="md-toggle md-nav__toggle" data-md-toggle="toc" type="checkbox" id="__toc"> + + + + + <label class="md-nav__link md-nav__link--active" for="__toc"> + CLI + </label> + + <a href="./" title="CLI" class="md-nav__link md-nav__link--active"> + CLI + </a> + + +<nav class="md-nav md-nav--secondary"> + + + + + + <label class="md-nav__title" for="__toc">Table of contents</label> + <ul class="md-nav__list" data-md-scrollfix> + + <li class="md-nav__item"> + <a href="#options" class="md-nav__link"> + Options + </a> + + <nav class="md-nav"> + <ul class="md-nav__list"> + + <li class="md-nav__item"> + <a href="#sudo-lux-neo-uninstall" class="md-nav__link"> + sudo lux-neo uninstall + </a> + +</li> + + <li class="md-nav__item"> + <a href="#sudo-lux-neo-update-skipnode" class="md-nav__link"> + sudo lux-neo update (skipNode) + </a> + +</li> + + <li class="md-nav__item"> + <a href="#sudo-lux-neo-conf" class="md-nav__link"> + sudo lux-neo conf + </a> + +</li> + + <li class="md-nav__item"> + <a href="#sudo-lux-neo-start-boot" class="md-nav__link"> + sudo lux-neo start (boot) + </a> + +</li> + + <li class="md-nav__item"> + <a href="#sudo-lux-neo-stop-boot" class="md-nav__link"> + sudo lux-neo stop (boot) + </a> + +</li> + + <li class="md-nav__item"> + <a href="#sudo-lux-neo-status" class="md-nav__link"> + sudo lux-neo status + </a> + +</li> + + <li class="md-nav__item"> + <a href="#sudo-lux-neo-log-serviceapp" class="md-nav__link"> + sudo lux-neo log service/app + </a> + +</li> + + <li class="md-nav__item"> + <a href="#sudo-lux-neo-version" class="md-nav__link"> + sudo lux-neo version + </a> + +</li> + + <li class="md-nav__item"> + <a href="#sudo-lux-neo-selectbranch-branch" class="md-nav__link"> + sudo lux-neo selectBranch <branch> + </a> + +</li> + + </ul> + </nav> + +</li> + + + + + + </ul> + +</nav> + + </li> + + + </ul> + </nav> + </li> + + + + + + + + <li class="md-nav__item md-nav__item--nested"> + + <input class="md-toggle md-nav__toggle" data-md-toggle="nav-4" type="checkbox" id="nav-4"> + + <label class="md-nav__link" for="nav-4"> + Scripting + </label> + <nav class="md-nav" data-md-component="collapsible" data-md-level="1"> + <label class="md-nav__title" for="nav-4"> + Scripting + </label> + <ul class="md-nav__list" data-md-scrollfix> + + + + + + + + <li class="md-nav__item"> + <a href="../../Scripting/SupportLib/" title="Support Library" class="md-nav__link"> + Support Library + </a> + </li> + + + + + + + + <li class="md-nav__item md-nav__item--nested"> + + <input class="md-toggle md-nav__toggle" data-md-toggle="nav-4-2" type="checkbox" id="nav-4-2"> + + <label class="md-nav__link" for="nav-4-2"> + Examples + </label> + <nav class="md-nav" data-md-component="collapsible" data-md-level="2"> + <label class="md-nav__title" for="nav-4-2"> + Examples + </label> + <ul class="md-nav__list" data-md-scrollfix> + + + + + + + + <li class="md-nav__item"> + <a href="../../Scripting/Examples/strandtest/" title="Strandtest" class="md-nav__link"> + Strandtest + </a> + </li> + + + </ul> + </nav> + </li> + + + </ul> + </nav> + </li> + + + + + + + + <li class="md-nav__item md-nav__item--nested"> + + <input class="md-toggle md-nav__toggle" data-md-toggle="nav-5" type="checkbox" id="nav-5"> + + <label class="md-nav__link" for="nav-5"> + Code Documentation + </label> + <nav class="md-nav" data-md-component="collapsible" data-md-level="1"> + <label class="md-nav__title" for="nav-5"> + Code Documentation + </label> + <ul class="md-nav__list" data-md-scrollfix> + + + + + + + + <li class="md-nav__item md-nav__item--nested"> + + <input class="md-toggle md-nav__toggle" data-md-toggle="nav-5-1" type="checkbox" id="nav-5-1"> + + <label class="md-nav__link" for="nav-5-1"> + Modules + </label> + <nav class="md-nav" data-md-component="collapsible" data-md-level="2"> + <label class="md-nav__title" for="nav-5-1"> + Modules + </label> + <ul class="md-nav__list" data-md-scrollfix> + + + + + + + + <li class="md-nav__item"> + <a href="../../Code Documentation/Modules/CompileAndRun/" title="CompileAndRun" class="md-nav__link"> + CompileAndRun + </a> + </li> + + + </ul> + </nav> + </li> + + + + + + + + <li class="md-nav__item"> + <a href="../../Code Documentation/Run/" title="Run" class="md-nav__link"> + Run + </a> + </li> + + + + + + + + <li class="md-nav__item"> + <a href="../../Code Documentation/Design/" title="Design" class="md-nav__link"> + Design + </a> + </li> + + + + + + + + <li class="md-nav__item md-nav__item--nested"> + + <input class="md-toggle md-nav__toggle" data-md-toggle="nav-5-4" type="checkbox" id="nav-5-4"> + + <label class="md-nav__link" for="nav-5-4"> + API + </label> + <nav class="md-nav" data-md-component="collapsible" data-md-level="2"> + <label class="md-nav__title" for="nav-5-4"> + API + </label> + <ul class="md-nav__list" data-md-scrollfix> + + + + + + + + <li class="md-nav__item"> + <a href="../../Code Documentation/SocketIO/" title="Socket-IO" class="md-nav__link"> + Socket-IO + </a> + </li> + + + </ul> + </nav> + </li> + + + </ul> + </nav> + </li> + + + </ul> +</nav> + </div> + </div> + </div> + + + <div class="md-sidebar md-sidebar--secondary" data-md-component="toc"> + <div class="md-sidebar__scrollwrap"> + <div class="md-sidebar__inner"> + +<nav class="md-nav md-nav--secondary"> + + + + + + <label class="md-nav__title" for="__toc">Table of contents</label> + <ul class="md-nav__list" data-md-scrollfix> + + <li class="md-nav__item"> + <a href="#options" class="md-nav__link"> + Options + </a> + + <nav class="md-nav"> + <ul class="md-nav__list"> + + <li class="md-nav__item"> + <a href="#sudo-lux-neo-uninstall" class="md-nav__link"> + sudo lux-neo uninstall + </a> + +</li> + + <li class="md-nav__item"> + <a href="#sudo-lux-neo-update-skipnode" class="md-nav__link"> + sudo lux-neo update (skipNode) + </a> + +</li> + + <li class="md-nav__item"> + <a href="#sudo-lux-neo-conf" class="md-nav__link"> + sudo lux-neo conf + </a> + +</li> + + <li class="md-nav__item"> + <a href="#sudo-lux-neo-start-boot" class="md-nav__link"> + sudo lux-neo start (boot) + </a> + +</li> + + <li class="md-nav__item"> + <a href="#sudo-lux-neo-stop-boot" class="md-nav__link"> + sudo lux-neo stop (boot) + </a> + +</li> + + <li class="md-nav__item"> + <a href="#sudo-lux-neo-status" class="md-nav__link"> + sudo lux-neo status + </a> + +</li> + + <li class="md-nav__item"> + <a href="#sudo-lux-neo-log-serviceapp" class="md-nav__link"> + sudo lux-neo log service/app + </a> + +</li> + + <li class="md-nav__item"> + <a href="#sudo-lux-neo-version" class="md-nav__link"> + sudo lux-neo version + </a> + +</li> + + <li class="md-nav__item"> + <a href="#sudo-lux-neo-selectbranch-branch" class="md-nav__link"> + sudo lux-neo selectBranch <branch> + </a> + +</li> + + </ul> + </nav> + +</li> + + + + + + </ul> + +</nav> + </div> + </div> + </div> + + + <div class="md-content"> + <article class="md-content__inner md-typeset"> + + + + <h1 id="command-line-interface">Command line interface</h1> +<hr /> +<div class="admonition danger"> +<p class="admonition-title">Important!</p> +<p>This CLI assumes root access, so please run it with <code class="codehilite"><span class="n">sudo</span></code></p> +</div> +<h2 id="options">Options</h2> +<h3 id="sudo-lux-neo-uninstall"><code class="codehilite"><span class="n">sudo</span> <span class="n">lux</span><span class="o">-</span><span class="n">neo</span> <span class="n">uninstall</span></code></h3> +<p>Uninstall the whole thing. You will have to remove this script yourself.</p> +<h3 id="sudo-lux-neo-update-skipnode"><code class="codehilite"><span class="n">sudo</span> <span class="n">lux</span><span class="o">-</span><span class="n">neo</span> <span class="k">update</span> <span class="p">(</span><span class="n">skipNode</span><span class="p">)</span></code></h3> +<p>Update to the newest version on the current branch. +If <code class="codehilite"><span class="n">skipNode</span></code> is the second argument, <code class="codehilite"><span class="n">npm</span></code> won't be run.</p> +<h3 id="sudo-lux-neo-conf"><code class="codehilite"><span class="n">sudo</span> <span class="n">lux</span><span class="o">-</span><span class="n">neo</span> <span class="n">conf</span></code></h3> +<p>Open the strip-config in <code class="codehilite"><span class="n">nano</span></code>.</p> +<h3 id="sudo-lux-neo-start-boot"><code class="codehilite"><span class="n">sudo</span> <span class="n">lux</span><span class="o">-</span><span class="n">neo</span> <span class="k">start</span> <span class="p">(</span><span class="n">boot</span><span class="p">)</span></code></h3> +<p>Start the server. +If you add <code class="codehilite"><span class="n">boot</span></code>, it will start when the system boots: +<table class="codehilitetable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span>1</pre></div></td><td class="code"><div class="codehilite"><pre><span></span>sudo lux-neo start boot +</pre></div> +</td></tr></table></p> +<h3 id="sudo-lux-neo-stop-boot"><code class="codehilite"><span class="n">sudo</span> <span class="n">lux</span><span class="o">-</span><span class="n">neo</span> <span class="n">stop</span> <span class="p">(</span><span class="n">boot</span><span class="p">)</span></code></h3> +<p>Stop the server. +If you add <code class="codehilite"><span class="n">boot</span></code>, it will <em>NOT</em> start when the system boots: +<table class="codehilitetable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span>1</pre></div></td><td class="code"><div class="codehilite"><pre><span></span>sudo lux-neo start boot +</pre></div> +</td></tr></table></p> +<h3 id="sudo-lux-neo-status"><code class="codehilite"><span class="n">sudo</span> <span class="n">lux</span><span class="o">-</span><span class="n">neo</span> <span class="n">status</span></code></h3> +<p>This will output the status of the app. First it reports if the service is running, +and some general info. Then it prints the systemd-status report.</p> +<p>Example output: +<table class="codehilitetable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span> 1 + 2 + 3 + 4 + 5 + 6 + 7 + 8 + 9 +10 +11 +12 +13 +14 +15 +16 +17 +18 +19</pre></div></td><td class="code"><div class="codehilite"><pre><span></span>Luxcena-neo-cli [args: 'status'] + +╭─────────────────────╮ +│ Service active: yes │ +│ Starts on boot: yes │ +│ Has failed: no │ +╰─────────────────────╯ + +━━━Service status━━━━━━━━━━━━━━━━━━ +● luxcena-neo.service - Luxcena Neo + Loaded: loaded (/etc/systemd/system/luxcena-neo.service; enabled; vendor preset: enabled) + Active: active (running) since Wed 2018-12-05 22:55:28 UTC; 6min ago + Main PID: 2365 (luxcena-neo.sh) + CGroup: /system.slice/luxcena-neo.service + ├─2365 /bin/bash /home/lux-neo/src/bin/luxcena-neo.sh + └─2367 node /home/lux-neo/src/app.js + +Dec 05 22:55:28 LUXCENA-STUE-SKAP systemd[1]: Started Luxcena Neo. +━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ +</pre></div> +</td></tr></table></p> +<h3 id="sudo-lux-neo-log-serviceapp"><code class="codehilite"><span class="n">sudo</span> <span class="n">lux</span><span class="o">-</span><span class="n">neo</span> <span class="n">log</span> <span class="n">service</span><span class="o">/</span><span class="n">app</span></code></h3> +<p>This shows the last 20 lines of the chosen log-file. And stays open to show +all new entries.</p> +<p>Example output: +<table class="codehilitetable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span>1 +2 +3 +4 +5</pre></div></td><td class="code"><div class="codehilite"><pre><span></span>Luxcena-neo-cli [args: 'log app'] + +━━━App log (press ctrl+c to exit)━━━━━━━━━━━━━━━━━━ +[3.11.2018 23:5:21:401] EVENT Starting Luxcena-Neo... +[3.11.2018 23:5:22:462] SUCCESS Webserver now listening at *:8080 +</pre></div> +</td></tr></table></p> +<h3 id="sudo-lux-neo-version"><code class="codehilite"><span class="n">sudo</span> <span class="n">lux</span><span class="o">-</span><span class="n">neo</span> <span class="k">version</span></code></h3> +<p>Currently not really doing anything usefull apart from showing which branch you are on.</p> +<p>Example output: +<table class="codehilitetable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span>1 +2 +3 +4 +5 +6</pre></div></td><td class="code"><div class="codehilite"><pre><span></span>Luxcena-neo-cli [args: 'version'] + +╭─────────────────────╮ +│ Version: Unknown │ +│ branch : dev │ +╰─────────────────────╯ +</pre></div> +</td></tr></table></p> +<h3 id="sudo-lux-neo-selectbranch-branch"><code class="codehilite"><span class="n">sudo</span> <span class="n">lux</span><span class="o">-</span><span class="n">neo</span> <span class="n">selectBranch</span> <span class="o"><</span><span class="n">branch</span><span class="o">></span></code></h3> +<p>This will change what branch you are on to <branch>. Stashing changes (shouldn't be a concern, but just saying it anyways).</p> +<div class="admonition note"> +<p class="admonition-title">Note</p> +<p>Please note that the version-checker now will just be useless, as it does not now what branch we really are on.</p> +</div> + + + + + + + + + + </article> + </div> + </div> + </main> + + +<footer class="md-footer"> + + <div class="md-footer-nav"> + <nav class="md-footer-nav__inner md-grid"> + + <a href="../Configuration/" title="Configuration" class="md-flex md-footer-nav__link md-footer-nav__link--prev" rel="prev"> + <div class="md-flex__cell md-flex__cell--shrink"> + <i class="md-icon md-icon--arrow-back md-footer-nav__button"></i> + </div> + <div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title"> + <span class="md-flex__ellipsis"> + <span class="md-footer-nav__direction"> + Previous + </span> + Configuration + </span> + </div> + </a> + + + <a href="../../Scripting/SupportLib/" title="Support Library" class="md-flex md-footer-nav__link md-footer-nav__link--next" rel="next"> + <div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title"> + <span class="md-flex__ellipsis"> + <span class="md-footer-nav__direction"> + Next + </span> + Support Library + </span> + </div> + <div class="md-flex__cell md-flex__cell--shrink"> + <i class="md-icon md-icon--arrow-forward md-footer-nav__button"></i> + </div> + </a> + + </nav> + </div> + + <div class="md-footer-meta md-typeset"> + <div class="md-footer-meta__inner md-grid"> + <div class="md-footer-copyright"> + + powered by + <a href="https://www.mkdocs.org">MkDocs</a> + and + <a href="https://squidfunk.github.io/mkdocs-material/"> + Material for MkDocs</a> + </div> + + </div> + </div> +</footer> + + </div> + + <script src="../../assets/javascripts/application.c648116f.js"></script> + + <script>app.initialize({version:"1.0.4",url:{base:"../.."}})</script> + + <script src="../../assets/luxcena-colors.js"></script> + + <script src="../../assets/webfont.js"></script> + + <script src="../../assets/snap.svg-min.js"></script> + + <script src="../../assets/underscore-min.js"></script> + + <script src="../../assets/sequence-diagram.min.js"></script> + + <script src="../../assets/js-sequence.js"></script> + + + </body> +</html>
\ No newline at end of file |