Skip to content

Commit f1ad70a

Browse files
Shashankss1205Shashankss1205
committed
1 parent e04b7e7 commit f1ad70a

27 files changed

Lines changed: 1599 additions & 171 deletions

File tree

‎404.html‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -476,7 +476,7 @@
476476
stroke-width="2.5">
477477
<path d="M20.59 13.41l-7.17 7.17a2 2 0 0 1-2.83 0L2 12V2h10l8.59 8.59a2 2 0 0 1 0 2.82z" />
478478
<line x1="7" y1="7" x2="7.01" y2="7" />
479-
</svg> <span id="git-version">v0.4.16</span></span>
479+
</svg> <span id="git-version">v0.4.19</span></span>
480480
<span class="rw-stat"><svg width="10" height="10" viewBox="0 0 24 24" fill="currentColor">
481481
<path
482482
d="M12 2l3.09 6.26L22 9.27l-5 4.87 1.18 6.88L12 17.77l-6.18 3.25L7 14.14 2 9.27l6.91-1.01L12 2z" />
@@ -623,6 +623,11 @@
623623
CLI Reference
624624
</a>
625625

626+
<a href="/reference/api/"
627+
class="rw-sidebar__link ">
628+
HTTP API Reference
629+
</a>
630+
626631
<a href="/reference/mcp/"
627632
class="rw-sidebar__link ">
628633
MCP Tool Reference

‎concepts/architecture/index.html‎

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -487,7 +487,7 @@
487487
stroke-width="2.5">
488488
<path d="M20.59 13.41l-7.17 7.17a2 2 0 0 1-2.83 0L2 12V2h10l8.59 8.59a2 2 0 0 1 0 2.82z" />
489489
<line x1="7" y1="7" x2="7.01" y2="7" />
490-
</svg> <span id="git-version">v0.4.16</span></span>
490+
</svg> <span id="git-version">v0.4.19</span></span>
491491
<span class="rw-stat"><svg width="10" height="10" viewBox="0 0 24 24" fill="currentColor">
492492
<path
493493
d="M12 2l3.09 6.26L22 9.27l-5 4.87 1.18 6.88L12 17.77l-6.18 3.25L7 14.14 2 9.27l6.91-1.01L12 2z" />
@@ -634,6 +634,11 @@
634634
CLI Reference
635635
</a>
636636

637+
<a href="../../reference/api/"
638+
class="rw-sidebar__link ">
639+
HTTP API Reference
640+
</a>
641+
637642
<a href="../../reference/mcp/"
638643
class="rw-sidebar__link ">
639644
MCP Tool Reference
@@ -736,8 +741,8 @@ <h2 id="2-the-persistence-layer">2. The Persistence Layer</h2>
736741
<ul>
737742
<li><strong>Database Abstraction API</strong>: A client layer exposing methods to write batch transactions (<code>write_nodes</code>, <code>write_edges</code>) and query graph relationships via Cypher or native bindings.</li>
738743
<li><strong>Embedded Engines</strong>:</li>
739-
<li><strong>FalkorDB Lite (Default)</strong>: Embedded in-memory graph engine (Unix only).</li>
740-
<li><strong>KuzuDB</strong>: In-process C++ graph engine offering zero-dependency persistence on all platforms.</li>
744+
<li><strong>FalkorDB Lite (Default on Unix)</strong>: Embedded in-memory graph engine when <code>falkordblite</code> is installed (Linux/macOS, Python 3.12+).</li>
745+
<li><strong>KuzuDB (Cross-platform fallback)</strong>: In-process C++ graph engine used automatically on Windows or when FalkorDB Lite is unavailable.</li>
741746
<li><strong>LadybugDB</strong>: SQL-based embedded graph engine designed for concurrent read/write transactions.</li>
742747
<li><strong>Networked Server Engines</strong>:</li>
743748
<li><strong>FalkorDB Remote</strong>: Remote client linking to FalkorDB instances.</li>

‎concepts/backends/index.html‎

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -487,7 +487,7 @@
487487
stroke-width="2.5">
488488
<path d="M20.59 13.41l-7.17 7.17a2 2 0 0 1-2.83 0L2 12V2h10l8.59 8.59a2 2 0 0 1 0 2.82z" />
489489
<line x1="7" y1="7" x2="7.01" y2="7" />
490-
</svg> <span id="git-version">v0.4.16</span></span>
490+
</svg> <span id="git-version">v0.4.19</span></span>
491491
<span class="rw-stat"><svg width="10" height="10" viewBox="0 0 24 24" fill="currentColor">
492492
<path
493493
d="M12 2l3.09 6.26L22 9.27l-5 4.87 1.18 6.88L12 17.77l-6.18 3.25L7 14.14 2 9.27l6.91-1.01L12 2z" />
@@ -634,6 +634,11 @@
634634
CLI Reference
635635
</a>
636636

