本文へスキップ

ドキュメント コマンドライン コマンドライン

コマンド一覧

vmpalはVMPalのコマンドラインツールで、dockerやghと同じように使えます。このページでは、すべてのコマンドを簡単に紹介してから、知っておきたいルールを説明します。コマンドのオプションはvmpal help <command>で、ガイドはvmpal help <topic>で確認できます。

表中の<VM>は、VMの名前、ID(先頭の4文字以上でも可)、または.vmpalフォルダのパスです。これらはvmpal listで確認できます。

AIエージェントに頼む

ここにある操作は、すべてAIエージェントに任せられます。VMPalはすべてのコマンドのヘルプとガイドをエージェントに渡すので、エージェントはコマンドを書くことも、実行することもできます。エージェントをVMPalに接続してから、たとえば次のように頼みます。

  • 「WindowsのVMにフォルダをコピーするvmpalコマンドはどれ?」
  • 「UbuntuのVMをクローンして、そのクローンでテストを実行してから削除して。」

VM

コマンド 動作
vmpal list VMと、それぞれの状態を一覧表示します
vmpal info <VM> 1台のVMの詳細をすべて表示します
vmpal systems インストールできるシステムをIDとともに一覧表示します。“ターミナルのみ”にできるシステムもわかります
vmpal create <system> --wait VMを作成し、インストールが終わってコマンドを実行できるようになるまで待ちます
vmpal create --file <path> システムIDの代わりに、IPSWまたはISOファイルからインストールします
vmpal create <system> --terminal-only デスクトップなしでLinuxをインストールします
vmpal create <system> --password-file <path> 新しいVMのパスワードを、自分だけが読めるファイルに書き込みます
vmpal clone <VM> シャットダウンしたVMをクローンします。クローンはすぐに使えます
vmpal clone <VM> --shut-down 先にVMをシャットダウンしてから、クローンします
vmpal clone <VM> --start --wait クローンを起動し、コマンドを実行できるようになるまで待ちます
vmpal set <VM> --cpus 4 --memory 8 ハードウェア、共有フォルダ、ポート、ネットワーク、サインインなど、VMの設定を変更します。すべての設定はvmpal help setで確認できます
vmpal set <VM> --display 1440x900@2x どの画面でも、バックグラウンドでも、VMのディスプレイを指定したサイズ(ポイント単位)とスケール(1xまたは2x)に固定します。ウインドウには収まるように拡大・縮小して表示され、クローンにも引き継がれます。UIテストやスクリーンショットに使います。windowを指定すると、再びウインドウに追従します
vmpal set <VM> --render-scale 75 WindowsのVMのディスプレイを、ウインドウの各辺の75%または50%で描画し、MetalFXで拡大します。値が低いほど、GPUがボトルネックになっているゲームは速くなりますが、画面はぼやけます。100で元のサイズに戻ります
vmpal set <VM> --user <name> VM内のアカウント名をVMPalに伝えます。VMPalが作成していないアカウントや、VM内で名前を変えたアカウントに使います。VM内では何も名前を変更しません
vmpal delete <VM> VMをゴミ箱に移動します
vmpal delete <VM> --force 実行中のVMの電源を先にオフにしてから、ゴミ箱に移動します
vmpal delete <VM> --permanently ゴミ箱を使わずに、完全に削除します
vmpal import <path> 別のMacの.vmpalvmファイル、またはParallelsのVMを読み込みます。.vmpalフォルダは、その場所のまま追加されます
vmpal move <VM> <location> シャットダウンしたVMを、VMPalの別の場所に移動します。--waitを付けると、移動が終わるまで待ちます
vmpal compress <VM> 別のMacに移せるように、VMを.vmpalvmファイルにまとめます。--outputで指定しない限り、デスクトップに保存されます
vmpal cancel <VM> VMのダウンロードまたは移動を中止します
vmpal cancel 進行中の読み込みまたは圧縮を中止します

createのそのほかのオプションはvmpal help createで確認できます。--name、--cpus、--memory、--disk、--location、--user、Linux用の--install-updates、Windows用の--sign-in-automatically、--start-at-login、--no-agent-controlがあります。

CPU、メモリ、GPUなど一部の設定は、VMをシャットダウンして再び起動するまで反映されません。vmpal restart <VM> --apply-settingsを使うと、これを自動で行います。

電源

