Runeya

Quick Start ​

This page explains how to install Runeya and start a first service.

Start Runeya ​

sh
npm install -g @runeya/runeya
runeya

runeya opens the installer page. Follow it, then start Runeya.

Requirements, updates and uninstalling: see Installation.

Create the master password ​

On first launch, the "Configure Runeya" screen asks for a master password. It protects your secrets on this machine. See Master password.

Create a project ​

  1. On the "Select a project" screen, click Import or create a local project.
  2. Pick your project's folder. Symbolic links to folders are listed, and hidden folders show up when you tick Show hidden folders. If it already holds a Runeya project, it is imported. Otherwise, click Create a project in “…”.
  3. In the "New project" window, enter a name, leave the location on Local, then click Create a project.

Runeya creates a .runeya/ folder in the project folder. That is where the project's configuration is saved when you don't use the cloud. Runeya also writes a .gitignore in it, so you can version this folder with your project. The shareable configuration is committed, and private data (encryption key, conversations, personal overrides, logs) stays on your machine.

The "Select services to launch" screen comes next. The project is empty: click Skip.

Declare a service ​

  1. In the sidebar, click Add service.
  2. Pick the project, name the service (for example api), then click Create Service.
  3. The service's Config tab opens. In General, set the working directory. In Commands, click Add command and type it (for example node src/index.js).

Click Start. The logs appear live in the Terminal tab.

The process runs on an agent. By default this is the agent on your machine, and there is nothing to configure. A service can be moved to another machine later without changing its configuration.

Next ​

Runeya