API Reference

Every public symbol re-exported from @fishnet/core and @fishnet/runtime, grouped by @category. Each entry shows its package of origin — the apropos / man -k section marker is always rendered.

Looking for a specific symbol? Use the search bar, or jump directly to a category below.

Composition

Builders, presets, and factories that assemble a Unix system from parts.

• bcCalc — @fishnet/core
• cliExtension — @fishnet/runtime
• containerManagement — @fishnet/runtime
• coreutils — @fishnet/core
• cronService — @fishnet/core
• curl — @fishnet/core
• diffutils — @fishnet/core
• findutils — @fishnet/core
• gawk — @fishnet/core
• grep — @fishnet/core
• jq — @fishnet/core
• jsRepl — @fishnet/core
• mergeExtensions — @fishnet/core
• nsTools — @fishnet/core
• pkgManager — @fishnet/core
• procps — @fishnet/core
• RuntimeAwareBuilder — @fishnet/runtime
• sed — @fishnet/core
• shell — @fishnet/core
• stdSystem — @fishnet/core
• Unix — @fishnet/runtime
• UnixBuilderImpl — @fishnet/core
• UnixImageImpl — @fishnet/core
• utilLinux — @fishnet/core
• Unix — @fishnet/core Deprecated

Runtime

Platform runtimes (Node.js, browser, test) and container runtime surfaces.

• AssetResolver — @fishnet/core
• autoTty — @fishnet/runtime
• BindSpec — @fishnet/runtime
• BootContext — @fishnet/core
• bootFromImage — @fishnet/runtime
• BootOpts — @fishnet/core
• BootRuntime — @fishnet/core
• browserRuntime — @fishnet/runtime
• BrowserRuntimeConfig — @fishnet/runtime
• buildNamespace — @fishnet/runtime
• chainResolvers — @fishnet/runtime
• Channel — @fishnet/runtime
• completeAsyncifyRewind — @fishnet/runtime
• Container — @fishnet/runtime
• ContainerDeviceOpts — @fishnet/runtime
• ContainerImpl — @fishnet/runtime
• ContainerManager — @fishnet/runtime
• ContainerManagerImpl — @fishnet/runtime
• ContainerRegistry — @fishnet/runtime
• ContainerRuntime — @fishnet/runtime
• ContainerRuntimeImpl — @fishnet/runtime
• ContainerShorthand — @fishnet/runtime
• ContainerSpec — @fishnet/runtime
• ContainerState — @fishnet/runtime
• createBrowserCapabilities — @fishnet/runtime
• createBufferedOutput — @fishnet/runtime
• createContainerKernel — @fishnet/runtime
• createContainerManager — @fishnet/runtime
• createContainerRuntime — @fishnet/runtime
• createInputQueue — @fishnet/runtime
• createMemoryChannel — @fishnet/runtime
• createNodeCapabilities — @fishnet/runtime
• CreateOpts — @fishnet/runtime
• createRuntime — @fishnet/runtime
• createTestCapabilities — @fishnet/runtime
• createWasiBin — @fishnet/runtime
• createWasmBin — @fishnet/runtime
• derivePreloadPaths — @fishnet/runtime
• detectRuntime — @fishnet/runtime
• DeviceSpec — @fishnet/runtime
• ExecOpts — @fishnet/runtime
• exportFS — @fishnet/runtime
• ExportHandle — @fishnet/runtime
• FsRequest — @fishnet/runtime
• FsResponse — @fishnet/runtime
• getExitStatusCode — @fishnet/runtime
• getWasmApi — @fishnet/runtime
• gracefulShutdown — @fishnet/runtime
• ImageManifest — @fishnet/runtime
• ImageRef — @fishnet/runtime
• importFS — @fishnet/runtime
• installTTYBridge — @fishnet/runtime
• InterpretedNamespace — @fishnet/runtime
• isExitStatus — @fishnet/runtime
• isWasiExitSentinel — @fishnet/runtime
• mergeSpecs — @fishnet/runtime
• MountPolicy — @fishnet/runtime
• MountSpec — @fishnet/runtime
• NamespaceBuildOpts — @fishnet/runtime
• NamespacePermissions — @fishnet/runtime
• NamespaceSpec — @fishnet/runtime
• nodeRuntime — @fishnet/runtime
• NodeRuntimeConfig — @fishnet/runtime
• nodeTty — @fishnet/runtime
• NodeTtyHandle — @fishnet/runtime
• PlatformCapabilities — @fishnet/runtime
• presetResolver — @fishnet/runtime
• ProcessSpec — @fishnet/runtime
• ResourceLimits — @fishnet/runtime
• RootContainer — @fishnet/runtime
• Runtime — @fishnet/runtime
• RuntimeConfig — @fishnet/runtime
• runWithAsyncify — @fishnet/runtime
• specFromImage — @fishnet/runtime
• testRuntime — @fishnet/runtime
• wasiExec — @fishnet/runtime
• WasiHost — @fishnet/runtime
• WasiMemory — @fishnet/runtime
• wasmExec — @fishnet/runtime

