rdp-cli · 0.3.1

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

リモートデスクトップ、Linux アプリ、Android を操作する109のコマンド。接続、観察、入力、ファイル交換、操作の引き継ぎに対応します。

目的別にコマンドを探す

初めて使う場合は、インストールと最初の接続から始めましょう。 →

connect
永続的な RDP、VNC、Android ADB セッションに接続します。
screenshot
一貫したPNG観察画像を取得
click
リモート座標をクリック
type
クリップボードを変えずに入力します。Android は表示可能な ASCII、改行、タブに対応し、Unicode 貼り付けには android text を使います。
files upload
セッションのファイルルートにアップロードし、転送完了を確認します。
files download
RDP 交換ドライブまたは安定した Android ファイルスナップショットからダウンロードします。
watch
人向けビューアーを開く
list
利用可能なセッションを一覧表示

Windows、macOS、Linux のビルド 2026110701 で確認したコマンド一覧です。インストール済みファイルは --version と --help-json で確認してください。

観察・操作・検証

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 は参考情報であり、無条件の再実行を許可しません。
data.activity
現在または直近の動作、人/Agent の操作元、経過時間、転送進捗です。入力内容やクリップボードの内容は含まず、遠隔タスクの完了を証明するものではありません。

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

--request-id ID · --timeout-ms MILLISECONDS

セッション

RDP/VNC の connect には --host、RDP には --user も必要です。標準ポートは 3389 と 5900 です。認証時はパスワードの入力元を一つ選びます。--vnc-security none はパスワードを使いません。ADB は --device と --transport を使い、Wi-Fi のホストと接続ポートを指定できます。--domain、--size、--layout は RDP 用です。reconnect 後は一時停止し、disconnect は遠隔ユーザーをログオフしません。

rdp-cli connect#

永続的な RDP、VNC、Android ADB セッションに接続します。

セッションは必須ではありません。任意指定に対応する場合は下表に表示します。

コマンドのオプション
オプション形式と値指定条件
--profile

保存済み接続プロファイル

テキスト任意
--host

RDP/VNC のホスト、または明示的な Android Wi-Fi エンドポイント。

テキスト任意
--protocol

プロトコルは RDP、VNC、ADB、X11。それぞれ明示した接続先と認証規則を使います。

選択値
rdp | vnc | adb | x11
既定値: rdp
任意
--mode

X11 の既存デスクトップまたはアプリ転送モード。

選択値
desktop | application
任意
--display

許可された既存の X11 display。desktop 専用。

テキスト任意
--xauthority

既存リモート Xauthority ファイルの絶対パス。desktop 専用。

テキスト任意
--ssh-known-hosts

ローカルの OpenSSH known_hosts ファイル。外部 SSH 実行ファイルは不要です。

パス任意
--ssh-key

ローカルの SSH 秘密鍵。パスワード入力でパスフレーズを渡します。

パス任意
--ssh-host-key

別経路で確認した SSH SHA256 フィンガープリント。

テキスト任意
--linux-file-root

許可された SFTP 絶対ディレクトリ。既定は SSH ホーム内の非公開セッション用ディレクトリ。

テキスト任意
--application

インストール済みリモート X11 アプリの絶対パス。

テキスト任意
--app-args

JSON の引数配列。シェルによる解釈は行いません。

テキスト任意
--device

android devices の明示的なデバイス ID。ADB では必須です。

テキスト任意
--transport

USB または Wi-Fi を明示します。ADB では必須です。

選択値
usb | wifi
任意
--device-auth-ref

OS の認証情報ストアに明示的に保存した ID を再利用します。

テキスト任意
--save-device-auth

認証済み ID をこのローカル参照名で保存します。

テキスト任意
--device-file-root

許可された Android ディレクトリ。標準は /sdcard/Download/rdp-cli/<session-id>。

パス任意
--android-display

スマートフォンの主画面またはセッション専用仮想画面

選択値
main | virtual
任意
--android-virtual-size

仮想画面の幅x高さ

テキスト任意
--android-virtual-dpi

仮想画面の DPI

正の整数任意
--android-start-app

新しい仮想画面で起動するインストール済みアプリ

テキスト任意
--vnc-security

VNC 認証方式。none は明示指定が必要

選択値
vnc-auth | none | x509-plain | ard
任意
--vnc-tls-pin

確認済みの VNC X509Plain リーフ証明書 SHA256 フィンガープリント。

テキスト任意
--port

TCP ポート:RDP は 3389、VNC は 5900。android pair は端末のペア設定用ポート、ADB connect は別の接続用ポートを使用します。

正の整数
既定値: RDP 3389 · VNC 5900
任意
--user

ローカルまたはドメインのアカウント。RDP では必須

テキスト任意
--domain

Windows ドメイン

テキスト任意
--password

パスワード。従来型 VNC は先頭 8 UTF-8 バイトを使用

テキスト任意
--password-stdin

標準入力から EOF までパスワードを読む

フラグ任意
--cert-policy

RDP サーバーの証明書方針。Web HTTPS とは独立

選択値
ignore | strict
既定値: ignore
任意
--tls-profile

modern は TLS 1.2 と新しい暗号方式を要求。legacy はこのセッションで古い署名・暗号(TLS 1.2 の SHA-1 を含む)と TLS 1.0 を許可しますが、ダウングレードは強制しません

選択値
modern | legacy
既定値: modern
任意
--credential-ref

既存のプラットフォーム資格情報ストアの参照

テキスト任意
--audio-mode

RDP の再生先:ビューアー(client)、操作対象 PC(host)、または無効(off)

選択値
client | host | off
既定値: client
任意
--microphone-mode

RDP のマイク入力:許可済みビューアー(client)、操作対象 PC の対応ヘルパー(host)、または無効(off)

選択値
client | host | off
既定値: client
任意
--save-credential

接続に成功したパスワードをこの参照で保存

テキスト任意
--name

読みやすいセッション名

テキスト任意
--size

デスクトップの大きさ WIDTHxHEIGHT

テキスト任意
--layout

画面配置の JSON または @file

テキスト任意
--connect-timeout-ms

接続期限(ミリ秒)

正の整数任意
--agent-id

制御を受け取る Agent

テキスト任意
--agent-ref

呼び出し元 Agent の認証情報参照

テキスト任意
--claim-ref

現在の操作権の参照

テキスト任意
--task

永続タスク ID

テキスト任意
--run

タスクの実行 ID

テキスト任意

rdp-cli connect --help

rdp-cli list#

利用可能なセッションを一覧表示

セッションは必須ではありません。任意指定に対応する場合は下表に表示します。

コマンドのオプション
オプション形式と値指定条件
--agent-id

制御を受け取る Agent

テキスト任意
--agent-ref

呼び出し元 Agent の認証情報参照

テキスト任意
--claim-ref

現在の操作権の参照

テキスト任意
--task

永続タスク ID

テキスト任意
--run

タスクの実行 ID

テキスト任意

rdp-cli list --help

rdp-cli status#

セッションの状態を照会

--session SESSION が必須です。

コマンドのオプション
オプション形式と値指定条件
--agent-id

制御を受け取る Agent

テキスト任意
--agent-ref

呼び出し元 Agent の認証情報参照

テキスト任意
--claim-ref

現在の操作権の参照

テキスト任意
--task

永続タスク ID

テキスト任意
--run

タスクの実行 ID

テキスト任意

rdp-cli status --help

rdp-cli reconnect#

再接続して一時停止を維持

--session SESSION が必須です。

コマンドのオプション
オプション形式と値指定条件
--agent-id

制御を受け取る Agent

テキスト任意
--agent-ref

呼び出し元 Agent の認証情報参照

テキスト任意
--claim-ref

現在の操作権の参照

テキスト任意
--task

永続タスク ID

テキスト任意
--run

タスクの実行 ID

テキスト任意

rdp-cli reconnect --help

rdp-cli disconnect#

リモートセッションを閉じます。RDP では Windows ユーザーをログオフしません。

--session SESSION が必須です。

コマンドのオプション
オプション形式と値指定条件
--agent-id

制御を受け取る Agent

テキスト任意
--agent-ref

呼び出し元 Agent の認証情報参照

テキスト任意
--claim-ref

現在の操作権の参照

テキスト任意
--task

永続タスク ID

テキスト任意
--run

タスクの実行 ID

テキスト任意

rdp-cli disconnect --help

ビューアーとデスクトップ状態

watch は人向けの読み取り専用ビューアーを開きます。--viewer は window または web。Agent のコマンドにビューアーは不要です。presence show/hide は状態表示、--floating はフローティング操作、--panel はmacOS または Linux のセッションパネル用です。観察用ビューアーを閉じても接続は続きます。

rdp-cli watch#

人向けビューアーを開く

--session SESSION が必須です。

コマンドのオプション
オプション形式と値指定条件
--viewer

ビューアーの実装

選択値
window | web
既定値: window
任意
--agent-id

制御を受け取る Agent

テキスト任意
--agent-ref

呼び出し元 Agent の認証情報参照

テキスト任意
--claim-ref

現在の操作権の参照

テキスト任意
--task

永続タスク ID

テキスト任意
--run

タスクの実行 ID

テキスト任意

rdp-cli watch --help

rdp-cli presence show#

デスクトップの状態表示を開く

セッションは必須ではありません。任意指定に対応する場合は下表に表示します。

コマンドのオプション
オプション形式と値指定条件
--floating

任意のフローティング制御も表示

フラグ任意
--panel

macOS または Linux のセッションパネルも開く

フラグ任意
--agent-id

制御を受け取る Agent

テキスト任意
--agent-ref

呼び出し元 Agent の認証情報参照

テキスト任意
--claim-ref

現在の操作権の参照

テキスト任意
--task

永続タスク ID

テキスト任意
--run

タスクの実行 ID

テキスト任意

rdp-cli presence show --help

rdp-cli presence hide#

切断せず状態表示を隠す

セッションは必須ではありません。任意指定に対応する場合は下表に表示します。

コマンドのオプション
オプション形式と値指定条件
--agent-id

制御を受け取る Agent

テキスト任意
--agent-ref

呼び出し元 Agent の認証情報参照

テキスト任意
--claim-ref

現在の操作権の参照

テキスト任意
--task

永続タスク ID

テキスト任意
--run

タスクの実行 ID

テキスト任意

rdp-cli presence hide --help

操作権と引き継ぎ

pause は --session または --all を指定し、人の操作権も取り消します。resume はAgentに戻します。control take は接続済み viewer ID、release はそのビューアーまたは返却先Agentを指定できます。人による一時停止を尊重し、返却後は再撮影します。

