# @cyclone-ui/cli 中文文档

规范地址：https://npmcn.com/package/%40cyclone-ui/cli/

版本：0\.6\.57
npm 元数据更新时间：2026-11-10T16:22:04.125Z
中文译文更新时间：2026-11-11T07:01:08.585Z
软件包许可：Apache-2\.0

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40cyclone-ui/cli
原文对照：https://npmcn.com/package/%40cyclone-ui/cli/?lang=original
项目主页：https://stormsoftware.com/
源码仓库：https://github.com/storm-software/cyclone-ui

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：4.5 MB，160 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：12 个
- 首次发布：2026-10-12T01:57:15.292Z
- 最新版本发布：2026-11-10T16:22:03.782Z
- 近 30 天下载量：9229（2026-10-11 至 2026-11-09，npm 官方下载统计）
- 已发布版本数：57（近 12 个月 57 个）

## 中文简介

Tamagui软件所使用的基于Tamagui的设计组件。 和Shadcn/ui一样,组件通过旋风CLI被复制到其他寄存器.

## 安装

```sh
npm install @cyclone-ui/cli
```

也可以使用：`pnpm add @cyclone-ui/cli`、`yarn add @cyclone-ui/cli`、`bun add @cyclone-ui/cli`

## README

# 旋风UI - 命令线接口(CLI)

气旋UI命令行界面应用.

## 目录

