Skip to content

Commit 9b9327e

Browse files
1 parent 1ad309f commit 9b9327e

11 files changed

Lines changed: 64 additions & 64 deletions

File tree

concepts/how-it-works/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -756,7 +756,7 @@ <h2 id="4-serving-queries-via-cypher">4. Serving Queries via Cypher</h2>
756756
<p>CGC translates CLI requests and MCP tool invocations into <strong>Cypher Queries</strong> that run against the active database.</p>
757757
<p>For instance, calling <code>cgc analyze callers calculate_total</code> translates into a Cypher query:</p>
758758
<div class="highlight"><pre><span></span><code><span class="k">MATCH</span><span class="w"> </span><span class="p">(</span><span class="n">caller</span><span class="p">:</span><span class="n">Function</span><span class="p">)</span><span class="o">-[</span><span class="p">:</span><span class="n">CALLS</span><span class="o">]-&gt;</span><span class="p">(</span><span class="n">callee</span><span class="p">:</span><span class="n">Function</span><span class="p">)</span>
759-
<span class="k">WHERE</span><span class="w"> </span><span class="n">callee</span><span class="p">.</span><span class="n">name</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="s">&#39;calculate_total&#39;</span>
759+
<span class="k">WHERE</span><span class="w"> </span><span class="n">callee</span><span class="p">.</span><span class="n">name</span><span class="w"> </span><span class="p">=</span><span class="w"> </span><span class="s">'calculate_total'</span>
760760
<span class="k">RETURN</span><span class="w"> </span><span class="n">caller</span><span class="p">.</span><span class="n">name</span><span class="p">,</span><span class="w"> </span><span class="n">caller</span><span class="p">.</span><span class="n">path</span><span class="p">,</span><span class="w"> </span><span class="n">caller</span><span class="p">.</span><span class="n">start_line</span>
761761
</code></pre></div>
762762
<p>By querying the database engine via Cypher, CGC traverses relationships in milliseconds, bypassing the need to search raw source code files in real-time.</p>

contributing/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -725,7 +725,7 @@ <h2 id="setting-up-the-development-workspace">Setting Up the Development Workspa
725725
Initialize an isolated python environment and install dependencies:
726726
<div class="highlight"><pre><span></span><code>python<span class="w"> </span>-m<span class="w"> </span>venv<span class="w"> </span>.venv
727727
<span class="nb">source</span><span class="w"> </span>.venv/bin/activate
728-
pip<span class="w"> </span>install<span class="w"> </span>-e<span class="w"> </span><span class="s2">&quot;.[dev]&quot;</span>
728+
pip<span class="w"> </span>install<span class="w"> </span>-e<span class="w"> </span><span class="s2">".[dev]"</span>
729729
</code></pre></div></p>
730730
</li>
731731
</ol>

contributing_languages/index.html

Lines changed: 27 additions & 27 deletions
Large diffs are not rendered by default.