rdp-cli pause#

入力を停止し人の操作権を取り消す

--session SESSION または --all のいずれか一方を指定します。

コマンドのオプション
オプション形式と値指定条件
--agent-id

制御を受け取る Agent

テキスト任意
--agent-ref

呼び出し元 Agent の認証情報参照

テキスト任意
--claim-ref

現在の操作権の参照

テキスト任意
--task

永続タスク ID

テキスト任意
--run

タスクの実行 ID

テキスト任意

rdp-cli pause --help

rdp-cli resume#

一時停止したセッションをAgentへ返す

--session SESSION が必須です。

コマンドのオプション
オプション形式と値指定条件
--agent-id

制御を受け取る Agent

テキスト任意
--agent-ref

呼び出し元 Agent の認証情報参照

テキスト任意
--claim-ref

現在の操作権の参照

テキスト任意
--task

永続タスク ID

テキスト任意
--run

タスクの実行 ID

テキスト任意

rdp-cli resume --help

rdp-cli control take#

接続済みビューアーへ操作権を渡す

--session SESSION が必須です。

コマンドのオプション
オプション形式と値指定条件
--viewer-id

接続済みビューアー ID。必要に応じて制御権の所有者

テキスト必須
--agent-id

制御を受け取る Agent

テキスト任意
--agent-ref

呼び出し元 Agent の認証情報参照

テキスト任意
--claim-ref

現在の操作権の参照

テキスト任意
--task

永続タスク ID

テキスト任意
--run

タスクの実行 ID

テキスト任意

rdp-cli control take --help

rdp-cli control release#

操作権をAgentへ返す

--session SESSION が必須です。

コマンドのオプション
オプション形式と値指定条件
--viewer-id

接続済みビューアー ID。必要に応じて制御権の所有者

テキスト任意
--agent-id

制御を受け取る Agent

テキスト任意
--to-agent

対象 Agent の識別情報

テキスト任意
--agent-ref

呼び出し元 Agent の認証情報参照

テキスト任意
--claim-ref

現在の操作権の参照

テキスト任意
--task

永続タスク ID

テキスト任意
--run

タスクの実行 ID

テキスト任意

rdp-cli control release --help

画面・入力・クリップボード

screenshot は --out にPNGを保存し、--monitor で画面を選べます。座標入力には observation と画面内座標または --desktop が必要で、混在できません。drag は始点・終点と任意の画面IDを指定します。type は --text と --text-stdin の二者択一。--sensitive は表示ヒントだけを変更し、画像を隠しません。key は --keys または --key と --state。クリップボード書き込みは遠隔側のテキストを置換します。

rdp-cli screenshot#

一貫したPNG観察画像を取得

--session SESSION が必須です。

コマンドのオプション
オプション形式と値指定条件
--monitor

モニター ID。screenshot では all も指定可能

テキスト
既定値: all
任意
--region

遠隔画面のピクセル領域 x,y,width,height

テキスト任意
--max-width

画像の最大幅。入力座標は変更しない

正の整数任意
--since

前のスクリーンショットの比較参照

テキスト任意
--out

保存先の PNG ファイル

パス任意
--agent-id

制御を受け取る Agent

テキスト任意
--agent-ref

呼び出し元 Agent の認証情報参照

テキスト任意
--claim-ref

現在の操作権の参照

テキスト任意
--task

永続タスク ID

テキスト任意
--run

タスクの実行 ID

テキスト任意

rdp-cli screenshot --help

rdp-cli move#

リモートポインターを移動

--session SESSION が必須です。

コマンドのオプション
オプション形式と値指定条件
--x

リモートの x 座標

整数必須
--y

リモートの y 座標

整数必須
--monitor

モニター ID。screenshot では all も指定可能

テキスト任意
--desktop

画面内座標ではなくデスクトップ座標を使用

フラグ任意
--observation

新しいスクリーンショットの観測トークン

テキスト必須
--agent-id

制御を受け取る Agent

テキスト任意
--agent-ref

呼び出し元 Agent の認証情報参照

テキスト任意
--claim-ref

現在の操作権の参照

テキスト任意
--task

永続タスク ID

テキスト任意
--run

タスクの実行 ID

テキスト任意

rdp-cli move --help

rdp-cli click#

リモート座標をクリック

--session SESSION が必須です。

コマンドのオプション
オプション形式と値指定条件
--x

リモートの x 座標

整数必須
--y

リモートの y 座標

整数必須
--button

マウスボタン

選択値
left | right | middle
既定値: left
任意
--count

クリック回数

正の整数任意
--monitor

モニター ID。screenshot では all も指定可能

テキスト任意
--desktop

画面内座標ではなくデスクトップ座標を使用

フラグ任意
--observation

新しいスクリーンショットの観測トークン

テキスト必須
--agent-id

制御を受け取る Agent

テキスト任意
--agent-ref

呼び出し元 Agent の認証情報参照

テキスト任意
--claim-ref

現在の操作権の参照

テキスト任意
--task

永続タスク ID

テキスト任意
--run

タスクの実行 ID

テキスト任意

rdp-cli click --help

rdp-cli scroll#

指定位置でスクロール

--session SESSION が必須です。

コマンドのオプション
オプション形式と値指定条件
--x

リモートの x 座標

整数必須
--y

リモートの y 座標

整数必須
--delta-x

符号付きの水平ホイール量

整数任意
--delta-y

符号付きの垂直ホイール量

整数任意
--monitor

モニター ID。screenshot では all も指定可能

テキスト任意
--desktop

画面内座標ではなくデスクトップ座標を使用

フラグ任意
--observation

新しいスクリーンショットの観測トークン

テキスト必須
--agent-id

制御を受け取る Agent

テキスト任意
--agent-ref

呼び出し元 Agent の認証情報参照

テキスト任意
--claim-ref

現在の操作権の参照

テキスト任意
--task

永続タスク ID

テキスト任意
--run

タスクの実行 ID

テキスト任意

rdp-cli scroll --help

rdp-cli drag#

座標間をドラッグ

--session SESSION が必須です。

コマンドのオプション
オプション形式と値指定条件
--from-x

開始 x 座標

整数必須
--from-y

開始 y 座標

整数必須
--to-x

終了 x 座標

整数必須
--to-y

終了 y 座標

整数必須
--from-monitor

開始モニター ID

テキスト任意
--to-monitor

終了モニター ID

テキスト任意
--desktop

画面内座標ではなくデスクトップ座標を使用

フラグ任意
--observation

新しいスクリーンショットの観測トークン

テキスト必須
--agent-id

制御を受け取る Agent

テキスト任意
--agent-ref

呼び出し元 Agent の認証情報参照

テキスト任意
--claim-ref

現在の操作権の参照

テキスト任意
--task

永続タスク ID

テキスト任意
--run

タスクの実行 ID

テキスト任意

rdp-cli drag --help

rdp-cli type#

クリップボードを変えずに入力します。Android は表示可能な ASCII、改行、タブに対応し、Unicode 貼り付けには android text を使います。

--session SESSION が必須です。

コマンドのオプション
オプション形式と値指定条件
--text

Unicode 入力またはクリップボードの文字列

テキスト任意
--text-stdin

標準入力から EOF まで入力/クリップボードの文字列を読む

フラグ任意
--sensitive

観測イベント内の文字列を隠す。スクリーンショットにはデスクトップが映る

フラグ任意
--observation

新しいスクリーンショットの観測トークン

テキスト必須
--agent-id

制御を受け取る Agent

テキスト任意
--agent-ref

呼び出し元 Agent の認証情報参照

テキスト任意
--claim-ref

現在の操作権の参照

テキスト任意
--task

永続タスク ID

テキスト任意
--run

タスクの実行 ID

テキスト任意

rdp-cli type --help

rdp-cli key#

キーの組み合わせ・状態を送信

--session SESSION が必須です。

コマンドのオプション
オプション形式と値指定条件
--keys

CTRL+S などのキーの組み合わせ

テキスト任意
--key

キー名。android key は一覧のシステムキーを使います。

テキスト任意
--state

列挙されたキー状態または消音状態

選択値
down | up
任意
--observation

新しいスクリーンショットの観測トークン

テキスト必須
--agent-id

制御を受け取る Agent

テキスト任意
--agent-ref

呼び出し元 Agent の認証情報参照

テキスト任意
--claim-ref

現在の操作権の参照

テキスト任意
--task

永続タスク ID

テキスト任意
--run

タスクの実行 ID

テキスト任意

rdp-cli key --help

rdp-cli clipboard get#

リモートのテキストクリップボードを読む

--session SESSION が必須です。

コマンドのオプション
オプション形式と値指定条件
--agent-id

制御を受け取る Agent

テキスト任意
--agent-ref

呼び出し元 Agent の認証情報参照

テキスト任意
--claim-ref

現在の操作権の参照

テキスト任意
--task

永続タスク ID

テキスト任意
--run

タスクの実行 ID

テキスト任意

rdp-cli clipboard get --help

rdp-cli clipboard set#

リモートのテキストクリップボードへ書く

--session SESSION が必須です。

コマンドのオプション
オプション形式と値指定条件
--text

Unicode 入力またはクリップボードの文字列

テキスト任意
--text-stdin

標準入力から EOF まで入力/クリップボードの文字列を読む

フラグ任意
--observation

新しいスクリーンショットの観測トークン

テキスト必須
--agent-id

制御を受け取る Agent

テキスト任意
--agent-ref

呼び出し元 Agent の認証情報参照

テキスト任意
--claim-ref

現在の操作権の参照

テキスト任意
--task

永続タスク ID

テキスト任意
--run

タスクの実行 ID

テキスト任意

rdp-cli clipboard set --help

ファイル

--path は許可された RDP 交換ドライブ、Android ディレクトリ、X11 SFTP ルートからの相対パスです。--local はローカルのファイルやフォルダです。置換には --overwrite が必要です。状態と完了ハッシュを確認し、結果不明の操作は繰り返さないでください。

rdp-cli files list#

RDP 交換ドライブまたは許可された Android ディレクトリのファイルを一覧表示します。

--session SESSION が必須です。

コマンドのオプション
オプション形式と値指定条件
--path

RDP 交換ドライブまたは許可された Android ディレクトリからの相対パス。

パス任意
--agent-id

制御を受け取る Agent

テキスト任意
--agent-ref

呼び出し元 Agent の認証情報参照

テキスト任意
--claim-ref

