SuperAPI AI 工具集

typeui-cli

设计与创作

查看项目

更新于 10-15 20:06

技能介绍

用途:借助 typeui.sh 命令行,为项目中的智能体工具生成、更新、列出和拉取设计系统技能文件。适用情形包括:让智能体创建或刷新设计系统指令、按 slug 拉取已有样式、交互式浏览并选择样式,以及在写文件前仅做预览运行。

前置条件:在目标项目根目录执行命令;需 Node.js 18+。若从本仓库源码运行,需先执行 npm install 与 npm run build。

命令:

  • npx typeui.sh generate:交互式创建新的受管技能内容。
  • npx typeui.sh update:更新已生成文件中受管的部分。
  • npx typeui.sh pull <slug>:拉取指定注册表技能并写入所选 provider 路径。
  • npx typeui.sh list:列出可用注册表 slug、展示预览链接,并拉取所选一项。

本地开发调用:node dist/cli.js --help / generate / update / list / pull <slug>。

共用参数:-p, --providers <providers> 指定逗号分隔的 provider(如 cursor,codex);--dry-run 仅预览文件变更而不写入。

Provider 行为:始终包含通用目标 .agents/skills/design-system/SKILL.md;所选 provider 会追加额外输出目标(如 .cursor/...、.codex/...)。

注册表行为:list/pull 的数据源为 https://github.com/bergside/awesome-design-skills,CLI 使用的索引为 https://raw.githubusercontent.com/bergside/awesome-design-skills/main/skills/index.json。pull 流程会校验 slug 格式、从索引解析 skillPath、再从 raw GitHub 路径获取 markdown;list 读取同一索引并展示 https://www.typeui.sh/design-systems/<slug> 的预览链接。

推荐工作流:已知样式时先运行 pull <slug> --dry-run;未知样式时运行 list 并选择;预览无误后去掉 --dry-run 重跑;最后报告生成或更新的文件路径及是否发生变更。

限制与排错:注册表拉取失败 not_found 表示 slug 不在索引中或 markdown 路径缺失,可运行 list 选择有效 slug;slug 只能包含小写字母、数字、连字符或下划线;update 时若提示没有现有受管设计系统,需先运行 generate 创建受管块。官方文本未提供,以上全部依据所给资料整理。