Skip to content
Loopstack
Color theme

Local File Explorer Examples

Local file explorer workflow example for the Loopstack automation framework.

Shows how a workflow reads the local disk with FileSystemService from @loopstack/local-file-explorer. The same module also lights up the Studio file panel and exposes a REST API for it. Reach for this when a workflow needs to inspect files on the machine the app runs on.

Use in Your App

Copy this directory into your app, then install what it imports:

Terminal window
npm install @loopstack/common @loopstack/local-file-explorer

Register the module:

import { Module } from '@nestjs/common';
import { LoopstackModule } from '@loopstack/loopstack-module';
import { LocalFileExplorerExamplesModule } from './local-file-explorer/local-file-explorer-examples.module';


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

Environment

None — the workflow reads the local disk. No Docker, remote agent or secrets are required.

Examples

Example Studio title Description
Local File Explorer Local File Explorer - File Tree Example Build a workspace file tree with FileSystemService

Local File Explorer

Calls FileSystemService.buildFileTree() on the app’s working directory and renders the top-level entries (up to 50) as a markdown document.

Run it from Studio (Local File Explorer Examples → Local File Explorer - File Tree Example) or the CLI:

Terminal window
loopstack run local_file_explorer_example

Files

  • local-file-explorer-example.workflow.ts — workflow class

About

Author: Jakob Klippel

License: MIT