CLI コマンド
最新のヘルプ出力は、ターミナルで snapvm --help または snapvm help <command> を実行して確認してください。
グローバルオプション
Section titled “グローバルオプション”これらのオプションはコマンドの前に指定できます。
| オプション | 環境変数 | 用途 |
| --- | --- | --- |
| --api-url <url> | SNAPVM_API_URL | 管理者から案内されたカスタム SnapVM API URL を使います。 |
| --org <slug>, -o <slug> | SNAPVM_ORG | コマンドで使う組織を選択します。 |
| --machine <name-or-id>, -m <name-or-id> | SNAPVM_MACHINE | コマンドで使うマシンを選択します。 |
例:
snapvm --org my-team --machine frontend-lab consolesnapvm login
Section titled “snapvm login”ブラウザ経由でサインインします。
snapvm login--web-url は、ワークスペース管理者からカスタム SnapVM Web URL を案内された場合のみ使います。
snapvm logout
Section titled “snapvm logout”保存済みの CLI 認証情報を削除します。
snapvm logoutアップデート
Section titled “アップデート”snapvm update
Section titled “snapvm update”インストール済みの CLI をアップデートします。
snapvm updatesnapvm list
Section titled “snapvm list”マシンを一覧表示します。
snapvm listオプション:
--output table|jsonは出力形式を変更します。--allは、ロールで許可されている場合に全ユーザー所有のマシンを表示します。--user-id me|all|user_xxxは所有者で絞り込みます。
snapvm create
Section titled “snapvm create”マシンを作成します。
snapvm create --name frontend-labオプション:
--name <name>はマシン名を設定します。--launch-type sprites|externalはデプロイで提供されている起動種別を選択します。--package <npm-package>は初期セットアップ時に npm パッケージをインストールします。複数指定する場合はフラグを繰り返します。--package-manager bun|npmは--packageで使うパッケージマネージャーを選びます。--output summary|jsonは出力形式を変更します。
例:
snapvm create --name automation-lab --package typescript --package-manager npmsnapvm destroy
Section titled “snapvm destroy”マシンを完全に削除します。
snapvm destroy frontend-lab削除は永続的です。マシンを削除する前に、必要なファイル、リポジトリ、生成データ、ローカルデータベースを別の場所へ移してください。
ローカルコンテキスト
Section titled “ローカルコンテキスト”snapvm use
Section titled “snapvm use”現在のディレクトリで使うマシンを有効化します。
snapvm use frontend-lab以後、同じディレクトリで実行する snapvm exec や snapvm console はそのマシンを使います。
ローカルコンテキストを削除します。
snapvm use --unsetコマンド実行
Section titled “コマンド実行”snapvm exec
Section titled “snapvm exec”選択中のマシン内でコマンドを実行します。
snapvm exec pwdsnapvm exec --dir ~/projects/app npm testエイリアス:
snapvm x pwdオプション:
--dir <path>は作業ディレクトリを指定します。--env KEY=valueは環境変数を渡します。複数指定する場合はフラグを繰り返します。--stdinは標準入力を転送します。--ttyは対話ターミナルを割り当てます。
snapvm console
Section titled “snapvm console”選択中のマシンで対話シェルを開きます。
snapvm consoleエイリアス:
snapvm cチェックポイント
Section titled “チェックポイント”snapvm checkpoint create
Section titled “snapvm checkpoint create”チェックポイントを作成します。
snapvm checkpoint create --comment "before dependency upgrade"snapvm checkpoint list
Section titled “snapvm checkpoint list”チェックポイントを一覧表示します。
snapvm checkpoint listsnapvm checkpoint list --output jsonsnapvm checkpoint info
Section titled “snapvm checkpoint info”チェックポイントの詳細を表示します。
snapvm checkpoint info <version-id>snapvm checkpoint delete
Section titled “snapvm checkpoint delete”チェックポイントを削除します。
snapvm checkpoint delete <version-id>snapvm restore
Section titled “snapvm restore”チェックポイントから復元します。
snapvm restore <version-id>復元すると、マシンは選択したチェックポイントの状態に戻ります。残しておきたい作業がある場合は、復元前に保存または退避してください。
非推奨コマンド
Section titled “非推奨コマンド”snapvm machines は古いワークフロー向けに残っていますが、新しい利用ではトップレベルコマンドを使ってください。
snapvm listsnapvm create --name frontend-labsnapvm destroy frontend-lab