From 997b165890c8421112f8cfed27e9124fd038ee75 Mon Sep 17 00:00:00 2001 From: luxick Date: Wed, 7 Jan 2026 07:29:23 +0100 Subject: [PATCH] Update readme --- README.md | 38 +++++++++++++++++++++++++------------- 1 file changed, 25 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 687ed24..59418f5 100644 --- a/README.md +++ b/README.md @@ -45,37 +45,43 @@ Examples: ## Install as a service -The scripts below install (or update) the client as a service that starts automatically with the system. -They assume the client binary already exists in the same folder as the scripts. +Use the built-in `install` / `uninstall` commands to install (or update) the client as a per-user service that starts automatically. +The `install` command copies the currently-running binary into the appropriate per-user install location. ### Linux (systemd) Install / update: ```bash -./install-linux.sh +./luxtools-client install ``` Optional flags: ```bash # Change listen address (still must be loopback) -./install-linux.sh --listen 127.0.0.1:9000 +./luxtools-client install -listen 127.0.0.1:9000 # Restrict allowed folders (repeatable) -./install-linux.sh --allow "$HOME" --allow "/mnt/data" +./luxtools-client install -allow "$HOME" -allow "/mnt/data" + +# Validate only (no files written, no service changes) +./luxtools-client install -dry-run ``` Uninstall: ```bash -./uninstall-linux.sh +./luxtools-client uninstall ``` Keep config on uninstall: ```bash -./uninstall-linux.sh --keep-config +./luxtools-client uninstall -keep-config + +# Validate only (no files removed, no service changes) +./luxtools-client uninstall -dry-run ``` Notes: @@ -91,35 +97,41 @@ Because this tool needs to open File Explorer (a GUI app) in the *current user s Install / update: ```bat -install-windows-task.bat +luxtools-client.exe install ``` Optional flags: ```bat -install-windows-task.bat --listen 127.0.0.1:9000 +luxtools-client.exe install -listen 127.0.0.1:9000 REM Restrict allowed folders (repeatable) -install-windows-task.bat --allow "%USERPROFILE%" --allow "D:\Data" +luxtools-client.exe install -allow "%USERPROFILE%" -allow "D:\Data" + +REM Validate only (no files written, no task changes) +luxtools-client.exe install -dry-run ``` Uninstall: ```bat -uninstall-windows-task.bat +luxtools-client.exe uninstall ``` Keep config on uninstall: ```bat -uninstall-windows-task.bat --keep-config +luxtools-client.exe uninstall -keep-config + +REM Validate only (no files removed, no task changes) +luxtools-client.exe uninstall -dry-run ``` Notes: - Installs to `%LOCALAPPDATA%\luxtools-client\luxtools-client.exe` - Stores config in `%LOCALAPPDATA%\luxtools-client\config.json` -- Re-running the install script updates the EXE in place and restarts the task. +- Re-running `install` updates the EXE in place and refreshes the task. ## API