SDK
API reference
Every public export of @userland-run/nano-sdk at a glance. Consult the bundled dist/index.d.ts for exact signatures.
Entry points
Import path
Module
"@userland-run/nano-sdk"
the main SDK
"@userland-run/nano-sdk/worker"
the Web Worker entry point
"@userland-run/nano-sdk/service-worker"
nano-sw.js — the COOP/COEP injector
Core
Export
Kind
Purpose
createNano
fn
boot and return a Nano
Nano
class
the main VM host (code mode + factories)
nanoImage
fn
build an ImageConfig from a baseUrl + flags
Vfs
class
typed filesystem (nano.fs)
Execution & shell
Export
Kind
Purpose
Shell
class
stateful terminal engine
tokenize
fn
quote-aware word split
NodeRuntime
class
snapshot-based Node fast path
Scripting · Serve · Worker · Catalog
Export
Kind
Purpose
ScriptEngine / ScriptError
interface / class
sandboxed Boa engine + its error type
ServeBridge / startServer
class / fn
HTTP serve bridge + lifecycle helper
parseHttpResponse
fn
HTTP/1.1 response parser
NanoWorkerClient / createNanoWorker
class / fn
Web Worker transport
Catalog / CdnClient / installApp
class / class / fn
signed app catalog
Types
NanoConfig, ImageConfig, ScriptingConfig, ExecOptions, ExecResult, ShellOptions, ShellResult, ExposeConfig, ScriptEngineOptions, InstallOptions, Manifest and DirEntry are all exported and fully typed.
This mirrors the dist/index.d.ts surface — the .d.ts is authoritative for exact signatures.