Get-Clipboard (Microsoft.PowerShell.Management) - PowerShell (original) (raw)
Gets the contents of the clipboard.
Syntax
Default (Default)
Get-Clipboard
[-Raw]
[<CommonParameters>]
Description
The Get-Clipboard cmdlet gets the contents of the clipboard as text. Multiple lines of text are returned as an array of strings similar to Get-Content.
Note
On Linux, this cmdlet requires the xclip utility to be in the path. On macOS, this cmdlet uses the pbpaste utility.
Examples
Example 1: Get the content of the clipboard and display it to the command-line
In this example we have copied the text "hello" into the clipboard.
Get-Clipboard
hello
Parameters
-Raw
Gets the entire contents of the clipboard. Multiline text is returned as a single multiline string rather than an array of strings.
Parameter properties
| Type: | SwitchParameter |
|---|---|
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
|---|---|
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, seeabout_CommonParameters.
Inputs
None
You can't pipe objects to this cmdlet.
Outputs
String
This cmdlet returns a string containing the contents of the clipboard.
Notes
PowerShell includes the following aliases for Get-Clipboard:
- All platforms:
gcb
Support for this cmdlet on macOS was added in the PowerShell 7.0.0 release.