次の方法で共有


Set-Clipboard

クリップボードの内容を設定します。

構文

Default (既定)

Set-Clipboard
    [-Value] <string[]>
    [-Append]
    [-PassThru]
    [-AsOSC52]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

説明

Set-Clipboard コマンドレットは、クリップボードの内容を設定します。

Linux の場合、このコマンドレットでは、xclip ユーティリティがパス内に存在する必要があります。 macOS では、このコマンドレットは pbcopy ユーティリティを使用します。

例 1: テキストをクリップボードにコピーする

Set-Clipboard -Value "This is a test string"

例 2: ファイルの内容をクリップボードにコピーする

次の使用例は、ファイルの内容 (ssh 公開キー) をクリップボードにパイプします。 その後、キーを GitHub などの別のアプリケーションに貼り付けることができます。

Get-Content C:\Users\user1\.ssh\id_ed25519.pub | Set-Clipboard

例 3: SSH リモート セッション経由でローカル ホストのクリップボードにテキストをコピーする

AsOSC52 パラメーターを使用すると、SSH 経由でリモート セッションに接続するときにローカル コンピューターのクリップボードを設定できます。

Set-Clipboard -Value "This is a test string" -AsOSC52

例 4: **AsOSC52** パラメーターの既定値を設定する

$Env:SSH_CLIENT または $Env:SSH_TTY 環境変数の値を確認することで、SSH 経由でリモート セッションに接続されているかどうかを検出できます。 これらの変数のいずれかが設定されている場合は、SSH 経由でリモート セッションに接続されます。 この情報を使用して、AsOSC52 パラメーターの既定値を設定できます。 PowerShell プロファイル スクリプトに次のいずれかの行を追加します。

$PSDefaultParameterValues['Set-Clipboard:AsOSC52'] = $Env:SSH_CLIENT
$PSDefaultParameterValues['Set-Clipboard:AsOSC52'] = $Env:SSH_TTY

$PSDefaultParameterValuesの詳細については、about_Parameters_Default_Valuesを参照してください。

パラメーター

-Append

コマンドレットを置き換えるのではなく、クリップボードに追加する必要があることを示します。 既定では、コマンドレットはクリップボードから現在のコンテンツをクリアし、新しいコンテンツに設定します。 このパラメーターを指定すると、コマンドレットは改行の後に新しいコンテンツを現在のコンテンツに追加します。

パラメーターのプロパティ

型:SwitchParameter
規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-AsOSC52

SSH 経由でリモート セッションに接続すると、Set-Clipboard はローカル ホストではなくリモート コンピューターのクリップボードを設定します。 このパラメーターを使用する場合、Set-Clipboard は OSC52 ANSI エスケープ シーケンスを使用してローカル コンピューターのクリップボードを設定します。

この機能を機能させるには、ターミナル アプリケーションが OSC52 ANSI エスケープ シーケンスをサポートしている必要があります。 Windows ターミナル では、この機能がサポートされています。

このパラメーターは PowerShell 7.4 で追加されました。

パラメーターのプロパティ

型:SwitchParameter
規定値:None
ワイルドカードのサポート:False
DontShow:False
Aliases:ToLocalhost

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-Confirm

コマンドレットを実行する前に確認を求めるメッセージが表示されます。

パラメーターのプロパティ

型:SwitchParameter
規定値:False
ワイルドカードのサポート:False
DontShow:False
Aliases:cf

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-PassThru

作業中のアイテムを表すオブジェクトを返します。 既定では、このコマンドレットは出力を生成しません。

パラメーターのプロパティ

型:SwitchParameter
規定値:False
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-Value

クリップボードに追加する文字列値。

パラメーターのプロパティ

型:

String[]

規定値:None
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:True
パイプラインからの値:True
プロパティ名別のパイプラインからの値:True
残りの引数からの値:False

-WhatIf

コマンドレットを実行した場合の動作を示します。 コマンドレットは実行されません。

パラメーターのプロパティ

型:SwitchParameter
規定値:False
ワイルドカードのサポート:False
DontShow:False
Aliases:ウィスコンシン

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

CommonParameters

このコマンドレットでは、一般的なパラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable の各パラメーターがサポートされています。 詳細については、about_CommonParametersを参照してください。

入力

String

コンテンツを含む文字列をパイプ処理して、クリップボードに設定してこのコマンドレットに設定できます。

出力

None

このコマンドレットは出力を返しません。

メモ

PowerShell には、Set-Clipboardの次のエイリアスが含まれています。

  • すべてのプラットフォーム:
    • scb

macOS でのこのコマンドレットのサポートは、PowerShell 7.0.0 リリースで追加されました。