mcpField
G
gitnexus-cli

gitnexus-cli

github.com/mindfold-ai开发15.1k86 次安装6 周前更新
代码仓库

关于 gitnexus-cli

gitnexus-cli 是用于管理代码库 GitNexus 索引的命令参考，涵盖索引构建、状态检查、清理、图谱文档生成及已注册代码库列表。

主要功能

  1. 01构建或刷新代码库索引
  2. 02检查索引新鲜度和计数
  3. 03删除单个或全部索引
  4. 04生成基于图谱的文档
  5. 05列出已注册代码库

适用场景

  1. 01首次为代码库建立索引
  2. 02代码变更后刷新索引
  3. 03删除损坏或过时的索引
  4. 04根据代码图谱生成代码库文档

MCP 相关

GitNexus 提供 MCP 工具，其中 `list_repos` 与 CLI 的 `list` 命令一样可列出代码库。说明还介绍了索引后读取 GitNexus 代码库上下文资源。

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/mindfold-ai/trellis --skill gitnexus-cli

安装后在 Claude Code 中输入/gitnexus-cli确认已加载。

详细介绍

GitNexus CLI 命令

以下命令使用 node .gitnexus/run.cjs <command>——项目本地运行器 gitnexus analyze 会将其放在索引旁边。它会在调用时自动选择可用的运行器（全局 gitnexus，否则使用 pnpm dlx，再否则使用 npx），因此不依赖特定的包管理器，也不需要全局安装。

尚未分析，或 node .gitnexus/run.cjs 报告 Cannot find module（被 Git 忽略的运行器不存在——例如刚克隆仓库或执行了 git clean）？在项目根目录运行 npx gitnexus analyze 重新生成。使用 npm 11.x 时，如果 npx 在安装期间崩溃（node.target is null），请使用 npm i -g gitnexus 安装一次（然后运行 gitnexus analyze），或者使用 pnpm --allow-build=@ladybugdb/core --allow-build=gitnexus --allow-build=tree-sitter dlx gitnexus@latest analyze。参见 #1939。

命令

analyze — 构建或刷新索引
node .gitnexus/run.cjs analyze

在项目根目录运行。此命令会解析所有源文件、构建知识图谱、将其写入 .gitnexus/，并生成 CLAUDE.md / AGENTS.md 上下文文件。

标志作用
--force强制完整重新索引，即使索引已是最新
--embeddings启用嵌入生成，以支持语义搜索（默认关闭）
--drop-embeddings重建时删除现有嵌入。默认情况下，不带 --embeddings 的 analyze 会保留嵌入。

运行时机： 首次在项目中使用、重大代码更改后，或 gitnexus://repo/{name}/context 报告索引已过期时。在 Claude Code 中，PostToolUse 钩子会在 git commit 和 git merge 后检测索引是否过期，并通知 Agent 运行 analyze——该钩子本身不会运行分析，以避免阻塞 Agent 长达 120s，并防止超时导致 KuzuDB 损坏。

status — 检查索引是否最新
node .gitnexus/run.cjs status

显示当前仓库是否有 GitNexus 索引、上次更新时间，以及符号和关系的数量。可用它检查是否需要重新索引。

clean — 删除索引
node .gitnexus/run.cjs clean

删除 .gitnexus/ 目录，并从全局注册表中注销该仓库。如果索引损坏，或从项目中移除 GitNexus 后，可在重新索引前使用此命令。

标志作用
--force跳过确认提示
--all清理所有已索引的仓库，而不只是当前仓库
wiki — 根据图谱生成文档
node .gitnexus/run.cjs wiki

使用大模型根据知识图谱生成仓库文档。需要 API 密钥（首次使用时会保存到 ~/.gitnexus/config.json）。

标志作用
--force强制完整重新生成
--model <model>大模型（默认值：minimax/minimax-m2.5）
--base-url <url>大模型 API 基础 URL
--api-key <key>大模型 API 密钥
--concurrency <n>并行的大模型调用数（默认值：3）
--gist将 wiki 发布为公开的 GitHub Gist
list — 显示所有已索引的仓库
node .gitnexus/run.cjs list

列出在 ~/.gitnexus/registry.json 中注册的所有仓库。MCP list_repos 工具提供相同的信息。

索引完成后

  1. 读取 gitnexus://repo/{name}/context，确认索引已加载
  2. 根据任务使用其他 GitNexus 技能（exploring、debugging、impact-analysis、refactoring）

故障排除

  • “不在 git 仓库内”：请在 git 仓库内的目录中运行
  • 重新分析后索引仍然过时：重启 Claude Code 以重新加载 MCP 服务
  • 嵌入速度较慢：省略 --embeddings（默认关闭），或设置 OPENAI_API_KEY，以便更快地通过 API 进行嵌入

评论

支持 Markdown