Skip to content

Installation

sh
npm install -g @runeya/apps-cli
runeya

From source

sh
git clone https://github.com/runeya/runeya.git
cd runeya
yarn install
yarn build
yarn dev

The interface is available at http://localhost:5173 in development mode.

System environment variables

VariableDefaultDescription
RUNEYA_HTTP_PORT9545Local server port (takes priority over PORT)
PORT9545Server port (legacy — use RUNEYA_HTTP_PORT instead)
DATA_DIR./.runeyaProject data directory
RUNEYA_AGENT_PORT9546Local agent port (default: RUNEYA_HTTP_PORT + 1)

Example:

sh
RUNEYA_HTTP_PORT=8080 runeya

Data directory

Runeya creates ./.runeya/ in the current folder (or the path defined by DATA_DIR) with the following structure:

.runeya/
├── projects.json       # Projects
├── services.json       # Services and their configs
├── agents.json         # Registered agents (encrypted passphrases)
├── environments.json   # Global environments
├── settings.json       # Global settings + log parsers
├── schema-version.json # Data schema version
└── .encryption.key     # AES-256 key (600 perms, never committed)

WARNING

Never commit the .encryption.key file. It is used to encrypt your service secrets.

Updating

sh
npm update -g @runeya/apps-cli

Uninstalling

sh
npm uninstall -g @runeya/apps-cli
rm -rf .runeya   # removes current project data

Released under the MIT License.