From 392caaca416174050d16b3549632e34592cb1128 Mon Sep 17 00:00:00 2001 From: Jakob Stendahl Date: Thu, 6 Dec 2018 00:15:37 +0100 Subject: :memo: Add docs on the new CLI --- docs/_book/Usage/CLI.html | 72 ++++++++++++++++++++++++++++++++----- docs/_book/Usage/Configuration.html | 2 +- docs/_book/Usage/Install.html | 2 +- docs/_book/Usage/index.html | 2 +- 4 files changed, 66 insertions(+), 12 deletions(-) (limited to 'docs/_book/Usage') diff --git a/docs/_book/Usage/CLI.html b/docs/_book/Usage/CLI.html index bae9eda..9df4e71 100644 --- a/docs/_book/Usage/CLI.html +++ b/docs/_book/Usage/CLI.html @@ -321,16 +321,70 @@

This CLI assumes root access, so please run it with sudo

Options

-

sudo lux-neo uninstall

+

sudo lux-neo uninstall

Uninstall the whole thing. You will have to remove this script yourself.

-

sudo lux-neo update

-

Update to the newest version on the current branch.

-

sudo lux-neo conf

+

sudo lux-neo update (skipNode)

+

Update to the newest version on the current branch. +If skipNode is the second argument, npm won't be run.

+

sudo lux-neo conf

Open the strip-config in nano.

-

sudo lux-neo start

-

Start the server.

-

sudo lux-neo stop

-

Stop the server.

+

sudo lux-neo start (boot)

+

Start the server. +If you add boot, it will start when the system boots:

+
sudo lux-neo start boot
+
+

sudo lux-neo stop (boot)

+

Stop the server. +If you add boot, it will NOT start when the system boots:

+
sudo lux-neo start boot
+
+

sudo lux-neo status

+

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.

+

Example output:

+
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.
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+
+

sudo lux-neo log service/app

+

This shows the last 20 lines of the chosen log-file. And stays open to show +all new entries.

+

Example output:

+
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
+
+

sudo lux-neo version

+

Currently not really doing anything usefull apart from showing which branch you are on.

+

Example output:

+
Luxcena-neo-cli [args: 'version']
+
+╭─────────────────────╮
+│ Version: Unknown    │
+│ branch : dev    │
+╰─────────────────────╯
+
+

sudo lux-neo selectBranch <branch>

+

This will change what branch you are on to . Stashing changes (shouldn't be a concern, but just saying it anyways).

+

Please note that the version-checker now will just be useless, as it does not now what branch we really are on.

@@ -370,7 +424,7 @@ diff --git a/docs/_book/Usage/Configuration.html b/docs/_book/Usage/Configuration.html index ffc7c9f..b9e529d 100644 --- a/docs/_book/Usage/Configuration.html +++ b/docs/_book/Usage/Configuration.html @@ -409,7 +409,7 @@ This is the dma-channel used to generate the data-stream. If you for some reason diff --git a/docs/_book/Usage/Install.html b/docs/_book/Usage/Install.html index 86579ad..d246f48 100644 --- a/docs/_book/Usage/Install.html +++ b/docs/_book/Usage/Install.html @@ -384,7 +384,7 @@ This is also where you will find possible reasons for a failed install. diff --git a/docs/_book/Usage/index.html b/docs/_book/Usage/index.html index 9a18cb7..172f57d 100644 --- a/docs/_book/Usage/index.html +++ b/docs/_book/Usage/index.html @@ -362,7 +362,7 @@ -- cgit v1.2.3