跳到主要内容

Gitnexus 探索器

使用 GitNexus 索引代码库,并通过 Web UI + Cloudflare 隧道提供交互式知识图谱服务。

技能元数据

可选 — 使用 hermes skills install official/research/gitnexus-explorer 安装
路径optional-skills/research/gitnexus-explorer
版本1.0.0
作者Hermes Agent + Teknium
许可MIT
平台linux, macos, windows
标签gitnexus, code-intelligence, knowledge-graph, visualization
相关技能native-mcp, codebase-inspection

参考:完整的 SKILL.md

信息

以下是 Hermes 在触发此技能时加载的完整技能定义。这是智能体在技能激活时看到的指令内容。

GitNexus 探索器

将任何代码库索引到知识图谱中,并提供一个交互式 Web UI 来探索符号、调用链、聚类和执行流。通过 Cloudflare 隧道进行远程访问。

使用场景

  • 用户想要直观地探索代码库的架构
  • 用户请求仓库的知识图谱/依赖关系图
  • 用户想要与他人共享一个交互式的代码库探索器

前提条件

  • Node.js (v18+) — GitNexus 和代理所需
  • git — 仓库必须有一个 .git 目录
  • cloudflared — 用于隧道(如果缺失,将自动安装到 ~/.local/bin)

规模警告

Web UI 会在浏览器中渲染所有节点。大约少于 5,000 个文件的仓库工作良好。大型仓库(3万+ 节点)可能会运行缓慢或使浏览器标签页崩溃。CLI/MCP 工具适用于任何规模 — 只有 Web 可视化存在此限制。

步骤

1. 克隆并构建 GitNexus(一次性设置)

GITNEXUS_DIR="${GITNEXUS_DIR:-$HOME/.local/share/gitnexus}"

if [ ! -d "$GITNEXUS_DIR/gitnexus-web/dist" ]; then
git clone https://github.com/abhigyanpatwari/GitNexus.git "$GITNEXUS_DIR"
cd "$GITNEXUS_DIR/gitnexus-shared" && npm install && npm run build
cd "$GITNEXUS_DIR/gitnexus-web" && npm install
fi

2. 修补 Web UI 以支持远程访问

Web UI 默认使用 localhost:4747 进行 API 调用。修补它以使用同源策略,以便它能通过隧道/代理工作:

文件:$GITNEXUS_DIR/gitnexus-web/src/config/ui-constants.ts 将:

export const DEFAULT_BACKEND_URL = 'http://localhost:4747';

改为:

export const DEFAULT_BACKEND_URL = typeof window !== 'undefined' && window.location.hostname !== 'localhost' ? window.location.origin : 'http://localhost:4747';

文件:$GITNEXUS_DIR/gitnexus-web/vite.config.tsserver: { } 块内添加 allowedHosts: true(仅当运行开发模式而非生产构建时需要):

server: {
allowedHosts: true,
// ... 现有配置
},

然后构建生产包:

cd "$GITNEXUS_DIR/gitnexus-web" && npx vite build

3. 索引目标仓库

cd /path/to/target-repo
npx gitnexus analyze --skip-agents-md
rm -rf .claude/ # 移除 Claude Code 特定的产物

添加 --embeddings 以支持语义搜索(更慢 — 需要数分钟而非数秒)。

索引文件保存在仓库内的 .gitnexus/ 目录中(自动被 gitignore)。

4. 创建代理脚本

