CLI | Tofu UI

概述

Tofu UI CLI 是一个自动化脚手架。通过这个CLI，您可以高效地添加、更新、移除和管理Tofu UI组件，从而优化前端项目的构建过程。

安装CLI

在开始使用Tofu UI之前，必须先在本地环境安装CLI工具。以下命令将会安装最新版本的Tofu UI CLI：

pnpm add -g tofu-ui-cli@latest

该命令将全局安装Tofu UI CLI，使其在任何项目中都可用。

注意

请一定要安装 `tofu-ui-cli` 1.4.0以上版本

快速开始

一旦CLI安装完成，您即可开始将Tofu UI组件集成到您的项目中。CLI支持多种命令，每个命令都具备特定功能，以简化开发流程。

命令与选项

tofu-ui add <component>: 将一个或多个组件添加到您的项目。
~~tofu-ui update: 先更新Cli本体，然后更新项目中的Tofu UI组件。(未实装)~~
~~tofu-ui remove <component>: 从您的项目中移除指定的Tofu UI组件。(未实装)~~
tofu-ui help: 显示详细的帮助信息和命令列表。

参数详解

~~-v, --version: 输出当前的CLI版本。(未实装)~~
-h, --help: 提供帮助信息，包括所有命令和选项的详细说明。
--opencf: 强制打开配置文件。

组件管理

添加组件

通过add命令，您可以轻松地向项目中添加需要的Tofu UI组件。支持单个或多个组件同时添加：

pnpm tofu-ui-cli add button,tofu

此命令将自动从最近的服务器节点下载并安装最新版本的button和tofu组件。

更新组件

注意

暂未实装上线，预计 1.5.0 版本上线

使用update命令，您可以更新Cli和UI组件到最新版本：

pnpm tofu-ui-cli update

此命令将先更新Cli到最新版本，然后检查所有已安装的组件更新，并从服务器获取最新版本进行更新。

移除组件

注意

暂未实装上线，预计 1.5.0 版本上线

如果需要从项目中移除不再使用的组件，可以使用remove命令：

pnpm tofu-ui-cli remove button

该命令将彻底从项目中删除button组件。

服务器节点

Tofu UI CLI 利用全球分布式的服务器节点确保组件下载和更新的高速性和高可用性。当前支持的节点包括：

[MAIN] Washington, D.C., USA (East) - 主节点
[HK] Hong Kong, China (Asia) - 香港节点
[CN] Guangdong, China (South) - OSS节点
[GITHUB] GitHub, Global (Online) - Github节点

高级配置文件

Tofu UI CLI 支持自定义配置文件，您可以通过--opencf来打开配置文件：

pnpm tofu-ui-cli --opencf

此命令将打开配置文件，您可以在其中自定义组件的语言、安装源、配置等。

如果Tofu UI CLI没能自动打开配置文件，您可以前往包目录~/.tofu-ui/.tofuconfig手动编辑配置文件。

// .tofuconfig - Tofu UI CLI 配置文件
 
{
  "lang": "zh",// 语言,en/zh
  "source": "MAIN",// 安装源
  "version": "x.x.x",// 版本
  ...
}

关于TailwindCSS注入

Tofu UI CLI 支持自动注入TailwindCSS，不过有一定几率会注入失败，可能需要你手动修改tailwindcss配置文件。

如果出现了问题，可以根据控制台指示，解包备份文件进行恢复。

// 演示环境
// Windows 11 专业版 23H2 22635.3420 Windows Feature Experience Pack 1000.22700.1003.0
 
PS F:\Project\UI\tofuui> pnpm tofu-ui-cli add tailwindcss-config
------------------------
[Config File] C:\Users\Administrator\.tofu-ui\.tofuconfig
------------------------
[Tofu UI CLI v1.6] - Alpha0603
检测到您请求安装的组件包括：tailwindcss-config.
⠋ 正在下载 tailwindcss-config.tsx  --目录已存在：F:\Project\UI\tofuui\components\ui\tofu
✔ 下载完成 - tailwindcss-config.tsx
tailwindcss-config 没有配置自定义安装命令，跳过此步骤。
⠋ 正在注入 Tailwind CSS 配置...配置已备份到 C:\Users\Administrator\.tofu-ui\backup\tailwind\六月\tailwind-2024-06-09-02-54-13.backup.gz
✔ Tailwind CSS 配置注入成功
 
------------------------
组件安装和配置已完成。如需回滚请在3天前执行 `backup` 命令。
------------------------
 
组件安装完成。感谢您选择TofuUI CLI进行开发！祝您编码愉快！