getting-started/mcp-setup/index.html

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -724,10 +724,10 @@ <h4 id="configuration-file-locations">Configuration File Locations:</h4>
724724
<h4 id="configuration-schema">Configuration Schema:</h4>
725725
<p>Add the following key under the <code>mcpServers</code> object:</p>
726726
<div class="highlight"><pre><span></span><code><span class="p">{</span>
727-
<span class="w"> </span><span class="nt">&quot;mcpServers&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
728-
<span class="w"> </span><span class="nt">&quot;codegraphcontext&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
729-
<span class="w"> </span><span class="nt">&quot;command&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;cgc&quot;</span><span class="p">,</span>
730-
<span class="w"> </span><span class="nt">&quot;args&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="s2">&quot;mcp&quot;</span><span class="p">,</span><span class="w"> </span><span class="s2">&quot;start&quot;</span><span class="p">]</span>
727+
<span class="w"> </span><span class="nt">"mcpServers"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
728+
<span class="w"> </span><span class="nt">"codegraphcontext"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
729+
<span class="w"> </span><span class="nt">"command"</span><span class="p">:</span><span class="w"> </span><span class="s2">"cgc"</span><span class="p">,</span>
730+
<span class="w"> </span><span class="nt">"args"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="s2">"mcp"</span><span class="p">,</span><span class="w"> </span><span class="s2">"start"</span><span class="p">]</span>
731731
<span class="w"> </span><span class="p">}</span>
732732
<span class="w"> </span><span class="p">}</span>
733733
<span class="p">}</span>
@@ -761,10 +761,10 @@ <h3 id="vs-code-via-continue-extension">VS Code (via Continue extension)</h3>
761761
<li>Add the server details inside the <code>contextProviders</code> or <code>mcp</code> settings array:</li>
762762
</ol>
763763
<div class="highlight"><pre><span></span><code><span class="p">{</span>
764-
<span class="w"> </span><span class="nt">&quot;mcp&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
765-
<span class="w"> </span><span class="nt">&quot;codegraphcontext&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
766-
<span class="w"> </span><span class="nt">&quot;command&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;cgc&quot;</span><span class="p">,</span>
767-
<span class="w"> </span><span class="nt">&quot;args&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="s2">&quot;mcp&quot;</span><span class="p">,</span><span class="w"> </span><span class="s2">&quot;start&quot;</span><span class="p">]</span>
764+
<span class="w"> </span><span class="nt">"mcp"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
765+
<span class="w"> </span><span class="nt">"codegraphcontext"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
766+
<span class="w"> </span><span class="nt">"command"</span><span class="p">:</span><span class="w"> </span><span class="s2">"cgc"</span><span class="p">,</span>
767+
<span class="w"> </span><span class="nt">"args"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="s2">"mcp"</span><span class="p">,</span><span class="w"> </span><span class="s2">"start"</span><span class="p">]</span>
768768
<span class="w"> </span><span class="p">}</span>
769769
<span class="w"> </span><span class="p">}</span>
770770
<span class="p">}</span>

