gitnexus 1.2.8 → 1.2.9
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +194 -186
- package/dist/cli/ai-context.js +71 -71
- package/dist/cli/analyze.js +1 -1
- package/dist/cli/setup.js +8 -1
- package/dist/cli/view.d.ts +13 -0
- package/dist/cli/view.js +59 -0
- package/dist/core/augmentation/engine.js +20 -20
- package/dist/core/embeddings/embedding-pipeline.js +26 -26
- package/dist/core/graph/html-graph-viewer.d.ts +15 -0
- package/dist/core/graph/html-graph-viewer.js +542 -0
- package/dist/core/graph/html-graph-viewer.test.d.ts +1 -0
- package/dist/core/graph/html-graph-viewer.test.js +67 -0
- package/dist/core/ingestion/cluster-enricher.js +16 -16
- package/dist/core/kuzu/kuzu-adapter.js +9 -9
- package/dist/core/kuzu/schema.js +256 -256
- package/dist/core/search/bm25-index.js +5 -5
- package/dist/core/search/hybrid-search.js +3 -3
- package/dist/core/wiki/graph-queries.js +52 -52
- package/dist/core/wiki/html-viewer.js +192 -192
- package/dist/core/wiki/prompts.js +82 -82
- package/dist/mcp/core/embedder.js +8 -4
- package/dist/mcp/local/local-backend.d.ts +6 -0
- package/dist/mcp/local/local-backend.js +224 -117
- package/dist/mcp/resources.js +42 -42
- package/dist/mcp/server.js +16 -16
- package/dist/mcp/tools.js +86 -77
- package/dist/server/api.d.ts +4 -2
- package/dist/server/api.js +253 -83
- package/hooks/claude/gitnexus-hook.cjs +135 -135
- package/hooks/claude/pre-tool-use.sh +78 -78
- package/hooks/claude/session-start.sh +42 -42
- package/package.json +82 -82
- package/skills/debugging.md +85 -85
- package/skills/exploring.md +75 -75
- package/skills/impact-analysis.md +94 -94
- package/skills/refactoring.md +113 -113
- package/vendor/leiden/index.cjs +355 -355
- package/vendor/leiden/utils.cjs +392 -392
package/package.json
CHANGED
|
@@ -1,82 +1,82 @@
|
|
|
1
|
-
{
|
|
2
|
-
"name": "gitnexus",
|
|
3
|
-
"version": "1.2.
|
|
4
|
-
"description": "Graph-powered code intelligence for AI agents. Index any codebase, query via MCP or CLI.",
|
|
5
|
-
"author": "Abhigyan Patwari",
|
|
6
|
-
"license": "PolyForm-Noncommercial-1.0.0",
|
|
7
|
-
"homepage": "https://github.com/abhigyanpatwari/GitNexus#readme",
|
|
8
|
-
"repository": {
|
|
9
|
-
"type": "git",
|
|
10
|
-
"url": "git+https://github.com/abhigyanpatwari/GitNexus.git",
|
|
11
|
-
"directory": "gitnexus"
|
|
12
|
-
},
|
|
13
|
-
"bugs": {
|
|
14
|
-
"url": "https://github.com/abhigyanpatwari/GitNexus/issues"
|
|
15
|
-
},
|
|
16
|
-
"keywords": [
|
|
17
|
-
"mcp",
|
|
18
|
-
"model-context-protocol",
|
|
19
|
-
"code-intelligence",
|
|
20
|
-
"knowledge-graph",
|
|
21
|
-
"cursor",
|
|
22
|
-
"claude",
|
|
23
|
-
"ai-agent",
|
|
24
|
-
"gitnexus",
|
|
25
|
-
"static-analysis",
|
|
26
|
-
"codebase-indexing"
|
|
27
|
-
],
|
|
28
|
-
"type": "module",
|
|
29
|
-
"bin": {
|
|
30
|
-
"gitnexus": "dist/cli/index.js"
|
|
31
|
-
},
|
|
32
|
-
"files": [
|
|
33
|
-
"dist",
|
|
34
|
-
"hooks",
|
|
35
|
-
"skills",
|
|
36
|
-
"vendor"
|
|
37
|
-
],
|
|
38
|
-
"scripts": {
|
|
39
|
-
"build": "tsc",
|
|
40
|
-
"dev": "tsx watch src/cli/index.ts",
|
|
41
|
-
"prepare": "npm run build"
|
|
42
|
-
},
|
|
43
|
-
"dependencies": {
|
|
44
|
-
"@huggingface/transformers": "^3.0.0",
|
|
45
|
-
"@modelcontextprotocol/sdk": "^1.0.0",
|
|
46
|
-
"cli-progress": "^3.12.0",
|
|
47
|
-
"commander": "^12.0.0",
|
|
48
|
-
"cors": "^2.8.5",
|
|
49
|
-
"express": "^4.19.2",
|
|
50
|
-
"glob": "^11.0.0",
|
|
51
|
-
"graphology": "^0.25.4",
|
|
52
|
-
"graphology-indices": "^0.17.0",
|
|
53
|
-
"graphology-utils": "^2.3.0",
|
|
54
|
-
"kuzu": "^0.11.3",
|
|
55
|
-
"lru-cache": "^11.0.0",
|
|
56
|
-
"mnemonist": "^0.39.0",
|
|
57
|
-
"pandemonium": "^2.4.0",
|
|
58
|
-
"tree-sitter": "^0.21.0",
|
|
59
|
-
"tree-sitter-c": "^0.21.0",
|
|
60
|
-
"tree-sitter-c-sharp": "^0.21.0",
|
|
61
|
-
"tree-sitter-cpp": "^0.22.0",
|
|
62
|
-
"tree-sitter-go": "^0.21.0",
|
|
63
|
-
"tree-sitter-java": "^0.21.0",
|
|
64
|
-
"tree-sitter-javascript": "^0.21.0",
|
|
65
|
-
"tree-sitter-python": "^0.21.0",
|
|
66
|
-
"tree-sitter-rust": "^0.21.0",
|
|
67
|
-
"tree-sitter-typescript": "^0.21.0",
|
|
68
|
-
"typescript": "^5.4.5",
|
|
69
|
-
"uuid": "^13.0.0"
|
|
70
|
-
},
|
|
71
|
-
"devDependencies": {
|
|
72
|
-
"@types/cli-progress": "^3.11.6",
|
|
73
|
-
"@types/cors": "^2.8.17",
|
|
74
|
-
"@types/express": "^4.17.21",
|
|
75
|
-
"@types/node": "^20.0.0",
|
|
76
|
-
"@types/uuid": "^10.0.0",
|
|
77
|
-
"tsx": "^4.0.0"
|
|
78
|
-
},
|
|
79
|
-
"engines": {
|
|
80
|
-
"node": ">=18.0.0"
|
|
81
|
-
}
|
|
82
|
-
}
|
|
1
|
+
{
|
|
2
|
+
"name": "gitnexus",
|
|
3
|
+
"version": "1.2.9",
|
|
4
|
+
"description": "Graph-powered code intelligence for AI agents. Index any codebase, query via MCP or CLI.",
|
|
5
|
+
"author": "Abhigyan Patwari",
|
|
6
|
+
"license": "PolyForm-Noncommercial-1.0.0",
|
|
7
|
+
"homepage": "https://github.com/abhigyanpatwari/GitNexus#readme",
|
|
8
|
+
"repository": {
|
|
9
|
+
"type": "git",
|
|
10
|
+
"url": "git+https://github.com/abhigyanpatwari/GitNexus.git",
|
|
11
|
+
"directory": "gitnexus"
|
|
12
|
+
},
|
|
13
|
+
"bugs": {
|
|
14
|
+
"url": "https://github.com/abhigyanpatwari/GitNexus/issues"
|
|
15
|
+
},
|
|
16
|
+
"keywords": [
|
|
17
|
+
"mcp",
|
|
18
|
+
"model-context-protocol",
|
|
19
|
+
"code-intelligence",
|
|
20
|
+
"knowledge-graph",
|
|
21
|
+
"cursor",
|
|
22
|
+
"claude",
|
|
23
|
+
"ai-agent",
|
|
24
|
+
"gitnexus",
|
|
25
|
+
"static-analysis",
|
|
26
|
+
"codebase-indexing"
|
|
27
|
+
],
|
|
28
|
+
"type": "module",
|
|
29
|
+
"bin": {
|
|
30
|
+
"gitnexus": "dist/cli/index.js"
|
|
31
|
+
},
|
|
32
|
+
"files": [
|
|
33
|
+
"dist",
|
|
34
|
+
"hooks",
|
|
35
|
+
"skills",
|
|
36
|
+
"vendor"
|
|
37
|
+
],
|
|
38
|
+
"scripts": {
|
|
39
|
+
"build": "tsc",
|
|
40
|
+
"dev": "tsx watch src/cli/index.ts",
|
|
41
|
+
"prepare": "npm run build"
|
|
42
|
+
},
|
|
43
|
+
"dependencies": {
|
|
44
|
+
"@huggingface/transformers": "^3.0.0",
|
|
45
|
+
"@modelcontextprotocol/sdk": "^1.0.0",
|
|
46
|
+
"cli-progress": "^3.12.0",
|
|
47
|
+
"commander": "^12.0.0",
|
|
48
|
+
"cors": "^2.8.5",
|
|
49
|
+
"express": "^4.19.2",
|
|
50
|
+
"glob": "^11.0.0",
|
|
51
|
+
"graphology": "^0.25.4",
|
|
52
|
+
"graphology-indices": "^0.17.0",
|
|
53
|
+
"graphology-utils": "^2.3.0",
|
|
54
|
+
"kuzu": "^0.11.3",
|
|
55
|
+
"lru-cache": "^11.0.0",
|
|
56
|
+
"mnemonist": "^0.39.0",
|
|
57
|
+
"pandemonium": "^2.4.0",
|
|
58
|
+
"tree-sitter": "^0.21.0",
|
|
59
|
+
"tree-sitter-c": "^0.21.0",
|
|
60
|
+
"tree-sitter-c-sharp": "^0.21.0",
|
|
61
|
+
"tree-sitter-cpp": "^0.22.0",
|
|
62
|
+
"tree-sitter-go": "^0.21.0",
|
|
63
|
+
"tree-sitter-java": "^0.21.0",
|
|
64
|
+
"tree-sitter-javascript": "^0.21.0",
|
|
65
|
+
"tree-sitter-python": "^0.21.0",
|
|
66
|
+
"tree-sitter-rust": "^0.21.0",
|
|
67
|
+
"tree-sitter-typescript": "^0.21.0",
|
|
68
|
+
"typescript": "^5.4.5",
|
|
69
|
+
"uuid": "^13.0.0"
|
|
70
|
+
},
|
|
71
|
+
"devDependencies": {
|
|
72
|
+
"@types/cli-progress": "^3.11.6",
|
|
73
|
+
"@types/cors": "^2.8.17",
|
|
74
|
+
"@types/express": "^4.17.21",
|
|
75
|
+
"@types/node": "^20.0.0",
|
|
76
|
+
"@types/uuid": "^10.0.0",
|
|
77
|
+
"tsx": "^4.0.0"
|
|
78
|
+
},
|
|
79
|
+
"engines": {
|
|
80
|
+
"node": ">=18.0.0"
|
|
81
|
+
}
|
|
82
|
+
}
|
package/skills/debugging.md
CHANGED
|
@@ -1,85 +1,85 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: gitnexus-debugging
|
|
3
|
-
description: Trace bugs through call chains using knowledge graph
|
|
4
|
-
---
|
|
5
|
-
|
|
6
|
-
# Debugging with GitNexus
|
|
7
|
-
|
|
8
|
-
## When to Use
|
|
9
|
-
- "Why is this function failing?"
|
|
10
|
-
- "Trace where this error comes from"
|
|
11
|
-
- "Who calls this method?"
|
|
12
|
-
- "This endpoint returns 500"
|
|
13
|
-
- Investigating bugs, errors, or unexpected behavior
|
|
14
|
-
|
|
15
|
-
## Workflow
|
|
16
|
-
|
|
17
|
-
```
|
|
18
|
-
1. gitnexus_query({query: "<error or symptom>"}) → Find related execution flows
|
|
19
|
-
2. gitnexus_context({name: "<suspect>"}) → See callers/callees/processes
|
|
20
|
-
3. READ gitnexus://repo/{name}/process/{name} → Trace execution flow
|
|
21
|
-
4. gitnexus_cypher({query: "MATCH path..."}) → Custom traces if needed
|
|
22
|
-
```
|
|
23
|
-
|
|
24
|
-
> If "Index is stale" → run `npx gitnexus analyze` in terminal.
|
|
25
|
-
|
|
26
|
-
## Checklist
|
|
27
|
-
|
|
28
|
-
```
|
|
29
|
-
- [ ] Understand the symptom (error message, unexpected behavior)
|
|
30
|
-
- [ ] gitnexus_query for error text or related code
|
|
31
|
-
- [ ] Identify the suspect function from returned processes
|
|
32
|
-
- [ ] gitnexus_context to see callers and callees
|
|
33
|
-
- [ ] Trace execution flow via process resource if applicable
|
|
34
|
-
- [ ] gitnexus_cypher for custom call chain traces if needed
|
|
35
|
-
- [ ] Read source files to confirm root cause
|
|
36
|
-
```
|
|
37
|
-
|
|
38
|
-
## Debugging Patterns
|
|
39
|
-
|
|
40
|
-
| Symptom | GitNexus Approach |
|
|
41
|
-
|---------|-------------------|
|
|
42
|
-
| Error message | `gitnexus_query` for error text → `context` on throw sites |
|
|
43
|
-
| Wrong return value | `context` on the function → trace callees for data flow |
|
|
44
|
-
| Intermittent failure | `context` → look for external calls, async deps |
|
|
45
|
-
| Performance issue | `context` → find symbols with many callers (hot paths) |
|
|
46
|
-
| Recent regression | `detect_changes` to see what your changes affect |
|
|
47
|
-
|
|
48
|
-
## Tools
|
|
49
|
-
|
|
50
|
-
**gitnexus_query** — find code related to error:
|
|
51
|
-
```
|
|
52
|
-
gitnexus_query({query: "payment validation error"})
|
|
53
|
-
→ Processes: CheckoutFlow, ErrorHandling
|
|
54
|
-
→ Symbols: validatePayment, handlePaymentError, PaymentException
|
|
55
|
-
```
|
|
56
|
-
|
|
57
|
-
**gitnexus_context** — full context for a suspect:
|
|
58
|
-
```
|
|
59
|
-
gitnexus_context({name: "validatePayment"})
|
|
60
|
-
→ Incoming calls: processCheckout, webhookHandler
|
|
61
|
-
→ Outgoing calls: verifyCard, fetchRates (external API!)
|
|
62
|
-
→ Processes: CheckoutFlow (step 3/7)
|
|
63
|
-
```
|
|
64
|
-
|
|
65
|
-
**gitnexus_cypher** — custom call chain traces:
|
|
66
|
-
```cypher
|
|
67
|
-
MATCH path = (a)-[:CodeRelation {type: 'CALLS'}*1..2]->(b:Function {name: "validatePayment"})
|
|
68
|
-
RETURN [n IN nodes(path) | n.name] AS chain
|
|
69
|
-
```
|
|
70
|
-
|
|
71
|
-
## Example: "Payment endpoint returns 500 intermittently"
|
|
72
|
-
|
|
73
|
-
```
|
|
74
|
-
1. gitnexus_query({query: "payment error handling"})
|
|
75
|
-
→ Processes: CheckoutFlow, ErrorHandling
|
|
76
|
-
→ Symbols: validatePayment, handlePaymentError
|
|
77
|
-
|
|
78
|
-
2. gitnexus_context({name: "validatePayment"})
|
|
79
|
-
→ Outgoing calls: verifyCard, fetchRates (external API!)
|
|
80
|
-
|
|
81
|
-
3. READ gitnexus://repo/my-app/process/CheckoutFlow
|
|
82
|
-
→ Step 3: validatePayment → calls fetchRates (external)
|
|
83
|
-
|
|
84
|
-
4. Root cause: fetchRates calls external API without proper timeout
|
|
85
|
-
```
|
|
1
|
+
---
|
|
2
|
+
name: gitnexus-debugging
|
|
3
|
+
description: Trace bugs through call chains using knowledge graph
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Debugging with GitNexus
|
|
7
|
+
|
|
8
|
+
## When to Use
|
|
9
|
+
- "Why is this function failing?"
|
|
10
|
+
- "Trace where this error comes from"
|
|
11
|
+
- "Who calls this method?"
|
|
12
|
+
- "This endpoint returns 500"
|
|
13
|
+
- Investigating bugs, errors, or unexpected behavior
|
|
14
|
+
|
|
15
|
+
## Workflow
|
|
16
|
+
|
|
17
|
+
```
|
|
18
|
+
1. gitnexus_query({query: "<error or symptom>"}) → Find related execution flows
|
|
19
|
+
2. gitnexus_context({name: "<suspect>"}) → See callers/callees/processes
|
|
20
|
+
3. READ gitnexus://repo/{name}/process/{name} → Trace execution flow
|
|
21
|
+
4. gitnexus_cypher({query: "MATCH path..."}) → Custom traces if needed
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
> If "Index is stale" → run `npx gitnexus analyze` in terminal.
|
|
25
|
+
|
|
26
|
+
## Checklist
|
|
27
|
+
|
|
28
|
+
```
|
|
29
|
+
- [ ] Understand the symptom (error message, unexpected behavior)
|
|
30
|
+
- [ ] gitnexus_query for error text or related code
|
|
31
|
+
- [ ] Identify the suspect function from returned processes
|
|
32
|
+
- [ ] gitnexus_context to see callers and callees
|
|
33
|
+
- [ ] Trace execution flow via process resource if applicable
|
|
34
|
+
- [ ] gitnexus_cypher for custom call chain traces if needed
|
|
35
|
+
- [ ] Read source files to confirm root cause
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
## Debugging Patterns
|
|
39
|
+
|
|
40
|
+
| Symptom | GitNexus Approach |
|
|
41
|
+
|---------|-------------------|
|
|
42
|
+
| Error message | `gitnexus_query` for error text → `context` on throw sites |
|
|
43
|
+
| Wrong return value | `context` on the function → trace callees for data flow |
|
|
44
|
+
| Intermittent failure | `context` → look for external calls, async deps |
|
|
45
|
+
| Performance issue | `context` → find symbols with many callers (hot paths) |
|
|
46
|
+
| Recent regression | `detect_changes` to see what your changes affect |
|
|
47
|
+
|
|
48
|
+
## Tools
|
|
49
|
+
|
|
50
|
+
**gitnexus_query** — find code related to error:
|
|
51
|
+
```
|
|
52
|
+
gitnexus_query({query: "payment validation error"})
|
|
53
|
+
→ Processes: CheckoutFlow, ErrorHandling
|
|
54
|
+
→ Symbols: validatePayment, handlePaymentError, PaymentException
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
**gitnexus_context** — full context for a suspect:
|
|
58
|
+
```
|
|
59
|
+
gitnexus_context({name: "validatePayment"})
|
|
60
|
+
→ Incoming calls: processCheckout, webhookHandler
|
|
61
|
+
→ Outgoing calls: verifyCard, fetchRates (external API!)
|
|
62
|
+
→ Processes: CheckoutFlow (step 3/7)
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
**gitnexus_cypher** — custom call chain traces:
|
|
66
|
+
```cypher
|
|
67
|
+
MATCH path = (a)-[:CodeRelation {type: 'CALLS'}*1..2]->(b:Function {name: "validatePayment"})
|
|
68
|
+
RETURN [n IN nodes(path) | n.name] AS chain
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
## Example: "Payment endpoint returns 500 intermittently"
|
|
72
|
+
|
|
73
|
+
```
|
|
74
|
+
1. gitnexus_query({query: "payment error handling"})
|
|
75
|
+
→ Processes: CheckoutFlow, ErrorHandling
|
|
76
|
+
→ Symbols: validatePayment, handlePaymentError
|
|
77
|
+
|
|
78
|
+
2. gitnexus_context({name: "validatePayment"})
|
|
79
|
+
→ Outgoing calls: verifyCard, fetchRates (external API!)
|
|
80
|
+
|
|
81
|
+
3. READ gitnexus://repo/my-app/process/CheckoutFlow
|
|
82
|
+
→ Step 3: validatePayment → calls fetchRates (external)
|
|
83
|
+
|
|
84
|
+
4. Root cause: fetchRates calls external API without proper timeout
|
|
85
|
+
```
|
package/skills/exploring.md
CHANGED
|
@@ -1,75 +1,75 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: gitnexus-exploring
|
|
3
|
-
description: Navigate unfamiliar code using GitNexus knowledge graph
|
|
4
|
-
---
|
|
5
|
-
|
|
6
|
-
# Exploring Codebases with GitNexus
|
|
7
|
-
|
|
8
|
-
## When to Use
|
|
9
|
-
- "How does authentication work?"
|
|
10
|
-
- "What's the project structure?"
|
|
11
|
-
- "Show me the main components"
|
|
12
|
-
- "Where is the database logic?"
|
|
13
|
-
- Understanding code you haven't seen before
|
|
14
|
-
|
|
15
|
-
## Workflow
|
|
16
|
-
|
|
17
|
-
```
|
|
18
|
-
1. READ gitnexus://repos → Discover indexed repos
|
|
19
|
-
2. READ gitnexus://repo/{name}/context → Codebase overview, check staleness
|
|
20
|
-
3. gitnexus_query({query: "<what you want to understand>"}) → Find related execution flows
|
|
21
|
-
4. gitnexus_context({name: "<symbol>"}) → Deep dive on specific symbol
|
|
22
|
-
5. READ gitnexus://repo/{name}/process/{name} → Trace full execution flow
|
|
23
|
-
```
|
|
24
|
-
|
|
25
|
-
> If step 2 says "Index is stale" → run `npx gitnexus analyze` in terminal.
|
|
26
|
-
|
|
27
|
-
## Checklist
|
|
28
|
-
|
|
29
|
-
```
|
|
30
|
-
- [ ] READ gitnexus://repo/{name}/context
|
|
31
|
-
- [ ] gitnexus_query for the concept you want to understand
|
|
32
|
-
- [ ] Review returned processes (execution flows)
|
|
33
|
-
- [ ] gitnexus_context on key symbols for callers/callees
|
|
34
|
-
- [ ] READ process resource for full execution traces
|
|
35
|
-
- [ ] Read source files for implementation details
|
|
36
|
-
```
|
|
37
|
-
|
|
38
|
-
## Resources
|
|
39
|
-
|
|
40
|
-
| Resource | What you get |
|
|
41
|
-
|----------|-------------|
|
|
42
|
-
| `gitnexus://repo/{name}/context` | Stats, staleness warning (~150 tokens) |
|
|
43
|
-
| `gitnexus://repo/{name}/clusters` | All functional areas with cohesion scores (~300 tokens) |
|
|
44
|
-
| `gitnexus://repo/{name}/cluster/{name}` | Area members with file paths (~500 tokens) |
|
|
45
|
-
| `gitnexus://repo/{name}/process/{name}` | Step-by-step execution trace (~200 tokens) |
|
|
46
|
-
|
|
47
|
-
## Tools
|
|
48
|
-
|
|
49
|
-
**gitnexus_query** — find execution flows related to a concept:
|
|
50
|
-
```
|
|
51
|
-
gitnexus_query({query: "payment processing"})
|
|
52
|
-
→ Processes: CheckoutFlow, RefundFlow, WebhookHandler
|
|
53
|
-
→ Symbols grouped by flow with file locations
|
|
54
|
-
```
|
|
55
|
-
|
|
56
|
-
**gitnexus_context** — 360-degree view of a symbol:
|
|
57
|
-
```
|
|
58
|
-
gitnexus_context({name: "validateUser"})
|
|
59
|
-
→ Incoming calls: loginHandler, apiMiddleware
|
|
60
|
-
→ Outgoing calls: checkToken, getUserById
|
|
61
|
-
→ Processes: LoginFlow (step 2/5), TokenRefresh (step 1/3)
|
|
62
|
-
```
|
|
63
|
-
|
|
64
|
-
## Example: "How does payment processing work?"
|
|
65
|
-
|
|
66
|
-
```
|
|
67
|
-
1. READ gitnexus://repo/my-app/context → 918 symbols, 45 processes
|
|
68
|
-
2. gitnexus_query({query: "payment processing"})
|
|
69
|
-
→ CheckoutFlow: processPayment → validateCard → chargeStripe
|
|
70
|
-
→ RefundFlow: initiateRefund → calculateRefund → processRefund
|
|
71
|
-
3. gitnexus_context({name: "processPayment"})
|
|
72
|
-
→ Incoming: checkoutHandler, webhookHandler
|
|
73
|
-
→ Outgoing: validateCard, chargeStripe, saveTransaction
|
|
74
|
-
4. Read src/payments/processor.ts for implementation details
|
|
75
|
-
```
|
|
1
|
+
---
|
|
2
|
+
name: gitnexus-exploring
|
|
3
|
+
description: Navigate unfamiliar code using GitNexus knowledge graph
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Exploring Codebases with GitNexus
|
|
7
|
+
|
|
8
|
+
## When to Use
|
|
9
|
+
- "How does authentication work?"
|
|
10
|
+
- "What's the project structure?"
|
|
11
|
+
- "Show me the main components"
|
|
12
|
+
- "Where is the database logic?"
|
|
13
|
+
- Understanding code you haven't seen before
|
|
14
|
+
|
|
15
|
+
## Workflow
|
|
16
|
+
|
|
17
|
+
```
|
|
18
|
+
1. READ gitnexus://repos → Discover indexed repos
|
|
19
|
+
2. READ gitnexus://repo/{name}/context → Codebase overview, check staleness
|
|
20
|
+
3. gitnexus_query({query: "<what you want to understand>"}) → Find related execution flows
|
|
21
|
+
4. gitnexus_context({name: "<symbol>"}) → Deep dive on specific symbol
|
|
22
|
+
5. READ gitnexus://repo/{name}/process/{name} → Trace full execution flow
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
> If step 2 says "Index is stale" → run `npx gitnexus analyze` in terminal.
|
|
26
|
+
|
|
27
|
+
## Checklist
|
|
28
|
+
|
|
29
|
+
```
|
|
30
|
+
- [ ] READ gitnexus://repo/{name}/context
|
|
31
|
+
- [ ] gitnexus_query for the concept you want to understand
|
|
32
|
+
- [ ] Review returned processes (execution flows)
|
|
33
|
+
- [ ] gitnexus_context on key symbols for callers/callees
|
|
34
|
+
- [ ] READ process resource for full execution traces
|
|
35
|
+
- [ ] Read source files for implementation details
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
## Resources
|
|
39
|
+
|
|
40
|
+
| Resource | What you get |
|
|
41
|
+
|----------|-------------|
|
|
42
|
+
| `gitnexus://repo/{name}/context` | Stats, staleness warning (~150 tokens) |
|
|
43
|
+
| `gitnexus://repo/{name}/clusters` | All functional areas with cohesion scores (~300 tokens) |
|
|
44
|
+
| `gitnexus://repo/{name}/cluster/{name}` | Area members with file paths (~500 tokens) |
|
|
45
|
+
| `gitnexus://repo/{name}/process/{name}` | Step-by-step execution trace (~200 tokens) |
|
|
46
|
+
|
|
47
|
+
## Tools
|
|
48
|
+
|
|
49
|
+
**gitnexus_query** — find execution flows related to a concept:
|
|
50
|
+
```
|
|
51
|
+
gitnexus_query({query: "payment processing"})
|
|
52
|
+
→ Processes: CheckoutFlow, RefundFlow, WebhookHandler
|
|
53
|
+
→ Symbols grouped by flow with file locations
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
**gitnexus_context** — 360-degree view of a symbol:
|
|
57
|
+
```
|
|
58
|
+
gitnexus_context({name: "validateUser"})
|
|
59
|
+
→ Incoming calls: loginHandler, apiMiddleware
|
|
60
|
+
→ Outgoing calls: checkToken, getUserById
|
|
61
|
+
→ Processes: LoginFlow (step 2/5), TokenRefresh (step 1/3)
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
## Example: "How does payment processing work?"
|
|
65
|
+
|
|
66
|
+
```
|
|
67
|
+
1. READ gitnexus://repo/my-app/context → 918 symbols, 45 processes
|
|
68
|
+
2. gitnexus_query({query: "payment processing"})
|
|
69
|
+
→ CheckoutFlow: processPayment → validateCard → chargeStripe
|
|
70
|
+
→ RefundFlow: initiateRefund → calculateRefund → processRefund
|
|
71
|
+
3. gitnexus_context({name: "processPayment"})
|
|
72
|
+
→ Incoming: checkoutHandler, webhookHandler
|
|
73
|
+
→ Outgoing: validateCard, chargeStripe, saveTransaction
|
|
74
|
+
4. Read src/payments/processor.ts for implementation details
|
|
75
|
+
```
|