現在の操作権の参照

テキスト任意
--task

永続タスク ID

テキスト任意
--run

タスクの実行 ID

テキスト任意

rdp-cli files list --help

rdp-cli files upload#

セッションのファイルルートにアップロードし、転送完了を確認します。

--session SESSION が必須です。

コマンドのオプション
オプション形式と値指定条件
--local

アップロードするローカルファイル/ディレクトリ、またはダウンロード先

パス必須
--path

RDP 交換ドライブまたは許可された Android ディレクトリからの相対パス。

パス必須
--overwrite

既存の対象の置き換えを許可

フラグ任意
--agent-id

制御を受け取る Agent

テキスト任意
--agent-ref

呼び出し元 Agent の認証情報参照

テキスト任意
--claim-ref

現在の操作権の参照

テキスト任意
--task

永続タスク ID

テキスト任意
--run

タスクの実行 ID

テキスト任意

rdp-cli files upload --help

rdp-cli files download#

RDP 交換ドライブまたは安定した Android ファイルスナップショットからダウンロードします。

--session SESSION が必須です。

コマンドのオプション
オプション形式と値指定条件
--path

RDP 交換ドライブまたは許可された Android ディレクトリからの相対パス。

パス必須
--local

アップロードするローカルファイル/ディレクトリ、またはダウンロード先

パス必須
--overwrite

既存の対象の置き換えを許可

フラグ任意
--agent-id

制御を受け取る Agent

テキスト任意
--agent-ref

呼び出し元 Agent の認証情報参照

テキスト任意
--claim-ref

現在の操作権の参照

テキスト任意
--task

永続タスク ID

テキスト任意
--run

タスクの実行 ID

テキスト任意

rdp-cli files download --help

rdp-cli files status#

転送状態を照会

--session SESSION が必須です。

コマンドのオプション
オプション形式と値指定条件
--transfer-id

転送 ID。files status では省略するとセッションの転送一覧

テキスト任意
--agent-id

制御を受け取る Agent

テキスト任意
--agent-ref

呼び出し元 Agent の認証情報参照

テキスト任意
--claim-ref

現在の操作権の参照

テキスト任意
--task

永続タスク ID

テキスト任意
--run

タスクの実行 ID

テキスト任意

rdp-cli files status --help

rdp-cli files cancel#

転送を中止

--session SESSION が必須です。

コマンドのオプション
オプション形式と値指定条件
--transfer-id

転送 ID。files status では省略するとセッションの転送一覧

テキスト必須
--agent-id

制御を受け取る Agent

テキスト任意
--agent-ref

呼び出し元 Agent の認証情報参照

テキスト任意
--claim-ref

現在の操作権の参照

テキスト任意
--task

永続タスク ID

テキスト任意
--run

タスクの実行 ID

テキスト任意

rdp-cli files cancel --help

rdp-cli files cleanup#

交換内容を削除

--session SESSION が必須です。

コマンドのオプション
オプション形式と値指定条件
--path

RDP 交換ドライブまたは許可された Android ディレクトリからの相対パス。

パス必須
--agent-id

制御を受け取る Agent

テキスト任意
--agent-ref

呼び出し元 Agent の認証情報参照

テキスト任意
--claim-ref

現在の操作権の参照

テキスト任意
--task

永続タスク ID

テキスト任意
--run

タスクの実行 ID

テキスト任意

rdp-cli files cleanup --help

音声とマイク

RDP の --audio-mode client|host|off と --microphone-mode client|host|off は、新しい接続の再生先とマイク入力元を個別に選びます。録音は開始しません。host は接続先 Windows の対応サービスが必要で、Linux では使えません。X11/VNC に本製品の音声チャネルはありません。

rdp-cli host-microphone install#

この Windows PC に操作対象 PC のマイクヘルパーをインストールして開始

セッションは必須ではありません。任意指定に対応する場合は下表に表示します。

コマンドのオプション
オプション形式と値指定条件
--agent-id

制御を受け取る Agent

テキスト任意
--agent-ref

呼び出し元 Agent の認証情報参照

テキスト任意
--claim-ref

現在の操作権の参照

テキスト任意
--task

永続タスク ID

テキスト任意
--run

タスクの実行 ID

テキスト任意

rdp-cli host-microphone install --help

rdp-cli host-microphone status#

この Windows PC に操作対象 PC のマイクヘルパーがインストール済みか確認

セッションは必須ではありません。任意指定に対応する場合は下表に表示します。

コマンドのオプション
オプション形式と値指定条件
--agent-id

制御を受け取る Agent

テキスト任意
--agent-ref

呼び出し元 Agent の認証情報参照

テキスト任意
--claim-ref

現在の操作権の参照

テキスト任意
--task

永続タスク ID

テキスト任意
--run

タスクの実行 ID

テキスト任意

rdp-cli host-microphone status --help

rdp-cli host-microphone uninstall#

この Windows PC の操作対象 PC マイクヘルパーを停止して削除

セッションは必須ではありません。任意指定に対応する場合は下表に表示します。

コマンドのオプション
オプション形式と値指定条件
--agent-id

制御を受け取る Agent

テキスト任意
--agent-ref

呼び出し元 Agent の認証情報参照

テキスト任意
--claim-ref

現在の操作権の参照

テキスト任意
--task

永続タスク ID

テキスト任意
--run

タスクの実行 ID

テキスト任意

rdp-cli host-microphone uninstall --help

rdp-cli audio status#

音声機能・ソースを照会

--session SESSION が必須です。

コマンドのオプション
オプション形式と値指定条件
--agent-id

制御を受け取る Agent

テキスト任意
--agent-ref

呼び出し元 Agent の認証情報参照

テキスト任意
--claim-ref

現在の操作権の参照

テキスト任意
--task

永続タスク ID

テキスト任意
--run

タスクの実行 ID

テキスト任意

rdp-cli audio status --help

rdp-cli audio mute#

ビューアーのミュートを切り替え

--session SESSION が必須です。

コマンドのオプション
オプション形式と値指定条件
--viewer-id

接続済みビューアー ID。必要に応じて制御権の所有者

テキスト必須
--state

列挙されたキー状態または消音状態

選択値
on | off
必須
--agent-id

制御を受け取る Agent

テキスト任意
--agent-ref

呼び出し元 Agent の認証情報参照

テキスト任意
--claim-ref

現在の操作権の参照

テキスト任意
--task

永続タスク ID

テキスト任意
--run

タスクの実行 ID

テキスト任意

rdp-cli audio mute --help

rdp-cli audio volume#

ビューアーの音量を設定

--session SESSION が必須です。

コマンドのオプション
オプション形式と値指定条件
--viewer-id

接続済みビューアー ID。必要に応じて制御権の所有者

テキスト必須
--percent

再生ゲインの百分率

正の整数必須
--agent-id

制御を受け取る Agent

テキスト任意
--agent-ref

呼び出し元 Agent の認証情報参照

テキスト任意
--claim-ref

現在の操作権の参照

テキスト任意
--task

永続タスク ID

テキスト任意
--run

タスクの実行 ID

テキスト任意

rdp-cli audio volume --help

rdp-cli audio microphone#

マイクを照会・停止

--session SESSION が必須です。

コマンドのオプション
オプション形式と値指定条件
--action

マイクの状態確認または停止。開始には人間のビューアー操作が必要

選択値
status | stop
既定値: status
任意
--agent-id

制御を受け取る Agent

テキスト任意
--agent-ref

呼び出し元 Agent の認証情報参照

テキスト任意
--claim-ref

現在の操作権の参照

テキスト任意
--task

永続タスク ID

テキスト任意
--run

タスクの実行 ID

テキスト任意

rdp-cli audio microphone --help

rdp-cli audio android#

端末の再生音、マイク、またはオフを明示的に選択します。

Android 対応の現行版が必要です。Windows(x64 / x86 / ARM64)、macOS(Apple silicon / Intel)、Linux(x86_64 / ARM64)から選べます。

--session SESSION が必須です。

コマンドのオプション
オプション形式と値指定条件
--source

端末の音源:off、output(システムの共有許可が必要)、microphone(操作権と新しい --observation が必要)。

選択値
off | output | microphone
必須
--observation

新しいスクリーンショットの観測トークン

テキスト任意
--agent-id

制御を受け取る Agent

テキスト任意
--agent-ref

呼び出し元 Agent の認証情報参照

テキスト任意
--claim-ref

現在の操作権の参照

テキスト任意
--task

永続タスク ID

テキスト任意
--run

タスクの実行 ID

テキスト任意

rdp-cli audio android --help

rdp-cli audio poll#

上限のある直近の PCM 音声サンプルを読み取ります。

--session SESSION が必須です。

コマンドのオプション
オプション形式と値指定条件
--after

このシーケンスより後のイベントまたは PCM サンプルを返します。

正の整数任意
--agent-id

制御を受け取る Agent

テキスト任意
--agent-ref

呼び出し元 Agent の認証情報参照

テキスト任意
--claim-ref

現在の操作権の参照

テキスト任意
--task

永続タスク ID

テキスト任意
--run

タスクの実行 ID

テキスト任意

rdp-cli audio poll --help

ディスプレイ

monitors は画面構成を返します。monitors set はJSONまたは @file、--allow-reconnect は動的変更ができない場合の再接続を許可します。変更後は構成を確認して再撮影します。VNC はフレームバッファを報告しますが、要求による構成変更には対応しません。

rdp-cli monitors#

交渉済み画面構成を照会

--session SESSION が必須です。

コマンドのオプション
オプション形式と値指定条件
--agent-id

制御を受け取る Agent

テキスト任意
--agent-ref

呼び出し元 Agent の認証情報参照

テキスト任意
--claim-ref

現在の操作権の参照

テキスト任意
--task

永続タスク ID

テキスト任意
--run

タスクの実行 ID

テキスト任意

rdp-cli monitors --help

rdp-cli monitors set#

画面構成を変更

--session SESSION が必須です。

コマンドのオプション
オプション形式と値指定条件
--layout

画面配置の JSON または @file

テキスト必須
--allow-reconnect

動的な画面配置が使えない場合に再接続を許可

フラグ任意
--agent-id

制御を受け取る Agent

テキスト任意
--agent-ref

呼び出し元 Agent の認証情報参照

テキスト任意
--claim-ref

現在の操作権の参照

テキスト任意
--task

永続タスク ID

テキスト任意
--run

タスクの実行 ID

テキスト任意

rdp-cli monitors set --help

Web アクセス