Fileservers

Fileserver factories that mount into the VFS (memoryFS, procFS, etc).

• containerFS — @fishnet/runtime
• createConsFS — @fishnet/core
• devFS — @fishnet/core
• Fileserver — @fishnet/core
• httpFS — @fishnet/core
• memoryFS — @fishnet/core
• procFS — @fishnet/core
• readonlyFS — @fishnet/core
• srvFS — @fishnet/core
• userFS — @fishnet/core

Kernel Contracts

Interfaces and types implemented by the kernel / consumed by bins.

• BinFunction — @fishnet/core
• ChildHandle — @fishnet/core
• Extension — @fishnet/core
• ImageResolver — @fishnet/runtime
• isSrvCapable — @fishnet/core
• isSrvObservable — @fishnet/core
• isSymlinkCapable — @fishnet/core
• isTtyReadable — @fishnet/core
• MergedConfig — @fishnet/core
• NodeType — @fishnet/core
• ProcContext — @fishnet/core
• RestartPolicy — @fishnet/core
• ServiceDef — @fishnet/core
• SpawnOpts — @fishnet/core
• SrvCapable — @fishnet/core
• SrvEvent — @fishnet/core
• SrvObservable — @fishnet/core
• SymlinkCapable — @fishnet/core
• TtyConfig — @fishnet/core
• TtyReadable — @fishnet/core
• UnixBuilder — @fishnet/core
• UnixImage — @fishnet/core
• UnixInstance — @fishnet/core
• UnixConfig — @fishnet/core Deprecated

Utilities

Helpers, parsers, and type guards used across the kernel and bins.

• allocDeviceId — @fishnet/core
• BinHelp — @fishnet/core
• BufferedTTYOutput — @fishnet/runtime
• BuildCache — @fishnet/core
• BuildError — @fishnet/core
• chainAwareId — @fishnet/core
• checkPermission — @fishnet/core
• CliExtensionOpts — @fishnet/runtime
• CompletionProvider — @fishnet/core
• computeBuildCacheKey — @fishnet/core
• computeLayerHash — @fishnet/core
• computeLayerSize — @fishnet/core
• ConsOpts — @fishnet/core
• ConsResult — @fishnet/core
• ConsTerminal — @fishnet/core
• createBuildCache — @fishnet/core
• createLayerFromFs — @fishnet/core
• createLayerStore — @fishnet/core
• DiffEntry — @fishnet/core
• EmscriptenAsyncify — @fishnet/runtime
• EmscriptenFS — @fishnet/runtime
• EmscriptenModule — @fishnet/runtime
• EmscriptenModuleFactory — @fishnet/runtime
• EmscriptenTermios — @fishnet/runtime
• EmscriptenTTY — @fishnet/runtime
• EmscriptenTTYOps — @fishnet/runtime
• FlagDoc — @fishnet/core
• FrozenMemoryFS — @fishnet/core
• HttpFSOpts — @fishnet/core
• InputQueue — @fishnet/runtime
• Layer — @fishnet/core
• LayerStore — @fishnet/core
• parseProcArgv — @fishnet/core
• parseProcStatus — @fishnet/core
• PkgManagerOpts — @fishnet/core
• ProcFSOpts — @fishnet/core
• ProcStatus — @fishnet/core
• renderHelp — @fishnet/core
• SYMLINK_LIMIT — @fishnet/core
• TerminalSize — @fishnet/core
• TTYBridgeOptions — @fishnet/runtime
• TtyMode — @fishnet/core
• WasiExecOptions — @fishnet/runtime
• WasmExecOptions — @fishnet/runtime
• WasmLinearMemory — @fishnet/runtime
• WasmModule — @fishnet/runtime
• WasmTTYInput — @fishnet/runtime
• WasmTTYOutput — @fishnet/runtime
• WasmTerminalSize — @fishnet/runtime Deprecated

Branded Types

Nominally-typed primitives (Pid, Uid, AbsPath, …) and their constructors.

• absPath — @fishnet/core
• ExitCode — @fishnet/core
• fdNumber — @fishnet/core
• Gid — @fishnet/core
• gid — @fishnet/core
• innerPath — @fishnet/core
• Pid — @fishnet/core
• pid — @fishnet/core
• Signal — @fishnet/core
• Uid — @fishnet/core
• uid — @fishnet/core