将以下内容写入一个文件(例如,$GITNEXUS_DIR/proxy.mjs)。它提供生产版 Web UI 的服务,并将 /api/* 请求代理到 GitNexus 后端 — 同源,没有 CORS 问题,无需 sudo,无需 nginx。

import http from 'node:http';
import fs from 'node:fs';
import path from 'node:path';

const API_PORT = parseInt(process.env.API_PORT || '4747');
const DIST_DIR = process.argv[2] || './dist';
const PORT = parseInt(process.argv[3] || '8888');

const MIME = {
'.html': 'text/html', '.js': 'application/javascript', '.css': 'text/css',
'.json': 'application/json', '.png': 'image/png', '.svg': 'image/svg+xml',
'.ico': 'image/x-icon', '.woff2': 'font/woff2', '.woff': 'font/woff',
'.wasm': 'application/wasm',
};

function proxyToApi(req, res) {
const opts = {
hostname: '127.0.0.1', port: API_PORT,
path: req.url, method: req.method, headers: req.headers,
};
const proxy = http.request(opts, (upstream) => {
res.writeHead(upstream.statusCode, upstream.headers);
upstream.pipe(res, { end: true });
});
proxy.on('error', () => { res.writeHead(502); res.end('Backend unavailable'); });
req.pipe(proxy, { end: true });
}

function serveStatic(req, res) {
let filePath = path.join(DIST_DIR, req.url === '/' ? 'index.html' : req.url.split('?')[0]);
if (!fs.existsSync(filePath)) filePath = path.join(DIST_DIR, 'index.html');
const ext = path.extname(filePath);
const mime = MIME[ext] || 'application/octet-stream';
try {
const data = fs.readFileSync(filePath);
res.writeHead(200, { 'Content-Type': mime, 'Cache-Control': 'public, max-age=3600' });
res.end(data);
} catch { res.writeHead(404); res.end('Not found'); }
}

http.createServer((req, res) => {
if (req.url.startsWith('/api')) proxyToApi(req, res);
else serveStatic(req, res);
}).listen(PORT, () => console.log(`GitNexus proxy on http://localhost:${PORT}`));

5. 启动服务

# 终端 1:GitNexus 后端 API
npx gitnexus serve &

# 终端 2:代理(Web UI + API 在同一端口)
node "$GITNEXUS_DIR/proxy.mjs" "$GITNEXUS_DIR/gitnexus-web/dist" 8888 &

验证:curl -s http://localhost:8888/api/repos 应返回已索引的仓库。

6. 使用 Cloudflare 隧道(可选 — 用于远程访问)

# 如果需要,安装 cloudflared(无需 sudo)
if ! command -v cloudflared &>/dev/null; then
mkdir -p ~/.local/bin
curl -sL https://github.com/cloudflare/cloudflared/releases/latest/download/cloudflared-linux-amd64 \
-o ~/.local/bin/cloudflared
chmod +x ~/.local/bin/cloudflared
export PATH="$HOME/.local/bin:$PATH"
fi

# 启动隧道(--config /dev/null 避免与现有的命名隧道配置冲突)
cloudflared tunnel --config /dev/null --url http://localhost:8888 --no-autoupdate --protocol http2

隧道 URL(例如 https://random-words.trycloudflare.com)将打印到标准错误。分享它 — 任何拥有链接的人都可以探索该图谱。

7. 清理

# 停止服务
pkill -f "gitnexus serve"
pkill -f "proxy.mjs"
pkill -f cloudflared

# 从目标仓库中移除索引
cd /path/to/target-repo
npx gitnexus clean
rm -rf .claude/

注意事项

  • 对于 cloudflared,--config /dev/null 是必需的,如果用户现有的命名隧道配置位于 ~/.cloudflared/config.yml。没有它,配置中的通配符入口规则会为所有快速隧道请求返回 404。

  • 隧道必须使用生产构建。 Vite 开发服务器默认会阻止非 localhost 主机(allowedHosts)。生产构建 + Node 代理完全避免了这个问题。

  • Web UI 不会创建 .claude/CLAUDE.md 这些是由 npx gitnexus analyze 创建的。使用 --skip-agents-md 来抑制 markdown 文件的生成,然后 rm -rf .claude/ 移除其余部分。这些是 hermes-agent 用户不需要的 Claude Code 集成。

  • 浏览器内存限制。 Web UI 会将整个图谱加载到浏览器内存中。拥有 5k+ 文件的仓库可能会运行缓慢。30k+ 文件可能会导致标签页崩溃。

  • 嵌入是可选的。 --embeddings 启用语义搜索,但在大型仓库上需要数分钟。快速探索时可以跳过它;如果您想通过 AI 聊天面板进行自然语言查询,请添加它。

  • 多个仓库。 gitnexus serve 为所有已索引的仓库提供服务。索引多个仓库,启动一次 serve,Web UI 允许您在它们之间切换。