aboutsummaryrefslogtreecommitdiff
path: root/docs/Usage/CLI.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/Usage/CLI.md')
-rw-r--r--docs/Usage/CLI.md26
1 files changed, 26 insertions, 0 deletions
diff --git a/docs/Usage/CLI.md b/docs/Usage/CLI.md
new file mode 100644
index 0000000..f689a3d
--- /dev/null
+++ b/docs/Usage/CLI.md
@@ -0,0 +1,26 @@
+# Command line interface
+---
+
+This gets installed in the `/usr/bin` directory, and can be called by:
+```bash
+$ luxcena-neo.sh
+```
+or is alias
+```bash
+$ lux-neo
+```
+{% hint style='danger' %}
+This CLI assumes root access, so please run it with `sudo`
+{% endhint %}
+
+## Options
+#### `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`
+Open the strip-config in `nano`.
+#### `sudo lux-neo start`
+Start the server.
+#### `sudo lux-neo stop`
+Stop the server.