guides/bundles/index.html

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -727,21 +727,21 @@ <h2 id="bundle-structure">📦 Bundle Structure</h2>
727727
<h3 id="file-formats">File Formats</h3>
728728
<h4 id="metadatajson">metadata.json</h4>
729729
<div class="highlight"><pre><span></span><code><span class="p">{</span>
730-
<span class="w"> </span><span class="nt">&quot;cgc_version&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;0.5.0&quot;</span><span class="p">,</span>
731-
<span class="w"> </span><span class="nt">&quot;exported_at&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;2026-01-13T22:00:00&quot;</span><span class="p">,</span>
732-
<span class="w"> </span><span class="nt">&quot;repo&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;numpy/numpy&quot;</span><span class="p">,</span>
733-
<span class="w"> </span><span class="nt">&quot;commit&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;a1b2c3d4&quot;</span><span class="p">,</span>
734-
<span class="w"> </span><span class="nt">&quot;languages&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="s2">&quot;python&quot;</span><span class="p">,</span><span class="w"> </span><span class="s2">&quot;c&quot;</span><span class="p">],</span>
735-
<span class="w"> </span><span class="nt">&quot;format_version&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;1.0&quot;</span>
730+
<span class="w"> </span><span class="nt">"cgc_version"</span><span class="p">:</span><span class="w"> </span><span class="s2">"0.5.0"</span><span class="p">,</span>
731+
<span class="w"> </span><span class="nt">"exported_at"</span><span class="p">:</span><span class="w"> </span><span class="s2">"2026-01-13T22:00:00"</span><span class="p">,</span>
732+
<span class="w"> </span><span class="nt">"repo"</span><span class="p">:</span><span class="w"> </span><span class="s2">"numpy/numpy"</span><span class="p">,</span>
733+
<span class="w"> </span><span class="nt">"commit"</span><span class="p">:</span><span class="w"> </span><span class="s2">"a1b2c3d4"</span><span class="p">,</span>
734+
<span class="w"> </span><span class="nt">"languages"</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="s2">"python"</span><span class="p">,</span><span class="w"> </span><span class="s2">"c"</span><span class="p">],</span>
735+
<span class="w"> </span><span class="nt">"format_version"</span><span class="p">:</span><span class="w"> </span><span class="s2">"1.0"</span>
736736
<span class="p">}</span>
737737
</code></pre></div>
738738
<h4 id="nodesjsonl-excerpt">nodes.jsonl (excerpt)</h4>
739-
<div class="highlight"><pre><span></span><code>{&quot;_id&quot;: &quot;4:abc123&quot;, &quot;_labels&quot;: [&quot;Function&quot;], &quot;name&quot;: &quot;array&quot;, &quot;path&quot;: &quot;/numpy/core/array.py&quot;, &quot;line_number&quot;: 42}
740-
{&quot;_id&quot;: &quot;4:def456&quot;, &quot;_labels&quot;: [&quot;Class&quot;], &quot;name&quot;: &quot;ndarray&quot;, &quot;path&quot;: &quot;/numpy/core/multiarray.py&quot;, &quot;line_number&quot;: 100}
739+
<div class="highlight"><pre><span></span><code>{"_id": "4:abc123", "_labels": ["Function"], "name": "array", "path": "/numpy/core/array.py", "line_number": 42}
740+
{"_id": "4:def456", "_labels": ["Class"], "name": "ndarray", "path": "/numpy/core/multiarray.py", "line_number": 100}
741741
</code></pre></div>
742742
<h4 id="edgesjsonl-excerpt">edges.jsonl (excerpt)</h4>
743-
<div class="highlight"><pre><span></span><code>{&quot;from&quot;: &quot;4:abc123&quot;, &quot;to&quot;: &quot;4:def456&quot;, &quot;type&quot;: &quot;CALLS&quot;, &quot;properties&quot;: {}}
744-
{&quot;from&quot;: &quot;4:xyz789&quot;, &quot;to&quot;: &quot;4:def456&quot;, &quot;type&quot;: &quot;INHERITS&quot;, &quot;properties&quot;: {}}
743+
<div class="highlight"><pre><span></span><code>{"from": "4:abc123", "to": "4:def456", "type": "CALLS", "properties": {}}
744+
{"from": "4:xyz789", "to": "4:def456", "type": "INHERITS", "properties": {}}
745745
</code></pre></div>
746746
<hr />
747747
<h2 id="quick-start">🚀 Quick Start</h2>
@@ -879,18 +879,18 @@ <h3 id="1-index-your-repositories">1. Index Your Repositories</h3>
879879
<h3 id="2-export-to-bundle">2. Export to Bundle</h3>
880880
<div class="highlight"><pre><span></span><code><span class="c1"># Get commit info</span>
881881
<span class="nv">COMMIT</span><span class="o">=</span><span class="k">$(</span>git<span class="w"> </span>rev-parse<span class="w"> </span>--short<span class="w"> </span>HEAD<span class="k">)</span>
882-
<span class="nv">TAG</span><span class="o">=</span><span class="k">$(</span>git<span class="w"> </span>describe<span class="w"> </span>--tags<span class="w"> </span>--abbrev<span class="o">=</span><span class="m">0</span><span class="w"> </span><span class="m">2</span>&gt;/dev/null<span class="w"> </span><span class="o">||</span><span class="w"> </span><span class="nb">echo</span><span class="w"> </span><span class="s2">&quot;main&quot;</span><span class="k">)</span>
882+
<span class="nv">TAG</span><span class="o">=</span><span class="k">$(</span>git<span class="w"> </span>describe<span class="w"> </span>--tags<span class="w"> </span>--abbrev<span class="o">=</span><span class="m">0</span><span class="w"> </span><span class="m">2</span>&gt;/dev/null<span class="w"> </span><span class="o">||</span><span class="w"> </span><span class="nb">echo</span><span class="w"> </span><span class="s2">"main"</span><span class="k">)</span>
883883

