Sync docs: add environment variables and working directory support to command exec #26653
+21
−3
Conversation
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
agents-git-bot
bot
requested review from
a team and
whoiskatrin
as code owners
Contributor
|
This pull request requires reviews from CODEOWNERS as it changes files that match the following patterns:
|
Contributor
agents-git-bot
bot
force-pushed
the
sync-docs-pr-204
branch
from
13ae41f to
084eb8a
Compare
Contributor
Author
|
Updated documentation to reflect the new per-command ChangesCommands API (
|
Contributor
Author
|
✅ Documentation sync complete! Files Updated1.
|
Contributor
Author
|
Added comprehensive documentation for all |
agents-git-bot
bot
force-pushed
the
sync-docs-pr-204
branch
from
4d2e471 to
1f61420
Compare
Document new env and cwd parameters for exec(), execStream(), and startProcess() methods. These options allow temporary per-command overrides of session/sandbox-level settings without persisting changes. - Updated commands.mdx with env and cwd parameters for exec() and execStream() - Added example showing usage of env and cwd options - Updated startProcess() documentation with complete options list - Updated environment-variables.mdx to include execStream() example Related PR: cloudflare/sandbox-sdk#204 Generated with Claude Code Co-Authored-By: Claude <[email protected]>
agents-git-bot
bot
force-pushed
the
sync-docs-pr-204
branch
from
1f61420 to
6b9482e
Compare
Contributor
Author
|
Updated documentation to include:
The documentation now accurately reflects the API changes from cloudflare/sandbox-sdk#204. |
Remove timeout from execStream() and timeout/encoding/autoCleanup from startProcess() to match actual SDK implementation. These parameters were accepted by the SDK but not used in the execution flow, causing potential confusion for users.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
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