NylorunDocsBeta
BuildRunDeployReferenceMore

Host Runtime

Run the standalone OSS Runtime as its own process.

Generated projects start Runtime through @nylorun/cli. Custom hosts can run the same server or call startRuntime.

nylorun up
nylorun runtime status

nylorun up is runtime start. It writes state under the project .nylorun/ scope (or ~/.nylorun with --global). Default address: http://127.0.0.1:8787.

Programmatic entry:

import { startRuntime } from "@nylorun/runtime/core";

const runtime = await startRuntime({
  sqlitePath: "./nylorun.sqlite",
  serverToken: process.env.NYLORUN_SERVER_KEY!,
  executors: [],
  port: 8787,
});

await runtime.close();

serverToken must be at least 16 characters. Missing server credentials fail startup. executors at startup are process-only: they take precedence for their agentId and are never persisted. A running host learns additional executors through PUT /v1/executors.

Pass useHostModel: true to read the host vault at call time. Omitting model without that flag uses scriptedModel().

@nylorun/runtime/server (what the CLI launches) sets NYLORUN_PROJECT_PROVIDER=1 so the vault is used. Configure binding and storage with HOST, PORT, and NYLORUN_SQLITE_PATH.

One process owns each SQLite database. A local PID lock rejects concurrent owners and recovers only when the recorded process no longer exists. Shared or network filesystems and multiple replicas are unsupported.

The previous in-process host (Runtime, serveAgents, openSession) has been removed. See Runtime reference for options and the HTTP table.

Next step

On this page