Quickstart

Get Secure Exec running in a few minutes.

1. Install

   npm

   npm install secure-exec
   
2. Create a kernel

   A kernel manages a virtual filesystem, process table, and permissions. Mount a Node runtime to execute JavaScript.

   import {
     createKernel,
     createInMemoryFileSystem,
     createNodeRuntime,
   } from "secure-exec";
   
   const filesystem = createInMemoryFileSystem();
   const kernel = createKernel({ filesystem });
   await kernel.mount(createNodeRuntime());
   
3. Run code

   Use kernel.exec() to run commands. Use the filesystem to read and write files.

   Simple

   import {
     createKernel,
     createInMemoryFileSystem,
     createNodeRuntime,
   } from "secure-exec";
   
   const kernel = createKernel({
     filesystem: createInMemoryFileSystem(),
   });
   await kernel.mount(createNodeRuntime());
   
   const result = await kernel.exec(
     "node -e \"console.log('hello from secure-exec')\""
   );
   
   console.log(result.stdout); // "hello from secure-exec\n"
   
   await kernel.dispose();
   

Alternative: NodeRuntime

For direct code execution with typed return values, use the NodeRuntime convenience class.

import {
  NodeRuntime,
  createNodeDriver,
  createNodeRuntimeDriverFactory,
} from "secure-exec";

const runtime = new NodeRuntime({
  systemDriver: createNodeDriver(),
  runtimeDriverFactory: createNodeRuntimeDriverFactory(),
});

const result = await runtime.run<{ message: string }>(
  "module.exports = { message: 'hello from secure-exec' };"
);

console.log(result.exports?.message); // "hello from secure-exec"

Next steps

SDK Overview

Full tour of the API surface and core concepts.

Permissions

Control filesystem, network, and process access.

Security Model

Trust boundaries, timing hardening, and resource limits.