TypeScript Quickstart

pnpm add @struktoai/mirage-node
pnpm add -D tsx typescript

import { MountMode, RAMVFS, Workspace } from '@struktoai/mirage-node'

async function main(): Promise<void> {
  const ws = new Workspace({ '/data': new RAMVFS() }, { mode: MountMode.WRITE })

  await ws.shell('echo "hello mirage" | tee /data/hello.txt')
  const result = await ws.shell('cat /data/hello.txt')
  process.stdout.write(result.stdoutText)

  await ws.close()
}

main()

pnpm tsx quickstart.ts

import { MountMode, RAMVFS, Workspace } from '@struktoai/mirage-node'

async function main(): Promise<void> {
  const ws = new Workspace({ '/data': new RAMVFS() }, { mode: MountMode.WRITE })

  await ws.shell(`echo '{"name": "alice"}' | tee /data/user.json`)

  const files = await ws.shell('ls /data/')
  process.stdout.write(files.stdoutText)

  const name = await ws.shell('jq ".name" /data/user.json')
  process.stdout.write(name.stdoutText)

  const match = await ws.shell('grep alice /data/user.json')
  process.stdout.write(match.stdoutText)

  await ws.close()
}

main()

import { Limit, MountMode, OnExceed, RAMVFS, Workspace } from '@struktoai/mirage-node'

const ws = new Workspace(
  {
    '/data': [
      new RAMVFS(),
      MountMode.WRITE,
      { grep: new Limit({ maxLines: 50, onExceed: OnExceed.ERROR }) },
    ],
  },
  {
    mode: MountMode.WRITE,
    commandLimits: { head: new Limit({ maxLines: 500, timeoutSeconds: 30 }) },
    profiles: { researcher: { commandLimits: { head: new Limit({ maxLines: 5000 }) } } },
  },
)
ws.createSession('research', { profile: 'researcher' })