tmui-cli 1.3.0 → 2.0.1

package/README.md

@@ -1,103 +1,79 @@
+# tmui-cli
 
+TMUI DESIGN 终端工具：在命令行里创建或升级 uniapp CLI / HBX 项目，也可作为 IDE 的 MCP 服务。
 
-#  TMUI 3.0
+## 环境
 
-![TMUI 3.0](https://tmui.design/images/logoGreat.png)
+Node.js 22.18+
 
-### tmui-cli使用介绍
-
-#### 全局安装
-必须nodejs 18+以上版本才能使用
-```npm
-
-windows:
-npm -g install tmui-cli
-mac/liunx:
-sudo pm -g install tmui-cli
-
-安装成功后输入:tmui
-即可查看所有可用命令
-```
-
-## 1.1.6及以上的使用方式
-
-```npm
-在命令行中输入:tmui
-会打开默认浏览器,出现可视化安装界面,可以选择导入和管理你的项目.
+## 安装
 
+```bash
+npm i -g tmui-cli
+tmui
 ```
-1.1.6及以上的界面如下:
-
-![TMUI 3.0](https://cdn.tmui.design/public/design/tmuicli_img.png)
-
-## 1.1.5及以下的使用方式
-
-#### 使用
-请在项目文件的根目录下执行命令
-输入 ```tmui```
-即可取得所有可控的命令行
-
-#### 命令解释
-
-0. tmui 4x 创建uniappx 平台的hbx tmui4.0x项目
-1. tmui cli 创建uniapp 平台的cli初始项目，内部已经包含了tmui最新框架（自动更新）
-2. tmui hbx 创建uniapp 平台的HBX初始项目，内部已经包含了tmui最新框架（自动更新）
-3. tmui rcli 为【已有】uniapp 平台的cli项目，更新和下载tmui最新框架（自动更新）
-4. tmui rhbx 为【已有】uniapp 平台的HBX项目，更新和下载tmui最新框架（自动更新）
-4. tmui use 为保姆级引导式下载安装上述功能项目。
 
-#### 注意事项
-如果你是需要创建tmui新项目可以使用命令行创建全新的项目。<br>
-如果你是为老项目添加本tmui框架，你下载安装后，还需要按照文档步骤配置 [配置](https://tmui.design/doc/start/%E5%BF%AB%E9%80%9F%E4%B8%8A%E6%89%8B.html)<br>
-如果是全新的使用本cli创建项目，则是一键配置到位，安装完立即就可以编译出一个tmui 程序的demo
+## 使用
 
+在任意目录执行 `tmui`
 
+升级：
 
-[![star](https://gitee.com/LYTB/tmui-design/badge/star.svg?theme=dark)](https://gitee.com/LYTB/tmui-design/stargazers) [![fork](https://gitee.com/LYTB/tmui-design/badge/fork.svg?theme=dark)](https://gitee.com/LYTB/tmui-design/members)
+- TMUI：下载组件库到 `uni_modules/tm-ui`（3.1 为 `tmui`）
+- UniSdk：仅 CLI，改 `package.json` 后用所选 npm/pnpm 安装
 
-### [tmui3.0开发文档](https://tmui.design/)
+按键：`↑/↓` 选择，`Enter` 确认，`Esc` 返回，`Ctrl+C` 退出。
 
- TMUI 3.0有以下可见的优势方案执行未来的发展：
-- 暗黑模式更为可靠
-- 主题配置更为简单
-- 组件库精细化打磨
-- 依托UNIAPP全平台兼容性，以原生渲染为基础的全平台兼容。
-- 常用功能组件不断迭代更新发布
-- 各组件样式设置丰富，不局限，尽量能做到千人千面。
-- 各组件经过微信开发工具的性能测试>=96分以上
+## MCP（给 Cursor / VS Code 等 IDE 用）
 
-[![同名自定义/tmui design](https://gitee.com/LYTB/tmui-design/widgets/widget_card.svg?colors=393222,ebdfc1,fffae5,d8ca9f,393222,a28b40)](https://gitee.com/LYTB/tmui-design)
+`tmui mcp` 启动 MCP stdio 服务，**不会**打开交互界面。stdout 只走协议。
 
-[tmui2.0文档](https://ext.dcloud.net.cn/plugin?id=5949)
+全局安装后，在 IDE 的 MCP 配置里写：
 
-### [注意事项](https://ext.dcloud.net.cn/plugin?name=tm-ui)
-
-- 提出建议和bug,请访问码云代码库：[点击打开](https://gitee.com/LYTB/tmui-design)
-，并反馈相关bug或者建议.
-
----
-### [贡献者](https://tmui.design/doc/start/%E8%B4%A1%E7%8C%AE%E8%80%85.html#%E8%B4%A1%E7%8C%AE%E4%BA%BA%E5%91%98)
-在伟大的无私贡献人员帮助下，使得此开源项目的可持续性发展更加的持久。他/她们理应得到展示，并为大家所知。不管是如何的贡献，哪怕很小的一部分也值得称赞！！<br>
-点击图片查看更多
-
-[![](https://vkceyugu.cdn.bspapp.com/VKCEYUGU-f5b1722f-8766-40af-a22a-acc454202a37/ef8a8962-1153-44c9-aee5-6a616996e595.jpg)](https://tmui.design/doc/start/%E8%B4%A1%E7%8C%AE%E8%80%85.html)
-
-**微信用户群2** <br>
-![用户群](https://cdn.tmui.design/public/design/weixinQR2.jpg)
-
-----
-
-### 版本预览
-
-![tmui3.0 预览](https://cdn.tmui.design/public/design/verHeji.jpg)
+```json
+{
+  "mcpServers": {
+    "tmui": {
+      "command": "tmui",
+      "args": ["mcp"]
+    }
+  }
+}
+```
 
-----
+或用 npx（无需全局安装）：
+
+```json
+{
+  "mcpServers": {
+    "tmui": {
+      "command": "npx",
+      "args": ["-y", "tmui-cli", "mcp"]
+    }
+  }
+}
+```
 
-### 赞助项目，以持续更新
+本仓库开发期可指向构建产物：
+
+```json
+{
+  "mcpServers": {
+    "tmui": {
+      "command": "node",
+      "args": ["xui-cli/dist/main.mjs", "mcp"]
+    }
+  }
+}
+```
 
-如果帮到了你，适当的赞助有助力作者成果上的回报，报以项目的持续更新。
+提供的工具：`create_uniapp_hbx_project`、`create_uniapp_cli_project`、`query_tmui_config`、`list_components`、`get_component_doc`、`query_tmui_doc`。
 
-![tmui3.0 赞助](https://cdn.tmui.design/public/design/payzhanzhu.jpg)
+发布前请先生成文档快照：
 
-----
+```bash
+npm run build:data
+npm run build
+npm run smoke
+```