Working with Files

import { Sandbox } from "@opencomputer/sdk";

const sandbox = await Sandbox.create();

await sandbox.files.write("/app/hello.txt", "Hello, World!");
const content = await sandbox.files.read("/app/hello.txt");
console.log(content); // "Hello, World!"

await sandbox.kill();

from opencomputer import Sandbox

async with await Sandbox.create() as sandbox:
    await sandbox.files.write("/app/hello.txt", "Hello, World!")
    content = await sandbox.files.read("/app/hello.txt")
    print(content)  # "Hello, World!"

// Read as string
const text = await sandbox.files.read("/app/config.json");

// Read as bytes
const bytes = await sandbox.files.readBytes("/app/image.png");

# Read as string
text = await sandbox.files.read("/app/config.json")

# Read as bytes
data = await sandbox.files.read_bytes("/app/image.png")

// Write text
await sandbox.files.write("/app/config.json", JSON.stringify({ port: 3000 }));

// Write binary
const imageData = new Uint8Array([...]);
await sandbox.files.write("/app/logo.png", imageData);

# Write text
await sandbox.files.write("/app/config.json", '{"port": 3000}')

# Write binary
await sandbox.files.write("/app/logo.png", image_bytes)

const entries = await sandbox.files.list("/app");
for (const entry of entries) {
  console.log(entry.isDir ? "📁" : "📄", entry.name, entry.size);
}

entries = await sandbox.files.list("/app")
for entry in entries:
    kind = "dir" if entry.is_dir else "file"
    print(f"{kind}: {entry.name} ({entry.size} bytes)")

await sandbox.files.makeDir("/app/data");

await sandbox.files.make_dir("/app/data")

await sandbox.files.remove("/app/temp");

await sandbox.files.remove("/app/temp")

if (await sandbox.files.exists("/app/config.json")) {
  const config = await sandbox.files.read("/app/config.json");
}

if await sandbox.files.exists("/app/config.json"):
    config = await sandbox.files.read("/app/config.json")

// Stream a large file download — returns a ReadableStream, not a buffer
const stream = await sandbox.files.readStream("/data/model.bin");

// Pipe to a file, or process chunks incrementally
const reader = stream.getReader();
while (true) {
  const { done, value } = await reader.read();
  if (done) break;
  // process each Uint8Array chunk...
}

// Stream a large file upload — accepts ReadableStream or Uint8Array
const fileStream = someReadableStream; // e.g. from fs.createReadStream
await sandbox.files.writeStream("/data/model.bin", fileStream);

// Uint8Array also works (sent without buffering a copy)
await sandbox.files.writeStream("/data/output.bin", largeUint8Array);

# Stream a large file download — returns an async byte iterator
stream = await sandbox.files.read_stream("/data/model.bin")
async for chunk in stream:
    # process each bytes chunk...
    pass

# Stream a large file upload — accepts an async iterator
async def file_chunks():
    with open("local_model.bin", "rb") as f:
        while chunk := f.read(256 * 1024):
            yield chunk

await sandbox.files.write_stream("/data/model.bin", file_chunks())

await sandbox.files.write("/tmp/setup.sh", `#!/bin/bash
apt-get update && apt-get install -y redis-server
redis-server --daemonize yes
`);
await sandbox.exec.run("chmod +x /tmp/setup.sh && /tmp/setup.sh");

await sandbox.files.write("/tmp/setup.sh", """#!/bin/bash
apt-get update && apt-get install -y redis-server
redis-server --daemonize yes
""")
await sandbox.exec.run("chmod +x /tmp/setup.sh && /tmp/setup.sh")