コマンド 動作
vmpal start <VM> --wait VMを起動し、コマンドを実行できるようになるまで待ちます
vmpal start <VM> --background ウインドウを開かずに起動します。ウインドウはvmpal showで開けます
vmpal start <VM> --recovery macOSのVMをmacOS復旧で起動します
vmpal stop <VM> シャットダウンします
vmpal stop <VM> --force 電源プラグを抜くように、すぐに電源をオフにします
vmpal pause <VM> 実行中のVMを一時停止します
vmpal resume <VM> 一時停止したVMを再開します
vmpal suspend <VM> セッションをディスクに保存して閉じます。vmpal startで中断したところから再開します
vmpal restart <VM> VM内のシステムを再起動します
vmpal restart <VM> --apply-settings 再起動が必要な設定を反映するために、シャットダウンしてから再び起動します
vmpal restart <VM> --reset リセットボタンを押したように、すぐに再起動します
vmpal show <VM> 実行中のVMのウインドウを最前面に表示します
vmpal show <VM> --apps-on-mac 表示 › WindowsアプリをMacで実行と同じく、WindowsのVMのアプリを1つずつMacのウインドウとして表示します。GPUアクセラレーションを使うLinuxのVMでも、表示 › LinuxアプリをMacで実行と同じように動作します。次回からVMはこの表示で開きます
vmpal show <VM> --window アプリの代わりに、VMのウインドウに戻します
vmpal wait <VM> コマンドを実行できるようになるまで待ちます。デフォルトでは10分で打ち切ります
vmpal wait <VM> --until stopped 代わりにstoppedになるまで待ちます。--untilにはrunningとinstalledも指定できます

待機の上限は、start、stop、clone --startが5分、start --wait、clone --start --wait、restart --wait、waitが10分です。create --wait、move --wait、compress --waitは2時間で打ち切ります。--timeoutを使うと、別の上限を最大24時間まで指定できます。

VM内

コマンド 動作
vmpal exec <VM> -- <command> docker execと同じように、VM内でコマンドを実行します。出力は逐次表示されます
vmpal exec <VM> --arch x64 -- <command> arm64とx64の両方に対応したプログラムの、x64版を実行します。--arch arm64ではもう一方を実行します
vmpal cp <from> <to> docker cpと同じように、VMとの間でファイルをコピーします。VM側は<VM>:<path>と書きます
vmpal run <VM> -- <command> シャットダウンしたVMの新しいクローンで、まっさらなCIランナーのようにコマンドを実行します。ファイルは--copy-inと--copy-outでコピーします。終わるとVMPalがクローンを削除します。詳しくはCI/CDをご覧ください
vmpal ssh <VM> “ターミナルのみ”のLinux VMに、このMacのsshでサインインします。入力ができ、端末も使えます
vmpal ssh <VM> -- <command> ssh経由でVM内のコマンドを実行します
vmpal ssh <VM> --tty -- <command> ssh -tと同じく、コマンドに端末も割り当てます。topのようなプログラムに使います
vmpal sign-in <VM> VMPalが保存しているパスワードで、VMのサインイン画面からサインインします
vmpal ui <VM> ... 画面のウインドウ、ボタン、テキストや、WindowsのUACなどOSの確認画面を読み取り(vmpal ui <VM> tree)、クリック、入力、スクリーンショットを行います。使い方はvmpal ui helpで確認できます
vmpal status <VM> コマンドを実行できるかどうか、画面の状態、誰が入力を操作しているかを表示します
vmpal send-files <VM> <path>... ドロップしたときと同じように、VMのユーザのデスクトップにファイルを置きます
vmpal reinstall-tools <VM> VMにVMPal Toolsを再インストールします

スナップショット

スナップショットはVMの現在の状態を保存し、あとでその状態に戻せるようにします。

コマンド 動作
vmpal snapshot <VM> [name] スナップショットを作成します
vmpal snapshots <VM> VMのスナップショットを一覧表示します
vmpal revert <VM> [name] スナップショットに戻します。名前を省略すると、最新のスナップショットに戻します
vmpal revert <VM> --snapshot-first 現在の状態を新しいスナップショットに保存してから戻します
vmpal rename-snapshot <VM> <snapshot> <new name> スナップショットの名前を変更します
vmpal delete-snapshot <VM> <snapshot> スナップショットを完全に削除します

Hub

これらのコマンドは、VMPalのHubにあるスクリプトを管理します。スクリプトとは、VMPalが保存して代わりに実行するシェルスクリプトまたはPowerShellスクリプトです。AIエージェントは、VMPalのMCPツールで同じことを行います。

<script>はスクリプトの名前(大文字と小文字は区別しません)またはIDです。

