Skip to content

docs: document sandbox file exports#121

Open
remiconnesson wants to merge 2 commits into
mainfrom
codex/document-sandbox-file-exports
Open

docs: document sandbox file exports#121
remiconnesson wants to merge 2 commits into
mainfrom
codex/document-sandbox-file-exports

Conversation

@remiconnesson

Copy link
Copy Markdown

Summary

  • document SandboxSession.readFile() as the streaming primitive for exporting sandbox files
  • compare readFile(), readBinaryFile(), and readTextFile() by buffering and decoding behavior
  • show how to stream a sandbox file into the app runtime without buffering it
  • show how frontend message parts can render validated tool outputs as inline images or download links
  • distinguish bounded data URLs from storage URLs for larger or sensitive artifacts

Why

The sandbox guide listed readFile() in a method table but did not state its return type or connect it to file-export workflows. This made an existing capability difficult to discover and obscured the boundary between reading sandbox bytes and creating a browser download.

This PR documents the existing public ReadableStream<Uint8Array> | null contract. It does not add or change an API type.

Relationship to the Vercel fix

Issue #120 tracks the Vercel backend returning a Node stream instead of Eve's advertised Web stream. PR #117 fixes that implementation. This documentation PR targets main independently but should merge after #117 so the example works consistently across every backend.

Verification

  • pnpm fmt
  • pnpm docs:check (67 docs, 164 Eve import paths, and 224 code blocks validated; all MDX compiled)

No changeset is included because this PR changes documentation only.

Signed-off-by: Rémi Connesson <remiconnesson2@gmail.com>
@vercel

vercel Bot commented Jun 19, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
eve-docs Ready Ready Preview, Comment, Open in v0 Jun 19, 2026 9:21pm

@remiconnesson remiconnesson changed the title [codex] document sandbox file exports [WIP] document sandbox file exports Jun 19, 2026
Signed-off-by: Rémi Connesson <remiconnesson2@gmail.com>
@remiconnesson remiconnesson changed the title [WIP] document sandbox file exports docs: document sandbox file exports Jun 19, 2026
@remiconnesson remiconnesson marked this pull request as ready for review June 19, 2026 21:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant