admin-vben5/docs/src/guide/project/cli.md

outline
deep

CLI

项目中，提供了一些命令行工具，用于一些常用的操作，代码位于 scrips 内。

vsh

用于一些项目操作，如清理项目、检查项目等。

用法

pnpm vsh [command] [options]

vsh check-circular

检查整个项目循环引用，如果有循环引用，会在控制台输出循环引用的模块。

用法

pnpm vsh check-circular

选项

选项	说明
--staged	只检查git暂存区内的文件,默认false

vsh check-dep

检查整个项目依赖情况，并在控制台输出未使用的依赖、未安装的依赖信息

用法

pnpm vsh check-dep

选项

选项	说明
-r,--recursive	递归删除整个项目,默认true
--del-lock	是否删除pnpm-lock.yaml文件,默认true

vsh lint

对项目进行lint检查，检查项目中的代码是否符合规范。

用法

pnpm vsh lint

选项

选项	说明
--format	检查并尝试修复错误,默认false

vsh publint

对 Monorepo 项目进行包规范检查，检查项目中的包是否符合规范。

用法

pnpm vsh publint

选项

选项	说明
--check	仅执行检查,默认false

vsh code-workspace

生成 vben-admin.code-workspace 文件，目前不需要手动执行，会在代码提交时自动执行。

用法

pnpm vsh code-workspace

选项

选项	说明
--auto-commit	git commit时候，自动提交,默认false
--spaces	缩进格式,默认 2个缩进

turbo-run

用于快速执行大仓中脚本，并提供选项式交互选择。

用法

pnpm turbo-run [command]

turbo-run dev

快速执行dev命令，并提供选项式交互选择。