# Nylorun Docs

> Build agents with the Nylorun Agents SDK, run them on the open-source Runtime, and deploy them behind your own app server. Append `.md` to any page URL for Markdown.

## Get started

- [Quickstart](https://docs.nylorun.com/docs.md): Start the local Runtime, connect the starter agent, and run it in about five minutes.
- [Studio](https://docs.nylorun.com/docs/studio.md): Chat with your agents, read session history, and follow live events in the local dashboard.
- [Your project](https://docs.nylorun.com/docs/project.md): Understand the generated application, its scripts, and where state lives.

## Build

- [Agent](https://docs.nylorun.com/docs/build.md): Define an agent with instructions and a tool, then add only the capabilities it needs.
- [Instructions](https://docs.nylorun.com/docs/build/instructions.md): Static instruction strings and dynamic patches from before hooks.
- [Tools](https://docs.nylorun.com/docs/build/tools.md): Give the model a typed host-owned function the connected executor can run.
- [Hooks](https://docs.nylorun.com/docs/build/hooks.md): Scoped before and after hooks replace beforeModelCall and afterModelCall.
- [Capabilities](https://docs.nylorun.com/docs/build/capabilities.md): Add instructions, tools, and before/after hooks to an agent.
- [MCP](https://docs.nylorun.com/docs/build/mcp.md): Declare MCP servers the Runtime discovers for a session.
- [Sandbox](https://docs.nylorun.com/docs/build/sandbox.md): Give an agent Runtime-executed computer tools on an isolated machine.
- [Skills](https://docs.nylorun.com/docs/build/skills.md): Load an Agent Skills catalog folder into a capability.
- [Plugins](https://docs.nylorun.com/docs/build/plugins.md): Load an Agent Plugin package as one capability.
- [Subagents](https://docs.nylorun.com/docs/build/subagents.md): Put an agent in another agent's tools so the model can delegate a self-contained task.
- [Loop](https://docs.nylorun.com/docs/build/loop.md): Run, verify, and retry workflow work until a decision returns output.
- [Chain](https://docs.nylorun.com/docs/build/chain.md): Run workflow steps in order and reshape data between them.
- [Switch](https://docs.nylorun.com/docs/build/switch.md): Select one workflow branch from a deterministic routing key.
- [Map](https://docs.nylorun.com/docs/build/map.md): Run one workflow node concurrently for every item in a list.
- [Parallel](https://docs.nylorun.com/docs/build/parallel.md): Run a fixed set of named workflow branches concurrently.
- [Workflows](https://docs.nylorun.com/docs/build/workflows.md): Compose agents, tools, and deterministic functions into durable runnable graphs.
- [Examples](https://docs.nylorun.com/docs/build/examples.md): Start with the generated agent, then explore shipped agent and workflow patterns.

## Run

- [Run](https://docs.nylorun.com/docs/run.md): Call your agents from code and understand what the Runtime does with each session.
- [Models](https://docs.nylorun.com/docs/run/models.md): Select a provider and model for the linked Tenant.
- [Sessions](https://docs.nylorun.com/docs/run/sessions.md): Open durable agent and workflow sessions inside one Tenant.
- [Executors](https://docs.nylorun.com/docs/run/executors.md): Run tools, hooks, and workflow functions in your Project process.
- [Events](https://docs.nylorun.com/docs/run/events.md): Read canonical session history and observe live SSE with an event cursor.
- [Control](https://docs.nylorun.com/docs/run/control.md): Cancel a turn cooperatively and understand what waits can and cannot do today.
- [Vault](https://docs.nylorun.com/docs/run/vault.md): Store model and end-user credentials inside an isolated Tenant.

## Deploy

- [Deploy](https://docs.nylorun.com/docs/deploy.md): Deploy two things, your app server and the Runtime, and pick where the Runtime runs.
- [App server](https://docs.nylorun.com/docs/deploy/app-server.md): Build and configure your app, connect its executor, and serve agents to signed-in users.
- [Docker](https://docs.nylorun.com/docs/deploy/docker.md): Run the Runtime on one machine with Docker, keep its data safe, and connect your app server.
- [Kubernetes](https://docs.nylorun.com/docs/deploy/kubernetes.md): Self-hosting the Runtime on Kubernetes is not available in this release.
- [Nylorun Cloud](https://docs.nylorun.com/docs/deploy/cloud.md): The hosted Runtime is not available yet. Early access is reviewed manually.

## Reference

- [Reference](https://docs.nylorun.com/docs/reference.md): Exact signatures for the Agents SDK, CLI, Runtime API, and Admin SDK.
- [Agents SDK](https://docs.nylorun.com/docs/reference/agents.md): The @nylorun/agents package, organized by import path.
- [define](https://docs.nylorun.com/docs/reference/agents/define.md): Agent, tool, capability, helper, and workflow definitions from @nylorun/agents/define.
- [client](https://docs.nylorun.com/docs/reference/agents/client.md): createClient, AgentsClient, as(), and SessionClient from @nylorun/agents/client.
- [executor](https://docs.nylorun.com/docs/reference/agents/executor.md): connectAgents registers agents and runs their tools from @nylorun/agents/executor.
- [ag-ui](https://docs.nylorun.com/docs/reference/agents/ag-ui.md): Serve agents to AG-UI clients from your own server with @nylorun/agents/ag-ui.
- [CLI](https://docs.nylorun.com/docs/reference/cli.md): The nylorun stack manager, the nylo Runtime client, and the project creator.
- [nylorun](https://docs.nylorun.com/docs/reference/cli/nylorun.md): Start, stop, inspect, and reset the local Runtime stack.
- [nylo](https://docs.nylorun.com/docs/reference/cli/nylo.md): Create and select Tenants, configure models, and print connection settings.
- [Runtime API](https://docs.nylorun.com/docs/reference/runtime-api.md): The Runtime's HTTP routes, protocol headers, and readiness checks.
- [Admin](https://docs.nylorun.com/docs/reference/admin.md): Operate Runtime Hosts and Tenants with @nylorun/admin.
- [Events](https://docs.nylorun.com/docs/reference/events.md): Canonical LiveEvent types emitted by OSS Runtime.
- [Errors and contracts](https://docs.nylorun.com/docs/reference/errors.md): Shared JSON contracts, manifests, diagnostics, and machine-readable errors.
- [Environment](https://docs.nylorun.com/docs/reference/environment.md): Runtime connection, stack, container, model, and sandbox variables.
- [Harness](https://docs.nylorun.com/docs/reference/harness.md): In-process run(), durable checkpoints, and model adapters.
- [Glossary](https://docs.nylorun.com/docs/reference/glossary.md): Every Nylorun term in one place.

## More

- [Troubleshooting](https://docs.nylorun.com/docs/troubleshooting.md): Recover from local stack, Project link, Tenant, model, executor, and Studio failures.
- [Compatibility](https://docs.nylorun.com/docs/compatibility.md): The tested package and image set, how to upgrade, and what broke between releases.
- [Use with AI agents](https://docs.nylorun.com/docs/ai-agents.md): Connect Codex, Claude Code, Gemini CLI, and other MCP clients to Nylorun's public documentation.

## Optional

- [Full documentation](https://docs.nylorun.com/llms-full.txt): Every page in one Markdown file.
- [Docs MCP server](https://docs.nylorun.com/mcp): Read-only MCP endpoint with list_pages, get_page, and search.
- [Runtime API](https://docs.nylorun.com/docs/reference/runtime-api.md): The Runtime's HTTP routes and headers.