Skip to content

Installation

Once the requirements are in place, installation takes a single command or a few manual steps.

One-line install

Terminal window
curl -fsSL --proto '=https' --tlsv1.2 \
https://raw.githubusercontent.com/DerRemo/penates/main/install.sh | bash

The installer checks what is already present, installs what is missing (Homebrew, Node, tmux, jq, the CLIs, moshi-hook), runs setup.sh, and guides you through CLI logins and optional remote access inline. Anything still requiring manual action is printed as a checklist at the end.

To check prerequisites without changing anything:

Terminal window
./install.sh --check

Manual install

Clone the repository, then run setup.sh:

Terminal window
cd ~
git clone https://github.com/DerRemo/penates.git
cd penates
chmod +x setup.sh
./setup.sh

setup.sh does five things in order:

  1. Checks that Node.js and tmux are present (installs tmux via Homebrew if missing).
  2. Runs npm install to pull in server dependencies.
  3. Creates a .env file with a randomly generated AUTH_TOKEN.
  4. Installs a macOS LaunchAgent (or a Linux systemd user unit) so the server starts automatically after a reboot.
  5. Starts the server.

When the script finishes, you see:

✓ Penates läuft!
Lokal: http://localhost:3333

First login

Open a browser on the same machine:

http://localhost:3333

The browser prompts for the token on first visit. After you enter it, it is stored in localStorage and you will not be asked again on that browser.

For access from other devices or over the internet, see Remote access.