rdp-cli コマンドリファレンス

観察・操作・検証

USER、SESSION、OBSERVATION、X、Y は置き換える値です。標準入力でパスワードを渡してストリームを閉じます。--password-stdin は対話式の入力画面ではありません。data.session を保存し、before.png を読み、その画像から座標を選び、after.png で結果を確認します。入力の送信だけでは作業完了を確認できません。

rdp-cli connect --host desktop.example.net --user USER --password-stdin
rdp-cli screenshot --session SESSION --out before.png
rdp-cli click --session SESSION --desktop --x X --y Y --observation OBSERVATION
rdp-cli screenshot --session SESSION --out after.png

--version はバージョンと機能、--help-json は機械可読の一覧を返します。COMMAND --help はセッションを開始せずに全オプションを説明します。

rdp-cli --version
rdp-cli --help-json
rdp-cli connect --help

JSON と共通オプション

通常のコマンドは stdout に UTF-8 の JSON オブジェクトを1つ出力します。成功時は ok: true と data、失敗時は ok: false と error です。stderr は診断情報です。終了コードは成功0、実行エラー1、引数エラー2です。

ヘルプはテキストです。events --follow は NDJSON を連続出力し、通常の events は data.events と data.ndjson を含む単一 JSON 結果を返します。 PowerShell 5.1 で非ASCII文字を扱う場合、[Console]::OutputEncoding と $OutputEncoding を UTF-8 に設定します。

data.session

connect が返したセッションIDを後続のコマンドで使います。

data.observation

スクリーンショットの観察トークンです。再接続、操作権や画面構成の変更後に撮り直します。

data.capabilities

ファイル、音声、クリップボード、画面操作の前に、交渉済みの機能を確認します。

data.state / data.remote_outcome

queued、sent、partial、unknown、cancelled、failed は入力の進行状況です。remote_outcome: not_confirmed は結果の目視確認が必要です。

data.transfer_id

files status または files cancel に渡します。最終状態を待ち、完了ファイルのハッシュも確認します。

error.code / error.message / error.retryable

安定したエラーコードで判断します。メッセージと retryable は参考情報であり、無条件の再実行を許可しません。

全コマンドで --request-id と --timeout-ms を使えます。保持期間内で同一コマンド・同一引数を再送する場合だけIDを再利用します。ローカルのタイムアウトは未送信を意味しません。先に operations status を確認します。

プロトコルと環境の条件

• RDP の既定値は --cert-policy ignore と --tls-profile modern。strict は信頼と名前を検証し、legacy は古いTLSを明示的に許可します。Web HTTPSの検証は変えません。
• VNC は --user、--domain、--size、--layout、--cert-policy、--tls-profile を拒否します。従来認証はパスワードの先頭8 UTF-8バイトを使用。認証なしは --vnc-security none とパスワード指定なしが必要です。対応VNC通信は暗号化されません。
• VNC はファイル、音声、マイク、能動的な画面構成変更に非対応です。UTF-8クリップボードは交渉が必要で、それ以外はLatin-1のみです。
• RDPファイルにはドライブリダイレクトが必要です。音声、クリップボード、マイク、複数画面もサーバーポリシーに依存します。
• Windows/macOS はネイティブ表示と状態入口を提供します。Linux は画面・音声サービス、認証情報保存には Secret Service が必要です。デスクトップのないホストでも対応CLI操作は利用できます。
• Unicode入力は互換性のため間隔を空けて送信します。長文ではタイムアウトを調整して結果を確認してください。ビューアーを開いても全サーバー・全文字の入力は保証されません。

エラーからの復旧

OBSERVATION_REQUIRED / INVALID_COORDINATES

再撮影し、画面構成と座標を確認します。

SESSION_PAUSED / CONTROL_HELD_BY_HUMAN

入力を止め、人が明示的にAgentへ返すまで待ちます。

AUTH_FAILED / VNC_AUTH_FAILED

アカウント、パスワードの渡し方、サーバーポリシーを確認します。

RDP_TLS_HANDSHAKE_FAILED / CERTIFICATE_UNTRUSTED

TLS、証明書方針、指紋を確認します。TLS失敗はパスワード誤りとは限りません。

CAPABILITY_UNAVAILABLE / CLIPBOARD_ENCODING_UNSUPPORTED

機能または文字コードを確認し、対応する操作を選びます。

REQUEST_TIMEOUT / REQUEST_ID_CONFLICT / REQUEST_WINDOW_EXPIRED

再試行前に操作と画面を確認します。別の引数や保持期限後に同じIDでの重複排除を期待しません。