README

GitNexus



  
    
  

  
    
      
    
    
      
    
    
      
    
    
      
    
    
      
    
  


GitNexus indexes a codebase into a knowledge graph of symbols, calls, dependencies
and execution flows. Use it through your coding agent's MCP tools, the CLI, or a
web graph explorer.

Quick start · Documentation ·
Web UI · Discord

https://github.com/user-attachments/assets/172685ba-8e54-4ea7-9ad1-e31a3398da72

 Quick start

Requires Node.js 22.18+ on 22.x, or 24.11+. See platform requirements
for Linux and Windows native dependencies.

bash
 Run from your repository root
npx gitnexus analyze

 Connect your editors once
npx gitnexus setup


analyze builds the index, installs agent skills, registers Claude Code hooks,
and writes AGENTS.md / CLAUDE.md context files. setup configures MCP for your
editors. Use gitnexus analyze --index-only to index without those repository
integration files.

For repeated use, install globally with npm install -g gitnexus.
If installation fails, see troubleshooting.

 What you can do

| Task                                        | Tool             |
| ------------------------------------------- | ---------------- |
| Find code and related execution flows       | query          |
| Inspect a symbol's callers and dependencies | context        |
| Check what a change could affect            | impact         |
| Trace a path between two symbols            | trace          |
| Review the impact of a Git diff             | detect_changes |
| Preview and apply a semantic rename         | rename         |

Ask your agent questions such as “What calls this function?” or “What would this
change affect?” Resolution depends on language support and available evidence;
check reported ambiguity, index freshness and coverage limits.

 Editor setup

gitnexus setup detects Claude Code, Cursor, Codex, Antigravity, Factory Droid,
OpenCode, CodeBuddy and Qoder. Windsurf requires manual MCP configuration.
To select editors:

bash
gitnexus setup -c cursor,codex


See editor setup for the support matrix, manual MCP
configuration, hooks and plugin installation.

 Everyday commands

bash
gitnexus analyze                  Refresh the current repository's index
gitnexus analyze --watch          Reindex as local files change
gitnexus query "authentication"   Search the graph
gitnexus impact UserService --direction upstream
gitnexus status                   Check index freshness
gitnexus list                     List indexed repositories
gitnexus serve                    Serve indexed repositories to the web UI


For multiple concurrent agents, use one gitnexus mcp --http --port 3111 server
and connect clients to http://127.0.0.1:3111/mcp. See the
shared-server instructions.

 Web UI

Run gitnexus serve, then open gitnexus.vercel.app.
The UI connects to the backend to browse indexed repositories and use AI chat.
It uses the existing index; no re-upload or re-index is needed.



For Docker, hosted deployments, image verification, 

Top issues

Discussions

Latest release

GitNexus v1.6.12

 The portable-index release. Index artifacts no longer have to live inside the checkout — GITNEXUS_STORAGE_PATH and GITNEXUS_STORAGE_ROOT put them wherever an orchestrator wants them, and GITNEXUS_CONTENT_RETENTION decides how much source text comes along. Objective-C joins the supported languages, staleness stops calling an unresolvable index fresh, and long embedding jobs resume instead of restarting. 62 merged pull requests since v1.6.11.

 ✨ Highlights

- 📂 Index artifacts can live outside the checkout — GITNEXUS_STORAGE_PATH writes one repository's graph, metadata, parse