# CLI commands - [install](#install-command) - [uninstall](#uninstall-command) - [start](#start-command) - [stop](#stop-command) - [restart](#restart-command) - [status](#status-command) - [test](#test-command) - [refresh](#refresh-command) - [customize](#customize-command) ## `install` command Installs the service. ### Usage ```console winsw install [] [--no-elevate] [--user|--username ] [--pass|--password ] ``` ### Arguments `path-to-config` The path to the configuration file. If a file isn't specified, WinSW searches the executable directory for a *.xml* file with the same file name without the extension. ### Options - `--no-elevate` Doesn't automatically trigger a UAC prompt. - `--user|--username ` Specifies the user name of the service account. - `--pass|--password ` Specifies the password of the service account. ## `uninstall` command Uninstalls the service. ### Usage ```console winsw uninstall [] [--no-elevate] ``` ### Arguments `path-to-config` The path to the configuration file. If a file isn't specified, WinSW searches the executable directory for a *.xml* file with the same file name without the extension. ### Options - `--no-elevate` Doesn't automatically trigger a UAC prompt. ## `start` command Starts the service. ### Usage ```console winsw start [] [--no-elevate] ``` ### Arguments `path-to-config` The path to the configuration file. If a file isn't specified, WinSW searches the executable directory for a *.xml* file with the same file name without the extension. ### Options - `--no-elevate` Doesn't automatically trigger a UAC prompt. ## `stop` command Stops the service. ### Usage ```console winsw stop [] [--no-elevate] [--no-wait] ``` ### Arguments `path-to-config` The path to the configuration file. If a file isn't specified, WinSW searches the executable directory for a *.xml* file with the same file name without the extension. ### Options - `--no-elevate` Doesn't automatically trigger a UAC prompt. - `--no-wait` Doesn't wait for the service to actually stop. - `--force` Stops the service even if it has started dependent services. ## `restart` command Stops and then starts the service. ### Usage ```console winsw restart [] [--no-elevate] ``` ### Arguments `path-to-config` The path to the configuration file. If a file isn't specified, WinSW searches the executable directory for a *.xml* file with the same file name without the extension. ### Options - `--no-elevate` Doesn't automatically trigger a UAC prompt. - `--force` Restarts the service even if it has started dependent services. ## `status` command Checks the status of the service. ### Usage ```console winsw status [] ``` ### Arguments `path-to-config` The path to the configuration file. If a file isn't specified, WinSW searches the executable directory for a *.xml* file with the same file name without the extension. ## `test` command Checks if the service can be started and then stopped without installation. ### Usage ```console winsw test [] [--no-elevate] [--timeout ] [--no-break] ``` ### Arguments `path-to-config` The path to the configuration file. If a file isn't specified, WinSW searches the executable directory for a *.xml* file with the same file name without the extension. ### Options - `--no-elevate` Doesn't automatically trigger a UAC prompt. - `--timeout ` Specifies the number of seconds to wait before the service is stopped. If not specified or -1 is specified, WinSW waits for a keystroke indefinitely. - `--no-break` Ignores keystrokes. If specified, WinSW waits for Ctrl+C. ## `refresh` command Refreshes the service properties without reinstallation. ### Usage ```console winsw refresh [] [--no-elevate] ``` ### Arguments `path-to-config` The path to the configuration file. If a file isn't specified, WinSW searches the executable directory for a *.xml* file with the same file name without the extension. ### Options - `--no-elevate` Doesn't automatically trigger a UAC prompt. ## `customize` command Customizes the wrapper executable. ### Usage ```console winsw customize -o|--output

--manufacturer ``` ### Options - `-o|--output

` Required. Specifies the path to the output file. - `--manufacturer ` Specifies the manufacturer name of the customized executable. ## `dev ps` command Draws the process tree associated with the service. ### Usage ```console winsw dev ps [] [-a|--all] ``` ### Options - `-a|--all` Optional. Draws the process tree associated with all services. ## `dev kill` command Terminates the service if it has stopped responding. ### Usage ```console winsw dev kill [] [--no-elevate] ``` ## `dev list` command Lists services managed by the current executable. ### Usage ```console winsw dev list ```