@quicktvui/ai 1.1.0 → 1.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. package/README.md +31 -0
  2. package/USAGE.md +22 -7
  3. package/package.json +1 -1
  4. package/rules/.docs/zh-CN/guide/ai/ai-assistant.md +16 -6
package/README.md CHANGED
@@ -37,6 +37,37 @@ yarn add @quicktvui/ai --dev
37
37
 
38
38
  ---
39
39
 
40
+ ## 🌐 可选：全局 Skills 安装（Skill Runtime）
41
+
42
+ 如果你使用支持 `~/.agents/skills/` 的 Agent（如部分本地 Agent 工具链），可以额外安装全局 skills：
43
+
44
+ ```bash
45
+ npm install -g @quicktvui/ai-cli @quicktvui/ai-skills
46
+ quicktvui-ai init
47
+ quicktvui-ai doctor
48
+ ```
49
+
50
+ 默认会安装到：
51
+
52
+ - `~/.agents/skills/quicktvui`
53
+
54
+ 并自动维护 Gemini 全局桥接配置：
55
+
56
+ - `~/.gemini/GEMINI.md`（加入 QuickTVUI skill `@...` 引入块）
57
+ - `~/.gemini/settings.json`（补齐 `context.fileName`）
58
+
59
+ 常用命令：
60
+
61
+ ```bash
62
+ quicktvui-ai validate
63
+ quicktvui-ai update
64
+ quicktvui-ai prompt --lang zh
65
+ ```
66
+
67
+ > 注意：全局 skills 不是对所有 AI 都自动生效。对仅读取项目文件的工具，仍需使用 `npm install @quicktvui/ai --save-dev` 注入项目内规则。
68
+
69
+ ---
70
+
40
71
  ## 🤖 支持的 AI 工具与配置
41
72
 
42
73
  本包一次性适配了市面上主流的 AI 编程助手，安装后会自动在项目根目录生成对应的配置文件：
package/USAGE.md CHANGED
@@ -4,7 +4,7 @@
4
4
 
5
5
  ## 1. 快速上手
6
6
 
7
- ### 第一步：安装规范包
7
+ ### 模式 A：项目内规则（兼容 Cursor/Copilot/Cline）
8
8
 
9
9
  在你的 QuickTVUI 项目（建议使用 `quicktvui-template` 创建）中安装：
10
10
 
@@ -12,16 +12,31 @@
12
12
  npm install @quicktvui/ai --save-dev
13
13
  ```
14
14
 
15
- ### 第二步：配置并开启推荐模型
15
+ AI 助手将自动读取项目根目录下的 `.cursorrules`, `GEMINI.md`, `CLAUDE.md` 等文件中的指令。
16
+
17
+ ### 模式 B：全局 Skills（兼容支持 `~/.agents/skills` 的 Agent）
18
+
19
+ ```bash
20
+ npm install -g @quicktvui/ai-cli @quicktvui/ai-skills
21
+ quicktvui-ai init
22
+ quicktvui-ai doctor
23
+ ```
24
+
25
+ 默认安装目录：
26
+
27
+ - `~/.agents/skills/quicktvui`
28
+
29
+ 安装后请重启或 reload AI Agent，让其重新扫描本地 skills。
30
+ `quicktvui-ai init` 同时会自动维护 Gemini 全局桥接配置（`~/.gemini/GEMINI.md` 与 `~/.gemini/settings.json`）。
31
+
32
+ ### 推荐模型
16
33
 
17
34
  为了达到最佳辅助效果，请在你的 AI 工具中优先选择以下模型：
18
35
 
19
- - **Claude **
36
+ - **Claude**
20
37
  - **Codex**
21
38
  - **Gemini**
22
39
 
23
- AI 助手将自动读取项目根目录下的 `.cursorrules`, `GEMINI.md`, `CLAUDE.md` 等文件中的指令。
24
-
25
40
  ## 2. 常见场景 AI 辅助示例
26
41
 
27
42
  ### 场景 A：创建新页面
@@ -32,7 +47,7 @@ AI 助手将自动读取项目根目录下的 `.cursorrules`, `GEMINI.md`, `CLAU
32
47
  ### 场景 B：API 查询
33
48
 
34
49
  **输入：** “qt-image 支持哪些属性？”