web start で待受アドレスとTLS証明書・鍵、または信頼するプロキシを設定します。--ice-server は繰り返し可能です。ループバック外ではLAN/VPN、HTTPS、認可が必要です。access grant は --permission と秒単位の --expires-in を指定します。権限は session.observe/control、clipboard.read/write、files.read/write、audio.listen/send。取り消すと対応するストリームも停止します。

rdp-cli web start#

認可付きWebサービスを開始

セッションは必須ではありません。任意指定に対応する場合は下表に表示します。

コマンドのオプション
オプション形式と値指定条件
--listen

待ち受けアドレス

テキスト任意
--tls-cert

HTTPS 証明書ファイル

パス任意
--tls-key

HTTPS 秘密鍵ファイル

パス任意
--trust-proxy

設定されたプロキシを信頼

フラグ任意
--ice-server

WebRTC 用 STUN/TURN URL

テキスト任意 · 繰り返し可
--agent-id

制御を受け取る Agent

テキスト任意
--agent-ref

呼び出し元 Agent の認証情報参照

テキスト任意
--claim-ref

現在の操作権の参照

テキスト任意
--task

永続タスク ID

テキスト任意
--run

タスクの実行 ID

テキスト任意

rdp-cli web start --help

rdp-cli web status#

Webサービスの状態を照会

セッションは必須ではありません。任意指定に対応する場合は下表に表示します。

コマンドのオプション
オプション形式と値指定条件
--agent-id

制御を受け取る Agent

テキスト任意
--agent-ref

呼び出し元 Agent の認証情報参照

テキスト任意
--claim-ref

現在の操作権の参照

テキスト任意
--task

永続タスク ID

テキスト任意
--run

タスクの実行 ID

テキスト任意

rdp-cli web status --help

rdp-cli web stop#

リモートセッションを接続したままブラウザーからのアクセスを停止します。

セッションは必須ではありません。任意指定に対応する場合は下表に表示します。

コマンドのオプション
オプション形式と値指定条件
--agent-id

制御を受け取る Agent

テキスト任意
--agent-ref

呼び出し元 Agent の認証情報参照

テキスト任意
--claim-ref

現在の操作権の参照

テキスト任意
--task

永続タスク ID

テキスト任意
--run

タスクの実行 ID

テキスト任意

rdp-cli web stop --help

rdp-cli access grant#

範囲付きWeb権限を作成

--session SESSION が必須です。

コマンドのオプション
オプション形式と値指定条件
--permission

アクセストークンに付与する権限

テキスト必須 · 繰り返し可
--expires-in

権限の有効期間(秒)

正の整数必須
--agent-id

制御を受け取る Agent

テキスト任意
--agent-ref

呼び出し元 Agent の認証情報参照

テキスト任意
--claim-ref

現在の操作権の参照

テキスト任意
--task

永続タスク ID

テキスト任意
--run

タスクの実行 ID

テキスト任意

rdp-cli access grant --help

rdp-cli access list#

Web権限を一覧表示

--session SESSION が必須です。

コマンドのオプション
オプション形式と値指定条件
--agent-id

制御を受け取る Agent

テキスト任意
--agent-ref

呼び出し元 Agent の認証情報参照

テキスト任意
--claim-ref

現在の操作権の参照

テキスト任意
--task

永続タスク ID

テキスト任意
--run

タスクの実行 ID

テキスト任意

rdp-cli access list --help

rdp-cli access revoke#

権限とストリームを取り消す

--session SESSION が必須です。

コマンドのオプション
オプション形式と値指定条件
--grant-id

権限付与 ID

テキスト必須
--agent-id

制御を受け取る Agent

テキスト任意
--agent-ref

呼び出し元 Agent の認証情報参照

テキスト任意
--claim-ref

現在の操作権の参照

テキスト任意
--task

永続タスク ID

テキスト任意
--run

タスクの実行 ID

テキスト任意

rdp-cli access revoke --help

Android スマートフォン

デバイス ID と usb または wifi を明示します。検出だけでは認証されません。ペア設定ポートと接続ポートは別です。コードは標準入力に渡して入力を終了します。ID の保存は明示的に指定します。入力やアプリ変更には制御権と新しい観察が必要です。不明な結果はジョブ照会で確認し、操作を繰り返さないでください。

rdp-cli android devices#

認証せずに USB と Wi-Fi の候補を検出します。

Android 対応の現行版が必要です。Windows(x64 / x86 / ARM64)、macOS(Apple silicon / Intel)、Linux(x86_64 / ARM64)から選べます。

セッションは必須ではありません。任意指定に対応する場合は下表に表示します。

コマンドのオプション
オプション形式と値指定条件
--agent-id

制御を受け取る Agent

テキスト任意
--agent-ref

呼び出し元 Agent の認証情報参照

テキスト任意
--claim-ref

現在の操作権の参照

テキスト任意
--task

永続タスク ID

テキスト任意
--run

タスクの実行 ID

テキスト任意

rdp-cli android devices --help

rdp-cli android pair#

ペア設定ポートと標準入力のコードで無線ペア設定します。

Android 対応の現行版が必要です。Windows(x64 / x86 / ARM64)、macOS(Apple silicon / Intel)、Linux(x86_64 / ARM64)から選べます。

セッションは必須ではありません。任意指定に対応する場合は下表に表示します。

コマンドのオプション
オプション形式と値指定条件
--host

RDP/VNC のホスト、または明示的な Android Wi-Fi エンドポイント。

テキスト必須
--port

TCP ポート:RDP は 3389、VNC は 5900。android pair は端末のペア設定用ポート、ADB connect は別の接続用ポートを使用します。

正の整数必須
--code-stdin

6 桁のペア設定コードを標準入力から読み取ります。

フラグ任意
--device-auth-ref

OS の認証情報ストアに明示的に保存した ID を再利用します。

テキスト任意
--save-device-auth

認証済み ID をこのローカル参照名で保存します。

テキスト任意
--agent-id

制御を受け取る Agent

テキスト任意
--agent-ref

呼び出し元 Agent の認証情報参照

テキスト任意
--claim-ref

現在の操作権の参照

テキスト任意
--task

永続タスク ID

テキスト任意
--run

タスクの実行 ID

テキスト任意

rdp-cli android pair --help

rdp-cli android forget#

保存したローカル Android ID を削除します。端末側の取り消しは別です。

Android 対応の現行版が必要です。Windows(x64 / x86 / ARM64)、macOS(Apple silicon / Intel)、Linux(x86_64 / ARM64)から選べます。

セッションは必須ではありません。任意指定に対応する場合は下表に表示します。

コマンドのオプション
オプション形式と値指定条件
--device-auth-ref

OS の認証情報ストアに明示的に保存した ID を再利用します。

テキスト必須
--agent-id

制御を受け取る Agent

テキスト任意
--agent-ref

呼び出し元 Agent の認証情報参照

テキスト任意
--claim-ref

現在の操作権の参照

テキスト任意
--task

永続タスク ID

テキスト任意
--run

タスクの実行 ID

テキスト任意

rdp-cli android forget --help

rdp-cli android apps list#

インストール済み Android パッケージを一覧表示します。

Android 対応の現行版が必要です。Windows(x64 / x86 / ARM64)、macOS(Apple silicon / Intel)、Linux(x86_64 / ARM64)から選べます。

--session SESSION が必須です。

コマンドのオプション
オプション形式と値指定条件
--agent-id

制御を受け取る Agent

テキスト任意
--agent-ref

呼び出し元 Agent の認証情報参照

テキスト任意
--claim-ref

現在の操作権の参照

テキスト任意
--task

永続タスク ID

テキスト任意
--run

タスクの実行 ID

テキスト任意

rdp-cli android apps list --help

rdp-cli android apps info#

パッケージの実際のインストール先を照会します。

Android 対応の現行版が必要です。Windows(x64 / x86 / ARM64)、macOS(Apple silicon / Intel)、Linux(x86_64 / ARM64)から選べます。

--session SESSION が必須です。

コマンドのオプション
オプション形式と値指定条件
--package

Android パッケージ名。

テキスト必須
--agent-id

制御を受け取る Agent

テキスト任意
--agent-ref

呼び出し元 Agent の認証情報参照

テキスト任意
--claim-ref

現在の操作権の参照

テキスト任意
--task

永続タスク ID

テキスト任意
--run

タスクの実行 ID

テキスト任意

rdp-cli android apps info --help

rdp-cli android apps install#

許可された端末ディレクトリの単一 APK を送信し、ジョブを追跡します。

Android 対応の現行版が必要です。Windows(x64 / x86 / ARM64)、macOS(Apple silicon / Intel)、Linux(x86_64 / ARM64)から選べます。

--session SESSION が必須です。

コマンドのオプション
オプション形式と値指定条件
--path

RDP 交換ドライブまたは許可された Android ディレクトリからの相対パス。

パス必須
--replace

インストール済みアプリを明示的に置換します。

フラグ任意
--observation

新しいスクリーンショットの観測トークン

テキスト必須
--agent-id

制御を受け取る Agent

テキスト任意
--agent-ref

呼び出し元 Agent の認証情報参照

テキスト任意
--claim-ref

現在の操作権の参照

テキスト任意
--task

永続タスク ID

テキスト任意
--run

タスクの実行 ID

テキスト任意

rdp-cli android apps install --help

rdp-cli android apps launch#

指定アプリを起動し、画面を確認します。

Android 対応の現行版が必要です。Windows(x64 / x86 / ARM64)、macOS(Apple silicon / Intel)、Linux(x86_64 / ARM64)から選べます。

--session SESSION が必須です。

コマンドのオプション
オプション形式と値指定条件
--package

Android パッケージ名。

テキスト必須
--activity

Activity クラス。省略時は起動先を解決します。

テキスト任意
--observation

新しいスクリーンショットの観測トークン

テキスト必須
--agent-id

制御を受け取る Agent

テキスト任意
--agent-ref

呼び出し元 Agent の認証情報参照

テキスト任意
--claim-ref

現在の操作権の参照

テキスト任意
--task

永続タスク ID

テキスト任意
--run

タスクの実行 ID

テキスト任意

rdp-cli android apps launch --help

rdp-cli android apps stop#

明示した Android パッケージを強制停止します。

Android 対応の現行版が必要です。Windows(x64 / x86 / ARM64)、macOS(Apple silicon / Intel)、Linux(x86_64 / ARM64)から選べます。

--session SESSION が必須です。

コマンドのオプション
オプション形式と値指定条件
--package

Android パッケージ名。

