You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Updated documentation to reflect the new per-command env and cwd options added in cloudflare/sandbox-sdk#204.
Changes
Commands API (/sandbox/api/commands/)
Updated exec() method documentation:
Added env parameter - per-command environment variables that do not persist
Added cwd parameter - per-command working directory that does not persist
Added comprehensive examples showing:
Setting per-command environment variables
Using custom working directory for a command
Demonstrating that values are scoped and do not persist
Updated execStream() method documentation:
Added env parameter
Added cwd parameter
Added example showing per-command options with streaming execution
Added clarifying note:
Explains the difference between per-command options (temporary) and session-level configuration (persistent)
Links to session documentation for persistent configuration
Why This Matters
This PR adds an important new capability - developers can now pass temporary environment variables and change directories for individual command executions without affecting the session state. This is useful for:
Testing with different configurations
Running commands in specific directories without changing session state
Temporarily setting environment variables for a single operation
The documentation clearly shows the scoping behavior with examples to prevent confusion.
Document new per-command environment variable and working directory
options added to exec(), execStream(), and startProcess() methods.
Changes:
- Add env and cwd parameters to exec() and execStream() API docs
- Add practical examples showing per-command env variable scoping
- Add working directory override examples
- Update environment variables configuration guide
- Clarify that per-command options do not persist in session
Related PR: cloudflare/sandbox-sdk#204
🤖 Generated with [Claude Code](https://claude.com/claude-code)
Co-Authored-By: Claude <noreply@anthropic.com>
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
agents-git-bot
bot
requested review from
a team and
whoiskatrin
as code owners
Summary
Documents new
envandcwdparameters added to command execution methods in the Cloudflare Sandbox SDK.Changes
API Documentation (
sandbox/api/commands.mdx)envandcwdparameters toexec()method documentationenvandcwdparameters toexecStream()method documentationExecute Commands Guide (
sandbox/guides/execute-commands.mdx)cwdoption as best practiceContext
These parameters allow customizing command execution on a per-command basis:
env: Environment variables merged with session environment (per-command only)cwd: Working directory that overrides session working directory (per-command only)This provides flexibility for different command contexts without affecting the broader session state.
Source
🤖 Synced from cloudflare/sandbox-sdk PR #204
Original PR Title: add environment variables and working directory support to command exec