add PTY support #27252
Open
add PTY support #27252
+448
−0
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
Contributor
|
This pull request requires reviews from CODEOWNERS as it changes files that match the following patterns:
|
9b1731a to
004b754
Compare
Contributor
Author
|
Updated with comprehensive PTY API documentation:
Ready for review. |
0d0f054 to
a497307
Compare
Contributor
Author
|
Updated documentation with comprehensive PTY coverage: Added Files
Documentation Highlights
All content follows Cloudflare docs style guide with TypeScriptExample components and proper linking. 🤖 Generated with Claude Code |
Contributor
Document the new PTY functionality added in sandbox-sdk PR #310. PTY enables interactive terminal sessions for running shells, text editors (vim/nano), and other terminal-based applications. New documentation includes: - Complete API reference for sandbox.pty namespace - All PTY handle methods (write, resize, kill, onData, onExit, close) - Usage examples for interactive shells, vim/nano, and scripted workflows - Integration with xterm.js for web-based terminals - Async iteration support for scripting Related to: cloudflare/sandbox-sdk#310
a497307 to
8f0537f
Compare
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
Sync documentation for sandbox-sdk PR #310: add PTY support
This PR adds comprehensive documentation for the new PTY (pseudo-terminal) feature that enables interactive terminal sessions in Cloudflare Sandbox.
Changes
New Documentation
PTY API Reference (
src/content/docs/sandbox/api/pty.mdx):sandbox.ptynamespacecreate(),attach(),getById(),list()write(),resize(),kill(),onData(),onExit(),close()id,sessionId,exitedUsage Examples:
Updated Documentation
src/content/docs/sandbox/api/index.mdx):What is PTY?
PTY (pseudo-terminal) provides full terminal control for interactive applications:
This differs from the existing Commands API which executes non-interactive commands and captures output.
Related Resources
sandbox.ptynamespace with create/attach/getById/list methodsNote: This documentation follows the Diátaxis framework with reference documentation and practical examples. The PTY feature is a minor release that adds significant new capability for terminal-based workflows.