コマンド 動作
vmpal script create <name> --file <path> VMPalのHubにスクリプトを追加します。--file -では標準入力から読み込みます。ほかのスクリプトと同じ名前には、「Test App 2」のように番号が付きます
vmpal script edit <script> 名前(--name)、本文(--file)、設定、実行場所を変更します。--no-targetsを指定すると、どこでも実行しないようにします
vmpal script show <script> 設定、実行場所、直近5回の実行とそのログのパス、本文を表示します
vmpal script list すべてのスクリプトを、言語、カラー、実行場所とともに一覧表示します
vmpal script run <script> --wait 今すぐ実行し、実行が終わるまで待ちます
vmpal script stop <script> 待機中または実行中の実行を停止します。--run <ID>で1つだけ停止します
vmpal script runs <script> 実行を新しい順に、ID、状態、失敗した理由とともに一覧表示します。対象は、最後に終了した50件と、待機中または実行中のものです。--limit <n>で件数を最大100まで指定できます
vmpal script log <script> 最新の実行のログを出力します。--run <ID>で別の実行のログを出力します。--tail <bytes>で末尾だけを出力します
vmpal script duplicate <script> スクリプトを複製し、Hubの一覧で元のスクリプトの直後に置きます
vmpal script move <script> --before <script> Hubの一覧で上下に移動します。--to-endで末尾に移動します
vmpal script delete <script> スクリプトを、その実行とログとともに削除します。進行中の実行は停止します

次のオプションで、スクリプトの実行場所を選びます。script create、script edit、script runで使えます。

オプション スクリプトの実行場所
--run-in <VM> VMの新しいクローン。まっさらなCIランナーのような使い捨てのコピーです
--run-in-place <VM> VM自体
--host このMac(自分として実行)
  • script runでは、その回の実行にだけ使われます。
  • script editでは、実行場所がこれらのオプションで置き換わります。
  • 実行は、VMの準備ができるのを最大30分待ちます。たとえば、クローンを作成する前にVMがシャットダウンするのを待ちます。

次のオプションは、script createとscript editでスクリプトの設定を変更します。

オプション 設定する内容
--language powershell PowerShellスクリプトにします。.ps1ファイルは最初からPowerShellスクリプトとして扱われます
--timeout <duration> 1回の実行にかけられる時間です。デフォルトは1時間で、最大24時間です
--color <color> Hubでのスクリプトの行に色を付けます。red、orange、yellow、green、mint、teal、cyan、blue、indigo、purple、pink、brown、grayから選べます。script editでは、--color noneで色を外せます

script run --waitはCIジョブと同じように終了するため、終了コードで実行が成功したかどうかがわかります。script runの--timeoutは、1回の実行にかけられる時間ではなく、vmpalが実行を待つ時間です。デフォルトでは、スクリプトのタイムアウトに35分を加えた時間だけ待ちます。

スマートフォンとタブレット

VMPalの「リモート」セクションにあるiPhone、iPad、iOSシミュレータ、Androidデバイスを、名前で指定します。詳しくはスマートフォンとタブレットをご覧ください。vmpal start <phone>で接続すると、vmpal ui <phone>でVMと同じように画面を操作できます。

コマンド 動作
vmpal device <phone> install <path> アプリをインストールします。iPhoneにはそのデバイス用に署名した.appまたは.ipa、シミュレータには.app、Androidには.apkを使います
vmpal device <phone> launch <bundle ID> アプリを起動し(実行中の場合はいったん終了してから)、その出力を記録します。アプリ自身の引数は--のあとに書きます。--no-consoleを付けると何も記録しません
vmpal device <phone> logs <bundle ID> launchで起動してからアプリが出力した内容を表示します。Androidではアプリのlogcatです。--lines <n>で行数を増減できます
vmpal device <phone> crashes [<bundle ID>] クラッシュレポートを新しい順に表示します。1つを読むにはvmpal device <phone> crash <report>を使います
vmpal device <phone> apps インストールされているアプリを表示します。システムのアプリは含みません
vmpal device <phone> terminate <bundle ID> アプリを終了します。uninstallで削除します
vmpal device <phone> rotate landscape-left デバイスを回転します。portrait、landscape-left、landscape-right、upside-downを指定できます
vmpal device <phone> button home ボタンを押します。home、volume-up、volume-downのほか、Androidではback、recents、powerも使えます
vmpal device <phone> open-url <url> Webページ、またはアプリ独自のリンクを開きます
vmpal device <phone> pinch --scale 2 2本指でピンチします。位置は--xと--yで0〜1の範囲で指定し、省略すると中央です。1より大きいとズームインします
vmpal device <phone> release iPhoneやiPadでVMPalのテストセッションを終了し、Xcodeで自分のUIテストを実行できるようにします

