Run
Start the persistent Runtime, connect tools, and work with sessions.
From a generated project:
npm run devRuntime listens at http://127.0.0.1:8787. Studio opens on a free port
starting at 4161. Runtime is a persistent process. Stopping dev (or
Ctrl-C in that terminal) leaves Runtime running so sessions survive a source
change. Stop it with nylorun down.
nylorun dev loads agents/index.ts with project-local tsx, ensures Runtime
is up, registers manifests, and connects a scoped executor. Source edits
re-register agents and reconnect the executor; they do not restart the host.
Set --port or PORT to change Runtime's listen port.
This path is the local OSS Runtime (beta). Cloud Runtime is coming soon.
Runtime lifecycle
| Command | Role |
|---|---|
nylorun up | Start Runtime in the background (runtime start). |
nylorun down | Stop Runtime and keep .nylorun/ (runtime stop). |
nylorun runtime status | Print scope, URL, PID, versions, and paths. |
nylorun logs | Tail runtime.log. |
nylorun serve [entry] | Load the compiled registry (default dist/agents/index.js) and connect the executor. |
nylorun configure | Write the host model credential to the vault. Requires a running Runtime. |
nylorun studio | Attach Studio to the active scope. |
dev and serve start Runtime for you when it is missing, then leave it
running. Pass --no-autostart so a missing Runtime fails instead of spawning
one.
nylorun up
nylorun runtime status
nylorun downSetup options
Pass these Creator options after npm's -- separator when the default
Quickstart flow does not fit your environment:
| Option | Use it when |
|---|---|
--no-open | Start Studio without opening a browser. |
--no-studio | Create a headless project without the Studio dependency. |
--yes | Pass --yes to dependency installation; provider prompts still run. |
Creator usage: npm create @nylorun/agent <directory> [--no-studio] [--no-open] [--yes].
If setup is cancelled or fails after files are created, resume with:
cd my-agent
nylorun up
nylorun configure
npm run devA non-interactive start without a stored host credential exits and names that
setup. NYLORUN_DEV_MODEL=fixture skips the provider prompt.
Use repeatable development flags without recreating the project:
npm run dev -- --no-open
npm run dev -- --no-studio
npm run dev -- --no-studio --no-open
npm run dev -- --no-autostartnylorun comes from @nylorun/cli.
The agent registry
import { assistant } from "./assistant/agent.js";
export const agents = [assistant];That matches
create-agent starter agents/index.ts.
Local discovery conveniences (server-authenticated) include GET /v1/agents and
GET /v1/sessions?agentId=.... /health is HTTP liveness; /ready checks
SQLite and scheduler availability, not provider connectivity. The session
protocol is /v1/sessions/... with authenticated executor SSE at
/v1/executors/connect.
See the Runtime reference for startRuntime and the
HTTP table. The generated tree, scripts, and .nylorun/ layout are on
Quickstart.