Skip to content

Quick Start

Runeya launches in seconds. This guide takes you from zero to a first supervised service.

Prerequisites

  • Node.js 22 or higher
  • npm / yarn / pnpm

Installation

sh
npm install -g @runeya/apps-cli
sh
yarn global add @runeya/apps-cli
sh
pnpm add -g @runeya/apps-cli

Launch

sh
runeya

Runeya starts on port 9545 by default and opens the interface in your browser.

✓ Server started on http://localhost:9545
✓ Agent started on http://localhost:9546
✓ UI available at http://localhost:9545

First-time Setup

On first launch, the setup assistant appears:

  1. Choose Local Simple (no-auth mode, localhost only)
  2. Runeya automatically creates the data directory ./.runeya/ in the current folder

Adding Your First Service

  1. Click "+ New Project" in the sidebar
  2. Give the project a name (e.g. my-app)
  3. Click "+ New Service"
  4. Fill in:
    • Name: api
    • Command: node src/index.js
    • Working directory: path to your project
  5. Click Save

Starting the Service

Click the ▶ Start button next to the service. Logs appear in real-time in the bottom panel.

Next Steps

Released under the MIT License.