@yoka-ui/cli

CLI for @yoka-ui/ui · 当前版本 0.4.0
查询组件知识、启动 MCP、一键配置 AI Agent、业务仓健康检查与缺陷报告。

复用 @yoka-ui/mcp 的数据访问逻辑，可在已安装 @yoka-ui/ui 的项目中离线工作；也可通过 YOKA_UI_REPO_PATH 指向源码仓。

完整用户文档见文档站：CLI（站点路由 /docs/cli）。

安装

npm i -g @yoka-ui/cli
# 或
npx @yoka-ui/cli <command>
# 或项目内
pnpm add -D @yoka-ui/cli

要求 Node.js >= 18。

命令一览

| 命令 | 说明 | | --- | --- | | yoka list | 列出 Yk / YkPro 组件 | | yoka info <Component> | Props / 类型 / 默认值 | | yoka doc <Component> | 完整 *.docs.md | | yoka demo <Component> [name] | Demo 源码（省略 name 列出 variant） | | yoka exports | 导出符号表 | | yoka token [--scope] | YK 设计令牌 | | yoka design [--source] [--section] | Design 规范 Markdown | | yoka semantic <Component> | 语义化槽位 | | yoka changelog [--version] [--component] | 查询 CHANGELOG | | yoka doctor [--cwd] | 业务仓接入健康度（只报告） | | yoka usage <Component> [--cwd] | 查找组件用法 | | yoka lint [--cwd] | 反模式规则（CI 友好） | | yoka bug / yoka bug-cli | GitLab Issue 模板（默认 dry-run） | | yoka migrate [--from] [--to] | CHANGELOG 升级导读（不改业务代码） | | yoka mcp | 启动 @yoka-ui/mcp stdio | | yoka setup --client <x> | 一键写 MCP / Skill |

知识查询命令支持 --format json|text（默认 text）。出错时非零退出；json 含 error 字段。

快速示例

yoka list
yoka info YkProTable
yoka doctor --cwd ./apps/web --format json
yoka setup --client cursor --mode both --dry-run
yoka migrate --from 1.0.0 --to 1.1.0

setup

yoka setup --client cursor
yoka setup --client claude --mode both --install

| 选项 | 说明 | | --- | --- | | --client | cursor / claude / vscode / codex / opencode / qoder / qwen-code | | --mode | mcp（默认）/ skill / both | | --dry-run | 只预览 | | --install | 未声明 @yoka-ui/ui 时自动安装；失败则中止 setup |

Skill 来自 CLI 自带的 vendor/skill/ 快照（构建时从仓库 ai/skill/ 打包），不依赖业务仓已装组件库。

bug / migrate

• yoka bug / yoka bug-cli：默认只打印模板与 New Issue URL；--submit 需 GITLAB_TOKEN（或 --token）
• yoka migrate：读数据根 CHANGELOG.md；--cwd 影响本地 CHANGELOG / --to 解析；不做 AST codemod

数据根

优先级：已安装的 @yoka-ui/ui（node_modules）→ YOKA_UI_REPO_PATH 源码仓。
mcp / setup 可不依赖业务仓已装 @yoka-ui/ui。

本地开发

cd ecosystem/yoka-ui-cli
pnpm build          # 拷贝 skill 快照 + father build
pnpm test           # vitest
pnpm test:coverage  # 覆盖率门禁（statements/lines/functions ≥80%）

源码：src/commands/、src/utils/；测试：src/__tests__/。

相关

• @yoka-ui/mcp
• 文档站 MCP Server · For Agents
• 消费方接入包 ai/