systemd-ts 0.1.0 → 0.1.1

package/README.md

@@ -2,3 +2,62 @@
 
 `systemd-ts` is a library for declaring, rendering, and managing `systemd`
 services and timers from TypeScript.
+
+## Usage
+
+The example below installs a user-scoped service and timer for a small
+nightly backup job. The service does the work, the timer schedules it, and
+`Systemd` writes both unit files before enabling and starting the timer.
+
+```ts
+import { homedir } from "node:os";
+import { join } from "node:path";
+
+import { Systemd, SystemdService, SystemdTimer } from "systemd-ts";
+
+const userUnitDir = join(homedir(), ".config/systemd/user");
+
+const service = new SystemdService({
+  name: "backup-db",
+  unit: {
+    Description: "Write a nightly database backup",
+  },
+  service: {
+    Type: "oneshot",
+    ExecStart: "/usr/bin/bash -lc '/srv/app/bin/backup-db >> /srv/app/log/backup-db.log 2>&1'",
+  },
+});
+
+const timer = new SystemdTimer({
+  name: "backup-db",
+  unit: {
+    Description: "Run the database backup every night",
+  },
+  timer: {
+    OnCalendar: "03:15",
+    Persistent: true,
+    Unit: service.filename,
+  },
+  install: {
+    WantedBy: "timers.target",
+  },
+});
+
+const systemd = new Systemd({
+  scope: "user",
+  unitDir: userUnitDir,
+  linkUnits: true,
+});
+
+const installed = await systemd.install(service, timer);
+
+console.log(installed.pathFor(service));
+console.log(installed.pathFor(timer));
+
+await systemd.enable(timer);
+await systemd.start(timer);
+```
+
+That will write `backup-db.service` and `backup-db.timer` into the user's unit
+directory, enable the timer under `timers.target`, and ask `systemd --user` to
+start waiting for the first scheduled run.