homepage: https://git.rootprojects.org/root/serviceman
tagline: |
Serviceman: cross-platform service management for Linux, Mac, and Windows.
-description: |
- Serviceman is a hassle-free wrapper around your system launcher. It works with the default system launcher to make it easy to start _user_- and _system_-level services, such as webservers, backup scripts, network and system tools, etc.
-
- Supports
- - `launchctl` (macOS)
- - `systemctl` (Linux)
- - The Registry (Windows)
---
+To update or switch versions, run `webi serviceman@stable`
+
+## Cheat Sheet
+
+> Serviceman is a hassle-free wrapper around your system launcher. It works with
+> the default system launcher to make it easy to start _user_- and
+> _system_-level services, such as webservers, backup scripts, network and
+> system tools, etc.
+
+Supports
+
+- `launchctl` (macOS)
+- `systemctl` (Linux)
+- The Registry (Windows)
+
Serviceman can run an app in just about any programming language very simply.
If you'd like to learn what `serviceman` does without actually making changes,
add the `--dryrun` option.
-### Node.js
+### Example: Bash
+
+```bash
+sudo env PATH="$PATH" serviceman add bash ./backup.sh /mnt/data
+```
+
+### Example: Node.js
**Development Server**
pushd ./my-node-app/
sudo env PATH="$PATH" \
- serviceman add --system --cap-net-bind npx nodemon
+ serviceman add --system --cap-net-bind \
+ npx nodemon ./server.js
```
**Production Server**
pushd ./my-node-app/
sudo env PATH="$PATH" \
- serviceman add --system --cap-net-bind npm start
+ serviceman add --system --cap-net-bind \
+ npm start
```
-### Golang
+### Example: Golang
```bash
pushd ./my-go-package/
./my-service --port 80
```
-### And even bash!
+### How to see all services
```bash
-sudo env PATH="$PATH" serviceman add bash ./backup.sh /mnt/data
+serviceman list --system
+serviceman list --user
+```
+
+```txt
+serviceman-managed services:
+
+ example-service
+```
+
+### How to restart a service
+
+You can either `add` the service again (which will update any changed options),
+or you can `stop` and then `start` any service by its name:
+
+```bash
+sudo env PATH="$PATH" serviceman stop example-service
+sudo env PATH="$PATH" serviceman start example-service
```
## What a typical systemd .service file looks like