Skip to main content

Module cli

Module cli 

Source
Expand description

bhtune-server’s CLI surface (server-windows-service): a --config flag plus five subcommands (install/uninstall/start/stop/status) that manage this binary’s registration as a platform service.

Kept deliberately tiny – unlike bhtune-cli, this binary is still meant to be run mostly unconfigured (env vars / bhtune.toml cover everything else, see crate::run). --config is the one flag worth adding now: it lets install bake an explicit, stable config path into the service’s registered launch command (see crate::service::service_launch_arguments), which matters because a Windows service normally runs under a different account than whoever ran install interactively, so it would otherwise resolve %APPDATA% to a different (system) profile and appear to have “lost” any config/database an operator set up while testing from their own terminal session – see docs/getting-started/installation.md’s “Run as a background service” section.

ServiceCommand is parsed identically on every platform (so --help output and argument validation are covered by CI’s Windows and Linux jobs alike), even though only Windows can actually act on it – see crate::service’s module doc comment for how the two other platforms respond instead.

Structs§

Cli
The bhtune-server binary’s command line.

Enums§

ServiceCommand
Manage bhtune-server’s registration as a platform service.