HeroUI CLI

以下是 HeroUI CLI 的 API 参考。

安装 CLI 后，运行以下命令以显示可用命令

要获取可用 CLI 命令的列表，请在项目目录中运行以下命令

这将生成以下帮助输出

命令

Init

使用官方模板初始化一个新的 HeroUI 项目。

Init 选项

• -t --template [string] 用于新项目的模板，例如 app、pages、vite
• -p --package [string] 用于新项目的包管理器（默认为 npm）

示例

输出

Add

向你的项目添加 HeroUI 组件。

功能

1. 自动添加项目中缺少的必需 dependencies
2. 自动添加项目所需的 tailwindcss.config.js 配置
3. 检测是否使用 pnpm，如果是，则将所需的配置添加到你的 .npmrc 文件中

Add 选项

• -a --all [boolean] 添加所有 HeroUI 组件（默认为 false）
• -p --packagePath [string] package.json 文件的路径
• -tw --tailwindPath [string] tailwind.config 文件的路径
• -app --appPath [string] App.tsx 文件的路径
• --prettier [boolean] 在添加的内容中添加 prettier 格式，这需要安装 prettier - (默认为 false)
• --addApp [boolean] 添加 App.tsx 文件内容，这需要 provider (默认为 false)
• -b --beta [boolean] 添加 beta 组件（默认为 false）

示例

在不设置特定组件的情况下，add 命令将显示可用组件的列表。

输出

如果要添加特定组件，可以指定组件名称。

输出

Upgrade

将 HeroUI 组件升级到最新版本。

Upgrade 选项

• -p --packagePath [string] package.json 文件的路径
• -a --all [boolean] 升级所有 HeroUI 组件（默认为 false）
• -w --write [boolean] 将升级版本写入 package.json 文件（默认为 false）
• -b --beta [boolean] 升级 beta 组件（默认为 false）
• -h --help 显示命令帮助

示例

将 Button 组件升级到最新版本。

输出

Remove

从你的项目中移除 HeroUI 组件。

注意：如果移除后没有 HeroUI 组件，也会移除所需的内容

Remove 选项

• -p --packagePath [string] package.json 文件的路径
• -a --all [boolean] 移除所有 HeroUI 组件（默认为 false）
• -tw --tailwindPath [string] tailwind.config 文件的路径
• --prettier [boolean] 在添加的内容中添加 prettier 格式，这需要安装 prettier - (默认为 false)

示例

从你的项目中移除 Button 组件。

输出

列表

列出所有当前已安装的组件。

列表选项

• -p --packagePath [string] package.json 文件的路径
• -r --remote 列出所有可用的远程组件

示例

输出

诊断

通过使用 doctor 命令检查你的项目是否存在问题。

功能

1. 检查项目中是否存在 冗余依赖项
2. 检查 HeroUI 组件 所需的依赖项是否已安装 在项目中
3. 检查所需的 tailwind.config.js 文件及其内容是否正确
4. 当使用 pnpm 时，检查 .npmrc 是否正确
5. 检查 具有所需版本的 peerDependencies 是否已安装在项目中

诊断选项

• -p --packagePath [string] package.json 文件的路径
• -tw --tailwindPath [string] tailwind.config 文件的路径
• -app --appPath [string] App.tsx 文件的路径
• -ca --checkApp [boolean] 开启 App 检查 (默认值: true)
• -ct --checkTailwind [boolean] 开启 tailwind.config 文件检查 (默认值: true)
• -cp --checkPnpm [boolean] 开启 Pnpm 检查 (默认值: true)

示例

输出

如果你的项目存在问题，doctor 命令将显示问题信息。

否则，doctor 命令将显示以下消息。

环境

显示关于本地环境的调试信息。

环境选项

• -p --packagePath [string] package.json 文件的路径

示例

通过使用 env 命令显示本地环境信息。

输出