ruimte 0.26.0 → 0.27.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +15 -12
  2. package/package.json +4 -4
package/README.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # ruimte
2
2
 
3
- Ruimte for a computer without the app. It runs the machine your terminals, agents and browsers live on, and you reach it from the Ruimte app on another computer or from [station.ruimte.app](https://station.ruimte.app).
3
+ Ruimte for a computer without the app. It runs the machine your terminals, agents and browsers live on. You reach it from the Ruimte app on another computer or from [station.ruimte.app](https://station.ruimte.app).
4
4
 
5
5
  ```sh
6
6
  npx ruimte # start the machine on 127.0.0.1:4210
@@ -15,39 +15,42 @@ npx ruimte closed-lid remove
15
15
  npx ruimte --version
16
16
  ```
17
17
 
18
- `bunx ruimte` works the same way. Node is enough; Bun does not have to be installed.
19
-
20
- It runs on Macs with Apple silicon and on Linux, on x64 and arm64. Windows is not supported yet.
18
+ `bunx ruimte` works too. Node is enough. It runs on Apple silicon Macs and on Linux (x64 and arm64), not on Windows yet.
21
19
 
22
20
  ## Reaching it
23
21
 
24
- `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 tailnet, the app connects to it directly through the door the machine keeps open on port 4220 (its own port plus 10; `--lan-port` moves it and `--no-lan` closes it). From anywhere else it connects through the broker. `npx ruimte status` says which of those are open.
22
+ After `npx ruimte login`, the Ruimte app on any device signed in to your account lists the machine. On the same network or tailnet the app connects through the machine's door on port 4220 (its own port plus 10). `--lan-port` moves it and `--no-lan` closes it. From anywhere else the app goes through the broker. `npx ruimte status` says which routes are open.
25
23
 
26
24
  ## The background service
27
25
 
28
- `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`.
26
+ `ruimte service install` copies the binary to `~/.ruimte/bin` and runs that copy, never the one in the npx cache.
27
+
28
+ - macOS: a LaunchAgent at `~/Library/LaunchAgents/app.ruimte.daemon.plist`, logs in `~/Library/Logs/Ruimte/daemon.log`
29
+ - Linux: a systemd user unit at `~/.config/systemd/user/ruimte-daemon.service`, logs in `journalctl --user -u ruimte-daemon`
30
+
31
+ Flags after `install` are the flags the service runs with, such as `npx ruimte service install --no-lan`.
29
32
 
30
- 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:
33
+ On Linux, systemd stops your services when you log out. To keep the machine running, enable lingering yourself (the command never does it for you):
31
34
 
32
35
  ```sh
33
36
  loginctl enable-linger "$USER"
34
37
  ```
35
38
 
36
- Running `npx ruimte@latest service install` again installs the newer binary. A running machine switches to it as soon as no agent or shell is busy on it.
39
+ Run `npx ruimte@latest service install` again to update. A running machine switches to the new binary once no agent or shell is busy.
37
40
 
38
- `RUIMTE_HOME` (default `~/.ruimte`) is where the machine keeps its identity, the devices it let in and its projects.
41
+ `RUIMTE_HOME` (default `~/.ruimte`) holds the machine's identity, the devices it let in and its projects.
39
42
 
40
43
  ## Awake with the lid closed
41
44
 
42
- 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 you install one rule, once:
45
+ A closed Mac lid sleeps the machine even while keep awake holds, unless an external display and power are connected. Only root can change that, so you install one rule, once:
43
46
 
44
47
  ```sh
45
48
  npx ruimte closed-lid install
46
49
  ```
47
50
 
48
- 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 `/usr/bin/pmset -a disablesleep 1` and `/usr/bin/pmset -a disablesleep 0` without a password, and 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.
51
+ It prints the rule before sudo asks for your password. The rule goes in `/etc/sudoers.d/ruimte-closed-lid-<uid>` and allows only `/usr/bin/pmset -a disablesleep 1` and `/usr/bin/pmset -a disablesleep 0` without a password. Then turn on "Also with the lid closed" under keep awake, on your phone or in the app on the Mac.
49
52
 
50
- 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.
53
+ Sleep stays off only while keep awake holds: on power, or on battery at 20% or more when keep awake may hold there. It comes back when keep awake lets go, when the machine stops, and through a watchdog when the machine is killed. `npx ruimte closed-lid remove` turns sleep back on and removes the rule. Removing Ruimte leaves the rule in place, so remove it first.
51
54
 
52
55
  ## License
53
56
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "ruimte",
3
- "version": "0.26.0",
3
+ "version": "0.27.0",
4
4
  "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.",
5
5
  "license": "FSL-1.1-MIT",
6
6
  "author": "Bas Milius",
@@ -21,8 +21,8 @@
21
21
  "node": ">=18"
22
22
  },
23
23
  "optionalDependencies": {
24
- "@ruimte/darwin-arm64": "0.26.0",
25
- "@ruimte/linux-x64": "0.26.0",
26
- "@ruimte/linux-arm64": "0.26.0"
24
+ "@ruimte/darwin-arm64": "0.27.0",
25
+ "@ruimte/linux-x64": "0.27.0",
26
+ "@ruimte/linux-arm64": "0.27.0"
27
27
  }
28
28
  }