Installation

npm install -g @runeya/runeya
runeya

Runeya requires Node.js 22 or later. When you run runeya from a terminal, it opens the installer page in your browser. It installs Runeya globally if it is not yet (as with npx), then creates a shortcut in your desktop menu. If npm's global folder needs administrator rights (Node installed by the system on Linux, official installer on macOS), Runeya installs into ~/.runeya/npm, without sudo. The shortcut and the in-app update then use that folder. From then on, Runeya starts from that shortcut. It starts the server and the agent, then opens the UI in the browser.

Data directory

Each local project has its own .runeya/ folder, inside the project folder: services, environments and project settings. The machine's list of projects is kept separately, in ~/.runeya/.

Runeya puts a .gitignore in each .runeya/ that excludes the encryption key and private data. The rest can be committed with the project.

To back up a project's environments, back up its .runeya/. On another machine, this folder is not enough to read the secrets back: the master password is combined with a secret held in the system keyring. If the keyring is not available, this secret is stored in the data folder, and this protection no longer applies. See Master password.

Deleting .runeya/ resets the project in Runeya without touching its code.

Update and uninstall

npm update -g @runeya/runeya
npm uninstall -g @runeya/runeya

If Runeya was installed into ~/.runeya/npm, add --prefix ~/.runeya/npm to both commands, or update from the app.

Uninstalling does not delete the .runeya/ folders.