テキスト必須
--observation

新しいスクリーンショットの観測トークン

テキスト必須
--agent-id

制御を受け取る Agent

テキスト任意
--agent-ref

呼び出し元 Agent の認証情報参照

テキスト任意
--claim-ref

現在の操作権の参照

テキスト任意
--task

永続タスク ID

テキスト任意
--run

タスクの実行 ID

テキスト任意

rdp-cli android apps stop --help

rdp-cli android apps status#

操作を再実行せずにアプリのジョブを照会します。

Android 対応の現行版が必要です。Windows(x64 / x86 / ARM64)、macOS(Apple silicon / Intel)、Linux(x86_64 / ARM64)から選べます。

--session SESSION が必須です。

コマンドのオプション
オプション形式と値指定条件
--job

インストール・起動・停止で返されたジョブ ID。

テキスト必須
--agent-id

制御を受け取る Agent

テキスト任意
--agent-ref

呼び出し元 Agent の認証情報参照

テキスト任意
--claim-ref

現在の操作権の参照

テキスト任意
--task

永続タスク ID

テキスト任意
--run

タスクの実行 ID

テキスト任意

rdp-cli android apps status --help

rdp-cli android touch#

新しいスクリーンショットを使って時間指定の完全なタッチ操作を送信します。

Android 対応の現行版が必要です。Windows(x64 / x86 / ARM64)、macOS(Apple silicon / Intel)、Linux(x86_64 / ARM64)から選べます。

--session SESSION が必須です。

コマンドのオプション
オプション形式と値指定条件
--kind

タッチジェスチャーの種類。

選択値
tap | double-tap | long-press | swipe | drag | pinch | gesture
必須
--x

リモートの x 座標

整数任意
--y

リモートの y 座標

整数任意
--to-x

終了 x 座標

整数任意
--to-y

終了 y 座標

整数任意
--second-x

2 本目の指の開始 X 座標。

整数任意
--second-y

2 本目の指の開始 Y 座標。

整数任意
--second-to-x

2 本目の指の終了 X 座標。

整数任意
--second-to-y

2 本目の指の終了 Y 座標。

整数任意
--duration-ms

操作時間 1–10000 ms。ドラッグには 400 ms の長押しを追加します。

正の整数任意
--events-stdin

標準入力から JSON 配列 [{at_ms,contact,phase,x,y}, …] を読み込みます。--kind gesture 専用です。

フラグ任意
--observation

新しいスクリーンショットの観測トークン

テキスト必須
--agent-id

制御を受け取る Agent

テキスト任意
--agent-ref

呼び出し元 Agent の認証情報参照

テキスト任意
--claim-ref

現在の操作権の参照

テキスト任意
--task

永続タスク ID

テキスト任意
--run

タスクの実行 ID

テキスト任意

rdp-cli android touch --help

rdp-cli android key#

制御権と新しい観察を使って Android システムキーを押します。

Android 対応の現行版が必要です。Windows(x64 / x86 / ARM64)、macOS(Apple silicon / Intel)、Linux(x86_64 / ARM64)から選べます。

--session SESSION が必須です。

コマンドのオプション
オプション形式と値指定条件
--key

キー名。android key は一覧のシステムキーを使います。

選択値
back | home | recent | enter | backspace
必須
--observation

新しいスクリーンショットの観測トークン

テキスト必須
--agent-id

制御を受け取る Agent

テキスト任意
--agent-ref

呼び出し元 Agent の認証情報参照

テキスト任意
--claim-ref

現在の操作権の参照

テキスト任意
--task

永続タスク ID

テキスト任意
--run

タスクの実行 ID

テキスト任意

rdp-cli android key --help

rdp-cli android text#

端末のクリップボードで Unicode を明示的に貼り付けます。

Android 対応の現行版が必要です。Windows(x64 / x86 / ARM64)、macOS(Apple silicon / Intel)、Linux(x86_64 / ARM64)から選べます。

--session SESSION が必須です。

コマンドのオプション
オプション形式と値指定条件
--method

明示的なテキスト方式:clipboard 貼り付け。

選択値
clipboard
必須
--text

Unicode 入力またはクリップボードの文字列

テキスト任意
--text-stdin

標準入力から EOF まで入力/クリップボードの文字列を読む

フラグ任意
--observation

新しいスクリーンショットの観測トークン

テキスト必須
--agent-id

制御を受け取る Agent

テキスト任意
--agent-ref

呼び出し元 Agent の認証情報参照

テキスト任意
--claim-ref

現在の操作権の参照

テキスト任意
--task

永続タスク ID

テキスト任意
--run

タスクの実行 ID

テキスト任意

rdp-cli android text --help

Linux デスクトップとアプリ

--protocol x11 と desktop または application を明示し、SSH の接続先を検証します。SSH クライアントとアプリ表示機能は内蔵です。既存の Wayland デスクトップには設定済みの RDP/VNC 接続先を使います。X11 に音声・マイク通路はありません。SFTP は許可されたディレクトリに限定され、リモートサービスはインストールしません。

rdp-cli linux targets#

サービスを起動せず、既存の Linux ディスプレイと対応する接続先を調べます。

セッションは必須ではありません。任意指定に対応する場合は下表に表示します。

コマンドのオプション
オプション形式と値指定条件
--host

RDP/VNC のホスト、または明示的な Android Wi-Fi エンドポイント。

テキスト必須
--user

ローカルまたはドメインのアカウント。RDP では必須

テキスト必須
--port

TCP ポート:RDP は 3389、VNC は 5900。android pair は端末のペア設定用ポート、ADB connect は別の接続用ポートを使用します。

正の整数
既定値: 22
任意
--ssh-known-hosts

ローカルの OpenSSH known_hosts ファイル。外部 SSH 実行ファイルは不要です。

パス任意
--ssh-host-key

別経路で確認した SSH SHA256 フィンガープリント。

テキスト任意
--ssh-key

ローカルの SSH 秘密鍵。パスワード入力でパスフレーズを渡します。

パス任意
--password

パスワード。従来型 VNC は先頭 8 UTF-8 バイトを使用

テキスト任意
--password-stdin

標準入力から EOF までパスワードを読む

フラグ任意
--credential-ref

既存のプラットフォーム資格情報ストアの参照

テキスト任意
--agent-id

制御を受け取る Agent

テキスト任意
--agent-ref

呼び出し元 Agent の認証情報参照

テキスト任意
--claim-ref

現在の操作権の参照

テキスト任意
--task

永続タスク ID

テキスト任意
--run

タスクの実行 ID

テキスト任意

rdp-cli linux targets --help

rdp-cli linux text#

文字を入力するか、明示的にリモートのクリップボードから貼り付けます。

--session SESSION が必須です。

コマンドのオプション
オプション形式と値指定条件
--method

明示的なテキスト方式:clipboard 貼り付け。

選択値
clipboard
必須
--keys

CTRL+S などのキーの組み合わせ

選択値
CTRL+V | CTRL+SHIFT+V | SHIFT+INSERT
既定値: CTRL+V
任意
--text

Unicode 入力またはクリップボードの文字列

テキスト任意
--text-stdin

標準入力から EOF まで入力/クリップボードの文字列を読む

フラグ任意
--observation

新しいスクリーンショットの観測トークン

テキスト必須
--agent-id

制御を受け取る Agent

テキスト任意
--agent-ref

呼び出し元 Agent の認証情報参照

テキスト任意
--claim-ref

現在の操作権の参照

テキスト任意
--task

永続タスク ID

テキスト任意
--run

タスクの実行 ID

テキスト任意

rdp-cli linux text --help

rdp-cli linux apps list#

このセッションで転送した X11 アプリのインスタンスを一覧表示します。

--session SESSION が必須です。

コマンドのオプション
オプション形式と値指定条件
--agent-id

制御を受け取る Agent

テキスト任意
--agent-ref

呼び出し元 Agent の認証情報参照

テキスト任意
--claim-ref

現在の操作権の参照

テキスト任意
--task

永続タスク ID

テキスト任意
--run

タスクの実行 ID

テキスト任意

rdp-cli linux apps list --help

rdp-cli linux apps stop#

明示的に選択したアプリのインスタンスを停止します。

--session SESSION が必須です。

コマンドのオプション
オプション形式と値指定条件
--instance

linux apps list が返した正確なインスタンス ID。

テキスト必須
--observation

新しいスクリーンショットの観測トークン

テキスト必須
--agent-id

制御を受け取る Agent

テキスト任意
--agent-ref

呼び出し元 Agent の認証情報参照

テキスト任意
--claim-ref

現在の操作権の参照

テキスト任意
--task

永続タスク ID

テキスト任意
--run

タスクの実行 ID

テキスト任意

rdp-cli linux apps stop --help

操作とイベント

operations status は operation ID または元の request ID で照会し、入力を再送しません。events はイベントを読み、--follow は継続、--after はカーソルから再開します。sent 後もアプリ上の結果を確認します。

rdp-cli operations status#

保持された操作結果を照会

--session SESSION が必須です。

コマンドのオプション
オプション形式と値指定条件
--operation-id

操作 ID

テキスト任意
--request-id

要求の関連付け/冪等 ID。operations status では元の要求を照会

テキスト任意
--agent-id

制御を受け取る Agent

テキスト任意
--agent-ref

呼び出し元 Agent の認証情報参照

テキスト任意
--claim-ref

現在の操作権の参照

テキスト任意
--task

永続タスク ID

テキスト任意
--run

タスクの実行 ID

テキスト任意

rdp-cli operations status --help

rdp-cli events#

イベントを読む・継続購読

--session SESSION が必須です。

コマンドのオプション
オプション形式と値指定条件
--follow

新しいイベントを継続して読む

フラグ任意
--after

このシーケンスより後のイベントまたは PCM サンプルを返します。

テキスト任意
--agent-id

制御を受け取る Agent

テキスト任意
--agent-ref

呼び出し元 Agent の認証情報参照

テキスト任意
--claim-ref

現在の操作権の参照

テキスト任意
--task

永続タスク ID

テキスト任意
--run

タスクの実行 ID

テキスト任意

rdp-cli events --help

信頼・認証情報・導入

trust はstrictモードで正確なRDP接続先と指紋を関連付けます。credentials remove は指定された製品の認証情報だけを削除します。macOS と Linux の install-cli/uninstall-cli は CLI 入口を管理し、--prefix で配置先を選びます。Windows はダウンロードした実行ファイルを使います。presence show --panel は macOS と Linux のセッションパネルを開きます。licenses は第三者のバージョンとライセンスを表示します。

