RuimteDocs

A machine without a screen

On a server or a computer without the app, npx ruimte starts a machine. You open it from the Ruimte app on another computer, the web or your iPhone.

Start a machine

You need Node. It runs on Macs with Apple silicon, Linux (x64 and arm64) and Windows (x64).

npx ruimte

bunx ruimte works too. Install the agent CLIs you want on that computer and log in to them there.

Add it to your account

  1. On the server, run:

    npx ruimte login

    It prints a code, such as BCDF-GHJK, and a fingerprint.

  2. In the desktop app or at station.ruimte.app, open Settings, Account, click Add machine, then Link a machine with a code.

  3. Enter the code and check that the fingerprint matches.

  4. Click Add to account.

The machine shows up under Machines a few seconds later.

On the same network or tailnet, the app connects to the machine on port 4220. From anywhere else it connects through your account. npx ruimte status shows which routes are open.

Keep it running

npx ruimte service install

This runs the machine in the background for your user: a LaunchAgent on macOS, a systemd user service on Linux.

On Linux, systemd stops your services when you log out. Run loginctl enable-linger "$USER" to keep the machine running.

To update, run npx ruimte@latest service install again. The machine switches to the new version once no agent or shell is busy.

Commands

CommandAction
npx ruimteStart the machine
npx ruimte loginAdd the machine to your account with a code
npx ruimte statusShow how your devices reach the machine
npx ruimte logoutTake the machine off its account
npx ruimte service installRun the machine in the background
npx ruimte service statusShow the background service
npx ruimte service uninstallRemove the background service
npx ruimte closed-lid installOn a Mac, let it stay awake with the lid closed
npx ruimte --versionPrint the version
FlagEffect
--no-lanCloses the local network route
--lan-port <port>Moves the local network route to another port