# vjskills

**Repository Path**: vjmap/vjskills

## Basic Information

- **Project Name**: vjskills
- **Description**: 唯杰（VJMAP）产品二次开发 **Agent Skills** 合集。每个子目录是一个独立的 skill，遵循 Agent Skills 开放规范（`SKILL.md` frontmatter 含 `name` + `description`）。把它们放进 AI 编程助手的 skills 目录后，助手会在你开发相关功能时按需加载对应文档。
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-10-15
- **Last Updated**: 2026-10-15

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# vjskills

唯杰（VJMAP）产品二次开发 **Agent Skills** 合集。每个子目录是一个独立的 skill，遵循 Agent Skills 开放规范（`SKILL.md` frontmatter 含 `name` + `description`）。把它们放进 AI 编程助手的 skills 目录后，助手会在你开发相关功能时按需加载对应文档。Claude Code 等支持 Skills 的工具都可以使用。

## 包含的 skills

| 目录 | 产品 | 文档对应的 npm 包版本 | 适用场景 |
|---|---|---|---|
| `vjmap/` | 唯杰地图 2D | `vjmap@1.0.161` | 打开 DWG、地图初始化、坐标转换、互联网底图叠加、Marker / Popup / Symbol、图层样式表达式、事件、后端查询与导出 |
| `vjmapext/` | 唯杰地图 2D 扩展包（MapCadLayer） | `vjmapext@1.0.1`（依赖 vjmap） | CAD 实体绘制与编辑、命令、捕捉 / 夹点、标注、撤销重做、序列化、fx 特效、渲染性能 |
| `vjmap3d/` | 唯杰地图三维引擎 | `vjmap3d@2.0.0`（peer `three@>=0.185.0`） | App / MapViewEntity、三维实体、坐标转换、相机与控制、拾取、粒子、后处理、3D Tiles |
| `vjcad/` | 唯杰 WebCAD | `vjcad@1.0.16` | 浏览器 CAD 编辑器 / 查看器、实体、自定义命令与交互、图层与选择集、DWG 打开保存、插件与 UI 定制、参数化自动成图 |
| `vjvp/` | 唯杰 AI 可视化平台（VP） | `vjvpsdk`（未发布到公网 npm） | 大屏 / 看板、SDK 嵌入、手写 `.vpproj.json`、VP-TSX、组态与数字孪生 |
| `vjmap-service/` | 唯杰地图服务（REST） | — | 各产品共用后端：图纸上传打开、瓦片 / WMS、要素查询、分析、导出、WebCAD 图纸、KV 存储；附 Node / Python 单文件 SDK 与 OpenAPI |

## 安装


### 复制到 skills 目录

Claude Code 的 skills 目录为项目级 `.claude/skills/` 或用户级 `~/.claude/skills/`。每个 skill 目录直接放在该目录下，按需挑选。

```bash
mkdir -p .claude/skills
cp -r node_modules/vjskills/vjmap node_modules/vjskills/vjmapext .claude/skills/
```

PowerShell：

```powershell
New-Item -ItemType Directory -Force .claude/skills | Out-Null
Copy-Item -Recurse node_modules/vjskills/vjmap, node_modules/vjskills/vjmapext .claude/skills/
```

其他支持 Agent Skills 的工具，放到该工具约定的 skills 目录即可，同样每个 skill 一个子目录。

### 注意

- **保持目录名不变，平铺在同一个 skills 目录下。** `SKILL.md` 的 `name` 与目录名一致；vjmap 和 vjmapext 的文档以 `../../../vjmap/…` 形式互相链接。
- **使用 vjmapext 时请同时安装 vjmap。** 扩展包建立在 vjmap 底图之上，底图相关内容在 vjmap skill 中。
- 调用 REST 接口（上传图纸、查询、导出等）时可加装 `vjmap-service`。

## 目录结构

```
<skill>/
├── SKILL.md       主文档：frontmatter 供 AI 判断何时加载，正文是按任务索引的入口
├── references/    分主题参考文档，由 SKILL.md 按需链接
├── templates/     可直接运行的前端模板（vite-app / cdn / iframe-embed）
├── examples/      独立示例（vjvp、vjmap-service）
├── scripts/       辅助脚本（vjvp：工程 JSON 校验、VP-TSX 编译；vjmap-service：冒烟测试）
├── sdk/           vjmap-service 的 Node / Python 单文件 SDK
└── openapi/       vjmap-service 的 OpenAPI 描述
```

## 使用模板

- 模板里的 `_gitignore` 复制出来后改名为 `.gitignore`（npm 发布会丢弃 `.gitignore` 文件）。
- 服务地址、token、mapid 通过 `.env`（由 `.env.example` 复制）或文件顶部常量注入，模板不含真实凭据。
- 文档示例中 `YOUR_` 开头的占位符（如天地图的 `YOUR_TK`），请替换为自己申请的 key。
- `vjvpsdk` 未发布到公网 npm，vjvp 模板以私有 registry 或本地包路径方式引入，详见 `vjvp/templates/vite-app/README.md`。

## 文档 MCP（可选）

搭配产品文档 MCP 服务，可让助手查询 skill 未覆盖的细节：

| 产品 | MCP 地址 |
|---|---|
| vjmap 2D | `https://vjmap.com/server/aimcp/mcp?products=map2d` |
| vjmapext | `https://vjmap.com/server/aimcp/mcp?products=mapext` |
| vjmap3d | `https://vjmap.com/server/aimcp/mcp?products=map3d` |
| vjcad | `https://vjmap.com/server/aimcp/mcp?products=vjcad` |
| vjvp | `https://vjmap.com/server/vp/mcp` |
| 唯杰地图服务 | `https://vjmap.com/server/mcp?token=<token>` |

## 版本说明

文档内容按上表所列的 npm 包版本核对。产品升级后如接口有出入，以对应产品的官方文档为准。

## 许可

LGPL-3.0