CLI 参考

⚠️ 正在进行中：Vize 正在积极开发中，CLI 表面仍在不断发展。

大多数应用流程都应该安装vize npm包并通过package.json 剧本。本页介绍了 LSP 的底层 Rust 原生 vize 二进制，IDE 管理， check-server、分析以及其他直接的CLI工作流程。npm 包会暴露共享配置 辅助工具以及NAPI支持的build、fmt、lint、check、clean、ready和upgrade命令。

关于分析流程的更高级解释，请参见静态分析。

应用包脚本

对于应用，从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 ...，但文档化时更倾向于使用命名脚本 工作流程和配置项。

锈蚀二进制安装

对于v1 alpha，可以使用预构建的GitHub发布二进制文件或Nix入口。Rust CLI 不是 crates.io 安装渠道支持。

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

你也可以从以下平台下载特定平台的二进制文件 GitHub发布。

在本仓库内进行本地开发时，请安装工作区构建：

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

npm 包脚本 vs Rust CLI

命令

vize [COMMAND]

当无命令调用时，vize默认为build。

所有--profile终端报告均由本地vize_curator箱处理。该 Instrumentation Hooks仍vize_carton，而Curator则拥有CLI报告表格 面向探员和特工的文物。

建造

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

关键选项：

节目形式

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

关键选项：

绒毛

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有通过corsa-bind展示的vize_canon和Corsa项目会议支持。Vize为Vue SFC生成虚拟TypeScript，在本地路径上运行项目诊断，并将结果映射回原始源位置。

当没有明确路径时，vize check使用tsconfig.json files / include / 如果有的话exclude。显式输入可以是文件、目录或块状，可以包括.vue， .ts、.tsx和.d.ts。

关键选项：

当你想在开发 Vize 或测试 Corsa 时钉住自定义 Corsa 可执行文件时，可以使用 --corsa-path 本地corsa-bind结账。共享配置密钥为typeChecker.corsaPath;typeChecker.tsgoPath 仅作为兼容性别名保留。

实用的模式：

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或您自己的文件 Vue声明在tsconfig.json中，然后在需要时选择该项目，--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;
  }
}

警官

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将一个或多个.vue文件打包到游乐场消耗的有效载荷中 编译器检查员。浏览器随后检查Vue输出、Vize输出、虚拟TS、VIR以及 跨文件图，然后生成一个永久链接和一个预填充的拉取请求链接。

当其他本地工具或 AI 代理需要相同的复制品时，可以使用 --format agent 浏览器。报告包含具体的有效载荷、游乐场网址、汇总指标和导入图表。 有效载荷、图和线差元数据由本地专用vize_curator箱构建，因此CLI和 游乐场检查保持对齐。

关键选项：

关于贡献者的工作流程，请参见编译器检查器。

干净

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报告/快照/令牌、Patina会话、配置模式、LSP日志、套接字剩余、OXC 转储、Oxlint 绕过文件以及实体化的 Corsa 项目文件。未知条目.vize 默认保留;只有在选定的工件根应被移除时才使用--force 批发。--dry-run打印出将被移除的遗迹路径。用--scope node-modules 或者--scope project只清理一个神器根部。

准备好了

vize ready src
vize ready --output dist src

vize ready按顺序运行fmt --write、lint、check和build。命令停止于 第一步失败。

关键选项：

升级

vize upgrade
vize upgrade --dry-run

默认情况下，vize upgrade通过Vite+更新npm包：

vp install -D vize@latest

只用--source cargo来做明确的本地货运安装。

博物馆

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

musea分指挥部目前专注于脚手架和实验性进入点。 对于日常画廊开发，目前推荐的工作流程是 @vizejs/vite-plugin-musea。

npm 包还提供了一个方便vize musea命令，可以运行 Vite 和 Musea 一起运行 项目中安装的插件：

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