35
- **AI 将检索：** 它会查阅 `node_modules/@quicktvui/ai/rules/.docs/component/image.md` 并返回：`src`, `enableFade`,
50
+ **AI 将检索：** 它会查阅 `node_modules/@quicktvui/ai/rules/.docs/zh-CN/component/image.md` 并返回：`src`, `enableFade`,
36
51
  `resizeMode` 等原生支持的属性。
37
52
 
38
53
  ### 场景 C：样式纠错
@@ -71,4 +86,4 @@ AI 助手将自动读取项目根目录下的 `.cursorrules`, `GEMINI.md`, `CLAU
71
86
 
72
87
  1. **重新引用规则**：告诉它：“请参考项目根目录下的 `.cursorrules` (或 `GEMINI.md`) 重新检查规范。”
73
88
  2. **强制读取文档**：告诉它：“请读取 `node_modules/@quicktvui/ai/rules/.docs/` 下的相关组件文档后再回答。”
74
-
89
+ 3. **检查全局技能安装**：运行 `quicktvui-ai doctor --strict`，确认 `~/.agents/skills/quicktvui` 目录和必需文件完整。
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@quicktvui/ai",
3
- "version": "1.1.0",
3
+ "version": "1.1.1",
4
4
  "description": "QuickTVUI AI 开发规范与脚手架注入工具",
5
5
  "main": "index.js",
6
6
  "scripts": {
package/rules/.docs/zh-CN/guide/ai/ai-assistant.md CHANGED
@@ -4,7 +4,7 @@
4
4
 
5
5
  ## 1. 快速上手
6
6
 
7
- ### 第一步：安装规范包
7
+ ### 方式 A：安装项目规范包（推荐，通用）
8
8
 
9
9
  在你的 QuickTVUI 项目（建议使用 `quicktvui-template` 创建）中安装：
10
10
 
@@ -12,7 +12,19 @@
12
12
  npm install @quicktvui/ai --save-dev
13
13
  ```
14
14
 
15
- ### 第二步：配置并开启推荐模型
15
+ AI 助手将自动读取项目根目录下的 `.cursorrules`, `GEMINI.md`, `CLAUDE.md` 等文件中的指令。
16
+
17
+ ### 方式 B：安装全局 Skills（可选）
18
+
19
+ ```bash
20
+ npm install -g @quicktvui/ai-cli @quicktvui/ai-skills
21
+ quicktvui-ai init
22
+ quicktvui-ai doctor
23
+ ```
24
+
25
+ 默认安装目录为 `~/.agents/skills/quicktvui`。
26
+
27
+ ### 推荐模型
16
28
 
17
29
  为了达到最佳辅助效果，请在你的 AI 工具中优先选择以下模型：
18
30
 
@@ -20,8 +32,6 @@ npm install @quicktvui/ai --save-dev
20
32
  - **Codex**
21
33
  - **Gemini**
22
34
 
23
- AI 助手将自动读取项目根目录下的 `.cursorrules`, `GEMINI.md`, `CLAUDE.md` 等文件中的指令。
24
-
25
35
  ## 2. 常见场景 AI 辅助示例
26
36
 
27
37
  ### 场景 A：创建新页面
@@ -32,7 +42,7 @@ AI 助手将自动读取项目根目录下的 `.cursorrules`, `GEMINI.md`, `CLAU
32
42
  ### 场景 B：API 查询
33
43
 
34
44
  **输入：** “qt-image 支持哪些属性？”
35
- **AI 将检索：** 它会查阅 `node_modules/@quicktvui/ai/rules/.docs/component/image.md` 并返回：`src`, `enableFade`,
45
+ **AI 将检索：** 它会查阅 `node_modules/@quicktvui/ai/rules/.docs/zh-CN/component/image.md` 并返回：`src`, `enableFade`,
36
46
  `resizeMode` 等原生支持的属性。
37
47
 
38
48
  ### 场景 C：样式纠错
@@ -71,4 +81,4 @@ AI 助手将自动读取项目根目录下的 `.cursorrules`, `GEMINI.md`, `CLAU
71
81
 
72
82
  1. **重新引用规则**：告诉它：“请参考项目根目录下的 `.cursorrules` (或 `GEMINI.md`) 重新检查规范。”
73
83
  2. **强制读取文档**：告诉它：“请读取 `node_modules/@quicktvui/ai/rules/.docs/` 下的相关组件文档后再回答。”
74
-
84
+ 3. **全局技能体检**：如已使用全局 skills，执行 `quicktvui-ai doctor --strict` 检查安装状态。