diff options
| author | Jakob Stendahl <jakob.stendahl@outlook.com> | 2018-11-29 23:14:58 +0100 |
|---|---|---|
| committer | Jakob Stendahl <jakob.stendahl@outlook.com> | 2018-11-29 23:14:58 +0100 |
| commit | 101745c6a4a2c6a186be48182d48814177840c65 (patch) | |
| tree | ee7c7420291473033cf7cd9f921fe21958bf571f /docs/Usage/CLI.md | |
| parent | 2147880e40ee39ae07c8df9d3500080da467475d (diff) | |
| download | Luxcena-Neo-101745c6a4a2c6a186be48182d48814177840c65.tar.gz Luxcena-Neo-101745c6a4a2c6a186be48182d48814177840c65.zip | |
:construction: Chenged things, and written some docs
Diffstat (limited to 'docs/Usage/CLI.md')
| -rw-r--r-- | docs/Usage/CLI.md | 26 |
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. |