NextUI CLI

以下是 NextUI CLI 的 API 参考。

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

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

这将产生以下帮助输出

命令

初始化

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

初始化选项

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

示例

输出

添加

将 NextUI 组件添加到您的项目。

特性

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

添加选项

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

示例

如果不设置特定的组件，add 命令将显示可用组件的列表。

输出

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

输出

升级

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

升级选项

• -p --packagePath [string] package.json 文件的路径
• -a --all [boolean] 升级所有 NextUI 组件（默认：false）
• -w --write [布尔值] 将升级版本写入 package.json 文件 (默认值: false)
• -b --beta [布尔值] 升级 beta 组件 (默认值: false)
• -h --help 显示命令的帮助信息

示例

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

输出

移除

从您的项目中移除 NextUI 组件。

注意：如果移除后没有 NextUI 组件，则相关的必要内容也将被移除。

移除选项

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

示例

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

输出

列表

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

列表选项

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

示例

输出

诊断

使用 doctor 命令检查您的项目中是否存在问题。

特性

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

诊断选项

• -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 命令将显示以下消息。

环境

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

环境选项

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

示例

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

输出