OpenParable
Skip to content
← Back to skills

Bun File Io

Development
bun-file-io

Bun File Io is an Agent Skill for development published in the synthetic-sciences/openscience repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.

Use this when you are working on file operations like reading, writing, scanning, or deleting files. It summarizes the preferred file APIs and patterns used in this repo. It also notes when to use filesystem helpers for directories.

View on GitHub ↗
QUICK START

How to use this skill

Bring this guide into your coding agent with a prompt tailored to the tool you use.

  1. Open your project in Codex.
  2. Copy and paste the prompt below.
  3. Review files and risks before approving any action.
Prompt to paste
Inspect the Agent Skill at https://github.com/synthetic-sciences/openscience/blob/HEAD/.openscience/skill/bun-file-io/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/bun-file-io, but wait for my approval before writing files or running scripts.

Copying this prompt does not install or run the skill. Review third-party files before use.

Use this when

  • Editing file I/O or scans in backend/cli (the OpenScience CLI package)
  • Handling directory operations or external tools

Bun file APIs (from Bun docs)

  • Bun.file(path) is lazy; call text, json, stream, arrayBuffer, bytes, exists to read.
  • Metadata: file.size, file.type, file.name.
  • Bun.write(dest, input) writes strings, buffers, Blobs, Responses, or files.
  • Bun.file(...).delete() deletes a file.
  • file.writer() returns a FileSink for incremental writes.
  • Bun.Glob + Array.fromAsync(glob.scan({ cwd, absolute, onlyFiles, dot })) for scans.
  • Use Bun.which to find a binary, then Bun.spawn to run it.
  • Bun.readableStreamToText/Bytes/JSON for stream output.

When to use node:fs

  • Use node:fs/promises for directories (mkdir, readdir, recursive operations).

Repo patterns

  • Prefer Bun APIs over Node fs for file access.
  • Check Bun.file(...).exists() before reading.
  • For binary/large files use arrayBuffer() and MIME checks via file.type.
  • Use Bun.Glob + Array.fromAsync for scans.
  • Decode tool stderr with Bun.readableStreamToText.
  • For large writes, use Bun.write(Bun.file(path), text).

Quick checklist

  • Use Bun APIs first.
  • Use path.join/path.resolve for paths.
  • Prefer promise .catch(...) over try/catch when possible.