CLI Reference

⚠️ Work in Progress: Vize is under active development and the CLI surface is still evolving.

Most application workflows should install the vize npm package and run it through package.json scripts. This page describes the lower-level Rust-native vize binary for LSP, IDE management, check-server, profiling, and other direct CLI workflows. The npm package exposes shared config helpers plus NAPI-backed build, fmt, lint, check, clean, ready, and upgrade commands.

For a higher-level explanation of the analysis pipeline, see Static Analysis.

Application Package Scripts

For apps, install from npm and wire stable commands into project scripts:

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

Use vp exec vize ... for one-off local debugging, but prefer named scripts for documented workflows and CI.

Rust Binary Installation

For v1 alpha, use the prebuilt GitHub release binaries or the Nix entry point. The Rust CLI is not a supported crates.io install channel yet.

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

You can also download platform-specific binaries from GitHub Releases.

For local development inside this repository, install the workspace build:

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

npm Package Scripts vs Rust CLI

Commands

vize [COMMAND]

When invoked without a command, vize defaults to build.

All --profile terminal reports are rendered by the local-only vize_curator crate. The instrumentation hooks remain in vize_carton, while curator owns the CLI report shape alongside inspector and agent-facing artifacts.

Build

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

Key options:

Format

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

Key options:

Lint

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

Key options:

Presets are intended for staged adoption:

Examples:

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

Check

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

vize check is backed by vize_canon and Corsa project sessions exposed through corsa-bind. Vize generates virtual TypeScript for Vue SFCs, runs project diagnostics on a native path, and maps the results back to the original source locations.

When no explicit paths are given, vize check uses tsconfig.json files / include / exclude if available. Explicit inputs may be files, directories, or globs and can include .vue, .ts, .tsx, and .d.ts.

Key options:

Use --corsa-path when you want to pin a custom Corsa executable while developing Vize or testing a local corsa-bind checkout. The shared config key is typeChecker.corsaPath; typeChecker.tsgoPath is kept only as a compatibility alias.

Useful patterns:

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

Project-wide template values and Vue ambient types should be visible through TypeScript project configuration. Include generated files such as auto-imports.d.ts, components.d.ts, or your own Vue declarations in tsconfig.json, then select that project with --tsconfig when needed:

{
  "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;
  }
}

vize check --tsconfig tsconfig.app.json src

Inspector

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 packages one or more .vue files into the payload consumed by the playground compiler inspector. The browser then inspects Vue output, Vize output, Virtual TS, VIR, and the cross-file graph, then produces a permalink plus a prefilled pull request link.

Use --format agent when another local tool or AI agent needs the same repro without opening the browser. The report contains the exact payload, playground URL, summary metrics, and import graph. Payload, graph, and line diff metadata are built by the local-only vize_curator crate so CLI and playground inspection stay aligned.

Key options:

See Compiler Inspector for the contributor workflow.

Clean

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 removes known Vize-owned local artifacts for the selected project root, then removes empty .vize and node_modules/.vize parents. The managed artifact list covers profile outputs, Musea reports/snapshots/tokens, Patina sessions, config schemas, LSP logs, socket leftovers, OXC dumps, Oxlint workaround files, and materialized Corsa project files. Unknown entries under .vize are preserved by default; use --force only when the selected artifact root should be removed wholesale. --dry-run prints the artifact paths that would be removed. Use --scope node-modules or --scope project when only one artifact root should be cleaned.

Ready

vize ready src
vize ready --output dist src

vize ready runs fmt --write, lint, check, and build in order. The command stops at the first failing step.

Key options:

Upgrade

vize upgrade
vize upgrade --dry-run

By default, vize upgrade updates the npm package through Vite+:

vp install -D vize@latest

Use --source cargo only for explicit local Cargo installs.

Musea

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

The musea subcommand currently focuses on scaffolding and experimental entry points. For day-to-day gallery development, the recommended workflow today is @vizejs/vite-plugin-musea.

The npm package also exposes a convenience vize musea command that runs Vite with the Musea plugin installed in your project:

vp exec vize musea
vp exec vize musea --build

LSP and IDE

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

vize lsp starts the language server directly. vize ide adds editor-specific install and management commands for the VS Code and Zed integrations.

Global Options

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