Skip to content
Loopstack
Color theme

Sandbox Examples

Docker sandbox workflow example for the Loopstack automation framework.

Shows how a workflow runs file operations in an isolated Docker container with @loopstack/sandbox-tool (container lifecycle) and @loopstack/sandbox-filesystem (file operations inside the container). Reach for this pattern when a workflow needs to execute or inspect untrusted code without touching the host.

Terminal window
npx giget@latest gh:loopstack-ai/loopstack/registry/examples/sandbox-examples src/sandbox-examples
npm install @loopstack/sandbox-tool @loopstack/sandbox-filesystem

Register the module:

import { Module } from '@nestjs/common';
import { LoopstackModule } from '@loopstack/loopstack-module';
import { SandboxExamplesModule } from './sandbox-examples/sandbox-examples.module';


@Module({
  imports: [LoopstackModule.forRoot(), SandboxExamplesModule],
})
export class AppModule {}

Install as a Dependency

Terminal window
npm install @loopstack/sandbox-examples
import { SandboxExamplesModule } from '@loopstack/sandbox-examples';

Environment

The workflow needs a Docker daemon reachable from the app (the default socket, /var/run/docker.sock). The app boots without one; the run fails at the first sandbox call if Docker isn’t available. The node:18 image is pulled on first use. No secrets are required.

Examples

Example Studio title Description
Sandbox Sandbox - Filesystem Example Full Docker sandbox lifecycle — init, file ops, destroy

Sandbox

Walks the complete Docker sandbox lifecycle: sandboxInit → directory + file operations (sandboxCreateDirectory, sandboxWriteFile, sandboxReadFile, sandboxListDirectory, sandboxExists, sandboxFileInfo, sandboxDelete) → sandboxDestroy. Each step posts a message with the tool’s result.

Run it from Studio (Sandbox Examples → Sandbox - Filesystem Example) or the CLI:

Terminal window
loopstack run sandbox_example --arg outputDir=/tmp/sandbox-out

outputDir is the host directory mounted into the container (defaults to ./out).

Files

  • sandbox-example.workflow.ts — workflow class

About

Author: Jakob Klippel

License: MIT