rdp-cli trust list#

RDP証明書の信頼記録を表示

セッションは必須ではありません。任意指定に対応する場合は下表に表示します。

コマンドのオプション
オプション形式と値指定条件
--agent-id

制御を受け取る Agent

テキスト任意
--agent-ref

呼び出し元 Agent の認証情報参照

テキスト任意
--claim-ref

現在の操作権の参照

テキスト任意
--task

永続タスク ID

テキスト任意
--run

タスクの実行 ID

テキスト任意

rdp-cli trust list --help

rdp-cli trust add#

接続先の指紋を信頼

セッションは必須ではありません。任意指定に対応する場合は下表に表示します。

コマンドのオプション
オプション形式と値指定条件
--target

RDP の信頼対象

テキスト必須
--fingerprint

証明書のフィンガープリント

テキスト必須
--agent-id

制御を受け取る Agent

テキスト任意
--agent-ref

呼び出し元 Agent の認証情報参照

テキスト任意
--claim-ref

現在の操作権の参照

テキスト任意
--task

永続タスク ID

テキスト任意
--run

タスクの実行 ID

テキスト任意

rdp-cli trust add --help

rdp-cli trust remove#

接続先の信頼記録を削除

セッションは必須ではありません。任意指定に対応する場合は下表に表示します。

コマンドのオプション
オプション形式と値指定条件
--target

RDP の信頼対象

テキスト必須
--agent-id

制御を受け取る Agent

テキスト任意
--agent-ref

呼び出し元 Agent の認証情報参照

テキスト任意
--claim-ref

現在の操作権の参照

テキスト任意
--task

永続タスク ID

テキスト任意
--run

タスクの実行 ID

テキスト任意

rdp-cli trust remove --help

rdp-cli credentials remove#

製品の認証情報を削除

セッションは必須ではありません。任意指定に対応する場合は下表に表示します。

コマンドのオプション
オプション形式と値指定条件
--reference

削除する資格情報ストアの参照

テキスト必須
--agent-id

制御を受け取る Agent

テキスト任意
--agent-ref

呼び出し元 Agent の認証情報参照

テキスト任意
--claim-ref

現在の操作権の参照

テキスト任意
--task

永続タスク ID

テキスト任意
--run

タスクの実行 ID

テキスト任意

rdp-cli credentials remove --help

rdp-cli install-cli#

macOS または Linux の CLI 入口をインストール

セッションは必須ではありません。任意指定に対応する場合は下表に表示します。

コマンドのオプション
オプション形式と値指定条件
--prefix

ユーザーが管理できるインストール先プレフィックス

パス任意
--agent-id

制御を受け取る Agent

テキスト任意
--agent-ref

呼び出し元 Agent の認証情報参照

テキスト任意
--claim-ref

現在の操作権の参照

テキスト任意
--task

永続タスク ID

テキスト任意
--run

タスクの実行 ID

テキスト任意

rdp-cli install-cli --help

rdp-cli uninstall-cli#

作成したCLI入口を削除

セッションは必須ではありません。任意指定に対応する場合は下表に表示します。

コマンドのオプション
オプション形式と値指定条件
--agent-id

制御を受け取る Agent

テキスト任意
--agent-ref

呼び出し元 Agent の認証情報参照

テキスト任意
--claim-ref

現在の操作権の参照

テキスト任意
--task

永続タスク ID

テキスト任意
--run

タスクの実行 ID

テキスト任意

rdp-cli uninstall-cli --help

rdp-cli licenses#

第三者のバージョンとライセンスを表示

セッションは必須ではありません。任意指定に対応する場合は下表に表示します。

コマンドのオプション
オプション形式と値指定条件
--agent-id

制御を受け取る Agent

テキスト任意
--agent-ref

呼び出し元 Agent の認証情報参照

テキスト任意
--claim-ref

現在の操作権の参照

テキスト任意
--task

永続タスク ID

テキスト任意
--run

タスクの実行 ID

テキスト任意

rdp-cli licenses --help

Agent のタスクと自動化

領域の撮影と画像比較、条件付き待機、バッチ操作、永続タスクのレポート、複数 Agent の連携、MCP・接続プロファイル・診断、Android 仮想画面を追加しました。

rdp-cli tasks create#

永続タスクを作成する

セッションは必須ではありません。任意指定に対応する場合は下表に表示します。

コマンドのオプション
オプション形式と値指定条件
--title

タスク名

テキスト必須
--session

明示的なセッション ID

テキスト任意
--record-frames

スクリーンショットのキーフレームを明示的に保存

フラグ任意
--agent-id

制御を受け取る Agent

テキスト任意
--agent-ref

呼び出し元 Agent の認証情報参照

テキスト任意
--claim-ref

現在の操作権の参照

テキスト任意
--task

永続タスク ID

テキスト任意
--run

タスクの実行 ID

テキスト任意

rdp-cli tasks create --help

rdp-cli tasks list#

アクセス可能なタスクを一覧表示する

セッションは必須ではありません。任意指定に対応する場合は下表に表示します。

コマンドのオプション
オプション形式と値指定条件
--agent-id

制御を受け取る Agent

テキスト任意
--agent-ref

呼び出し元 Agent の認証情報参照

テキスト任意
--claim-ref

現在の操作権の参照

テキスト任意
--task

永続タスク ID

テキスト任意
--run

タスクの実行 ID

テキスト任意

rdp-cli tasks list --help

rdp-cli tasks status#

タスクの進行状況と履歴を読む

セッションは必須ではありません。任意指定に対応する場合は下表に表示します。

コマンドのオプション
オプション形式と値指定条件
--task

永続タスク ID

テキスト必須
--agent-id

制御を受け取る Agent

テキスト任意
--agent-ref

呼び出し元 Agent の認証情報参照

テキスト任意
--claim-ref

現在の操作権の参照

テキスト任意
--run

タスクの実行 ID

テキスト任意

rdp-cli tasks status --help

rdp-cli tasks attach#

認可済みセッションをタスクに関連付ける

--session SESSION が必須です。

コマンドのオプション
オプション形式と値指定条件
--task

永続タスク ID

テキスト必須
--agent-id

制御を受け取る Agent

テキスト任意
--agent-ref

呼び出し元 Agent の認証情報参照

テキスト任意
--claim-ref

現在の操作権の参照

テキスト任意
--run

タスクの実行 ID

テキスト任意

rdp-cli tasks attach --help

rdp-cli tasks checkpoint#

入力を再実行せずチェックポイントを保存する

セッションは必須ではありません。任意指定に対応する場合は下表に表示します。

コマンドのオプション
オプション形式と値指定条件
--task

永続タスク ID

テキスト必須
--note

秘密情報を含めない進行メモ

テキスト必須
--agent-id

制御を受け取る Agent

テキスト任意
--agent-ref

呼び出し元 Agent の認証情報参照

テキスト任意
--claim-ref

現在の操作権の参照

テキスト任意
--run

タスクの実行 ID

テキスト任意

rdp-cli tasks checkpoint --help

rdp-cli tasks new-run#

チェックポイントから新しい実行を始める

--session SESSION が必須です。

コマンドのオプション
オプション形式と値指定条件
--task

永続タスク ID

テキスト必須
--from-checkpoint

既存チェックポイント ID

テキスト必須
--agent-id

制御を受け取る Agent

テキスト任意
--agent-ref

呼び出し元 Agent の認証情報参照

テキスト任意
--claim-ref

現在の操作権の参照

テキスト任意
--run

タスクの実行 ID

テキスト任意

rdp-cli tasks new-run --help

rdp-cli tasks grants list#

タスクの権限を一覧表示する

セッションは必須ではありません。任意指定に対応する場合は下表に表示します。

コマンドのオプション
オプション形式と値指定条件
--task

永続タスク ID

テキスト必須
--agent-id

制御を受け取る Agent

テキスト任意
--agent-ref

呼び出し元 Agent の認証情報参照

テキスト任意
--claim-ref

現在の操作権の参照

テキスト任意
--run

タスクの実行 ID

テキスト任意

rdp-cli tasks grants list --help

rdp-cli tasks grants grant#

タスクの権限を付与する

セッションは必須ではありません。任意指定に対応する場合は下表に表示します。

コマンドのオプション
オプション形式と値指定条件
--task

永続タスク ID

テキスト必須
--to-agent

対象 Agent の識別情報

テキスト必須
--permission

アクセストークンに付与する権限

テキスト必須 · 繰り返し可
--agent-id

制御を受け取る Agent

テキスト任意
--agent-ref

呼び出し元 Agent の認証情報参照

テキスト任意
--claim-ref

現在の操作権の参照

テキスト任意
--run

タスクの実行 ID

テキスト任意

rdp-cli tasks grants grant --help

rdp-cli tasks grants revoke#

今後のタスクへのアクセスを取り消す

セッションは必須ではありません。任意指定に対応する場合は下表に表示します。

コマンドのオプション
オプション形式と値指定条件
--task

永続タスク ID

テキスト必須
--to-agent

対象 Agent の識別情報

テキスト必須
--agent-id

制御を受け取る Agent

テキスト任意
--agent-ref

呼び出し元 Agent の認証情報参照

テキスト任意
--claim-ref

現在の操作権の参照

テキスト任意
--run

タスクの実行 ID

テキスト任意

rdp-cli tasks grants revoke --help

rdp-cli tasks evidence#

選択したローカル証拠を保存する

セッションは必須ではありません。任意指定に対応する場合は下表に表示します。

コマンドのオプション
オプション形式と値指定条件
--task

永続タスク ID

テキスト必須
--file

ローカル証拠ファイル、最大 4 MiB

パス必須
--agent-id

制御を受け取る Agent

テキスト任意
--agent-ref

呼び出し元 Agent の認証情報参照

テキスト任意
--claim-ref

現在の操作権の参照

テキスト任意
--run

タスクの実行 ID

テキスト任意

rdp-cli tasks evidence --help

rdp-cli tasks export#

オフラインの JSON または HTML レポートを出力する

セッションは必須ではありません。任意指定に対応する場合は下表に表示します。

コマンドのオプション
オプション形式と値指定条件
--task

永続タスク ID

テキスト必須
--out

保存先の PNG ファイル

パス必須
--format

出力形式。このコマンドの許容値を参照

選択値
json | html
既定値: json
任意
--include-evidence

明示的に保存した証拠を含める

フラグ任意
--agent-id

制御を受け取る Agent

テキスト任意
--agent-ref

