HeroUI CLI
以下是 HeroUI CLI 的 API 参考文档。
安装 CLI 后，运行以下命令显示可用命令：
要获取可用的 CLI 命令列表，请在项目目录中运行以下命令：
这将生成以下帮助输出：
命令
Init
使用官方模板初始化新的 HeroUI 项目。
Init 选项
-t --template [字符串]用于新项目的模板，例如：app、laravel、pages、remix、vite-p --package [字符串]用于新项目的包管理器（默认：npm）
示例
输出：
Add
- 向项目添加 HeroUI 组件。
- 向项目添加 HeroUI Chat 代码库。
功能特性
- 自动向项目添加缺失的必要
依赖项- 自动向项目添加必要的
tailwindcss.config.js配置- 检测是否使用 pnpm，如果是则向
.npmrc文件添加必要配置- 向项目添加 HeroUI Chat 代码库
Add 选项
-a --all[布尔值] 添加所有组件（默认：false）-p --packagePath[字符串] package.json 文件的路径-tw --tailwindPath[字符串] tailwind.config 配置文件的路径-app --appPath[字符串] App.tsx 文件的路径--prettier[布尔值] 在添加内容时使用 prettier 格式化（需要已安装 prettier）-（默认：false）--addApp[布尔值] 添加 App.tsx 文件内容（需要 provider）-（默认：false）-b --beta[布尔值] 添加 Beta 版组件（默认：false）-d --directory[字符串] 将 HeroUI Chat 代码库添加到指定目录
示例
不指定具体组件时，add 命令将显示可用组件列表。
输出：
如果要添加特定组件，可以指定组件名称。
输出：
Upgrade
将 HeroUI 组件升级到最新版本。
Upgrade 选项
-p --packagePath[字符串] package.json 文件的路径-a --all[布尔值] 升级所有 HeroUI 组件（默认：false）-w --write[布尔值] 将升级版本写入 package.json 文件（默认：false）-b --beta[布尔值] 升级 Beta 版组件（默认：false）-h --help显示命令帮助信息
示例
将 Button 组件升级到最新版本。
输出：
Remove
从项目中移除 HeroUI 组件。
注意: 如果移除后没有 HeroUI 组件，相关必要内容也会被移除
Remove 选项
-p --packagePath[字符串] package.json 文件的路径-a --all[布尔值] 移除所有 HeroUI 组件（默认：false）-tw --tailwindPath[字符串] tailwind.config 配置文件的路径--prettier[布尔值] 在添加内容时使用 prettier 格式化（需要已安装 prettier）-（默认：false）
示例
从项目中移除 Button 组件。
输出：
List
列出所有当前已安装的组件。
List 选项
-p --packagePath[字符串] package.json 文件的路径-r --remote列出所有远程可用的组件
示例
输出：
Doctor
使用 doctor 命令检查项目中存在的问题。
功能特性
- 检查项目中是否存在
冗余依赖- 检查 HeroUI 组件
所需依赖是否已安装- 检查必要的
tailwind.config.js文件及其内容是否正确- 使用
pnpm时检查.npmrc是否正确- 检查
所需版本的同级依赖是否已安装在项目中
Doctor 选项
-p--packagePath[字符串] package.json 文件的路径-tw--tailwindPath[字符串] tailwind.config 配置文件的路径-app--appPath[字符串] App.tsx 文件的路径-ca--checkApp[布尔值] 启用 App 检查（默认：true）-ct--checkTailwind[布尔值] 启用 tailwind.config 文件检查（默认：true）-cp--checkPnpm[布尔值] 启用 Pnpm 检查（默认：true）
示例
输出：
如果项目中存在问题，doctor 命令将显示问题信息。
如果没有问题，doctor 命令将显示以下信息。
Env
显示关于本地环境的调试信息。
Env 选项
-p --packagePath[字符串] package.json 文件的路径
示例
使用 env 命令显示本地环境信息。
输出：
