Sync docs from cloudflare/sandbox-sdk#310: add PTY support

[agents-git-bot]

Syncs documentation changes from cloudflare/sandbox-sdk#310 (cloudflare/sandbox-sdk#310): add PTY support

[github-actions]

This pull request requires reviews from CODEOWNERS as it changes files that match the following patterns:

Pattern	Owners
/src/content/docs/sandbox/	@whoiskatrin, @ghostwriternr, @cloudflare/pcx-technical-writing, @cloudflare/ai-agents

[agents-git-bot]

Updated with comprehensive PTY API documentation:

• Complete API reference for all pty methods (create(), attach(), getById(), list())
• PTY handle methods documentation (write(), resize(), kill(), onData(), onExit(), close())
• Async iteration support examples
• Use case examples: interactive shells, language REPLs, automated terminal sessions
• Transport considerations (HTTP vs WebSocket)
• Updated API index with PTY card

Ready for review.

[agents-git-bot]

Updated documentation with comprehensive PTY coverage:

Added Files

• API Reference (src/content/docs/sandbox/api/pty.mdx): Complete PTY API documentation with all methods, parameters, and examples
• How-to Guide (src/content/docs/sandbox/guides/interactive-terminals.mdx): Practical guide for building interactive terminal applications
• API Index Update: Added PTY card to API navigation

Documentation Highlights

• Clear distinction between PTY and Commands API use cases
• Complete method documentation with TypeScript examples
• Real-world use cases (interactive shells, text editors, Python REPL)
• Control character handling and terminal resizing
• Session attachment patterns
• Error handling and best practices

All content follows Cloudflare docs style guide with TypeScriptExample components and proper linking.

🤖 Generated with Claude Code

[github-actions]

Preview URL: https://0d601766.preview.developers.cloudflare.com
Preview Branch URL: https://sync-docs-pr-310.preview.developers.cloudflare.com

Files with changes (up to 15)

Original Link	Updated Link
https://developers.cloudflare.com/sandbox/guides/interactive-terminals/	https://sync-docs-pr-310.preview.developers.cloudflare.com/sandbox/guides/interactive-terminals/
https://developers.cloudflare.com/sandbox/api/pty/	https://sync-docs-pr-310.preview.developers.cloudflare.com/sandbox/api/pty/
https://developers.cloudflare.com/sandbox/api/	https://sync-docs-pr-310.preview.developers.cloudflare.com/sandbox/api/

[agents-git-bot]

Updated with complete documentation:

• Rewrote API reference with comprehensive coverage of all PTY methods and properties
• Added detailed how-to guide with practical examples including web terminal implementation, xterm.js integration, and interactive automation patterns
• Ensured compliance with Cloudflare style guide (TypeScriptExample components, proper links, no contractions)
• Added cross-links to related documentation

Ready for review!

[agents-git-bot]

Updated documentation based on the final implementation in cloudflare/sandbox-sdk#310:

Changes

• Complete API reference covering all PTY namespace methods and PTY handle API
• Comprehensive how-to guide with real-world examples including:
  • xterm.js integration patterns
  • WebSocket-based terminal implementation
  • Collaborative terminal example
  • Session attachment for context inheritance
  • Terminal resize handling and control sequences
  • Lifecycle management and reconnection patterns

Documentation Structure

• api/pty.mdx: Technical API reference with all methods, parameters, and return types
• guides/interactive-terminals.mdx: Step-by-step how-to guide with production-ready examples

Following Cloudflare docs style guidelines with TypeScriptExample components, proper cross-links, and Diátaxis framework structure.

[agents-git-bot]

Update: Added Terminal Emulation Guide

I've added a comprehensive how-to guide for terminal emulation to complement the existing PTY API reference:

New file: src/content/docs/sandbox/guides/terminal-emulation.mdx

Coverage:

• When to use PTY vs exec() for different scenarios
• Integration with xterm.js for web-based terminals
• WebSocket handler implementation patterns
• ANSI escape sequences and terminal control
• Running interactive applications (Python REPL, vim, etc.)
• Collaborative terminal pattern for multi-user sessions
• Session reconnection handling
• Best practices for PTY management

This guide provides practical examples for developers building terminal interfaces, complementing the API reference with real-world implementation patterns.

Related to cloudflare/sandbox-sdk#310