codegraphcontext 0.1.36__tar.gz → 0.1.37__tar.gz
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.
- {codegraphcontext-0.1.36/src/codegraphcontext.egg-info → codegraphcontext-0.1.37}/PKG-INFO +122 -76
- {codegraphcontext-0.1.36 → codegraphcontext-0.1.37}/README.md +122 -76
- {codegraphcontext-0.1.36 → codegraphcontext-0.1.37}/pyproject.toml +1 -1
- {codegraphcontext-0.1.36 → codegraphcontext-0.1.37/src/codegraphcontext.egg-info}/PKG-INFO +122 -76
- {codegraphcontext-0.1.36 → codegraphcontext-0.1.37}/LICENSE +0 -0
- {codegraphcontext-0.1.36 → codegraphcontext-0.1.37}/MANIFEST.in +0 -0
- {codegraphcontext-0.1.36 → codegraphcontext-0.1.37}/setup.cfg +0 -0
- {codegraphcontext-0.1.36 → codegraphcontext-0.1.37}/src/codegraphcontext/__init__.py +0 -0
- {codegraphcontext-0.1.36 → codegraphcontext-0.1.37}/src/codegraphcontext/__main__.py +0 -0
- {codegraphcontext-0.1.36 → codegraphcontext-0.1.37}/src/codegraphcontext/cli/__init__.py +0 -0
- {codegraphcontext-0.1.36 → codegraphcontext-0.1.37}/src/codegraphcontext/cli/cli_helpers.py +0 -0
- {codegraphcontext-0.1.36 → codegraphcontext-0.1.37}/src/codegraphcontext/cli/config_manager.py +0 -0
- {codegraphcontext-0.1.36 → codegraphcontext-0.1.37}/src/codegraphcontext/cli/main.py +0 -0
- {codegraphcontext-0.1.36 → codegraphcontext-0.1.37}/src/codegraphcontext/cli/registry_commands.py +0 -0
- {codegraphcontext-0.1.36 → codegraphcontext-0.1.37}/src/codegraphcontext/cli/setup_macos.py +0 -0
- {codegraphcontext-0.1.36 → codegraphcontext-0.1.37}/src/codegraphcontext/cli/setup_wizard.py +0 -0
- {codegraphcontext-0.1.36 → codegraphcontext-0.1.37}/src/codegraphcontext/cli/visualizer.py +0 -0
- {codegraphcontext-0.1.36 → codegraphcontext-0.1.37}/src/codegraphcontext/core/__init__.py +0 -0
- {codegraphcontext-0.1.36 → codegraphcontext-0.1.37}/src/codegraphcontext/core/cgc_bundle.py +0 -0
- {codegraphcontext-0.1.36 → codegraphcontext-0.1.37}/src/codegraphcontext/core/database.py +0 -0
- {codegraphcontext-0.1.36 → codegraphcontext-0.1.37}/src/codegraphcontext/core/database_falkordb.py +0 -0
- {codegraphcontext-0.1.36 → codegraphcontext-0.1.37}/src/codegraphcontext/core/falkor_worker.py +0 -0
- {codegraphcontext-0.1.36 → codegraphcontext-0.1.37}/src/codegraphcontext/core/jobs.py +0 -0
- {codegraphcontext-0.1.36 → codegraphcontext-0.1.37}/src/codegraphcontext/core/watcher.py +0 -0
- {codegraphcontext-0.1.36 → codegraphcontext-0.1.37}/src/codegraphcontext/prompts.py +0 -0
- {codegraphcontext-0.1.36 → codegraphcontext-0.1.37}/src/codegraphcontext/server.py +0 -0
- {codegraphcontext-0.1.36 → codegraphcontext-0.1.37}/src/codegraphcontext/tool_definitions.py +0 -0
- {codegraphcontext-0.1.36 → codegraphcontext-0.1.37}/src/codegraphcontext/tools/__init__.py +0 -0
- {codegraphcontext-0.1.36 → codegraphcontext-0.1.37}/src/codegraphcontext/tools/advanced_language_query_tool.py +0 -0
- {codegraphcontext-0.1.36 → codegraphcontext-0.1.37}/src/codegraphcontext/tools/code_finder.py +0 -0
- {codegraphcontext-0.1.36 → codegraphcontext-0.1.37}/src/codegraphcontext/tools/graph_builder.py +0 -0
- {codegraphcontext-0.1.36 → codegraphcontext-0.1.37}/src/codegraphcontext/tools/handlers/analysis_handlers.py +0 -0
- {codegraphcontext-0.1.36 → codegraphcontext-0.1.37}/src/codegraphcontext/tools/handlers/indexing_handlers.py +0 -0
- {codegraphcontext-0.1.36 → codegraphcontext-0.1.37}/src/codegraphcontext/tools/handlers/management_handlers.py +0 -0
- {codegraphcontext-0.1.36 → codegraphcontext-0.1.37}/src/codegraphcontext/tools/handlers/query_handlers.py +0 -0
- {codegraphcontext-0.1.36 → codegraphcontext-0.1.37}/src/codegraphcontext/tools/handlers/watcher_handlers.py +0 -0
- {codegraphcontext-0.1.36 → codegraphcontext-0.1.37}/src/codegraphcontext/tools/languages/c.py +0 -0
- {codegraphcontext-0.1.36 → codegraphcontext-0.1.37}/src/codegraphcontext/tools/languages/cpp.py +0 -0
- {codegraphcontext-0.1.36 → codegraphcontext-0.1.37}/src/codegraphcontext/tools/languages/csharp.py +0 -0
- {codegraphcontext-0.1.36 → codegraphcontext-0.1.37}/src/codegraphcontext/tools/languages/go.py +0 -0
- {codegraphcontext-0.1.36 → codegraphcontext-0.1.37}/src/codegraphcontext/tools/languages/haskell.py +0 -0
- {codegraphcontext-0.1.36 → codegraphcontext-0.1.37}/src/codegraphcontext/tools/languages/java.py +0 -0
- {codegraphcontext-0.1.36 → codegraphcontext-0.1.37}/src/codegraphcontext/tools/languages/javascript.py +0 -0
- {codegraphcontext-0.1.36 → codegraphcontext-0.1.37}/src/codegraphcontext/tools/languages/kotlin.py +0 -0
- {codegraphcontext-0.1.36 → codegraphcontext-0.1.37}/src/codegraphcontext/tools/languages/php.py +0 -0
- {codegraphcontext-0.1.36 → codegraphcontext-0.1.37}/src/codegraphcontext/tools/languages/python.py +0 -0
- {codegraphcontext-0.1.36 → codegraphcontext-0.1.37}/src/codegraphcontext/tools/languages/ruby.py +0 -0
- {codegraphcontext-0.1.36 → codegraphcontext-0.1.37}/src/codegraphcontext/tools/languages/rust.py +0 -0
- {codegraphcontext-0.1.36 → codegraphcontext-0.1.37}/src/codegraphcontext/tools/languages/scala.py +0 -0
- {codegraphcontext-0.1.36 → codegraphcontext-0.1.37}/src/codegraphcontext/tools/languages/swift.py +0 -0
- {codegraphcontext-0.1.36 → codegraphcontext-0.1.37}/src/codegraphcontext/tools/languages/typescript.py +0 -0
- {codegraphcontext-0.1.36 → codegraphcontext-0.1.37}/src/codegraphcontext/tools/languages/typescriptjsx.py +0 -0
- {codegraphcontext-0.1.36 → codegraphcontext-0.1.37}/src/codegraphcontext/tools/package_resolver.py +0 -0
- {codegraphcontext-0.1.36 → codegraphcontext-0.1.37}/src/codegraphcontext/tools/query_tool_languages/c_toolkit.py +0 -0
- {codegraphcontext-0.1.36 → codegraphcontext-0.1.37}/src/codegraphcontext/tools/query_tool_languages/cpp_toolkit.py +0 -0
- {codegraphcontext-0.1.36 → codegraphcontext-0.1.37}/src/codegraphcontext/tools/query_tool_languages/csharp_toolkit.py +0 -0
- {codegraphcontext-0.1.36 → codegraphcontext-0.1.37}/src/codegraphcontext/tools/query_tool_languages/go_toolkit.py +0 -0
- {codegraphcontext-0.1.36 → codegraphcontext-0.1.37}/src/codegraphcontext/tools/query_tool_languages/haskell_toolkit.py +0 -0
- {codegraphcontext-0.1.36 → codegraphcontext-0.1.37}/src/codegraphcontext/tools/query_tool_languages/java_toolkit.py +0 -0
- {codegraphcontext-0.1.36 → codegraphcontext-0.1.37}/src/codegraphcontext/tools/query_tool_languages/javascript_toolkit.py +0 -0
- {codegraphcontext-0.1.36 → codegraphcontext-0.1.37}/src/codegraphcontext/tools/query_tool_languages/python_toolkit.py +0 -0
- {codegraphcontext-0.1.36 → codegraphcontext-0.1.37}/src/codegraphcontext/tools/query_tool_languages/ruby_toolkit.py +0 -0
- {codegraphcontext-0.1.36 → codegraphcontext-0.1.37}/src/codegraphcontext/tools/query_tool_languages/rust_toolkit.py +0 -0
- {codegraphcontext-0.1.36 → codegraphcontext-0.1.37}/src/codegraphcontext/tools/query_tool_languages/scala_toolkit.py +0 -0
- {codegraphcontext-0.1.36 → codegraphcontext-0.1.37}/src/codegraphcontext/tools/query_tool_languages/swift_toolkit.py +0 -0
- {codegraphcontext-0.1.36 → codegraphcontext-0.1.37}/src/codegraphcontext/tools/query_tool_languages/typescript_toolkit.py +0 -0
- {codegraphcontext-0.1.36 → codegraphcontext-0.1.37}/src/codegraphcontext/tools/system.py +0 -0
- {codegraphcontext-0.1.36 → codegraphcontext-0.1.37}/src/codegraphcontext/utils/debug_log.py +0 -0
- {codegraphcontext-0.1.36 → codegraphcontext-0.1.37}/src/codegraphcontext/utils/tree_sitter_manager.py +0 -0
- {codegraphcontext-0.1.36 → codegraphcontext-0.1.37}/src/codegraphcontext/utils/visualize_graph.py +0 -0
- {codegraphcontext-0.1.36 → codegraphcontext-0.1.37}/src/codegraphcontext.egg-info/SOURCES.txt +0 -0
- {codegraphcontext-0.1.36 → codegraphcontext-0.1.37}/src/codegraphcontext.egg-info/dependency_links.txt +0 -0
- {codegraphcontext-0.1.36 → codegraphcontext-0.1.37}/src/codegraphcontext.egg-info/entry_points.txt +0 -0
- {codegraphcontext-0.1.36 → codegraphcontext-0.1.37}/src/codegraphcontext.egg-info/requires.txt +0 -0
- {codegraphcontext-0.1.36 → codegraphcontext-0.1.37}/src/codegraphcontext.egg-info/top_level.txt +0 -0
- {codegraphcontext-0.1.36 → codegraphcontext-0.1.37}/tests/test_cpp_parser.py +0 -0
- {codegraphcontext-0.1.36 → codegraphcontext-0.1.37}/tests/test_database_validation.py +0 -0
- {codegraphcontext-0.1.36 → codegraphcontext-0.1.37}/tests/test_end_to_end.py +0 -0
- {codegraphcontext-0.1.36 → codegraphcontext-0.1.37}/tests/test_graph_indexing.py +0 -0
- {codegraphcontext-0.1.36 → codegraphcontext-0.1.37}/tests/test_graph_indexing_js.py +0 -0
- {codegraphcontext-0.1.36 → codegraphcontext-0.1.37}/tests/test_kotlin_parser.py +0 -0
- {codegraphcontext-0.1.36 → codegraphcontext-0.1.37}/tests/test_swift_parser.py +0 -0
- {codegraphcontext-0.1.36 → codegraphcontext-0.1.37}/tests/test_tree_sitter_manager.py +0 -0
- {codegraphcontext-0.1.36 → codegraphcontext-0.1.37}/tests/test_typescript_parser.py +0 -0
- {codegraphcontext-0.1.36 → codegraphcontext-0.1.37}/tests/test_visualization.py +0 -0
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.4
|
|
2
2
|
Name: codegraphcontext
|
|
3
|
-
Version: 0.1.
|
|
3
|
+
Version: 0.1.37
|
|
4
4
|
Summary: An MCP server that indexes local code into a graph database to provide context to AI assistants.
|
|
5
5
|
Author-email: Shashank Shekhar Singh <shashankshekharsingh1205@gmail.com>
|
|
6
6
|
License: MIT License
|
|
@@ -60,44 +60,93 @@ Requires-Dist: black>=23.11.0; extra == "dev"
|
|
|
60
60
|
Requires-Dist: pytest-asyncio>=0.21.0; extra == "dev"
|
|
61
61
|
Dynamic: license-file
|
|
62
62
|
|
|
63
|
-
# CodeGraphContext
|
|
63
|
+
# 🏗️ CodeGraphContext (CGC)
|
|
64
|
+
|
|
65
|
+
<p align="center">
|
|
66
|
+
<br>
|
|
67
|
+
<b>Bridge the gap between deep code graphs and AI context.</b>
|
|
68
|
+
<br><br>
|
|
69
|
+
<a href="https://pypi.org/project/codegraphcontext/">
|
|
70
|
+
<img src="https://img.shields.io/pypi/v/codegraphcontext?style=flat-square&logo=pypi" alt="PyPI Version">
|
|
71
|
+
</a>
|
|
72
|
+
<a href="https://pypi.org/project/codegraphcontext/">
|
|
73
|
+
<img src="https://img.shields.io/pypi/dm/codegraphcontext?style=flat-square" alt="PyPI Downloads">
|
|
74
|
+
</a>
|
|
75
|
+
<a href="LICENSE">
|
|
76
|
+
<img src="https://img.shields.io/github/license/CodeGraphContext/CodeGraphContext?style=flat-square" alt="License">
|
|
77
|
+
</a>
|
|
78
|
+
<img src="https://img.shields.io/badge/MCP-Compatible-green?style=flat-square" alt="MCP Compatible">
|
|
79
|
+
<a href="https://discord.gg/dR4QY32uYQ">
|
|
80
|
+
<img src="https://img.shields.io/discord/dR4QY32uYQ?style=flat-square&logo=discord" alt="Discord">
|
|
81
|
+
</a>
|
|
82
|
+
<br><br>
|
|
83
|
+
<a href="https://github.com/CodeGraphContext/CodeGraphContext/stargazers">
|
|
84
|
+
<img src="https://img.shields.io/github/stars/CodeGraphContext/CodeGraphContext?style=flat-square&logo=github" alt="Stars">
|
|
85
|
+
</a>
|
|
86
|
+
<a href="https://github.com/CodeGraphContext/CodeGraphContext/network/members">
|
|
87
|
+
<img src="https://img.shields.io/github/forks/CodeGraphContext/CodeGraphContext?style=flat-square&logo=github" alt="Forks">
|
|
88
|
+
</a>
|
|
89
|
+
<a href="https://github.com/CodeGraphContext/CodeGraphContext/issues">
|
|
90
|
+
<img src="https://img.shields.io/github/issues-raw/CodeGraphContext/CodeGraphContext?style=flat-square&logo=github" alt="Issues">
|
|
91
|
+
</a>
|
|
92
|
+
<a href="https://github.com/CodeGraphContext/CodeGraphContext/pulls">
|
|
93
|
+
<img src="https://img.shields.io/github/issues-pr/CodeGraphContext/CodeGraphContext?style=flat-square&logo=github" alt="PRs">
|
|
94
|
+
</a>
|
|
95
|
+
<a href="https://github.com/CodeGraphContext/CodeGraphContext/graphs/contributors">
|
|
96
|
+
<img src="https://img.shields.io/github/contributors/CodeGraphContext/CodeGraphContext?style=flat-square&logo=github" alt="Contributors">
|
|
97
|
+
</a>
|
|
98
|
+
<br><br>
|
|
99
|
+
<a href="https://github.com/CodeGraphContext/CodeGraphContext/actions/workflows/test.yml">
|
|
100
|
+
<img src="https://github.com/CodeGraphContext/CodeGraphContext/actions/workflows/test.yml/badge.svg" alt="Tests">
|
|
101
|
+
</a>
|
|
102
|
+
<a href="https://github.com/CodeGraphContext/CodeGraphContext/actions/workflows/e2e-tests.yml">
|
|
103
|
+
<img src="https://github.com/CodeGraphContext/CodeGraphContext/actions/workflows/e2e-tests.yml/badge.svg" alt="E2E Tests">
|
|
104
|
+
</a>
|
|
105
|
+
<a href="http://codegraphcontext.vercel.app/">
|
|
106
|
+
<img src="https://img.shields.io/badge/website-up-brightgreen?style=flat-square" alt="Website">
|
|
107
|
+
</a>
|
|
108
|
+
<a href="https://CodeGraphContext.github.io/CodeGraphContext/">
|
|
109
|
+
<img src="https://img.shields.io/badge/docs-GitHub%20Pages-blue?style=flat-square" alt="Docs">
|
|
110
|
+
</a>
|
|
111
|
+
<a href="https://youtu.be/KYYSdxhg1xU">
|
|
112
|
+
<img src="https://img.shields.io/badge/YouTube-Watch%20Demo-red?style=flat-square&logo=youtube" alt="YouTube Demo">
|
|
113
|
+
</a>
|
|
114
|
+
</p>
|
|
64
115
|
|
|
65
|
-
|
|
66
|
-
[](https://github.com/CodeGraphContext/CodeGraphContext/stargazers)
|
|
67
|
-
[](https://github.com/CodeGraphContext/CodeGraphContext/network/members)
|
|
68
|
-
[](https://github.com/CodeGraphContext/CodeGraphContext/issues)
|
|
69
|
-
[](https://github.com/CodeGraphContext/CodeGraphContext/pulls)
|
|
70
|
-
[](https://github.com/CodeGraphContext/CodeGraphContext/pulls?q=is%3Apr+is%3Aclosed)
|
|
71
|
-
[](https://github.com/CodeGraphContext/CodeGraphContext/graphs/contributors)
|
|
72
|
-
[](https://github.com/CodeGraphContext/CodeGraphContext)
|
|
73
|
-
[](https://github.com/CodeGraphContext/CodeGraphContext/actions/workflows/test.yml)
|
|
74
|
-
[](https://github.com/CodeGraphContext/CodeGraphContext/actions/workflows/e2e-tests.yml)
|
|
75
|
-
[](https://pypi.org/project/codegraphcontext/)
|
|
76
|
-
[](https://pypi.org/project/codegraphcontext/)
|
|
77
|
-
[](LICENSE)
|
|
78
|
-
[](http://codegraphcontext.vercel.app/)
|
|
79
|
-
[](https://CodeGraphContext.github.io/CodeGraphContext/)
|
|
80
|
-
[](https://youtu.be/KYYSdxhg1xU)
|
|
81
|
-
[](https://discord.gg/dR4QY32uYQ)
|
|
116
|
+
A powerful **MCP server** and **CLI toolkit** that indexes local code into a graph database to provide context to AI assistants and developers. Use it as a standalone CLI for comprehensive code analysis or connect it to your favorite AI IDE via MCP for AI-powered code understanding.
|
|
82
117
|
|
|
118
|
+
---
|
|
83
119
|
|
|
120
|
+
## 📍 Quick Navigation
|
|
121
|
+
* [🚀 Quick Start](#quick-start)
|
|
122
|
+
* [🌐 Supported Programming Languages](#supported-programming-languages)
|
|
123
|
+
* [🛠️ CLI Toolkit](#for-cli-toolkit-mode)
|
|
124
|
+
* [🤖 MCP Server](#-for-mcp-server-mode)
|
|
125
|
+
* [🗄️ Database Options](#database-options)
|
|
84
126
|
|
|
85
|
-
|
|
127
|
+
---
|
|
128
|
+
|
|
129
|
+
## ✨ Experience CGC
|
|
86
130
|
|
|
87
|
-
### Indexing
|
|
131
|
+
### 🛠️ Indexing in Seconds
|
|
132
|
+
> The CLI intelligently parses your tree-sitter nodes to build the graph.
|
|
88
133
|

|
|
89
134
|
|
|
90
|
-
###
|
|
135
|
+
### 🤖 Powering your AI Assistant
|
|
136
|
+
> Use natural language to query complex call-chains via MCP.
|
|
91
137
|

|
|
92
138
|
|
|
139
|
+
---
|
|
140
|
+
|
|
93
141
|
## Project Details
|
|
94
|
-
- **Version:** 0.1.
|
|
142
|
+
- **Version:** 0.1.37
|
|
95
143
|
- **Authors:** Shashank Shekhar Singh <shashankshekharsingh1205@gmail.com>
|
|
96
144
|
- **License:** MIT License (See [LICENSE](LICENSE) for details)
|
|
97
145
|
- **Website:** [CodeGraphContext](http://codegraphcontext.vercel.app/)
|
|
98
146
|
|
|
99
|
-
|
|
147
|
+
---
|
|
100
148
|
|
|
149
|
+
## 👨💻 Maintainer
|
|
101
150
|
**CodeGraphContext** is created and actively maintained by:
|
|
102
151
|
|
|
103
152
|
**Shashank Shekhar Singh**
|
|
@@ -108,11 +157,14 @@ A powerful **MCP server** and **CLI toolkit** that indexes local code into a gra
|
|
|
108
157
|
|
|
109
158
|
*Contributions and feedback are always welcome! Feel free to reach out for questions, suggestions, or collaboration opportunities.*
|
|
110
159
|
|
|
160
|
+
---
|
|
161
|
+
|
|
111
162
|
## Star History
|
|
112
163
|
[](https://www.star-history.com/#CodeGraphContext/CodeGraphContext&Date)
|
|
113
164
|
|
|
114
|
-
|
|
165
|
+
---
|
|
115
166
|
|
|
167
|
+
## Features
|
|
116
168
|
- **Code Indexing:** Analyzes code and builds a knowledge graph of its components.
|
|
117
169
|
- **Relationship Analysis:** Query for callers, callees, class hierarchies, call chains and more.
|
|
118
170
|
- **Pre-indexed Bundles:** Load famous repositories instantly with `.cgc` bundles - no indexing required! ([Learn more](docs/BUNDLES.md))
|
|
@@ -122,59 +174,35 @@ A powerful **MCP server** and **CLI toolkit** that indexes local code into a gra
|
|
|
122
174
|
- **Multi-Language Support:** Full support for 12 programming languages.
|
|
123
175
|
- **Flexible Database Backend:** FalkorDB Lite (default, inbuilt for Unix and through WSL for Windows) or Neo4j (all platforms via Docker/native).
|
|
124
176
|
|
|
125
|
-
|
|
177
|
+
---
|
|
126
178
|
|
|
127
179
|
## Supported Programming Languages
|
|
128
180
|
|
|
129
181
|
CodeGraphContext provides comprehensive parsing and analysis for the following languages:
|
|
130
182
|
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
- **C#** (`.cs`) - Full support for classes, methods, namespaces, and inheritance
|
|
138
|
-
- **Go** (`.go`)
|
|
139
|
-
- **Rust** (`.rs`)
|
|
140
|
-
- **Ruby** (`.rb`)
|
|
141
|
-
- **PHP** (`.php`)
|
|
142
|
-
- **Kotlin** (`.kt`) - Full support for classes, objects, companions, functions, and coroutines
|
|
143
|
-
- **Swift** (`.swift`) - Full support for classes, structs, protocols, enums, and generics
|
|
183
|
+
| | Language | | Language | | Language |
|
|
184
|
+
| :--- | :--- | :--- | :--- | :--- | :--- |
|
|
185
|
+
| 🐍 | **Python** | 📜 | **JavaScript** | 🔷 | **TypeScript** |
|
|
186
|
+
| ☕ | **Java** | 🏗️ | **C / C++** | #️⃣ | **C#** |
|
|
187
|
+
| 🐹 | **Go** | 🦀 | **Rust** | 💎 | **Ruby** |
|
|
188
|
+
| 🐘 | **PHP** | 🍎 | **Swift** | 🎨 | **Kotlin** |
|
|
144
189
|
|
|
145
190
|
Each language parser extracts functions, classes, methods, parameters, inheritance relationships, function calls, and imports to build a comprehensive code graph.
|
|
146
191
|
|
|
192
|
+
---
|
|
193
|
+
|
|
147
194
|
## Database Options
|
|
148
195
|
|
|
149
196
|
CodeGraphContext supports two graph database backends:
|
|
150
197
|
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
> ⚠️ **Windows Users:**
|
|
160
|
-
> FalkorDB Lite / redislite is **not supported on Windows**.
|
|
161
|
-
> You have three options:
|
|
162
|
-
> 1. Run the project under **WSL (Windows Subsystem for Linux)**: [WSL Install](https://learn.microsoft.com/en-us/windows/wsl/install)
|
|
163
|
-
> 2. Use **Docker** to run the project in a containerized Linux environment
|
|
164
|
-
> 3. Use **Neo4j** directly as your graph database (see below)
|
|
165
|
-
|
|
166
|
-
### Neo4j (Available for All Platforms)
|
|
167
|
-
- **Production-ready** and widely used graph database
|
|
168
|
-
- **Available on all operating systems**: Windows, Linux, macOS
|
|
169
|
-
- Can be installed via:
|
|
170
|
-
- **Docker** (recommended, cross-platform)
|
|
171
|
-
- **WSL** (for Windows users)
|
|
172
|
-
- **Native installation** (dedicated command for each OS)
|
|
173
|
-
- Supports local instances and cloud hosting (Neo4j AuraDB)
|
|
174
|
-
- Full Cypher query support for advanced graph analytics
|
|
175
|
-
- Recommended for Windows users and production deployments
|
|
176
|
-
|
|
177
|
-
The `cgc neo4j setup` wizard helps you configure the Neo4j database backend, while FalkorDB Lite is enabled by default on Unix systems with no configuration needed.
|
|
198
|
+
| Feature | FalkorDB Lite (Default) | Neo4j |
|
|
199
|
+
| :--- | :--- | :--- |
|
|
200
|
+
| **Setup** | Zero-config / In-process | Docker / External |
|
|
201
|
+
| **Platform** | Unix / WSL / macOS | All (incl. Windows Native) |
|
|
202
|
+
| **Use Case** | Local dev & Quick tests | Production & Massive graphs |
|
|
203
|
+
| **Requirement**| Python 3.12+ | Any supported Python |
|
|
204
|
+
|
|
205
|
+
---
|
|
178
206
|
|
|
179
207
|
## Used By
|
|
180
208
|
|
|
@@ -184,7 +212,9 @@ CodeGraphContext is already being explored by developers and projects for:
|
|
|
184
212
|
- **Graph-based visualization of projects**
|
|
185
213
|
- **Dead code and complexity detection**
|
|
186
214
|
|
|
187
|
-
|
|
215
|
+
_If you’re using CodeGraphContext in your project, feel free to open a PR and add it here! 🚀_
|
|
216
|
+
|
|
217
|
+
---
|
|
188
218
|
|
|
189
219
|
## Dependencies
|
|
190
220
|
|
|
@@ -205,10 +235,24 @@ If you’re using CodeGraphContext in your project, feel free to open a PR and a
|
|
|
205
235
|
|
|
206
236
|
**Note:** Python 3.10-3.14 is supported.
|
|
207
237
|
|
|
238
|
+
---
|
|
239
|
+
|
|
240
|
+
## Quick Start
|
|
241
|
+
### Install the core toolkit
|
|
242
|
+
```
|
|
243
|
+
pip install codegraphcontext
|
|
244
|
+
```
|
|
245
|
+
|
|
246
|
+
### If 'cgc' command isn't found, run our one-line fix:
|
|
247
|
+
```
|
|
248
|
+
curl -sSL [https://raw.githubusercontent.com/CodeGraphContext/CodeGraphContext/main/scripts/post_install_fix.sh](https://raw.githubusercontent.com/CodeGraphContext/CodeGraphContext/main/scripts/post_install_fix.sh) | bash
|
|
249
|
+
```
|
|
250
|
+
|
|
251
|
+
---
|
|
252
|
+
|
|
208
253
|
## Getting Started
|
|
209
254
|
|
|
210
255
|
### 📋 Understanding CodeGraphContext Modes
|
|
211
|
-
|
|
212
256
|
CodeGraphContext operates in **two modes**, and you can use either or both:
|
|
213
257
|
|
|
214
258
|
#### 🛠️ Mode 1: CLI Toolkit (Standalone)
|
|
@@ -227,12 +271,9 @@ Use CodeGraphContext as an **MCP server** for AI assistants:
|
|
|
227
271
|
|
|
228
272
|
**You can use both modes!** Install once, then use CLI commands directly OR connect to your AI assistant.
|
|
229
273
|
|
|
230
|
-
---
|
|
231
|
-
|
|
232
274
|
### Installation (Both Modes)
|
|
233
275
|
|
|
234
276
|
1. **Install:** `pip install codegraphcontext`
|
|
235
|
-
|
|
236
277
|
<details>
|
|
237
278
|
<summary>⚙️ Troubleshooting: In case, command <code>cgc</code> not found</summary>
|
|
238
279
|
|
|
@@ -273,10 +314,9 @@ Use CodeGraphContext as an **MCP server** for AI assistants:
|
|
|
273
314
|
|
|
274
315
|
---
|
|
275
316
|
|
|
276
|
-
###
|
|
317
|
+
### For CLI Toolkit Mode
|
|
277
318
|
|
|
278
319
|
**Start using immediately with CLI commands:**
|
|
279
|
-
|
|
280
320
|
```bash
|
|
281
321
|
# Index your current directory
|
|
282
322
|
cgc index .
|
|
@@ -308,7 +348,6 @@ cgc help
|
|
|
308
348
|
### 🤖 For MCP Server Mode
|
|
309
349
|
|
|
310
350
|
**Configure your AI assistant to use CodeGraphContext:**
|
|
311
|
-
|
|
312
351
|
1. **Setup:** Run the MCP setup wizard to configure your IDE/AI assistant:
|
|
313
352
|
|
|
314
353
|
```bash
|
|
@@ -331,14 +370,15 @@ cgc help
|
|
|
331
370
|
* It stores your database credentials securely in `~/.codegraphcontext/.env`.
|
|
332
371
|
* It updates the settings file of your chosen IDE/CLI (e.g., `.claude.json` or VS Code's `settings.json`).
|
|
333
372
|
|
|
334
|
-
2. **Start:** Launch the MCP server:
|
|
335
|
-
|
|
373
|
+
2. **Start:** Launch the MCP server:
|
|
336
374
|
```bash
|
|
337
375
|
cgc mcp start
|
|
338
376
|
```
|
|
339
377
|
|
|
340
378
|
3. **Use:** Now interact with your codebase through your AI assistant using natural language! See examples below.
|
|
341
379
|
|
|
380
|
+
---
|
|
381
|
+
|
|
342
382
|
## Ignoring Files (`.cgcignore`)
|
|
343
383
|
|
|
344
384
|
You can tell CodeGraphContext to ignore specific files and directories by creating a `.cgcignore` file in the root of your project. This file uses the same syntax as `.gitignore`.
|
|
@@ -357,6 +397,8 @@ You can tell CodeGraphContext to ignore specific files and directories by creati
|
|
|
357
397
|
*.log
|
|
358
398
|
```
|
|
359
399
|
|
|
400
|
+
---
|
|
401
|
+
|
|
360
402
|
## MCP Client Configuration
|
|
361
403
|
|
|
362
404
|
The `cgc mcp setup` command attempts to automatically configure your IDE/CLI. If you choose not to use the automatic setup, or if your tool is not supported, you can configure it manually.
|
|
@@ -405,6 +447,8 @@ Add the following server configuration to your client's settings file (e.g., VS
|
|
|
405
447
|
}
|
|
406
448
|
```
|
|
407
449
|
|
|
450
|
+
---
|
|
451
|
+
|
|
408
452
|
## Natural Language Interaction Examples
|
|
409
453
|
|
|
410
454
|
Once the server is running, you can interact with it through your AI assistant using plain English. Here are some examples of what you can say:
|
|
@@ -465,6 +509,8 @@ Once the server is running, you can interact with it through your AI assistant u
|
|
|
465
509
|
- "List all currently indexed repositories."
|
|
466
510
|
- "Delete the indexed repository at `/path/to/old-project`."
|
|
467
511
|
|
|
512
|
+
---
|
|
513
|
+
|
|
468
514
|
## Contributing
|
|
469
515
|
|
|
470
516
|
Contributions are welcome! 🎉
|
|
@@ -1,41 +1,90 @@
|
|
|
1
|
-
# CodeGraphContext
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
1
|
+
# 🏗️ CodeGraphContext (CGC)
|
|
2
|
+
|
|
3
|
+
<p align="center">
|
|
4
|
+
<br>
|
|
5
|
+
<b>Bridge the gap between deep code graphs and AI context.</b>
|
|
6
|
+
<br><br>
|
|
7
|
+
<a href="https://pypi.org/project/codegraphcontext/">
|
|
8
|
+
<img src="https://img.shields.io/pypi/v/codegraphcontext?style=flat-square&logo=pypi" alt="PyPI Version">
|
|
9
|
+
</a>
|
|
10
|
+
<a href="https://pypi.org/project/codegraphcontext/">
|
|
11
|
+
<img src="https://img.shields.io/pypi/dm/codegraphcontext?style=flat-square" alt="PyPI Downloads">
|
|
12
|
+
</a>
|
|
13
|
+
<a href="LICENSE">
|
|
14
|
+
<img src="https://img.shields.io/github/license/CodeGraphContext/CodeGraphContext?style=flat-square" alt="License">
|
|
15
|
+
</a>
|
|
16
|
+
<img src="https://img.shields.io/badge/MCP-Compatible-green?style=flat-square" alt="MCP Compatible">
|
|
17
|
+
<a href="https://discord.gg/dR4QY32uYQ">
|
|
18
|
+
<img src="https://img.shields.io/discord/dR4QY32uYQ?style=flat-square&logo=discord" alt="Discord">
|
|
19
|
+
</a>
|
|
20
|
+
<br><br>
|
|
21
|
+
<a href="https://github.com/CodeGraphContext/CodeGraphContext/stargazers">
|
|
22
|
+
<img src="https://img.shields.io/github/stars/CodeGraphContext/CodeGraphContext?style=flat-square&logo=github" alt="Stars">
|
|
23
|
+
</a>
|
|
24
|
+
<a href="https://github.com/CodeGraphContext/CodeGraphContext/network/members">
|
|
25
|
+
<img src="https://img.shields.io/github/forks/CodeGraphContext/CodeGraphContext?style=flat-square&logo=github" alt="Forks">
|
|
26
|
+
</a>
|
|
27
|
+
<a href="https://github.com/CodeGraphContext/CodeGraphContext/issues">
|
|
28
|
+
<img src="https://img.shields.io/github/issues-raw/CodeGraphContext/CodeGraphContext?style=flat-square&logo=github" alt="Issues">
|
|
29
|
+
</a>
|
|
30
|
+
<a href="https://github.com/CodeGraphContext/CodeGraphContext/pulls">
|
|
31
|
+
<img src="https://img.shields.io/github/issues-pr/CodeGraphContext/CodeGraphContext?style=flat-square&logo=github" alt="PRs">
|
|
32
|
+
</a>
|
|
33
|
+
<a href="https://github.com/CodeGraphContext/CodeGraphContext/graphs/contributors">
|
|
34
|
+
<img src="https://img.shields.io/github/contributors/CodeGraphContext/CodeGraphContext?style=flat-square&logo=github" alt="Contributors">
|
|
35
|
+
</a>
|
|
36
|
+
<br><br>
|
|
37
|
+
<a href="https://github.com/CodeGraphContext/CodeGraphContext/actions/workflows/test.yml">
|
|
38
|
+
<img src="https://github.com/CodeGraphContext/CodeGraphContext/actions/workflows/test.yml/badge.svg" alt="Tests">
|
|
39
|
+
</a>
|
|
40
|
+
<a href="https://github.com/CodeGraphContext/CodeGraphContext/actions/workflows/e2e-tests.yml">
|
|
41
|
+
<img src="https://github.com/CodeGraphContext/CodeGraphContext/actions/workflows/e2e-tests.yml/badge.svg" alt="E2E Tests">
|
|
42
|
+
</a>
|
|
43
|
+
<a href="http://codegraphcontext.vercel.app/">
|
|
44
|
+
<img src="https://img.shields.io/badge/website-up-brightgreen?style=flat-square" alt="Website">
|
|
45
|
+
</a>
|
|
46
|
+
<a href="https://CodeGraphContext.github.io/CodeGraphContext/">
|
|
47
|
+
<img src="https://img.shields.io/badge/docs-GitHub%20Pages-blue?style=flat-square" alt="Docs">
|
|
48
|
+
</a>
|
|
49
|
+
<a href="https://youtu.be/KYYSdxhg1xU">
|
|
50
|
+
<img src="https://img.shields.io/badge/YouTube-Watch%20Demo-red?style=flat-square&logo=youtube" alt="YouTube Demo">
|
|
51
|
+
</a>
|
|
52
|
+
</p>
|
|
20
53
|
|
|
54
|
+
A powerful **MCP server** and **CLI toolkit** that indexes local code into a graph database to provide context to AI assistants and developers. Use it as a standalone CLI for comprehensive code analysis or connect it to your favorite AI IDE via MCP for AI-powered code understanding.
|
|
21
55
|
|
|
56
|
+
---
|
|
22
57
|
|
|
23
|
-
|
|
58
|
+
## 📍 Quick Navigation
|
|
59
|
+
* [🚀 Quick Start](#quick-start)
|
|
60
|
+
* [🌐 Supported Programming Languages](#supported-programming-languages)
|
|
61
|
+
* [🛠️ CLI Toolkit](#for-cli-toolkit-mode)
|
|
62
|
+
* [🤖 MCP Server](#-for-mcp-server-mode)
|
|
63
|
+
* [🗄️ Database Options](#database-options)
|
|
24
64
|
|
|
25
|
-
|
|
65
|
+
---
|
|
66
|
+
|
|
67
|
+
## ✨ Experience CGC
|
|
68
|
+
|
|
69
|
+
### 🛠️ Indexing in Seconds
|
|
70
|
+
> The CLI intelligently parses your tree-sitter nodes to build the graph.
|
|
26
71
|

|
|
27
72
|
|
|
28
|
-
###
|
|
73
|
+
### 🤖 Powering your AI Assistant
|
|
74
|
+
> Use natural language to query complex call-chains via MCP.
|
|
29
75
|

|
|
30
76
|
|
|
77
|
+
---
|
|
78
|
+
|
|
31
79
|
## Project Details
|
|
32
|
-
- **Version:** 0.1.
|
|
80
|
+
- **Version:** 0.1.37
|
|
33
81
|
- **Authors:** Shashank Shekhar Singh <shashankshekharsingh1205@gmail.com>
|
|
34
82
|
- **License:** MIT License (See [LICENSE](LICENSE) for details)
|
|
35
83
|
- **Website:** [CodeGraphContext](http://codegraphcontext.vercel.app/)
|
|
36
84
|
|
|
37
|
-
|
|
85
|
+
---
|
|
38
86
|
|
|
87
|
+
## 👨💻 Maintainer
|
|
39
88
|
**CodeGraphContext** is created and actively maintained by:
|
|
40
89
|
|
|
41
90
|
**Shashank Shekhar Singh**
|
|
@@ -46,11 +95,14 @@ A powerful **MCP server** and **CLI toolkit** that indexes local code into a gra
|
|
|
46
95
|
|
|
47
96
|
*Contributions and feedback are always welcome! Feel free to reach out for questions, suggestions, or collaboration opportunities.*
|
|
48
97
|
|
|
98
|
+
---
|
|
99
|
+
|
|
49
100
|
## Star History
|
|
50
101
|
[](https://www.star-history.com/#CodeGraphContext/CodeGraphContext&Date)
|
|
51
102
|
|
|
52
|
-
|
|
103
|
+
---
|
|
53
104
|
|
|
105
|
+
## Features
|
|
54
106
|
- **Code Indexing:** Analyzes code and builds a knowledge graph of its components.
|
|
55
107
|
- **Relationship Analysis:** Query for callers, callees, class hierarchies, call chains and more.
|
|
56
108
|
- **Pre-indexed Bundles:** Load famous repositories instantly with `.cgc` bundles - no indexing required! ([Learn more](docs/BUNDLES.md))
|
|
@@ -60,59 +112,35 @@ A powerful **MCP server** and **CLI toolkit** that indexes local code into a gra
|
|
|
60
112
|
- **Multi-Language Support:** Full support for 12 programming languages.
|
|
61
113
|
- **Flexible Database Backend:** FalkorDB Lite (default, inbuilt for Unix and through WSL for Windows) or Neo4j (all platforms via Docker/native).
|
|
62
114
|
|
|
63
|
-
|
|
115
|
+
---
|
|
64
116
|
|
|
65
117
|
## Supported Programming Languages
|
|
66
118
|
|
|
67
119
|
CodeGraphContext provides comprehensive parsing and analysis for the following languages:
|
|
68
120
|
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
- **C#** (`.cs`) - Full support for classes, methods, namespaces, and inheritance
|
|
76
|
-
- **Go** (`.go`)
|
|
77
|
-
- **Rust** (`.rs`)
|
|
78
|
-
- **Ruby** (`.rb`)
|
|
79
|
-
- **PHP** (`.php`)
|
|
80
|
-
- **Kotlin** (`.kt`) - Full support for classes, objects, companions, functions, and coroutines
|
|
81
|
-
- **Swift** (`.swift`) - Full support for classes, structs, protocols, enums, and generics
|
|
121
|
+
| | Language | | Language | | Language |
|
|
122
|
+
| :--- | :--- | :--- | :--- | :--- | :--- |
|
|
123
|
+
| 🐍 | **Python** | 📜 | **JavaScript** | 🔷 | **TypeScript** |
|
|
124
|
+
| ☕ | **Java** | 🏗️ | **C / C++** | #️⃣ | **C#** |
|
|
125
|
+
| 🐹 | **Go** | 🦀 | **Rust** | 💎 | **Ruby** |
|
|
126
|
+
| 🐘 | **PHP** | 🍎 | **Swift** | 🎨 | **Kotlin** |
|
|
82
127
|
|
|
83
128
|
Each language parser extracts functions, classes, methods, parameters, inheritance relationships, function calls, and imports to build a comprehensive code graph.
|
|
84
129
|
|
|
130
|
+
---
|
|
131
|
+
|
|
85
132
|
## Database Options
|
|
86
133
|
|
|
87
134
|
CodeGraphContext supports two graph database backends:
|
|
88
135
|
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
> ⚠️ **Windows Users:**
|
|
98
|
-
> FalkorDB Lite / redislite is **not supported on Windows**.
|
|
99
|
-
> You have three options:
|
|
100
|
-
> 1. Run the project under **WSL (Windows Subsystem for Linux)**: [WSL Install](https://learn.microsoft.com/en-us/windows/wsl/install)
|
|
101
|
-
> 2. Use **Docker** to run the project in a containerized Linux environment
|
|
102
|
-
> 3. Use **Neo4j** directly as your graph database (see below)
|
|
103
|
-
|
|
104
|
-
### Neo4j (Available for All Platforms)
|
|
105
|
-
- **Production-ready** and widely used graph database
|
|
106
|
-
- **Available on all operating systems**: Windows, Linux, macOS
|
|
107
|
-
- Can be installed via:
|
|
108
|
-
- **Docker** (recommended, cross-platform)
|
|
109
|
-
- **WSL** (for Windows users)
|
|
110
|
-
- **Native installation** (dedicated command for each OS)
|
|
111
|
-
- Supports local instances and cloud hosting (Neo4j AuraDB)
|
|
112
|
-
- Full Cypher query support for advanced graph analytics
|
|
113
|
-
- Recommended for Windows users and production deployments
|
|
114
|
-
|
|
115
|
-
The `cgc neo4j setup` wizard helps you configure the Neo4j database backend, while FalkorDB Lite is enabled by default on Unix systems with no configuration needed.
|
|
136
|
+
| Feature | FalkorDB Lite (Default) | Neo4j |
|
|
137
|
+
| :--- | :--- | :--- |
|
|
138
|
+
| **Setup** | Zero-config / In-process | Docker / External |
|
|
139
|
+
| **Platform** | Unix / WSL / macOS | All (incl. Windows Native) |
|
|
140
|
+
| **Use Case** | Local dev & Quick tests | Production & Massive graphs |
|
|
141
|
+
| **Requirement**| Python 3.12+ | Any supported Python |
|
|
142
|
+
|
|
143
|
+
---
|
|
116
144
|
|
|
117
145
|
## Used By
|
|
118
146
|
|
|
@@ -122,7 +150,9 @@ CodeGraphContext is already being explored by developers and projects for:
|
|
|
122
150
|
- **Graph-based visualization of projects**
|
|
123
151
|
- **Dead code and complexity detection**
|
|
124
152
|
|
|
125
|
-
|
|
153
|
+
_If you’re using CodeGraphContext in your project, feel free to open a PR and add it here! 🚀_
|
|
154
|
+
|
|
155
|
+
---
|
|
126
156
|
|
|
127
157
|
## Dependencies
|
|
128
158
|
|
|
@@ -143,10 +173,24 @@ If you’re using CodeGraphContext in your project, feel free to open a PR and a
|
|
|
143
173
|
|
|
144
174
|
**Note:** Python 3.10-3.14 is supported.
|
|
145
175
|
|
|
176
|
+
---
|
|
177
|
+
|
|
178
|
+
## Quick Start
|
|
179
|
+
### Install the core toolkit
|
|
180
|
+
```
|
|
181
|
+
pip install codegraphcontext
|
|
182
|
+
```
|
|
183
|
+
|
|
184
|
+
### If 'cgc' command isn't found, run our one-line fix:
|
|
185
|
+
```
|
|
186
|
+
curl -sSL [https://raw.githubusercontent.com/CodeGraphContext/CodeGraphContext/main/scripts/post_install_fix.sh](https://raw.githubusercontent.com/CodeGraphContext/CodeGraphContext/main/scripts/post_install_fix.sh) | bash
|
|
187
|
+
```
|
|
188
|
+
|
|
189
|
+
---
|
|
190
|
+
|
|
146
191
|
## Getting Started
|
|
147
192
|
|
|
148
193
|
### 📋 Understanding CodeGraphContext Modes
|
|
149
|
-
|
|
150
194
|
CodeGraphContext operates in **two modes**, and you can use either or both:
|
|
151
195
|
|
|
152
196
|
#### 🛠️ Mode 1: CLI Toolkit (Standalone)
|
|
@@ -165,12 +209,9 @@ Use CodeGraphContext as an **MCP server** for AI assistants:
|
|
|
165
209
|
|
|
166
210
|
**You can use both modes!** Install once, then use CLI commands directly OR connect to your AI assistant.
|
|
167
211
|
|
|
168
|
-
---
|
|
169
|
-
|
|
170
212
|
### Installation (Both Modes)
|
|
171
213
|
|
|
172
214
|
1. **Install:** `pip install codegraphcontext`
|
|
173
|
-
|
|
174
215
|
<details>
|
|
175
216
|
<summary>⚙️ Troubleshooting: In case, command <code>cgc</code> not found</summary>
|
|
176
217
|
|
|
@@ -211,10 +252,9 @@ Use CodeGraphContext as an **MCP server** for AI assistants:
|
|
|
211
252
|
|
|
212
253
|
---
|
|
213
254
|
|
|
214
|
-
###
|
|
255
|
+
### For CLI Toolkit Mode
|
|
215
256
|
|
|
216
257
|
**Start using immediately with CLI commands:**
|
|
217
|
-
|
|
218
258
|
```bash
|
|
219
259
|
# Index your current directory
|
|
220
260
|
cgc index .
|
|
@@ -246,7 +286,6 @@ cgc help
|
|
|
246
286
|
### 🤖 For MCP Server Mode
|
|
247
287
|
|
|
248
288
|
**Configure your AI assistant to use CodeGraphContext:**
|
|
249
|
-
|
|
250
289
|
1. **Setup:** Run the MCP setup wizard to configure your IDE/AI assistant:
|
|
251
290
|
|
|
252
291
|
```bash
|
|
@@ -269,14 +308,15 @@ cgc help
|
|
|
269
308
|
* It stores your database credentials securely in `~/.codegraphcontext/.env`.
|
|
270
309
|
* It updates the settings file of your chosen IDE/CLI (e.g., `.claude.json` or VS Code's `settings.json`).
|
|
271
310
|
|
|
272
|
-
2. **Start:** Launch the MCP server:
|
|
273
|
-
|
|
311
|
+
2. **Start:** Launch the MCP server:
|
|
274
312
|
```bash
|
|
275
313
|
cgc mcp start
|
|
276
314
|
```
|
|
277
315
|
|
|
278
316
|
3. **Use:** Now interact with your codebase through your AI assistant using natural language! See examples below.
|
|
279
317
|
|
|
318
|
+
---
|
|
319
|
+
|
|
280
320
|
## Ignoring Files (`.cgcignore`)
|
|
281
321
|
|
|
282
322
|
You can tell CodeGraphContext to ignore specific files and directories by creating a `.cgcignore` file in the root of your project. This file uses the same syntax as `.gitignore`.
|
|
@@ -295,6 +335,8 @@ You can tell CodeGraphContext to ignore specific files and directories by creati
|
|
|
295
335
|
*.log
|
|
296
336
|
```
|
|
297
337
|
|
|
338
|
+
---
|
|
339
|
+
|
|
298
340
|
## MCP Client Configuration
|
|
299
341
|
|
|
300
342
|
The `cgc mcp setup` command attempts to automatically configure your IDE/CLI. If you choose not to use the automatic setup, or if your tool is not supported, you can configure it manually.
|
|
@@ -343,6 +385,8 @@ Add the following server configuration to your client's settings file (e.g., VS
|
|
|
343
385
|
}
|
|
344
386
|
```
|
|
345
387
|
|
|
388
|
+
---
|
|
389
|
+
|
|
346
390
|
## Natural Language Interaction Examples
|
|
347
391
|
|
|
348
392
|
Once the server is running, you can interact with it through your AI assistant using plain English. Here are some examples of what you can say:
|
|
@@ -403,6 +447,8 @@ Once the server is running, you can interact with it through your AI assistant u
|
|
|
403
447
|
- "List all currently indexed repositories."
|
|
404
448
|
- "Delete the indexed repository at `/path/to/old-project`."
|
|
405
449
|
|
|
450
|
+
---
|
|
451
|
+
|
|
406
452
|
## Contributing
|
|
407
453
|
|
|
408
454
|
Contributions are welcome! 🎉
|