Nylorun
Build AI agents. Run them on a durable, self-hosted Runtime.
Docs ·
Quickstart ·
API reference ·
Examples
[!WARNING]
Beta. APIs, protocols and on-disk formats change before 1.0. Upgrade every
Nylorun package together, and read
Compatibility before you skip a
release.
Quickstart
npx nylorun up
This starts a Runtime and Studio on your machine and prints their URLs. Check
it with npx nylorun status; stop it with npx nylorun down (volumes stay).
Requires Node.js 24, Docker Compose v2, and a model key if you call a provider.
On Windows, use WSL2 and keep the project on the Linux filesystem.
Next:
- Studio: chat with agents and inspect sessions.
- Agents SDK: define an agent and give it tools.
How it works
Nylorun is an open-source runtime for AI agents.
- Agents are declarative. Write one as a folder of Markdown and JSON
(
npx nylorun init agents/hello: its instructions,
tools,
MCP servers, skills and triggers,
or a flow of agents), or define it in TypeScript with the
Agents SDK and compose in one line:
.pipe(researcher, analyst). Save it with npx nylorun apply and start a
session with the Runtime (the CLI).
- The Runtime is a Docker Compose stack:
runtime, gateway, harness,
studio, postgres, restate, s2-lite and rustfs. Start it with
npx nylorun up; use it from Studio, the CLI, the SDKs or HTTP.
One installation is one Tenant, with its own database, Studio and data.
See Concepts for the vocabulary.
Documentation
The guides live at docs.nylorun.com.
Using a coding agent? Point it at llms.txt;
every page is also available as Markdown by appending .md to its URL.
Packages
| Package | Folder | Role |
|---|
@nylorun/agents | sdks/agents | Agents SDK: define agents, save them, open sessions; AG-UI and A2A handlers |
@nylorun/admin | sdks/admin | Admin SDK for the Management API: models, credential coverage, MCP previews, signing keys, application keys |
nylorun | cli/nylorun | Runs the local Runtime (up, down, status, studio), and writes, checks and saves agent folders and manages a Tenant (init, check, apply, agents, sessions, tenant, local) |
@nylorun/cli | cli/legacy | nylorun under another name: npx @nylorun/cli <command> runs npx nylorun <command> |
@nylorun/create-agent | cli/create-agent | : project scaffolding and compatibility pins |
Self-hosting
Everything here runs without a Nylorun account. The Runtime verifies and
enforces; it never signs people in. Your identity provider and secret store
plug in.
Contributing
Requires Node 24 and npm 11.
git clone https://github.com/nylorun/agents.git
cd agents
npm run setup # install both lockfiles and build the packages
npm run dev # build the Runtime and Studio images, run the examples' Tenant
npm run dev rebuilds packages and images as you edit. The Tenant keeps running
after you stop it, so sessions survive a source change; npx nylorun down
stops it. Read CONTRIBUTING.md for checks and workflow and
RELEASING.md for publishing. The domain vocabulary is in
runtime/server/src/CONTEXT.md.
Community
License
Apache-2.0
