CLI リファレンス

CLI を使うと、Vue ファイルのコンパイル・整形・lint・型チェックをターミナルや CI で実行できます。 アプリでは vize npm パッケージをインストールし、まず package.json のスクリプト を設定してください。 LSP、IDE 管理、check-server、プロファイリングには Rust バイナリ を使います。

npm パッケージは共有設定のヘルパーと、NAPI を利用する build、fmt、lint、check、clean、ready、upgrade を提供します。 エントリーポイントの比較 で用途に合うものを選び、具体的な作業順序は ユーザーワークフロー を参照してください。

package.json にスクリプトを登録する

アプリでは npm からインストールし、日常のコマンドをプロジェクトのスクリプトに登録します。

vp install -D vize

{
  "scripts": {
    "vize:build": "vize build src",
    "vize:fmt": "vize fmt --write src",
    "vize:lint": "vize lint --preset happy-path src",
    "vize:check": "vize check src",
    "vize:ready": "vize ready src"
  }
}

vp run vize:lint
vp run vize:check
vp run vize:ready

単発のデバッグには vp exec vize ... を使い、文書化するワークフローや CI には名前付きスクリプトを使ってください。

Rust バイナリのインストール

v1 alpha では、GitHub Releases のビルド済みバイナリか Nix のエントリーポイントを使います。crates.io 経由の Rust CLI インストールはまだサポートしていません。

nix run github:ubugeeei-prod/vize#vize -- --help

OS とアーキテクチャに合うバイナリは GitHub Releases からもダウンロードできます。 このリポジトリでローカル開発をする場合は、ワークスペースのビルドをインストールしてください。

cargo install --path crates/vize --force --locked

npm パッケージのスクリプトと Rust CLI の比較

コマンド

vize [COMMAND]

コマンドを指定しない場合、vize は build を実行します。

ビルド

vize build src/**/*.vue
vize build --ssr
vize build --profile src

<style lang="scss">・sass・less・stylus のブロックは、Vite と同じく、プロジェクトにインストールされたプリプロセッサ（sass または sass-embedded、less、stylus）でコンパイルしてからスコープを付けます。プリプロセッサのエラーは .vue ファイル内の行を指します。Node やパッケージが見つからない場合は、ブロックをそのまま出力して警告を表示します。

フォーマット

vize fmt --check src
vize fmt --write src

デフォルトのファイル探索では Vue、JavaScript/TypeScript、JSON/JSONC を整形します。YAML と Markdown の整形は未実装です。.yaml、.yml、.md、.markdown は探索対象から除外され、明示的に選択するとファイルを変更せずにエラーを返します。

lint

vize lint src
vize lint --preset opinionated src
vize lint --help-level short src

プリセットを選ぶと、段階的にルールを導入できます。

vize lint --preset essential --max-warnings 0 src
vize lint --preset opinionated --help-level short src
vize lint --cross-file --cross-file-tree src
vize lint --strict-reactivity src
vize lint --format ansi src
vize lint --format plain src
vize lint --format agent src
vize lint --format markdown src

型チェック

vize check
vize check src
vize check --tsconfig tsconfig.app.json
vize check --profile src

vize check は TypeScript のネイティブコンパイラー（TypeScript 7 として出荷される Go 実装、Project Corsa）で Vue SFC を型チェックします。Vize は SFC ごとに仮想 TypeScript を生成し、corsa-bind を通してネイティブにプロジェクトを診断し、結果を元の .vue の位置へ対応付けます。フラグや設定キーの「Corsa」は、このネイティブ TypeScript コンパイラーを指します。

パスを指定しない場合、利用可能な tsconfig.json の files / include / exclude を使います。明示的な入力にはファイル・ディレクトリ・glob を指定でき、.vue、.ts、.tsx、.d.ts を扱えます。

ローカルでビルドした Corsa や corsa-bind を開発・検証に使う場合、--corsa-path で実行ファイルを固定してください。共有設定キーは typeChecker.corsaPath です。typeChecker.tsgoPath は互換性のための別名としてのみ残っています。実験的な tsrs バックエンドを評価する場合は、typeChecker.tsrsPath とともに --tsrs-path を使います。

vize check --tsconfig tsconfig.app.json src
vize check --show-virtual-ts src/components/App.vue
vize check --profile src
vize check --declaration --declaration-dir dist/types

プロジェクト全体で使うテンプレートの値や Vue の型拡張は、TypeScript のプロジェクト設定から見える必要があります。auto-imports.d.ts、components.d.ts、独自の declare module "vue" を tsconfig.json の include に含め、必要に応じて --tsconfig でそのプロジェクトを選んでください。

