tmui-cli
v2.0.6
Published
TMUI DESIGN 终端 CLI:创建与升级 uniapp CLI / HBX / uni-app x 项目,并提供 tmui 3.2 / tmui4x 2.0 IDE MCP 服务
Readme
tmui-cli
TMUI DESIGN 终端工具:在命令行里创建或升级 uniapp CLI / HBX / uni-app x(VDOM、Vapor 蒸汽)项目,也可作为 IDE 的 MCP 服务。
环境
Node.js 22.18+
安装
npm i -g tmui-cli
tmui使用
在任意目录执行 tmui
升级:
- TMUI:下载组件库到
uni_modules/tm-ui(3.1 为tmui) - UniSdk:仅 CLI,改
package.json后用所选 npm/pnpm 安装
按键:↑/↓ 选择,Enter 确认,Esc 返回,Ctrl+C 退出。
MCP(给 Cursor / VS Code 等 IDE 用)
tmui mcp 启动 MCP stdio 服务,不会打开交互界面。stdout 只走协议。
全局安装后,在 IDE 的 MCP 配置里写:
{
"mcpServers": {
"tmui": {
"command": "npx",
"args": ["-y", "tmui-cli", "mcp"]
}
}
}提供的工具:create_uniapp_hbx_project、create_uniapp_cli_project、create_uniappx_vdom_project、create_uniappx_vapor_project、query_tmui_config、list_components、get_component_doc、query_tmui_doc。
MCP · tmui4x 2.0(蒸汽版文档)
tmui mcp4x 是另一套服务,只查 tmui4x 2.0 文档(教程 / 插件库 / 组件库 / 原生图表 / 工具库 / AI / 混合开发 / Flutter),不是 tmui 3.2。
工具和参数与上面的 tmui MCP 完全分开:
| 工具 | 参数 | 说明 |
| --- | --- | --- |
| list_tmui4x_docs | section? | 列出文档,可按分区过滤 |
| query_tmui4x_doc | doc、section? | 读一篇文档全文 |
| search_tmui4x_doc | query、section?、limit? | 全文检索 |
不要把 tmui 3.2 的 topic / keyword / name / category 传给这套工具。
{
"mcpServers": {
"tmui4x": {
"command": "npx",
"args": ["-y", "tmui-cli", "mcp4x"]
}
}
}MCP · uni-app x 官方文档
tmui uniappxdocs(短别名 tmui mcpux)查 uni-app x 官方文档(组件 / CSS / API / UTS语法 / Vue / 页面与manifest配置 / 教程 / 原生 / Web / 鸿蒙),不是 tmui 3.2 也不是 tmui4x。
| 工具 | 参数 | 说明 |
| --- | --- | --- |
| list_uniappx_docs | category? | 列出文档目录,可按分类过滤(组件 / CSS / API / UTS / Vue / 配置 / 教程 / 原生 / Web …) |
| query_uniappx_doc | doc、category? | 读一篇文档全文(doc 支持中文名/文件名) |
| search_uniappx_doc | query、category?、limit? | 全文检索,返回命中文档与摘要片段 |
| query_uniappx_component | component | 查组件:属性表 / 事件 / 子组件 / 兼容性(结构化,最快) |
| query_uniappx_css | prop | 查 CSS 属性:语法 / 取值 / 默认值 / 兼容性 |
{
"mcpServers": {
"uniappx": {
"command": "npx",
"args": ["-y", "tmui-cli", "uniappxdocs"]
}
}
}发布前请先生成文档快照:
npm run build:data
npm run build
npm run smoke