Skip to content

Repository files navigation

antv-g6-query

中文 | English

antv-g6-query 是一个可分发的通用 Agent Skill,用于从本地 AI 友好的知识库中检索 AntV G6 官方文档。

本技能内置由 G6 中文 /manual/api 官方文档生成的轻量 JSONL 语料,可以帮助 Agent 回答 @antv/g6 API、图数据、节点、边、组合、布局、插件、交互、数据处理、主题、渲染、配置项和迁移相关问题,并在回答中引用原始 G6 官方文档 URL。

仓库地址:shallinta/antv-g6-query

功能

  • 基于本地 G6 文档语料检索,回答问题时不必每次重新浏览官网。
  • 提供单一检索入口:skills/antv-g6-query/scripts/search-kb.mjs
  • 输出结构化 JSON,包含命中文档片段、相关实体、链接扩展、目录层级和引用来源。
  • 引用来源指向原始官方页面,例如 https://g6.antv.antgroup.com/api/data
  • 可分发技能目录位于 skills/antv-g6-query/
  • 当前仓库保留可复现的官网同步、Markdown 转换和语料构建流程。

安装

方式一:使用 Skills CLI 安装

npx skills add shallinta/antv-g6-query --skill antv-g6-query -g -y

安装后,重新开始或刷新你的 Agent 会话,让技能列表生效。

方式二:手动本地安装到不同 Agent

git clone https://github.com/shallinta/antv-g6-query.git
cd antv-g6-query

# Codex
mkdir -p ~/.codex/skills
cp -R skills/antv-g6-query ~/.codex/skills/antv-g6-query

# Claude Code
mkdir -p ~/.claude/skills
cp -R skills/antv-g6-query ~/.claude/skills/antv-g6-query

# opencode
mkdir -p ~/.opencode/skills
cp -R skills/antv-g6-query ~/.opencode/skills/antv-g6-query

# OpenClaw
mkdir -p ~/.openclaw/skills
cp -R skills/antv-g6-query ~/.openclaw/skills/antv-g6-query

# Hermes
mkdir -p ~/.hermes/skills
cp -R skills/antv-g6-query ~/.hermes/skills/antv-g6-query

以上路径是常见本地技能目录示例。如果你的 Agent 使用其他技能目录,把 skills/antv-g6-query 复制到对应目录即可。任意 Agent 都可以使用这个技能,只要它能够读取 SKILL.md 风格的指令目录,并能运行技能内置的 Node.js 检索脚本。

方式三:让运行中的 Agent 安装

如果你的 Agent 支持通过自然语言安装技能,也可以直接告诉它:

安装这个技能:https://github.com/shallinta/antv-g6-query

安装完成后,重新开始或刷新你的 Agent 会话,让技能列表生效。

使用

在任意支持 Agent Skill 的 Agent 中直接提出 G6 文档问题,例如:

Graph.getNodeData 支持哪些调用方式?
G6 圆形节点 size 怎么配置?
ProcessParallelEdges 的 merge 和 bundle 模式有什么区别?
如何在 G6 中使用 React 定义节点?

技能会要求 Agent 在回答前运行本地检索脚本,并在回答中引用原始 G6 官方文档 URL。

也可以在本仓库中直接运行检索脚本,或把它接入到工作流编排、RAG pipeline、CI 检查、自动文档问答等场景中。脚本默认输出 JSON,适合由上游编排器读取 resultsmatched_entitiescitations 后再交给 Agent 生成最终回答:

node skills/antv-g6-query/scripts/search-kb.mjs "Graph.getNodeData 支持哪些调用方式?" --limit 6
node skills/antv-g6-query/scripts/search-kb.mjs "圆形节点 size 怎么配置?" --text

常用参数:

--limit <n>             返回结果数量,默认 8
--max-text-chars <n>    每条结果最多输出的正文字符数,默认 1800
--references <dir>      指定包含 chunks/documents/entities/links JSONL 的目录
--skill-dir <dir>       指定技能目录,默认使用脚本父级目录
--no-entities           关闭实体精确匹配增强
--no-links              关闭本地链接扩展
--no-documents          关闭页面元数据增强
--text                  输出可读文本,而不是 JSON

项目结构

skills/antv-g6-query/
  SKILL.md                       Agent 加载的技能说明
  agents/openai.yaml             UI 元数据
  scripts/search-kb.mjs          对外检索入口
  references/*.jsonl             技能分发版内置轻量知识库

knowledge-base/
  sources/manifest.json          爬取清单和 source metadata
  sources/navigation.md          用于生成 breadcrumb 的文档导航树
  sources/docs/                  官方文档 Markdown 本地镜像
  sources/assets/                本地化的文档媒体资源
  corpus/*.jsonl                 生成后的检索语料
  eval/queries.jsonl             检索评测种子问题
  indexes/                       下游索引预留目录

scripts/
  sync-g6-docs.mjs               爬取并转换官方文档
  build-rag-corpus.mjs           构建 JSONL 检索语料
  verify-output.mjs              校验 source snapshot 完整性
  verify-rag-corpus.mjs          校验语料完整性

从源码构建

安装依赖:

pnpm install

刷新 G6 官方文档快照:

pnpm run sync

该命令会把 source snapshot 写入 knowledge-base/sources/

  • manifest.json
  • navigation.md
  • README.md
  • docs/**/*.md
  • assets/*

校验 source snapshot:

pnpm run verify

构建 AI 检索语料:

pnpm run kb

校验语料:

pnpm run verify:kb

刷新可分发技能引用文件:

cp knowledge-base/corpus/documents.jsonl skills/antv-g6-query/references/
cp knowledge-base/corpus/chunks.jsonl skills/antv-g6-query/references/
cp knowledge-base/corpus/entities.jsonl skills/antv-g6-query/references/
cp knowledge-base/corpus/links.jsonl skills/antv-g6-query/references/

校验技能包:

python3 /Users/bytedance/.codex/skills/.system/skill-creator/scripts/quick_validate.py skills/antv-g6-query

运行测试:

pnpm test

更新知识库

当 G6 官方文档更新时:

  1. 运行 pnpm run sync
  2. 运行 pnpm run verify
  3. 运行 pnpm run kb
  4. 运行 pnpm run verify:kb
  5. knowledge-base/corpus/*.jsonl 复制到 skills/antv-g6-query/references/
  6. 根据 knowledge-base/sources/manifest.json 更新 skills/antv-g6-query/SKILL.md 中的 Corpus Snapshot
  7. 运行技能校验、测试和至少一次检索冒烟测试。

当前语料快照:

  • Source: https://g6.antv.antgroup.com
  • Scope: Chinese /manual and /api
  • Documents: 144
  • Last synced: 2026-07-10T04:02:40.314Z

分发说明

轻量可分发技能包是 skills/antv-g6-query/。它只包含技能说明、检索脚本、UI 元数据和 JSONL references。

完整仓库额外保留 source snapshot 和语料生成脚本,用于在上游 G6 文档更新后可复现地更新技能。

About

让 Agent 更方便的检索 AntV/G6 文档的技能,已构建本地知识库,安装后可离线使用。

Resources

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages