diff options
| author | Jakob Stendahl <14180120+JakobST1n@users.noreply.github.com> | 2018-12-01 00:28:28 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2018-12-01 00:28:28 +0100 |
| commit | 19df9946b438b38b9a4f3f57ad002981a1ae1eaf (patch) | |
| tree | e8eb839a305502584e31e1b1a96c70406b9b6255 /docs/Usage/CLI.md | |
| parent | fd7a1b51126f8b8f889807cb7d56bb3626a0e0b5 (diff) | |
| parent | 7ec685de6e441af1f614bb9d18e25c047d21466b (diff) | |
| download | Luxcena-Neo-19df9946b438b38b9a4f3f57ad002981a1ae1eaf.tar.gz Luxcena-Neo-19df9946b438b38b9a4f3f57ad002981a1ae1eaf.zip | |
Merge pull request #6 from JakobST1n/dev
Written docs, finished CLI
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. |