vtj/docs/llms/quick-ref.md

VTJ 工具速查清单

AI 意图 → 工具/文档 快速映射。按任务场景查找，直达对应工具或文档。

---

一、页面管理

意图	工具方法	参考文档
查看页面树/菜单结构	getMenus	page.md
获取所有页面列表	getPages	page.md
新建页面	createPage	page.md
修改页面信息	updatePage	page.md
调整页面层级/父级	movePage	page.md
删除页面	removePage	page.md
设为首页	setHomepage	page.md

二、区块管理

意图	工具方法	参考文档
查看所有区块	getBlocks	block.md
创建区块	createBlock	block.md
修改区块信息	updateBlock	block.md
删除区块	removeBlock	block.md

三、API 接口管理

意图	工具方法	参考文档
查看所有接口	getApis	api.md
新建/更新接口	setApi	api.md
删除单个接口	removeApi	api.md
批量删除接口	removeApis	api.md
组件中调用接口	→ 用 __apis.xxx()	api.md、globals.md

四、文件与运行时操作

意图	工具方法
打开（激活）页面/区块	active
获取当前打开文件信息	getCurrentFile
获取当前文件 Vue 源码	getCurrentFileContent
刷新运行时、检测错误	refresh
获取选中节点路径	getNodeSelected

五、全局配置

意图	工具方法	参考文档
全局 CSS	getGlobalCss / setGlobalCss	settings.md
Pinia Store（vue3 状态管理）	getGlobalStore / setGlobalStore	settings.md
权限控制配置	getGlobalAccess / setGlobalAccess	settings.md
Axios 请求基础配置	getGlobalAxios / setGlobalAxios	settings.md
请求拦截器	getGlobalRequestInterceptor / setGlobalRequestInterceptor	settings.md
响应拦截器	getGlobalResponseInterceptor / setGlobalResponseInterceptor	settings.md
路由前置守卫	getGlobalBeforeEach / setGlobalBeforeEach	settings.md
路由后置守卫	getGlobalAfterEach / setGlobalAfterEach	settings.md

所有 set 类配置传入 JS 函数代码字符串，详见 settings.md。

六、环境变量管理

意图	工具方法	参考文档
查看所有环境变量	getEnv	env.md
新增环境变量	createEnv	env.md
删除环境变量	removeEnv	env.md
组件中访问	→ __provider.env.变量名	env.md、globals.md

七、国际化 i18n

意图	工具方法	参考文档
查看所有词条	getI18nMessage	i18n.md
新增词条	createI18nMessage	i18n.md
删除词条	removeI18nMessage	i18n.md
组件中使用翻译	→ __i18n.t('key')	i18n.md、globals.md

八、UniApp 专属

意图	工具方法/参数	参考文档
查看 UniApp 配置	getUniConfig(key)	uni.md
配置 manifest.json	setUniConfig("manifestJson", jsonStr)	uni.md
配置 pages.json	setUniConfig("pagesJson", jsonStr)	uni.md
全局 CSS	setUniConfig("css", cssStr)	uni.md
生命周期：启动/显示/隐藏等	setUniConfig("onLaunch", fnStr) 等	uni.md
配置 tabBar	→ 编辑 pagesJson 中的 tabBar 字段	uni.md

九、技能文档查询

意图	操作
查阅特定功能的详细用法	getSkills([技能ID]) — 技能 ID 见下表

可用技能 ID 与文档映射：