-   [旋风UI - 命令线接口(CLI)](https://npmcn.com/package/%40cyclone-ui/cli/#readme-cyclone-ui---command-line-interface-cli)
    -   [目录](https://npmcn.com/package/%40cyclone-ui/cli/#readme-table-of-contents)
    -   [安装](https://npmcn.com/package/%40cyclone-ui/cli/#readme-installing)
    -   [配置](https://npmcn.com/package/%40cyclone-ui/cli/#readme-configuration)
        -   [编码代理件保护](https://npmcn.com/package/%40cyclone-ui/cli/#readme-coding-agent-component-protection)
    -   [发展](https://npmcn.com/package/%40cyclone-ui/cli/#readme-development)
        -   [大楼](https://npmcn.com/package/%40cyclone-ui/cli/#readme-building)
        -   [运行单元测试](https://npmcn.com/package/%40cyclone-ui/cli/#readme-running-unit-tests)
        -   [线性](https://npmcn.com/package/%40cyclone-ui/cli/#readme-linting)

## 安装

使用 [小时](http://pnpm.io/)数字 :

```bash
pnpm add @cyclone-ui/cli
```

使用 npm

```bash
npm install @cyclone-ui/cli
```
使用线条

```bash
yarn add @cyclone-ui/cli
```

气旋CLI的下载源 来自公共R2注册处 `https://public.storm-cdn.com/cyclone-ui/registry`,在复制和拥有之后 shadcn/ui使用的工作流程. 桶装了 `registry.json` 目录和 自定义 `components/<name>.json` 文件; 不要求工作 API .

```bash
# Create components.json and the local component directory.
cyclone-ui init

# Browse the registry. `list` is an alias for `search`.
cyclone-ui search --query button

# Inspect or install registry components.
cyclone-ui view button
cyclone-ui add button

# Preview an installation or compare installed files with the registry.
cyclone-ui add button --dry-run
cyclone-ui diff button

# Inspect the current project configuration.
cyclone-ui info

# Generate a Tamagui config from design tokens, then compile it and its CSS.
cyclone-ui build --config razorwind.config.ts --output tamagui.config.ts

# Generate only the config, without compiling it.
cyclone-ui build-tokens --config razorwind.config.ts

# Validate a shadcn-format registry.
cyclone-ui registry validate registry.json
```

`init` 写入 `components.json` 包含公共注册 URL的文件,输出 路径,并显示已安装的组件. `add` 解决内部部分 依赖性,除非 `--overwrite` 实值 并记录已安装的版本和 文档。 注册文件路径受限制于配置组件 目录.

在第二个存储器中, 使用已安装 `cyclone-ui` 可执行文件 :

```bash
pnpm exec cyclone-ui init --path src/components/ui
pnpm exec cyclone-ui add button
pnpm install
```

组件依赖性递归复制. 复制组件之间的导入 成为相对的进口,包括从嵌入文件导入子路径。 其它 软件包,包括 `@cyclone-ui/helpers` 财务报告和审定财务报表 `@cyclone-ui/state`,添加到 `package.json` 带有已公布的版本范围。 现有扶养申报 被保留下来。 运行您的软件包管理器以安装新添加的依赖 .

使用另一个公共登记簿,通过 `--registry <url>` 改为 `init`,或更改 `registry` 内 `components.json`。以 `/registry.json` 也予以接受. 对于预释通道,使用注册处的 `/tags/<tag>` URL (中文(简体) ). 明确的遗产 结束于 `/api` 继续使用已键入的 API 客户端.

对于 Next.js App Router 项目,启用 React 服务器组件支持 `cyclone-ui init --rsc`,或添加 `"rsc": true` 给您现有的 `components.json`。 。 。 . 这保存了注册指令,匹配了Shadcn的RSC驱动的行为. 书记官处的作者负责提供 `"use client"` 联合国 只有客户端的组件、钩子和帮助者。 CLI 不推断客户端 边框或添加指令到无标记文件.

设定 `"rsc": false` 删除模块级别 `"use client"` 已安装指令 JavaScript和TypeScript文件,遵循Shadcn的RSC选出行为. 服务器/缓存指令、函数机构、注释和非标注文件保留 不变。 选择 `rsc` 保存登记内容而不进行转换. 这个 `add` 命令也接受 `--rsc` 以覆盖工程设置 安装。 预览和diffs使用与写作相同的已转换内容.

到样式组件 [塔玛吉·泰尔温](https://tamagui.dev/docs/core/tailwind) 类名称而不是样式道具,运行 `cyclone-ui init --style tailwind`,或 添加 `"style": "tailwind"` 给您现有的 `components.json`。组件 尾风变体(`Skeleton.tailwind.tsx`(d) 取代 默认文件,以及 `@tamagui/tailwind` 添加到 `package.json`样式 与 `className`,例如 `<Skeleton className="h-[32px] w-1/2" />`。 。 。 . 气旋定义了没有边界宽度符号,也没有尾风前飞行,所以 给边框一个 px 宽度和样式, 例如 `border-[1px] border-solid`。 。 。 . 动画课跟玉贵换班 `transition` 作为安装的道具 组件有. `@tamagui/tailwind` 离开它的道具类型,所以通过它 以散数键入 `TransitionProp` 从 `@tamagui/core`。 。 。 . 没有变体的部件安装了他们的Tamagui源,这就使得 与具有相同同义词和主题的 Tailwind 组件并列. 建设时间 CSS 提取, 添加 `tamaguiPlugin({ components: ["@tamagui/tailwind"] })` 从 `@tamagui/tailwind/vite` 给您的虚拟配置.

注册作者通过放置添加 Tailwind 变体 `<Name>.tailwind.tsx` 旁边 `<Name>.tsx` 与同样的出口.

`build` 接受相同的建议 `--cwd`, (中文(简体) ), `--config`, (中文(简体) ), `--tokens`,以及 `--output` 选项 作为 `build-tokens`它将生成的配置编译为 `.tamagui/` 写作 `tamagui.generated.css` 在工作目录中。 编译器包含在 气旋CLI;不需要单独的Tamagui CLI安装.

## 配置

### 编码代理件保护

除非 用户特别指示他们这样做. `components.json` 识别 配置组件路径并安装文件 。 一般特征、造型或 应用程序固定请求不授权组件编辑,格式化,重命名, 删除、登记更新或覆盖。 优先支持的道具,组成, 应用程序自有的包装符,以及安装文件外的主题配置. 如果需要更改一个组件,请解释原因并要求具体指示 先说 明确要求增加或更改的组成部分必须保持范围 保存不相关的已安装文件和本地编辑.

这一指导载于《国家综合倡议》 `guidelines` 命令( 也通过 MCP),组件指令描述,以及 `info` 输出. `info --json` 包含 `agentInstructions` 字段。 这是代理的指导,不是文件系统写锁; 继续提供明确要求的CLI行动.

## 发展

此工程是使用 [无](https://nx.dev/)因此,许多通常的情况 命令可以帮助开发.

### 大楼

运行 `nx build cli` 来建造图书馆。 Razorwind Shell 冲击插件 在建造过程中提取这个寄存器的设计系统 并烤出它的代币, cLI命令和MCP工具中的组件、图标和字体。 没有刮风 运行时需要配置或生成快照.

### 运行单元测试

运行 `nx test cli` 通过 [维特](https://vitest.dev/)。 。 。 .

### 线性

运行 `nx lint cli` 要运行 [ESLint 语录](https://eslint.org/) 在包裹上.

## 常见问题

### @cyclone-ui/cli 是什么？

Tamagui软件所使用的基于Tamagui的设计组件。 和Shadcn/ui一样,组件通过旋风CLI被复制到其他寄存器\.

### 如何安装 @cyclone-ui/cli？

在项目目录运行 npm install @cyclone-ui/cli，或使用 pnpm add / yarn add / bun add。它还提供命令行工具 cyclone-ui，可以用 npx cyclone-ui 直接运行。

### @cyclone-ui/cli 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @cyclone-ui/cli 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @cyclone-ui/cli 可以商用吗？

@cyclone-ui/cli 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @cyclone-ui/cli 的下载量有多少？

根据 npm 官方下载统计，@cyclone-ui/cli 在 2026/10/11 – 2026/11/09 这 30 天内被下载 9,229 次，日均约 308 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @cyclone-ui/cli 还在维护吗？

最新版本 0\.6\.57 发布于 2026/11/11（今天）；至今共发布 57 个版本，其中过去 12 个月发布了 57 个；首次发布于 2026/10/12。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。