637+
<a href="../../reference/api/"
638+
class="rw-sidebar__link ">
639+
HTTP API Reference
640+
</a>
641+
637642
<a href="../../reference/mcp/"
638643
class="rw-sidebar__link ">
639644
MCP Tool Reference
@@ -831,11 +836,21 @@ <h3 id="setup_3">Setup</h3>
831836
Configure CGC to connect to Neo4j:
832837
<div class="highlight"><pre><span></span><code>cgc<span class="w"> </span>config<span class="w"> </span>db<span class="w"> </span>neo4j
833838
cgc<span class="w"> </span>config<span class="w"> </span><span class="nb">set</span><span class="w"> </span>NEO4J_URI<span class="w"> </span>bolt://localhost:7687
834-
cgc<span class="w"> </span>config<span class="w"> </span><span class="nb">set</span><span class="w"> </span>NEO4J_USER<span class="w"> </span>neo4j
839+
cgc<span class="w"> </span>config<span class="w"> </span><span class="nb">set</span><span class="w"> </span>NEO4J_USERNAME<span class="w"> </span>neo4j
835840
cgc<span class="w"> </span>config<span class="w"> </span><span class="nb">set</span><span class="w"> </span>NEO4J_PASSWORD<span class="w"> </span>password
836841
</code></pre></div></p>
842+
<p>Or run the interactive wizard: <code>cgc neo4j setup</code>.</p>
843+
<hr />
844+
<h2 id="5-nornic-db">5. Nornic DB</h2>
845+
<p>Nornic is a Neo4j-compatible embedded graph driver. Configure it when you want Bolt/Cypher semantics without a standalone Neo4j server.</p>
846+
<div class="highlight"><pre><span></span><code>cgc<span class="w"> </span>config<span class="w"> </span>db<span class="w"> </span>nornic
847+
cgc<span class="w"> </span>config<span class="w"> </span><span class="nb">set</span><span class="w"> </span>NORNIC_URI<span class="w"> </span>bolt://localhost:7687
848+
cgc<span class="w"> </span>config<span class="w"> </span><span class="nb">set</span><span class="w"> </span>NORNIC_USERNAME<span class="w"> </span>nornic
849+
cgc<span class="w"> </span>config<span class="w"> </span><span class="nb">set</span><span class="w"> </span>NORNIC_PASSWORD<span class="w"> </span>&lt;password&gt;
850+
</code></pre></div>
851+
<p>Connection keys mirror the Neo4j section in <a href="../../reference/config/">Configuration Reference</a>.</p>
837852
<hr />
838-
<h2 id="in-memory-vs-file-backed-selection-logic">In-Memory vs. File-Backed Selection Logic</h2>
853+
<h2 id="backend-selection-logic">Backend Selection Logic</h2>
839854
<p>When executing commands, CGC automatically resolves the active database connection using the following precedence:</p>
840855
<ol>
841856
<li><strong>CLI Flag Override</strong>: Explicitly set using <code>--database</code> or <code>-db</code> (e.g., <code>cgc index --database neo4j</code>).</li>

‎concepts/graph-model/index.html‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -487,7 +487,7 @@
487487
stroke-width="2.5">
488488
<path d="M20.59 13.41l-7.17 7.17a2 2 0 0 1-2.83 0L2 12V2h10l8.59 8.59a2 2 0 0 1 0 2.82z" />
489489
<line x1="7" y1="7" x2="7.01" y2="7" />
490-
</svg> <span id="git-version">v0.4.16</span></span>
490+
</svg> <span id="git-version">v0.4.19</span></span>
491491
<span class="rw-stat"><svg width="10" height="10" viewBox="0 0 24 24" fill="currentColor">
492492
<path
493493
d="M12 2l3.09 6.26L22 9.27l-5 4.87 1.18 6.88L12 17.77l-6.18 3.25L7 14.14 2 9.27l6.91-1.01L12 2z" />
@@ -634,6 +634,11 @@
634634
CLI Reference
635635
</a>
636636

637+
<a href="../../reference/api/"
638+
class="rw-sidebar__link ">
639+
HTTP API Reference
640+
</a>
641+
637642
<a href="../../reference/mcp/"
638643
class="rw-sidebar__link ">
639644
MCP Tool Reference