その他

コマンド 動作
vmpal library VMPalの場所、OSイメージのファイル、進行中のダウンロード、読み込み、圧縮を表示します
vmpal add-location <path> 別のディスク上のフォルダなど、VMを保存するフォルダをVMPalに追加します
vmpal remove-location <path> VMPalの一覧からフォルダを外します。中のVMはそのまま残ります
vmpal delete-base-os <id> OSイメージのファイルをゴミ箱に移動します
vmpal diagnostics バグ報告のために、VMPalのログ、クラッシュレポート、VMの設定をZIPにまとめ、送り方を案内します。パスワードは含まれません
vmpal diagnostics <VM> 1台のVMについて同じことを行います。そのVMのログ全体と、そのVMのファイルだけが含まれます
vmpal diagnostics --problem <text> バグ報告用に、何が起きたかを説明として添えます
vmpal tool <name> [<json>] VMPalのMCPツールを名前で呼び出します。引数はJSONで渡します。--file <path>ではファイルから、-では標準入力から引数を読み込みます。--show-passwordを付けると、結果にVMのパスワードを含めます
vmpal help すべてのコマンドを一覧表示します
vmpal help <command> 1つのコマンドのオプションとガイドを表示します
vmpal help <topic> ガイドを読みます。setup、ci、exec、cp、sign-in、uiがあります

知っておきたいルール

VM内のコマンド

  • エージェントによる操作:exec、cp、run、ssh、ui、sign-inは、VMがエージェントによる操作を許可している間だけ使えます。start --waitのように、VMがコマンドを実行できるようになるまで待つ操作も同じです。誰かがオフにしていない限り、オンになっています。再びオンにするには、vmpal set <VM> --agent-control onを実行します。
  • シェルを介さない:execは、シェルを介さずにプログラムそのものを実行します。パイプや&&を使うには、vmpal exec "Ubuntu" -- /bin/sh -c 'make && make test'のようにシェルを自分で実行します。
  • テキスト出力:execは出力をテキストとして読み取るため、バイナリの出力は変化します。バイナリファイルはcpでコピーしてください。
  • 管理者:--adminはコマンドを管理者として実行します。macOSのVMでは、まずVM内で管理者が承認する必要があります。手順はvmpal help execで確認できます。
  • 時間制限:execは2時間、cpは1時間でコマンドを停止します。--timeoutで別の上限を最大24時間まで指定できます。古いVMPal Toolsでは10分までです。
  • 入力なし:execで実行したコマンドには入力が渡されません。“ターミナルのみ”のVMでは、vmpal sshを使えば入力できます。
  • フォルダのコピー:cpはcp -Rと同じように動作します。たとえばvmpal cp . "Ubuntu:src"は、このフォルダの中身をsrcにコピーします。
  • サインイン:Windowsは、誰かがサインインするまでコマンドを実行しません。そのため、create --wait、start --wait、wait、clone --start --wait、restart --wait、runは、VMPalが保存しているパスワードで自動的にサインインします。サインインは、WindowsまたはmacOSのサインイン画面で行います。--no-sign-inでこの動作をオフにできます。起動のたびにWindowsが自動でサインインするようにするには、vmpal set <VM> --sign-in-automatically onを実行します。

終了コード

一般的なコマンドラインツールと同じく、終了コードでコマンドが成功したかどうかをスクリプトやCIジョブに伝えます。

コマンド 終了コード
execとrun コマンド自身のコード。タイムアウトした場合は124、vmpalが実行できなかった場合は125、シグナルNの場合は128 + N、0〜255の範囲外のコード(Windowsの0xC0000005など。vmpalがそのコードを表示します)の場合は1
ssh ssh自身のコード。接続できなかった場合は255、vmpalがsshを起動できなかった場合は125
script run --wait すべての実行が成功した場合は0。それ以外の場合、実行が1回だけならその実行の終了コード、そうでなければ1
そのほかのコマンド 成功した場合は0、失敗した場合は1、コマンドラインが正しくない場合は2

スクリプト

  • このMacのスクリプトは自分のアカウントで実行されます。そのため、vmpalがこのMacでスクリプトを実行させようとするたびに、VMPalはこのMacでのスクリプトの設定を確認します。対象は、--host、このMacで実行するスクリプトのscript run、そうしたスクリプトの本文の変更です。設定には3つの選択肢があります。
    • 許可(エージェントが確認):デフォルトです。確認せずに実行させます。
    • VMPalで確認:スクリプトのバージョンごとに1回確認します。
    • オフ:拒否します。