aboutsummaryrefslogtreecommitdiff
path: root/docs/Usage/CLI.md
diff options
context:
space:
mode:
authorJakob Stendahl <14180120+JakobST1n@users.noreply.github.com>2018-12-06 00:23:57 +0100
committerGitHub <noreply@github.com>2018-12-06 00:23:57 +0100
commitc3f8b0a72de4a8a11bf5c8a1895143a4f5fa16ee (patch)
tree6c7a6c476f5a55661deea945d00f6a8cc3842dd5 /docs/Usage/CLI.md
parent354f5b9b2acf9faa6d8117386c2b6c8e3527ecbf (diff)
parente56c60e17f5060203c993c852272e795b3ee6224 (diff)
downloadLuxcena-Neo-c3f8b0a72de4a8a11bf5c8a1895143a4f5fa16ee.tar.gz
Luxcena-Neo-c3f8b0a72de4a8a11bf5c8a1895143a4f5fa16ee.zip
Merge branch 'dev' into python
Diffstat (limited to 'docs/Usage/CLI.md')
-rw-r--r--docs/Usage/CLI.md80
1 files changed, 75 insertions, 5 deletions
diff --git a/docs/Usage/CLI.md b/docs/Usage/CLI.md
index f689a3d..6052193 100644
--- a/docs/Usage/CLI.md
+++ b/docs/Usage/CLI.md
@@ -14,13 +14,83 @@ This CLI assumes root access, so please run it with `sudo`
{% endhint %}
## 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`
+
+### `sudo lux-neo update (skipNode)`
Update to the newest version on the current branch.
-#### `sudo lux-neo conf`
+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`
+
+### `sudo lux-neo start (boot)`
Start the server.
-#### `sudo lux-neo stop`
+If you add `boot`, it will start when the system boots:
+```bash
+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:
+```bash
+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:
+```text
+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:
+```text
+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:
+```text
+Luxcena-neo-cli [args: 'version']
+
+╭─────────────────────╮
+│ Version: Unknown │
+│ branch : dev │
+╰─────────────────────╯
+```
+### `sudo lux-neo selectBranch <branch>`
+This will change what branch you are on to <branch>. 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.*