呼び出し元 Agent の認証情報参照

テキスト任意
--claim-ref

現在の操作権の参照

テキスト任意
--run

タスクの実行 ID

テキスト任意

rdp-cli tasks export --help

rdp-cli tasks purge#

選択したローカル履歴を削除する

セッションは必須ではありません。任意指定に対応する場合は下表に表示します。

コマンドのオプション
オプション形式と値指定条件
--task

永続タスク ID

テキスト必須
--agent-id

制御を受け取る Agent

テキスト任意
--agent-ref

呼び出し元 Agent の認証情報参照

テキスト任意
--claim-ref

現在の操作権の参照

テキスト任意
--run

タスクの実行 ID

テキスト任意

rdp-cli tasks purge --help

rdp-cli agents register#

Agent の識別情報を登録する

セッションは必須ではありません。任意指定に対応する場合は下表に表示します。

コマンドのオプション
オプション形式と値指定条件
--name

読みやすいセッション名

テキスト必須
--agent-id

制御を受け取る Agent

テキスト任意
--agent-ref

呼び出し元 Agent の認証情報参照

テキスト任意
--claim-ref

現在の操作権の参照

テキスト任意
--task

永続タスク ID

テキスト任意
--run

タスクの実行 ID

テキスト任意

rdp-cli agents register --help

rdp-cli agents list#

秘密情報を含めず Agent を一覧表示する

セッションは必須ではありません。任意指定に対応する場合は下表に表示します。

コマンドのオプション
オプション形式と値指定条件
--agent-id

制御を受け取る Agent

テキスト任意
--agent-ref

呼び出し元 Agent の認証情報参照

テキスト任意
--claim-ref

現在の操作権の参照

テキスト任意
--task

永続タスク ID

テキスト任意
--run

タスクの実行 ID

テキスト任意

rdp-cli agents list --help

rdp-cli agents show#

Agent の識別情報と権限を読む

セッションは必須ではありません。任意指定に対応する場合は下表に表示します。

コマンドのオプション
オプション形式と値指定条件
--id

対象の識別情報

テキスト必須
--agent-id

制御を受け取る Agent

テキスト任意
--agent-ref

呼び出し元 Agent の認証情報参照

テキスト任意
--claim-ref

現在の操作権の参照

テキスト任意
--task

永続タスク ID

テキスト任意
--run

タスクの実行 ID

テキスト任意

rdp-cli agents show --help

rdp-cli agents revoke#

Agent の登録と操作権を取り消す

セッションは必須ではありません。任意指定に対応する場合は下表に表示します。

コマンドのオプション
オプション形式と値指定条件
--id

対象の識別情報

テキスト必須
--agent-id

制御を受け取る Agent

テキスト任意
--agent-ref

呼び出し元 Agent の認証情報参照

テキスト任意
--claim-ref

現在の操作権の参照

テキスト任意
--task

永続タスク ID

テキスト任意
--run

タスクの実行 ID

テキスト任意

rdp-cli agents revoke --help

rdp-cli agents grant#

Agent にセッションへのアクセスを許可する

--session SESSION が必須です。

コマンドのオプション
オプション形式と値指定条件
--id

対象の識別情報

テキスト必須
--permission

アクセストークンに付与する権限

テキスト必須 · 繰り返し可
--agent-id

制御を受け取る Agent

テキスト任意
--agent-ref

呼び出し元 Agent の認証情報参照

テキスト任意
--claim-ref

現在の操作権の参照

テキスト任意
--task

永続タスク ID

テキスト任意
--run

タスクの実行 ID

テキスト任意

rdp-cli agents grant --help

rdp-cli agents revoke-access#

Agent のセッション権限を取り消す

--session SESSION が必須です。

コマンドのオプション
オプション形式と値指定条件
--id

対象の識別情報

テキスト必須
--agent-id

制御を受け取る Agent

テキスト任意
--agent-ref

呼び出し元 Agent の認証情報参照

テキスト任意
--claim-ref

現在の操作権の参照

テキスト任意
--task

永続タスク ID

テキスト任意
--run

タスクの実行 ID

テキスト任意

rdp-cli agents revoke-access --help

rdp-cli control claim#

指定 Agent が一時停止中のセッションを取得する

--session SESSION が必須です。

コマンドのオプション
オプション形式と値指定条件
--lease-seconds

操作権の有効期間、秒

正の整数
既定値: 60
任意
--agent-id

制御を受け取る Agent

テキスト任意
--agent-ref

呼び出し元 Agent の認証情報参照

テキスト任意
--claim-ref

現在の操作権の参照

テキスト任意
--task

永続タスク ID

テキスト任意
--run

タスクの実行 ID

テキスト任意

rdp-cli control claim --help

rdp-cli control renew#

有効な操作権の期限を延長する

--session SESSION が必須です。

コマンドのオプション
オプション形式と値指定条件
--lease-seconds

操作権の有効期間、秒

正の整数
既定値: 60
任意
--agent-id

制御を受け取る Agent

テキスト任意
--agent-ref

呼び出し元 Agent の認証情報参照

テキスト任意
--claim-ref

現在の操作権の参照

テキスト任意
--task

永続タスク ID

テキスト任意
--run

タスクの実行 ID

テキスト任意

rdp-cli control renew --help

rdp-cli control unclaim#

操作権を解放してセッションを一時停止する

--session SESSION が必須です。

コマンドのオプション
オプション形式と値指定条件
--agent-id

制御を受け取る Agent

テキスト任意
--agent-ref

呼び出し元 Agent の認証情報参照

テキスト任意
--claim-ref

現在の操作権の参照

テキスト任意
--task

永続タスク ID

テキスト任意
--run

タスクの実行 ID

テキスト任意

rdp-cli control unclaim --help

rdp-cli control claim-status#

現在の操作権を確認する

--session SESSION が必須です。

コマンドのオプション
オプション形式と値指定条件
--agent-id

制御を受け取る Agent

テキスト任意
--agent-ref

呼び出し元 Agent の認証情報参照

テキスト任意
--claim-ref

現在の操作権の参照

テキスト任意
--task

永続タスク ID

テキスト任意
--run

タスクの実行 ID

テキスト任意

rdp-cli control claim-status --help

rdp-cli control handoff#

認可済み Agent に操作権を渡す

--session SESSION が必須です。

コマンドのオプション
オプション形式と値指定条件
--to-agent

対象 Agent の識別情報

テキスト必須
--lease-seconds

操作権の有効期間、秒

正の整数
既定値: 60
任意
--agent-id

制御を受け取る Agent

テキスト任意
--agent-ref

呼び出し元 Agent の認証情報参照

テキスト任意
--claim-ref

現在の操作権の参照

テキスト任意
--task

永続タスク ID

テキスト任意
--run

タスクの実行 ID

テキスト任意

rdp-cli control handoff --help

rdp-cli profiles list#

接続プロファイルを一覧表示する

セッションは必須ではありません。任意指定に対応する場合は下表に表示します。

コマンドのオプション
オプション形式と値指定条件
--agent-id

制御を受け取る Agent

テキスト任意
--agent-ref

呼び出し元 Agent の認証情報参照

テキスト任意
--claim-ref

現在の操作権の参照

テキスト任意
--task

永続タスク ID

テキスト任意
--run

タスクの実行 ID

テキスト任意

rdp-cli profiles list --help

rdp-cli profiles show#

プロファイルとパラメータの出所を読む

セッションは必須ではありません。任意指定に対応する場合は下表に表示します。

コマンドのオプション
オプション形式と値指定条件
--name

読みやすいセッション名

テキスト必須
--agent-id

制御を受け取る Agent

テキスト任意
--agent-ref

呼び出し元 Agent の認証情報参照

テキスト任意
--claim-ref

現在の操作権の参照

テキスト任意
--task

永続タスク ID

テキスト任意
--run

タスクの実行 ID

テキスト任意

rdp-cli profiles show --help

rdp-cli profiles save#

認証情報の参照を含むプロファイルを保存する

セッションは必須ではありません。任意指定に対応する場合は下表に表示します。

コマンドのオプション
オプション形式と値指定条件
--json

このコマンド用のバージョン付き JSON

テキスト必須
--replace

インストール済みアプリを明示的に置換します。

フラグ任意
--agent-id

制御を受け取る Agent

テキスト任意
--agent-ref

呼び出し元 Agent の認証情報参照

テキスト任意
--claim-ref

現在の操作権の参照

テキスト任意
--task

永続タスク ID

テキスト任意
--run

タスクの実行 ID

テキスト任意

rdp-cli profiles save --help

rdp-cli profiles remove#

認証情報を残してプロファイルを削除する

セッションは必須ではありません。任意指定に対応する場合は下表に表示します。

コマンドのオプション
オプション形式と値指定条件
--name

読みやすいセッション名

テキスト必須
--agent-id

制御を受け取る Agent

テキスト任意
--agent-ref

呼び出し元 Agent の認証情報参照

テキスト任意
--claim-ref

現在の操作権の参照

テキスト任意
--task

永続タスク ID

テキスト任意
--run

タスクの実行 ID

テキスト任意

rdp-cli profiles remove --help

rdp-cli profiles export#

秘密情報を含めずプロファイルを出力する

セッションは必須ではありません。任意指定に対応する場合は下表に表示します。

コマンドのオプション
オプション形式と値指定条件
--name

読みやすいセッション名

テキスト必須
--agent-id

制御を受け取る Agent

テキスト任意
--agent-ref

呼び出し元 Agent の認証情報参照

テキスト任意
--claim-ref

現在の操作権の参照

テキスト任意
--task

永続タスク ID

テキスト任意
--run

タスクの実行 ID

テキスト任意

rdp-cli profiles export --help

rdp-cli profiles import#

接続せずにプロファイルを取り込む

セッションは必須ではありません。任意指定に対応する場合は下表に表示します。

コマンドのオプション
オプション形式と値指定条件
--json

このコマンド用のバージョン付き JSON

テキスト必須
--replace

インストール済みアプリを明示的に置換します。

フラグ任意
--agent-id

制御を受け取る Agent

テキスト任意
--agent-ref

呼び出し元 Agent の認証情報参照

テキスト任意
--claim-ref

現在の操作権の参照

テキスト任意
--task

永続タスク ID

テキスト任意
--run

タスクの実行 ID

テキスト任意

rdp-cli profiles import --help

rdp-cli doctor#

機能を診断する。接続試験は明示的に指定する

セッションは必須ではありません。任意指定に対応する場合は下表に表示します。

