Skip to main content

Documentation Index

Fetch the complete documentation index at: https://nono.sh/docs/llms.txt

Use this file to discover all available pages before exploring further.

The nono Node.js SDK provides native bindings to the nono sandboxing library, enabling you to apply Landlock (Linux) or Seatbelt (macOS) restrictions from within your JavaScript or TypeScript applications.

​
Key Features

Capability-Based

Define exactly which filesystem paths and network access your application needs

OS-Enforced

Restrictions are enforced by the kernel, not userspace — they cannot be bypassed

Irreversible

Once applied, the sandbox cannot be weakened or removed for the lifetime of the process

Zero Dependencies

Native Rust code compiled to a single .node binary with no runtime dependencies

​
Platform Support

PlatformBackendMinimum Version
LinuxLandlockKernel 5.13+
macOSSeatbeltmacOS 10.5+
Windows—Not supported

​
Installation

npm install nono-ts

​
Quick Example

import { CapabilitySet, AccessMode, apply, isSupported } from 'nono-ts';

// Check platform support
if (!isSupported()) {
  console.error('Sandboxing not supported on this platform');
  process.exit(1);
}

// Build capabilities
const caps = new CapabilitySet();
caps.allowPath('/tmp', AccessMode.ReadWrite);
caps.allowPath('/usr/lib', AccessMode.Read);
caps.allowFile('/etc/resolv.conf', AccessMode.Read);
caps.blockNetwork();

// Apply sandbox (irreversible)
apply(caps);

// Process is now restricted to only the granted capabilities

​
Architecture

The SDK wraps the Rust nono crate using napi-rs, compiling to a native Node.js addon. This provides:
  • Performance: Native Rust code with zero JavaScript overhead for sandbox operations
  • Safety: Memory-safe Rust implementation with proper error handling
  • Compatibility: Works with Node.js 18+ on supported platforms

​
API Overview

Class/FunctionDescription
ExamplesRunnable JavaScript and TypeScript scenarios
DemonstratorEnd-to-end sandboxed file transformer workflow
CapabilitySetBuild a set of filesystem and network capabilities
QueryContextQuery whether operations would be permitted
SandboxStateSerialize and deserialize sandbox state
apply()Apply the sandbox with given capabilities
isSupported()Check if sandboxing is available
supportInfo()Get detailed platform support information