10 releases (2 stable)

1.1.0 Jan 18, 2022
1.0.0 May 20, 2021
0.6.2 Mar 9, 2021
0.6.1 Dec 23, 2020
0.4.0 Oct 5, 2019

#18 in Windows APIs

Download history 9/week @ 2021-10-03 10/week @ 2021-10-10 3/week @ 2021-10-24 6/week @ 2021-10-31 11/week @ 2021-11-07 16/week @ 2021-11-14 15/week @ 2021-11-21 23/week @ 2021-11-28 5/week @ 2021-12-05 9/week @ 2021-12-12 9/week @ 2021-12-19 15/week @ 2021-12-26 18/week @ 2022-01-02 10/week @ 2022-01-09 20/week @ 2022-01-16

64 downloads per month

MIT license

85KB
2K SLoC

Shawl

Build Status Version License: MIT

Shawl is a wrapper for running arbitrary programs as Windows services, written in Rust. It handles the Windows service API for you so that your program only needs to respond to ctrl-C/SIGINT. If you're creating a project that needs to run as a service, simply bundle Shawl with your project, set it as the entry point, and pass the command to run via CLI. Here is an example of creating a service wrapped with Shawl (note that -- separates Shawl's own options from the command that you'd like it to run):

  • Using Shawl's add command:
    • shawl add --name my-app -- C:/path/my-app.exe
  • Using the Windows sc command for more control:
    • sc create my-app binPath= "C:/path/shawl.exe run -- C:/path/my-app.exe"
  • Then start or configure the service as normal:
    • sc config my-app start= auto
      sc start my-app
      

Shawl will inspect the state of your program in order to report the correct status to Windows:

  • By default, when your program exits, Shawl will restart it if the exit code is nonzero. You can customize this behavior with --(no-)restart for all exit codes and --restart-if(-not) for specific exit codes.
  • When the service is requested to stop, Shawl sends your program a ctrl-C event, then waits up to 3000 milliseconds (based on --stop-timeout) before forcibly killing the process if necessary.
  • In either case, if Shawl is not restarting your program, then it reports the exit code to Windows as a service-specific error, unless the exit code is 0 or a code you've configured with --pass.

Shawl creates a log file for each service, shawl_for_<service>_*.log, in the same location as the Shawl executable, with both its own messages and the output from the commands that it runs. If anything goes wrong, you can read the log to find out more. You can disable all logging with --no-log, and you can disable just the command logs with --no-log-cmd. Each log file is limited to 2 MB, and up to 2 rotated copies will be retained.

Shawl differs from existing solutions like WinSW and NSSM in that they require running a special install command to prepare the service, which means, for example, that you have to run a CustomAction if you need to install a service in an MSI. With Shawl, you can configure the service however you want, such as with the normal ServiceInstall in an MSI or by running sc create, because Shawl doesn't have any special setup of its own. The shawl add command is just an optional convenience.

Bear in mind that the default account for new services is the Local System account, which has a different PATH environment variable than your user account. If you configure Shawl to run a command like npm start, that means npm needs to be in the Local System account's PATH, or you could also change the account used by the service instead.

Installation

  • Prebuilt binaries are available on the releases page. It's portable, so you can simply download it and put it anywhere without going through an installer.
  • If you have Rust installed, you can run cargo install shawl.

CLI

$ shawl --help
Wrap arbitrary commands as Windows services

USAGE:
    shawl.exe
    shawl.exe <SUBCOMMAND>

FLAGS:
    -h, --help       Prints help information
    -V, --version    Prints version information

SUBCOMMANDS:
    add     Add a new service
    help    Prints this message or the help of the given subcommand(s)
    run     Run a command as a service; only works when launched by the
            Windows service manager

Development

Please refer to CONTRIBUTING.md.

Dependencies

~2.7–4MB
~67K SLoC