‎concepts/how-it-works/index.html‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -487,7 +487,7 @@
487487
stroke-width="2.5">
488488
<path d="M20.59 13.41l-7.17 7.17a2 2 0 0 1-2.83 0L2 12V2h10l8.59 8.59a2 2 0 0 1 0 2.82z" />
489489
<line x1="7" y1="7" x2="7.01" y2="7" />
490-
</svg> <span id="git-version">v0.4.16</span></span>
490+
</svg> <span id="git-version">v0.4.19</span></span>
491491
<span class="rw-stat"><svg width="10" height="10" viewBox="0 0 24 24" fill="currentColor">
492492
<path
493493
d="M12 2l3.09 6.26L22 9.27l-5 4.87 1.18 6.88L12 17.77l-6.18 3.25L7 14.14 2 9.27l6.91-1.01L12 2z" />
@@ -634,6 +634,11 @@
634634
CLI Reference
635635
</a>
636636

637+
<a href="../../reference/api/"
638+
class="rw-sidebar__link ">
639+
HTTP API Reference
640+
</a>
641+
637642
<a href="../../reference/mcp/"
638643
class="rw-sidebar__link ">
639644
MCP Tool Reference

‎contributing/index.html‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -487,7 +487,7 @@
487487
stroke-width="2.5">
488488
<path d="M20.59 13.41l-7.17 7.17a2 2 0 0 1-2.83 0L2 12V2h10l8.59 8.59a2 2 0 0 1 0 2.82z" />
489489
<line x1="7" y1="7" x2="7.01" y2="7" />
490-
</svg> <span id="git-version">v0.4.16</span></span>
490+
</svg> <span id="git-version">v0.4.19</span></span>
491491
<span class="rw-stat"><svg width="10" height="10" viewBox="0 0 24 24" fill="currentColor">
492492
<path
493493
d="M12 2l3.09 6.26L22 9.27l-5 4.87 1.18 6.88L12 17.77l-6.18 3.25L7 14.14 2 9.27l6.91-1.01L12 2z" />
@@ -634,6 +634,11 @@
634634
CLI Reference
635635
</a>
636636

637+
<a href="../reference/api/"
638+
class="rw-sidebar__link ">
639+
HTTP API Reference
640+
</a>
641+
637642
<a href="../reference/mcp/"
638643
class="rw-sidebar__link ">
639644
MCP Tool Reference

‎contributing_languages/index.html‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -487,7 +487,7 @@
487487
stroke-width="2.5">
488488
<path d="M20.59 13.41l-7.17 7.17a2 2 0 0 1-2.83 0L2 12V2h10l8.59 8.59a2 2 0 0 1 0 2.82z" />
489489
<line x1="7" y1="7" x2="7.01" y2="7" />
490-
</svg> <span id="git-version">v0.4.16</span></span>
490+
</svg> <span id="git-version">v0.4.19</span></span>
491491
<span class="rw-stat"><svg width="10" height="10" viewBox="0 0 24 24" fill="currentColor">
492492
<path
493493
d="M12 2l3.09 6.26L22 9.27l-5 4.87 1.18 6.88L12 17.77l-6.18 3.25L7 14.14 2 9.27l6.91-1.01L12 2z" />
@@ -634,6 +634,11 @@
634634
CLI Reference
635635
</a>
636636

637+
<a href="../reference/api/"
638+
class="rw-sidebar__link ">
639+
HTTP API Reference
640+
</a>
641+
637642
<a href="../reference/mcp/"
638643
class="rw-sidebar__link ">
639644
MCP Tool Reference

‎getting-started/installation/index.html‎

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -487,7 +487,7 @@
487487
stroke-width="2.5">
488488
<path d="M20.59 13.41l-7.17 7.17a2 2 0 0 1-2.83 0L2 12V2h10l8.59 8.59a2 2 0 0 1 0 2.82z" />
489489
<line x1="7" y1="7" x2="7.01" y2="7" />
490-
</svg> <span id="git-version">v0.4.16</span></span>
490+
</svg> <span id="git-version">v0.4.19</span></span>
491491
<span class="rw-stat"><svg width="10" height="10" viewBox="0 0 24 24" fill="currentColor">
492492
<path
493493
d="M12 2l3.09 6.26L22 9.27l-5 4.87 1.18 6.88L12 17.77l-6.18 3.25L7 14.14 2 9.27l6.91-1.01L12 2z" />
@@ -634,6 +634,11 @@
634634
CLI Reference
635635
</a>
636636

