Set-Clipboard -Remote with OSC52

[dkaszews]

Prerequisites

• Existing Issue: Search the existing issues for this repository. If there is an issue that fits your needs do not file a new one. Subscribe, react, or comment on that issue instead.
• Descriptive Title: Write the title for this issue as a short synopsis. If possible, provide context. For example, "Document new Get-Foo cmdlet" instead of "New cmdlet."

Summary

Added switch -AsOSC52 (alias -ToLocalhost) which uses OSC52 escape sequence to set the clipboard of the host (system running terminal) instead of target (system actually running PowerShell).

Details

The documentation should explain the following:

• Difference between host and target when remoting and why this feature is useful.
• OSC52 needs to be implemented by the terminal, is supported by most (including Windows Terminal), but not all (notably missing gnome-terminal, the default terminal on many Linux distros, including Ubuntu).
• Terminal multiplexers such as screen and tmux may interfere and require additional configuration.
• If does not work, OSC52 is the term to search for.
• Get-Clipboard equivalent is considered a security risk and not implemented in PowerShell nor any terminal of note, but can be retrieved simply with Ctrl+Shift+V.
• Optional hint for the user: they can add $PSDefaultParameters['Set-Clipboard:AsOSC52'] = $env:SSH_CLIENT -or $env:SSH_TTY to their $PROFILE to automatically choose the correct method when connecting over SSH.

Articles

• reference/7.3/Microsoft.PowerShell.Management/Set-Clipboard.md

Related Source Pull Requests

• Set-Clipboard -AsOSC52 PowerShell/PowerShell#18222

Related Source Issues

• Set-Clipboard -Remote with OSC52 PowerShell/PowerShell#18116