Skip to content

window:copy_to_clipboard(text [,clipboard])

Since: Version 20220807-113146-c2fee766

The functionality described in this section requires version 20220807-113146-c2fee766 of wezterm, or a more recent version.

Puts text into the specified clipboard.

Clipboard can be one of:

  • "Clipboard" - the system clipboard
  • "PrimarySelection" - the primary selection buffer (applicable to X11 and some Wayland systems only)
  • "ClipboardAndPrimarySelection" - both the system clipboard and the primary selection. This is the default if you don't specify the clipboard.

Note that updating the clipboard is asynchronous; this method will return immediately while the clipboard is updated a few moments later in another thread. If you need to ensure that the published text is visible to other applications before you trigger some other action in your lua code then you may need to add a short sleep to allow for that to complete.

window:copy_to_clipboard 'put this text in the clipboard and primary selection!'

window:copy_to_clipboard('put me in the clipboard only', 'Clipboard')

window:copy_to_clipboard(
  'put me in the primary selection',
  'PrimarySelection'
)