{
  "include": ["src/**/*.ts", "src/**/*.tsx", "src/**/*.vue", "src/**/*.d.ts"]
}

// src/types/vue-app.d.ts
declare module "vue" {
  interface ComponentCustomProperties {
    $t: (key: string) => string;
  }
}

Doctor

vize doctor
vize doctor src
vize doctor src packages/shared --format json

vize doctor は Vue SFC とスクリプトモジュールを横断するアプリケーショングラフを作り、単一ファイルの lint では見えないアプリ全体の問題を報告します。

• 依存性注入（provide / inject）とコンポーネント間の props 契約
• 要素 ID の重複と、サーバーとクライアントの境界
• リアクティビティの流れ、非同期の変更によるリスク、setup コンテキストの所有権
• 循環 import

指摘は元の .vue ソースの位置を指します。ignore ファイルに従ってワークスペース内だけを探索し、解析できないファイルがあればエラーで停止します。ファイルには書き込みません。

終了コード 0 は検証の通過、1 は確実または高い確信度のエラー、2 は探索・構文解析・解析・シリアライズ・出力の失敗を示します。警告や確信度の低い指摘は健全性スコアに影響しますが、デフォルトでは失敗にしません。 フィルター、変更ファイル、スコア、自動化に関する詳しい仕様は Doctor による診断 を参照してください。--format json のレポートは同じ入力から同じ結果が得られ、形式とスコア計算のバージョンも明記されるため、CI や AI ツールで扱う場合に適しています。

vize doctor src --format json > doctor-report.json

インスペクター

vize inspector src/App.vue
vize inspector "src/**/*.vue" --target ssr
vize inspector src --format json --output inspector-payload.json
vize inspector src --format agent --output inspector-agent.json

vize inspector は、1 つ以上の .vue ファイルを、プレイグラウンドのコンパイラーインスペクターが読み込めるデータにまとめます。ブラウザーでは Vue の出力、Vize の出力、Virtual TS、VIR、ファイル間のグラフを比較でき、パーマリンクや、再現情報を入力済みの PR 作成リンクも生成できます。

ローカルツールや AI エージェントに同じ再現データを渡す場合は、--format agent を使ってください。ブラウザーを開かずに、同じデータ、プレイグラウンドの URL、概要の数値、import グラフを取得できます。

コントリビューター向けの作業手順は Compiler Inspector を参照してください。

クリーン

vize clean
vize clean --dry-run
vize clean --scope node-modules
vize clean --scope project
vize clean --force
vize clean path/to/project

vize clean は、Vize が .vize と node_modules/.vize に書き込むキャッシュとレポートを削除します。対象はプロファイル、Musea のレポートとスナップショット、lint のセッション、設定スキーマ、LSP ログ、vize check が生成する TypeScript プロジェクトです。

準備状況の確認

vize ready src
vize ready --output dist src

vize ready は fmt --write、lint、check、build を順番に実行し、最初に失敗した段階で停止します。 対話的な端末の stderr には段階の番号と完了までの時間を表示し、CI やリダイレクトした stderr には通常のログを出力します。進捗表示は端末の色と Unicode の設定に従います。

アップグレード

vize upgrade
vize upgrade --dry-run

デフォルトでは、vize upgrade は Vite+ を使い、プロジェクトのパッケージマネージャーで npm パッケージを更新します。

vp install -D vize@latest

--source cargo は、ローカルで明示的に Cargo を使ってインストールした場合にだけ指定してください。

Musea

vize musea --help
vize musea serve --port 6006
vize musea new

musea サブコマンドは、現在は雛形作成と実験的なエントリーポイントを中心に提供しています。日常のギャラリー開発には @vizejs/vite-plugin-musea を使ってください。 npm パッケージの vize musea は、プロジェクトにインストールした Musea プラグインを使って Vite を起動します。--build を付けると本番用にビルドします。

vp exec vize musea
vp exec vize musea --build

LSP と IDE

vize lsp
vize lsp --port 9527
vize ide vscode
vize ide zed

vize lsp は言語サーバーを直接起動します。vize ide は VS Code と Zed の連携をインストール・管理するコマンドを提供します。

グローバル オプション

vize --help
vize --version
vize <command> --help

プロジェクトを対象にするコマンド（build、fmt、lint、check、ready）は、特定の Vite 設定を読む -c, --config <path> と、プロジェクトの設定を読み込まない --no-config も受け付けます。