ruimte 0.13.0 → 0.14.0

package/README.md

@@ -4,12 +4,14 @@ Ruimte for a machine without the app. It runs the machine that terminals, agents
 
 ```sh
 npx ruimte                      # start the machine on 127.0.0.1:4210
-npx ruimte pair                 # print a pairing link for the app on another computer
 npx ruimte login                # add this machine to your Ruimte account with a code
+npx ruimte status               # how the app on other devices reaches this machine
 npx ruimte logout               # take this machine off its account
 npx ruimte service install      # keep it running in the background for this user
 npx ruimte service status
 npx ruimte service uninstall
+npx ruimte closed-lid install   # on a Mac: let keep awake hold with the lid closed
+npx ruimte closed-lid remove
 npx ruimte --version
 ```
 
@@ -17,9 +19,13 @@ npx ruimte --version
 
 It runs on macOS and Linux, on arm64 and x64. Windows is not supported yet.
 
+## Reaching it
+
+`npx ruimte login` puts the machine on your Ruimte account; the Ruimte app on any device signed in to that account then lists it. On the same network, or the same tailnet, the app connects to it directly through the door the machine keeps open on port 4220 (the daemon's port plus 10, `--lan-port` to move it, `--no-lan` to close it). From anywhere else it connects through the broker. `npx ruimte status` says which of those are open.
+
 ## The background service
 
-`ruimte service install` copies the binary to `~/.ruimte/bin` and runs that copy, never the one in the npx cache. On macOS it is a LaunchAgent (`~/Library/LaunchAgents/app.ruimte.daemon.plist`, logs in `~/Library/Logs/Ruimte/daemon.log`); on Linux a systemd user unit (`~/.config/systemd/user/ruimte-daemon.service`, logs in `journalctl --user -u ruimte-daemon`). Flags after `install` are the flags the service runs with, such as `npx ruimte service install --host 0.0.0.0`.
+`ruimte service install` copies the binary to `~/.ruimte/bin` and runs that copy, never the one in the npx cache. On macOS it is a LaunchAgent (`~/Library/LaunchAgents/app.ruimte.daemon.plist`, logs in `~/Library/Logs/Ruimte/daemon.log`); on Linux a systemd user unit (`~/.config/systemd/user/ruimte-daemon.service`, logs in `journalctl --user -u ruimte-daemon`). Flags after `install` are the flags the service runs with, such as `npx ruimte service install --no-lan`.
 
 On Linux, systemd stops a user's services when that user logs out. To keep the machine running while nobody is logged in, allow lingering yourself; the command never does it for you:
 
@@ -29,7 +35,19 @@ loginctl enable-linger "$USER"
 
 Running `npx ruimte@latest service install` again installs the newer binary. A daemon that is running switches to it as soon as no agent or shell is busy on it.
 
-`RUIMTE_HOME` (default `~/.ruimte`) is where the machine keeps its identity, pairings and projects.
+`RUIMTE_HOME` (default `~/.ruimte`) is where the machine keeps its identity, the devices it let in and its projects.
+
+## Awake with the lid closed
+
+Keep awake keeps a Mac from sleeping while agents work, but a closed lid still sleeps it unless an external display and the power adapter are connected. Only root can turn that off, so a person installs one rule, once:
+
+```sh
+npx ruimte closed-lid install
+```
+
+It prints the rule before sudo asks for your password. The rule goes in `/etc/sudoers.d/ruimte-closed-lid-<uid>` and lets you run exactly `/usr/bin/pmset -a disablesleep 1` and `/usr/bin/pmset -a disablesleep 0` without a password, nothing else. Then turn on "Also with the lid closed" under keep awake, from Ruimte on your phone or in the app on the Mac.
+
+Sleep stays off only while keep awake holds: on the power adapter, or on battery when keep awake may hold there and the battery is at 20% or more. It comes back on when keep awake lets go, when the machine stops, and through a small watchdog when the machine is killed. `npx ruimte status` says whether keep awake and the closed lid hold right now. `npx ruimte closed-lid remove` turns sleep back on and removes the rule. Removing Ruimte leaves the rule in place, so remove it first.
 
 ## License
 

package/bin/ruimte.js

@@ -15,8 +15,12 @@ var TARGETS = [
   { os: "linux", cpu: "x64" },
   { os: "linux", cpu: "arm64" }
 ];
-var targetId = (target) => `${target.os}-${target.cpu}`;
-var packageNameOf = (target) => `@ruimte/${targetId(target)}`;
+function targetId(target) {
+  return `${target.os}-${target.cpu}`;
+}
+function packageNameOf(target) {
+  return `@ruimte/${targetId(target)}`;
+}
 
 // packages/npm/src/launcher.ts
 class LauncherError extends Error {
@@ -24,7 +28,7 @@ class LauncherError extends Error {
 var WINDOWS_REFUSAL = "Ruimte does not run on Windows yet. It runs on Macs with Apple silicon and on Linux, on arm64 and x64.";
 var INTEL_NODE_REFUSAL = "This Node is built for Intel Macs, and Ruimte runs on Macs with Apple silicon only. On a Mac with Apple silicon this Node runs under Rosetta: install the arm64 build of Node and run Ruimte with that.";
 var MUSL_REFUSAL = "Ruimte runs on Linux with glibc, and this system uses musl (as Alpine does), so npm left its binary out. Run it on a distribution with glibc, such as Debian or Ubuntu, or in a container of one.";
-var platformPackageOf = (host) => {
+function platformPackageOf(host) {
   if (host.platform === "win32") {
     throw new LauncherError(WINDOWS_REFUSAL);
   }
@@ -36,8 +40,8 @@ var platformPackageOf = (host) => {
     throw new LauncherError(`Ruimte has no build for ${host.platform} on ${host.arch}. It runs on Macs with Apple silicon and on Linux, on arm64 and x64.`);
   }
   return packageNameOf(target);
-};
-var binaryPathOf = (host, resolve, libc = () => null) => {
+}
+function binaryPathOf(host, resolve, libc = () => null) {
   const name = platformPackageOf(host);
   let manifest;
   try {
@@ -49,23 +53,23 @@ var binaryPathOf = (host, resolve, libc = () => null) => {
     throw new LauncherError(`The package ${name} is missing. It holds the Ruimte binary for this machine and npm installs it as an optional dependency, ` + "so an install with --omit=optional or --no-optional leaves it out. Install ruimte again without that flag.");
   }
   return join(dirname(manifest), "bin", "ruimte");
-};
-var exitCodeOf = (code, signalNumber) => {
+}
+function exitCodeOf(code, signalNumber) {
   if (code !== null) {
     return code;
   }
   return signalNumber === null ? 1 : 128 + signalNumber;
-};
+}
 
 // packages/npm/src/bin.ts
 var require2 = createRequire(import.meta.url);
-var libc = () => {
+function libc() {
   if (process.platform !== "linux") {
     return null;
   }
   const report = process.report?.getReport();
   return report?.header?.glibcVersionRuntime ? "glibc" : "musl";
-};
+}
 var binary;
 try {
   binary = binaryPathOf({ platform: process.platform, arch: process.arch }, (request) => require2.resolve(request), libc);
@@ -89,7 +93,7 @@ if (typeof execve === "function") {
 }
 var child = spawn(binary, args, { stdio: "inherit" });
 var FORWARDED = ["SIGTERM", "SIGHUP", "SIGQUIT"];
-var ignoreInterrupt = () => {};
+function ignoreInterrupt() {}
 process.on("SIGINT", ignoreInterrupt);
 var forwarders = FORWARDED.map((signal) => {
   const forward = () => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ruimte",
-  "version": "0.13.0",
+  "version": "0.14.0",
   "description": "Ruimte for a machine without the app: the machine that terminals, agents and browsers run on, reachable from the Ruimte app and station.ruimte.app.",
   "license": "FSL-1.1-MIT",
   "author": "Bas Milius",
@@ -21,8 +21,8 @@
     "node": ">=18"
   },
   "optionalDependencies": {
-    "@ruimte/darwin-arm64": "0.13.0",
-    "@ruimte/linux-x64": "0.13.0",
-    "@ruimte/linux-arm64": "0.13.0"
+    "@ruimte/darwin-arm64": "0.14.0",
+    "@ruimte/linux-x64": "0.14.0",
+    "@ruimte/linux-arm64": "0.14.0"
   }
 }