技能 ID	文档	速查场景
api	api.md	API 配置、路径参数、Mock 数据、接口调用规范
block	block.md	区块概念、来源类型、复用机制
chart	chart.md	XChart、XMapChart、ECharts 图表配置
coder	coder.md	Vue Composition API 代码规范（AI 生成代码前必读）
env	env.md	环境变量双环境配置、UPPER_SNAKE_CASE 命名
globals	globals.md	全局注入变量详解：__store、__request、__apis、__access 等
i18n	i18n.md	多语言词条管理、__i18n.t() 翻译、参数插值
icons	icons.md	图标库 4 种来源、XIcon 组件、按需导入
page	page.md	页面类型（page/dir/layout）、路由体系、KeepAlive
settings	settings.md	全局配置（Store/Access/Axios/路由守卫）详细说明
tools	tools.md	所有设计器工具方法完整文档
ui	ui.md	@vtj/ui 组件：XGrid、XForm、XField、XDialog、Hooks
uni	uni.md	UniApp 平台配置（仅 UniApp 生效）
utils	utils.md	@vtj/utils 工具库：HTTP 请求、storage、URL 处理等

十、编程库 / 全局 API 速查

模块	用途	组件中访问方式	参考文档
@vtj/renderer	全局注入能力	__store、__request、__apis、__access、__libs、__pinia、__i18n、__provider	globals.md
@vtj/ui	企业级 UI 组件	<XGrid>, <XForm>, <XDialog>, <XField> 等	ui.md
@vtj/charts	ECharts 图表	<XChart>, <XMapChart>, useChart()	chart.md
@vtj/icons	图标系统	<XIcon icon="xxx">	icons.md
@vtj/utils	通用工具函数	request(), storage, url, downloadBlob 等	utils.md

十一、代码生成速查

场景	核心约束	参考文档
生成 Vue 页面/区块代码	强制 Composition API + script setup；状态命名 __state、props __props、emit __emit；用 __apis.xxx() 调接口；全局变量用 __store/__request/__access 等	coder.md（必读）
使用 UI 组件	组件 PascalCase 引用；@vtj/ui 组件用 <XGrid> 等；图表用 <XChart>；图标用 <XIcon>	ui.md、chart.md、icons.md
调用 API	const { data } = await __apis.getUserList({ ...opts })	api.md
使用全局 Store	const user = __store.state.user; __store.setUser(data)	settings.md、globals.md
模板翻译	{{ $t('key') }} — 注意：Composition 下 $t 仅在模板可用	i18n.md

十二、典型工作流

1. 了解项目 → getMenus / getPages                 (了解页面结构)
2. 创建页面 → createPage(page, parentId?)           (先父级再子级)
3. 创建区块 → createBlock(block)                    (跨页面复用的组件)
4. 注册接口 → setApi(apiSchema)                     (后端 API 对接)
5. 生成代码 → 遵循 coder.md 规范 + 调用 getSkills    (AI 生成 Vue 源码)
6. 验证结果 → refresh                               (检测运行时错误)
7. 全局配置 → setGlobalStore / setGlobalAccess 等    (Store/权限/路由守卫)
8. i18n 配置 → createI18nMessage                    (多语言词条)
9. 环境变量 → createEnv                             (开发/生产双环境值)

---

速查索引（按关键词）

关键词	动作
创建页面/删除页面/移动页面	→ 见页面管理
创建区块/删除区块	→ 见区块管理
注册接口/调接口/__apis	→ 见API 管理 + api.md
获取源码/刷新/选中节点	→ 见文件与运行时
全局CSS/Store/Pinia	→ 见全局配置 + settings.md
权限/登录/access	→ setGlobalAccess + settings.md
Axios/baseURL/请求拦截	→ setGlobalAxios + settings.md
路由守卫/beforeEach	→ setGlobalBeforeEach + settings.md
环境变量/env/__provider	→ 见环境变量 + env.md
i18n/多语言/翻译/$t	→ 见i18n + i18n.md
UniApp/manifest/pages.json	→ 见UniApp + uni.md
代码规范/Composition API/script setup	→ coder.md
全局变量/**store/**request/__libs	→ globals.md
XGrid 表格/XForm 表单/XDialog	→ ui.md
XChart 图表/useChart/ECharts	→ chart.md
XIcon 图标/SVG/Iconfont	→ icons.md
request/storage/工具函数	→ utils.md
生成 Vue 代码/parser 解析	→ coder.md
查看详细工具文档	→ tools.md