コマンドのオプション
オプション形式と値指定条件
--session

明示的なセッション ID

テキスト任意
--profile

保存済み接続プロファイル

テキスト任意
--probe

プロファイルで一時接続を明示的に作成

フラグ任意
--redact

対象名、アドレス、セッション ID を省略

フラグ任意
--agent-id

制御を受け取る Agent

テキスト任意
--agent-ref

呼び出し元 Agent の認証情報参照

テキスト任意
--claim-ref

現在の操作権の参照

テキスト任意
--task

永続タスク ID

テキスト任意
--run

タスクの実行 ID

テキスト任意

rdp-cli doctor --help

rdp-cli doctor status#

診断結果を読む

セッションは必須ではありません。任意指定に対応する場合は下表に表示します。

コマンドのオプション
オプション形式と値指定条件
--diagnostic-id

元の診断リクエスト ID

テキスト必須
--agent-id

制御を受け取る Agent

テキスト任意
--agent-ref

呼び出し元 Agent の認証情報参照

テキスト任意
--claim-ref

現在の操作権の参照

テキスト任意
--task

永続タスク ID

テキスト任意
--run

タスクの実行 ID

テキスト任意

rdp-cli doctor status --help

rdp-cli doctor cancel#

以降の診断を取り消す

セッションは必須ではありません。任意指定に対応する場合は下表に表示します。

コマンドのオプション
オプション形式と値指定条件
--diagnostic-id

元の診断リクエスト ID

テキスト必須
--agent-id

制御を受け取る Agent

テキスト任意
--agent-ref

呼び出し元 Agent の認証情報参照

テキスト任意
--claim-ref

現在の操作権の参照

テキスト任意
--task

永続タスク ID

テキスト任意
--run

タスクの実行 ID

テキスト任意

rdp-cli doctor cancel --help

rdp-cli wait#

画面または状態が条件を満たすまで待つ

--session SESSION が必須です。

コマンドのオプション
オプション形式と値指定条件
--condition

待機条件

選択値
changed | stable | connection | transfer | operation
必須
--region

遠隔画面のピクセル領域 x,y,width,height

テキスト任意
--state

列挙されたキー状態または消音状態

テキスト任意
--transfer-id

転送 ID。files status では省略するとセッションの転送一覧

テキスト任意
--operation-id

操作 ID

テキスト任意
--sample-ms

サンプリング間隔、ミリ秒

正の整数
既定値: 100
任意
--stable-ms

必要な連続安定時間、ミリ秒

正の整数
既定値: 1000
任意
--threshold-permille

変化ピクセルの割合、千分率

整数
既定値: 10
任意
--pixel-delta

無視する RGB チャンネル差

整数
既定値: 8
任意
--max-frame-age-ms

許容するフレームの最大経過時間、ミリ秒

正の整数
既定値: 5000
任意
--agent-id

制御を受け取る Agent

テキスト任意
--agent-ref

呼び出し元 Agent の認証情報参照

テキスト任意
--claim-ref

現在の操作権の参照

テキスト任意
--task

永続タスク ID

テキスト任意
--run

タスクの実行 ID

テキスト任意

rdp-cli wait --help

rdp-cli wait status#

待機結果を読む

--session SESSION が必須です。

コマンドのオプション
オプション形式と値指定条件
--wait-id

元の待機リクエスト ID

テキスト必須
--agent-id

制御を受け取る Agent

テキスト任意
--agent-ref

呼び出し元 Agent の認証情報参照

テキスト任意
--claim-ref

現在の操作権の参照

テキスト任意
--task

永続タスク ID

テキスト任意
--run

タスクの実行 ID

テキスト任意

rdp-cli wait status --help

rdp-cli wait cancel#

対象操作を止めず待機だけを取り消す

--session SESSION が必須です。

コマンドのオプション
オプション形式と値指定条件
--wait-id

元の待機リクエスト ID

テキスト必須
--agent-id

制御を受け取る Agent

テキスト任意
--agent-ref

呼び出し元 Agent の認証情報参照

テキスト任意
--claim-ref

現在の操作権の参照

テキスト任意
--task

永続タスク ID

テキスト任意
--run

タスクの実行 ID

テキスト任意

rdp-cli wait cancel --help

rdp-cli batch#

事前検証後に最大 64 ステップを順次実行する

--session SESSION が必須です。

コマンドのオプション
オプション形式と値指定条件
--json

このコマンド用のバージョン付き JSON

テキスト任意
--steps-stdin

標準入力からバッチ JSON を読む

フラグ任意
--agent-id

制御を受け取る Agent

テキスト任意
--agent-ref

呼び出し元 Agent の認証情報参照

テキスト任意
--claim-ref

現在の操作権の参照

テキスト任意
--task

永続タスク ID

テキスト任意
--run

タスクの実行 ID

テキスト任意

rdp-cli batch --help

rdp-cli batch status#

再実行せずバッチ結果を読む

--session SESSION が必須です。

コマンドのオプション
オプション形式と値指定条件
--batch-id

元のバッチリクエスト ID

テキスト必須
--agent-id

制御を受け取る Agent

テキスト任意
--agent-ref

呼び出し元 Agent の認証情報参照

テキスト任意
--claim-ref

現在の操作権の参照

テキスト任意
--task

永続タスク ID

テキスト任意
--run

タスクの実行 ID

テキスト任意

rdp-cli batch status --help

rdp-cli batch cancel#

未実行のバッチステップを取り消す

--session SESSION が必須です。

コマンドのオプション
オプション形式と値指定条件
--batch-id

元のバッチリクエスト ID

テキスト必須
--agent-id

制御を受け取る Agent

テキスト任意
--agent-ref

呼び出し元 Agent の認証情報参照

テキスト任意
--claim-ref

現在の操作権の参照

テキスト任意
--task

永続タスク ID

テキスト任意
--run

タスクの実行 ID

テキスト任意

rdp-cli batch cancel --help

rdp-cli operations cancel#

残りの入力を取り消す。送信済み入力は戻さない

--session SESSION が必須です。

コマンドのオプション
オプション形式と値指定条件
--operation-id

操作 ID

テキスト任意
--agent-id

制御を受け取る Agent

テキスト任意
--agent-ref

呼び出し元 Agent の認証情報参照

テキスト任意
--claim-ref

現在の操作権の参照

テキスト任意
--task

永続タスク ID

テキスト任意
--run

タスクの実行 ID

テキスト任意

rdp-cli operations cancel --help

rdp-cli mcp stdio#

標準入出力で MCP を提供する

セッションは必須ではありません。任意指定に対応する場合は下表に表示します。

コマンドのオプション
オプション形式と値指定条件
--agent-id

制御を受け取る Agent

テキスト任意
--agent-ref

呼び出し元 Agent の認証情報参照

テキスト任意
--claim-ref

現在の操作権の参照

テキスト任意
--task

永続タスク ID

テキスト任意
--run

タスクの実行 ID

テキスト任意

rdp-cli mcp stdio --help

プロトコルと環境の条件

  • RDP の既定値は --cert-policy ignore と --tls-profile modern です。TLS 1.2 サーバーでも古い署名や暗号が必要な場合があります。既知の旧式接続先では、認証情報と証明書ポリシーを維持し、新しいリクエスト ID で --tls-profile legacy を明示して一度だけ再試行します。reconnect は選択した設定を保持し、自動降格はしません。strict は証明書の信頼と名前を検証します。Web HTTPS には影響しません。
  • VNC の安全性は選択した方式によります。従来の VNC は暗号化されないため、信頼できるネットワークか VPN を使用してください。VeNCrypt X509Plain は TLS と証明書検証を使用します。 暗号化 VNC:--vnc-security x509-plain には --user、パスワード入力、別経路で確認した --vnc-tls-pin が必要です。従来の VNC は --user を受け付けません。RDP の --domain、--size、--layout は使用できません。
  • VNC はファイル、音声、マイク、能動的な画面構成変更に非対応です。UTF-8クリップボードは交渉が必要で、それ以外はLatin-1のみです。
  • RDPファイルにはドライブリダイレクトが必要です。音声、クリップボード、マイク、複数画面もサーバーポリシーに依存します。
  • Windows/macOS はネイティブ表示と状態入口を提供します。Linux は画面・音声サービス、認証情報保存には Secret Service が必要です。デスクトップのないホストでも対応CLI操作は利用できます。
  • Unicode入力は互換性のため間隔を空けて送信します。長文ではタイムアウトを調整して結果を確認してください。ビューアーを開いても全サーバー・全文字の入力は保証されません。
  • Android 12 以上が必要です。実機検証は Pixel 3 / Android 12 です。テキスト貼り付けはスマートフォンのクリップボードを書き換えます。再生音の取得にはシステムの共有許可が必要で、アプリの録音制限に従います。マイクは別の音源です。接続時や再接続後に録音は自動開始されません。
  • macOS の画面共有には --user で Mac のアカウント名を指定し、そのパスワードを渡します。ARD 認証が自動選択され、--vnc-security ard でも指定できます。別途設定した VNC パスワードを使う場合は --vnc-security vnc-auth を指定し、--user は付けません。ARD は画面データを暗号化しないため、信頼できるネットワークまたは VPN を使用してください。

エラーからの復旧

OBSERVATION_REQUIRED / INVALID_COORDINATES
再撮影し、画面構成と座標を確認します。
SESSION_PAUSED / CONTROL_HELD_BY_HUMAN
入力を止め、人が明示的にAgentへ返すまで待ちます。
AUTH_FAILED / VNC_AUTH_FAILED
アカウント、パスワードの渡し方、サーバーポリシーを確認します。
RDP_TLS_HANDSHAKE_FAILED / CERTIFICATE_UNTRUSTED
RDP_TLS_HANDSHAKE_FAILED:選択した設定とサーバーの暗号方式を確認します。古い TLS やパスワード誤りの証拠ではありません。既知の旧式接続先なら --tls-profile legacy と新しいリクエスト ID で connect を一度再試行します。CERTIFICATE_UNTRUSTED:証明書の信頼、名前、実際の指紋を検証します。TLS 設定の変更では証明書の信頼は解決しません。
CAPABILITY_UNAVAILABLE / CLIPBOARD_ENCODING_UNSUPPORTED
機能または文字コードを確認し、対応する操作を選びます。
REQUEST_TIMEOUT / REQUEST_ID_CONFLICT / REQUEST_WINDOW_EXPIRED
再試行前に操作と画面を確認します。別の引数や保持期限後に同じIDでの重複排除を期待しません。