884884
<span class="c1"># Export with version info</span>
885-
cgc<span class="w"> </span><span class="nb">export</span><span class="w"> </span><span class="s2">&quot;your-repo-</span><span class="si">${</span><span class="nv">TAG</span><span class="si">}</span><span class="s2">-</span><span class="si">${</span><span class="nv">COMMIT</span><span class="si">}</span><span class="s2">.cgc&quot;</span><span class="w"> </span>--repo<span class="w"> </span>.
885+
cgc<span class="w"> </span><span class="nb">export</span><span class="w"> </span><span class="s2">"your-repo-</span><span class="si">${</span><span class="nv">TAG</span><span class="si">}</span><span class="s2">-</span><span class="si">${</span><span class="nv">COMMIT</span><span class="si">}</span><span class="s2">.cgc"</span><span class="w"> </span>--repo<span class="w"> </span>.
886886
</code></pre></div>
887887
<h3 id="3-distribute">3. Distribute</h3>
888888
<h4 id="option-a-github-releases">Option A: GitHub Releases</h4>
889889
<div class="highlight"><pre><span></span><code><span class="c1"># Create a release</span>
890890
gh<span class="w"> </span>release<span class="w"> </span>create<span class="w"> </span>bundles-<span class="k">$(</span>date<span class="w"> </span>+%Y%m%d<span class="k">)</span><span class="w"> </span><span class="se">\</span>
891891
<span class="w"> </span>your-repo-*.cgc<span class="w"> </span><span class="se">\</span>
892-
<span class="w"> </span>--title<span class="w"> </span><span class="s2">&quot;Pre-indexed Bundles - </span><span class="k">$(</span>date<span class="w"> </span>+%Y-%m-%d<span class="k">)</span><span class="s2">&quot;</span><span class="w"> </span><span class="se">\</span>
893-
<span class="w"> </span>--notes<span class="w"> </span><span class="s2">&quot;Pre-indexed code graphs for instant loading&quot;</span>
892+
<span class="w"> </span>--title<span class="w"> </span><span class="s2">"Pre-indexed Bundles - </span><span class="k">$(</span>date<span class="w"> </span>+%Y-%m-%d<span class="k">)</span><span class="s2">"</span><span class="w"> </span><span class="se">\</span>
893+
<span class="w"> </span>--notes<span class="w"> </span><span class="s2">"Pre-indexed code graphs for instant loading"</span>
894894
</code></pre></div>
895895
<h4 id="option-b-object-storage-s3-r2-gcs">Option B: Object Storage (S3, R2, GCS)</h4>
896896
<div class="highlight"><pre><span></span><code><span class="c1"># Upload to S3</span>
@@ -950,7 +950,7 @@ <h3 id="validate-bundle">Validate Bundle</h3>
950950
<h2 id="use-cases">🎓 Use Cases</h2>
951951
<h3 id="1-ai-assistant-context">1. AI Assistant Context</h3>
952952
<div class="highlight"><pre><span></span><code><span class="c1"># AI can now query structure instantly</span>
953-
<span class="c1"># &quot;Show me all functions that use numpy.linalg&quot;</span>
953+
<span class="c1"># "Show me all functions that use numpy.linalg"</span>
954954
</code></pre></div>
955955
<h3 id="2-code-analysis-pipelines">2. Code Analysis Pipelines</h3>
956956
<div class="highlight"><pre><span></span><code><span class="c1"># CI/CD: Load pre-indexed dependencies</span>
@@ -1042,14 +1042,14 @@ <h3 id="python-api">Python API</h3>
10421042

10431043
<span class="c1"># Export</span>
10441044
<span class="n">success</span><span class="p">,</span> <span class="n">message</span> <span class="o">=</span> <span class="n">bundle</span><span class="o">.</span><span class="n">export_to_bundle</span><span class="p">(</span>
1045-
<span class="n">output_path</span><span class="o">=</span><span class="n">Path</span><span class="p">(</span><span class="s2">&quot;my-bundle.cgc&quot;</span><span class="p">),</span>
1046-
<span class="n">repo_path</span><span class="o">=</span><span class="n">Path</span><span class="p">(</span><span class="s2">&quot;/path/to/repo&quot;</span><span class="p">),</span>
1045+
<span class="n">output_path</span><span class="o">=</span><span class="n">Path</span><span class="p">(</span><span class="s2">"my-bundle.cgc"</span><span class="p">),</span>
1046+
<span class="n">repo_path</span><span class="o">=</span><span class="n">Path</span><span class="p">(</span><span class="s2">"/path/to/repo"</span><span class="p">),</span>
10471047
<span class="n">include_stats</span><span class="o">=</span><span class="kc">True</span>
10481048
<span class="p">)</span>
10491049

