Command-line options

Nexus is normally run as a service and you never type these. They are here for diagnosis, for scripted installs, and for running it in a console to watch it start.

raylux-nexus [options]

General

Option	Effect
--config <path>	Use a specific project file instead of raylux_project.json in the data directory.
--data-dir <path>	Where Nexus keeps its data. See Where files live.
--web-dist <path>	The built operator runtime to serve.
--log-level <level>	debug, info, warn or error.
--validate-config	Parse the project file and exit. Exit code 0 means valid, 2 means invalid.
--allow-missing-config	Start even when the project file is absent.
-v, --version	Print the version and exit.
-h, --help	Print usage and exit.

Check a configuration before restarting a running Nexus

raylux-nexus --validate-config --config /path/to/raylux_project.json

This tells you whether Nexus will accept the file without taking the running one down to find out.

Windows service

Run these from an elevated prompt.

Option	Effect
--install-service	Register Nexus with the Service Control Manager and exit.
--uninstall-service	Stop and remove the service, then exit. Running it twice is not an error.
--service-account <account>	The account to register the service under. Defaults to LocalSystem.
--service	Run under the Service Control Manager. Set by the installer — do not use it by hand.

--install-service bakes --data-dir, --config, --web-dist and --log-level into the registered command line if you supply them.

You normally do not need these

The installer registers the service itself. Use --install-service only for a build-from-source install. If you register a service by hand, supply --data-dir and --web-dist explicitly:

A service starts with its working directory set to C:\Windows\System32, and both of those default to paths resolved against the working directory. Without them Nexus writes its project file, history and TLS private key into System32, and serves no web interface.

.\raylux-nexus.exe --install-service `
    --data-dir "C:\ProgramData\Raylux" `
    --web-dist "C:\Program Files\Raylux\nexus\web"

It prints exactly what it registered. Confirm with:

sc qc RayluxNexus

The registered path is always quoted. An unquoted service path containing a space is a well-known privilege-escalation vector, so this is not left to chance.

Exit codes

Code	Meaning
0	Clean exit.
2	Invalid configuration (from --validate-config).