637+
<a href="../../reference/api/"
638+
class="rw-sidebar__link ">
639+
HTTP API Reference
640+
</a>
641+
637642
<a href="../../reference/mcp/"
638643
class="rw-sidebar__link ">
639644
MCP Tool Reference
@@ -714,7 +719,7 @@ <h3 id="method-c-standard-package-installation-via-pip">Method C: Standard Packa
714719
</code></pre></div>
715720
<hr />
716721
<h2 id="2-database-driver-setup">2. Database Driver Setup</h2>
717-
<p>CGC requires Python driver bindings for your selected database backend. FalkorDB Lite is configured by default.</p>
722+
<p>CGC requires Python driver bindings for your selected database backend. On <strong>Unix with Python 3.12+</strong>, FalkorDB Lite is the default when <code>falkordblite</code> is installed; on <strong>Windows</strong> (or when FalkorDB Lite is unavailable), CGC falls back to <strong>KuzuDB</strong>. See <a href="../../reference/config/#important-defaults-read-this-first">Important defaults</a>.</p>
718723
<h3 id="installing-kuzudb-drivers">Installing KuzuDB Drivers</h3>
719724
<p>KuzuDB is embedded and runs directly inside the Python process.
720725
<div class="highlight"><pre><span></span><code>pip<span class="w"> </span>install<span class="w"> </span>kuzu
@@ -734,10 +739,12 @@ <h3 id="installing-neo4j-drivers-optional">Installing Neo4j Drivers (Optional)</
734739
<hr />
735740
<h2 id="3-configuring-the-default-backend">3. Configuring the Default Backend</h2>
736741
<p>Set your preferred default database backend in the global configuration:</p>
737-
<div class="highlight"><pre><span></span><code>cgc<span class="w"> </span>config<span class="w"> </span>db<span class="w"> </span>falkordb<span class="w"> </span><span class="c1"># Configure FalkorDB Lite / Remote (Default)</span>
738-
cgc<span class="w"> </span>config<span class="w"> </span>db<span class="w"> </span>kuzudb<span class="w"> </span><span class="c1"># Configure KuzuDB</span>
739-
cgc<span class="w"> </span>config<span class="w"> </span>db<span class="w"> </span>ladybugdb<span class="w"> </span><span class="c1"># Configure LadybugDB</span>
740-
cgc<span class="w"> </span>config<span class="w"> </span>db<span class="w"> </span>neo4j<span class="w"> </span><span class="c1"># Configure Neo4j</span>
742+
<div class="highlight"><pre><span></span><code>cgc<span class="w"> </span>config<span class="w"> </span>db<span class="w"> </span>falkordb<span class="w"> </span><span class="c1"># FalkorDB Lite (default on Unix when falkordblite is installed)</span>
743+
cgc<span class="w"> </span>config<span class="w"> </span>db<span class="w"> </span>kuzudb<span class="w"> </span><span class="c1"># KuzuDB (cross-platform fallback)</span>
744+
cgc<span class="w"> </span>config<span class="w"> </span>db<span class="w"> </span>ladybugdb<span class="w"> </span><span class="c1"># LadybugDB</span>
745+
cgc<span class="w"> </span>config<span class="w"> </span>db<span class="w"> </span>falkordb-remote<span class="w"> </span><span class="c1"># Remote FalkorDB server</span>
746+
cgc<span class="w"> </span>config<span class="w"> </span>db<span class="w"> </span>neo4j<span class="w"> </span><span class="c1"># Neo4j</span>
747+
cgc<span class="w"> </span>config<span class="w"> </span>db<span class="w"> </span>nornic<span class="w"> </span><span class="c1"># Nornic (Neo4j-compatible)</span>
741748
</code></pre></div>
742749
<p>For remote databases (FalkorDB Remote, Neo4j), refer to the database connection properties in the <a href="../../reference/config/">Configuration Reference</a>.</p>
743750
<hr />

‎getting-started/mcp-setup/index.html‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -487,7 +487,7 @@
487487
stroke-width="2.5">
488488
<path d="M20.59 13.41l-7.17 7.17a2 2 0 0 1-2.83 0L2 12V2h10l8.59 8.59a2 2 0 0 1 0 2.82z" />
489489
<line x1="7" y1="7" x2="7.01" y2="7" />
490-
</svg> <span id="git-version">v0.4.16</span></span>
490+
</svg> <span id="git-version">v0.4.19</span></span>
491491
<span class="rw-stat"><svg width="10" height="10" viewBox="0 0 24 24" fill="currentColor">
492492
<path
493493
d="M12 2l3.09 6.26L22 9.27l-5 4.87 1.18 6.88L12 17.77l-6.18 3.25L7 14.14 2 9.27l6.91-1.01L12 2z" />
@@ -634,6 +634,11 @@
634634
CLI Reference
635635
</a>
636636