10501050
<span class="c1"># Import</span>
10511051
<span class="n">success</span><span class="p">,</span> <span class="n">message</span> <span class="o">=</span> <span class="n">bundle</span><span class="o">.</span><span class="n">import_from_bundle</span><span class="p">(</span>
1052-
<span class="n">bundle_path</span><span class="o">=</span><span class="n">Path</span><span class="p">(</span><span class="s2">&quot;my-bundle.cgc&quot;</span><span class="p">),</span>
1052+
<span class="n">bundle_path</span><span class="o">=</span><span class="n">Path</span><span class="p">(</span><span class="s2">"my-bundle.cgc"</span><span class="p">),</span>
10531053
<span class="n">clear_existing</span><span class="o">=</span><span class="kc">False</span>
10541054
<span class="p">)</span>
10551055
</code></pre></div>

guides/datasource-indexing/index.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -742,12 +742,12 @@ <h3 id="resulting-edges">Resulting Edges:</h3>
742742
<h2 id="4-querying-datasource-relationships">4. Querying Datasource Relationships</h2>
743743
<p>Once the unified graph is created, you can query relationships using Cypher:</p>
744744
<h3 id="example-a-trace-functions-modifying-a-table">Example A: Trace Functions Modifying a Table</h3>
745-
<div class="highlight"><pre><span></span><code><span class="k">MATCH</span><span class="w"> </span><span class="p">(</span><span class="n">fn</span><span class="p">:</span><span class="n">Function</span><span class="p">)</span><span class="o">-[</span><span class="p">:</span><span class="n">WRITES</span><span class="o">]-&gt;</span><span class="p">(</span><span class="n">table</span><span class="p">:</span><span class="n">DbTable</span><span class="w"> </span><span class="p">{</span><span class="n">name</span><span class="p">:</span><span class="w"> </span><span class="s">&#39;orders&#39;</span><span class="p">})</span>
745+
<div class="highlight"><pre><span></span><code><span class="k">MATCH</span><span class="w"> </span><span class="p">(</span><span class="n">fn</span><span class="p">:</span><span class="n">Function</span><span class="p">)</span><span class="o">-[</span><span class="p">:</span><span class="n">WRITES</span><span class="o">]-&gt;</span><span class="p">(</span><span class="n">table</span><span class="p">:</span><span class="n">DbTable</span><span class="w"> </span><span class="p">{</span><span class="n">name</span><span class="p">:</span><span class="w"> </span><span class="s">'orders'</span><span class="p">})</span>
746746
<span class="k">RETURN</span><span class="w"> </span><span class="n">fn</span><span class="p">.</span><span class="n">name</span><span class="p">,</span><span class="w"> </span><span class="n">fn</span><span class="p">.</span><span class="n">path</span>
747747
</code></pre></div>
748748
<h3 id="example-b-identify-functions-interfacing-with-cache-patterns">Example B: Identify Functions Interfacing with Cache Patterns</h3>
749749
<div class="highlight"><pre><span></span><code><span class="k">MATCH</span><span class="w"> </span><span class="p">(</span><span class="n">fn</span><span class="p">:</span><span class="n">Function</span><span class="p">)</span><span class="o">-[</span><span class="p">:</span><span class="n">READS</span><span class="o">]-&gt;</span><span class="p">(</span><span class="n">cache</span><span class="p">:</span><span class="n">RedisKeyPattern</span><span class="p">)</span>
750-
<span class="k">WHERE</span><span class="w"> </span><span class="n">cache</span><span class="p">.</span><span class="n">pattern</span><span class="w"> </span><span class="n">CONTAINS</span><span class="w"> </span><span class="s">&#39;session&#39;</span>
750+
<span class="k">WHERE</span><span class="w"> </span><span class="n">cache</span><span class="p">.</span><span class="n">pattern</span><span class="w"> </span><span class="n">CONTAINS</span><span class="w"> </span><span class="s">'session'</span>
751751
<span class="k">RETURN</span><span class="w"> </span><span class="n">fn</span><span class="p">.</span><span class="n">name</span><span class="p">,</span><span class="w"> </span><span class="n">cache</span><span class="p">.</span><span class="n">pattern</span>
752752
</code></pre></div>
753753
</div>

0 commit comments

Comments
 (0)