637+
<a href="../../reference/api/"
638+
class="rw-sidebar__link ">
639+
HTTP API Reference
640+
</a>
641+
637642
<a href="../../reference/mcp/"
638643
class="rw-sidebar__link ">
639644
MCP Tool Reference

‎getting-started/prerequisites/index.html‎

Lines changed: 18 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -487,7 +487,7 @@
487487
stroke-width="2.5">
488488
<path d="M20.59 13.41l-7.17 7.17a2 2 0 0 1-2.83 0L2 12V2h10l8.59 8.59a2 2 0 0 1 0 2.82z" />
489489
<line x1="7" y1="7" x2="7.01" y2="7" />
490-
</svg> <span id="git-version">v0.4.16</span></span>
490+
</svg> <span id="git-version">v0.4.19</span></span>
491491
<span class="rw-stat"><svg width="10" height="10" viewBox="0 0 24 24" fill="currentColor">
492492
<path
493493
d="M12 2l3.09 6.26L22 9.27l-5 4.87 1.18 6.88L12 17.77l-6.18 3.25L7 14.14 2 9.27l6.91-1.01L12 2z" />
@@ -634,6 +634,11 @@
634634
CLI Reference
635635
</a>
636636

637+
<a href="../../reference/api/"
638+
class="rw-sidebar__link ">
639+
HTTP API Reference
640+
</a>
641+
637642
<a href="../../reference/mcp/"
638643
class="rw-sidebar__link ">
639644
MCP Tool Reference
@@ -753,32 +758,38 @@ <h2 id="database-backend-selection">Database Backend Selection</h2>
753758
<tr>
754759
<td style="text-align: left;"><strong>FalkorDB Lite (Default)</strong></td>
755760
<td style="text-align: left;">In-process (Embedded)</td>
756-
<td style="text-align: left;">Unix-Only (Linux/macOS)</td>
757-
<td style="text-align: left;">Embedded, high-performance in-memory graph. Requires Python 3.12+.</td>
761+
<td style="text-align: left;">Unix (Linux/macOS), Python 3.12+</td>
762+
<td style="text-align: left;">Default when <code>falkordblite</code> is installed. In-memory, extremely low latency.</td>
758763
</tr>
759764
<tr>
760765
<td style="text-align: left;"><strong>KuzuDB</strong></td>
761766
<td style="text-align: left;">In-process (Embedded)</td>
762767
<td style="text-align: left;">Cross-Platform (Linux/macOS/Windows)</td>
763-
<td style="text-align: left;">Recommended for local development and zero-ops setups. Works natively out-of-the-box on Python 3.10+.</td>
768+
<td style="text-align: left;">Automatic fallback on Windows or when FalkorDB Lite is unavailable. Python 3.10+.</td>
764769
</tr>
765770
<tr>
766771
<td style="text-align: left;"><strong>LadybugDB</strong></td>
767772
<td style="text-align: left;">In-process (Embedded)</td>
768773
<td style="text-align: left;">Cross-Platform</td>
769-
<td style="text-align: left;">Embedded SQL-based graph engine. Operates similarly to KuzuDB.</td>
774+
<td style="text-align: left;">Alternative embedded engine; <code>pip install ladybug</code>.</td>
770775
</tr>
771776
<tr>
772777
<td style="text-align: left;"><strong>FalkorDB Remote</strong></td>
773778
<td style="text-align: left;">Networked Server</td>
774779
<td style="text-align: left;">Cross-Platform Client</td>
775-
<td style="text-align: left;">Standard client connecting to a remote FalkorDB instance.</td>
780+
<td style="text-align: left;">Connects to a remote FalkorDB/Redis-compatible server.</td>
776781
</tr>
777782
<tr>
778783
<td style="text-align: left;"><strong>Neo4j</strong></td>
779784
<td style="text-align: left;">Networked Server</td>
780785
<td style="text-align: left;">Cross-Platform Client</td>
781-
<td style="text-align: left;">Enterprise setups needing complex clustering, access controls, or Neo4j Browser visualization.</td>
786+
<td style="text-align: left;">Enterprise clustering, Neo4j Browser, AuraDB.</td>
787+
</tr>
788+
<tr>
789+
<td style="text-align: left;"><strong>Nornic DB</strong></td>
790+
<td style="text-align: left;">Embedded / Bolt client</td>
791+
<td style="text-align: left;">Cross-Platform</td>
792+
<td style="text-align: left;">Neo4j-compatible driver without a full Neo4j deployment.</td>
782793
</tr>
783794
</tbody>
784795
</table>

0 commit comments

Comments
 (0)