<!doctype html>
<html lang="en" class="no-js">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<link rel="icon" href="../assets/images/favicon.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.7.1">
<title>CodeGraphContext – Windows Setup Guide - CodeGraphContext</title>
<link rel="stylesheet" href="../assets/stylesheets/main.484c7ddc.min.css">
<link rel="stylesheet" href="../assets/stylesheets/palette.ab4e12ef.min.css">
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">
<style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
<script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
</head>
<body dir="ltr" data-md-color-scheme="default" data-md-color-primary="teal" data-md-color-accent="purple">
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
<label class="md-overlay" for="__drawer"></label>
<div data-md-component="skip">
<a href="#codegraphcontext-windows-setup-guide" class="md-skip">
Skip to content
</a>
</div>
<div data-md-component="announce">
</div>
<header class="md-header" data-md-component="header">
<nav class="md-header__inner md-grid" aria-label="Header">
<a href=".." title="CodeGraphContext" class="md-header__button md-logo" aria-label="CodeGraphContext" data-md-component="logo">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
</a>
<label class="md-header__button md-icon" for="__drawer">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></svg>
</label>
<div class="md-header__title" data-md-component="header-title">
<div class="md-header__ellipsis">
<div class="md-header__topic">
<span class="md-ellipsis">
CodeGraphContext
</span>
</div>
<div class="md-header__topic" data-md-component="header-topic">
<span class="md-ellipsis">
CodeGraphContext – Windows Setup Guide
</span>
</div>
</div>
</div>
<form class="md-header__option" data-md-component="palette">
<input class="md-option" data-md-color-media="" data-md-color-scheme="default" data-md-color-primary="teal" data-md-color-accent="purple" aria-label="Switch to dark mode" type="radio" name="__palette" id="__palette_0">
<label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_1" hidden>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m17.75 4.09-2.53 1.94.91 3.06-2.63-1.81-2.63 1.81.91-3.06-2.53-1.94L12.44 4l1.06-3 1.06 3zm3.5 6.91-1.64 1.25.59 1.98-1.7-1.17-1.7 1.17.59-1.98L15.75 11l2.06-.05L18.5 9l.69 1.95zm-2.28 4.95c.83-.08 1.72 1.1 1.19 1.85-.32.45-.66.87-1.08 1.27C15.17 23 8.84 23 4.94 19.07c-3.91-3.9-3.91-10.24 0-14.14.4-.4.82-.76 1.27-1.08.75-.53 1.93.36 1.85 1.19-.27 2.86.69 5.83 2.89 8.02a9.96 9.96 0 0 0 8.02 2.89m-1.64 2.02a12.08 12.08 0 0 1-7.8-3.47c-2.17-2.19-3.33-5-3.49-7.82-2.81 3.14-2.7 7.96.31 10.98 3.02 3.01 7.84 3.12 10.98.31"/></svg>
</label>
<input class="md-option" data-md-color-media="" data-md-color-scheme="slate" data-md-color-primary="teal" data-md-color-accent="lime" aria-label="Switch to light mode" type="radio" name="__palette" id="__palette_1">
<label class="md-header__button md-icon" title="Switch to light mode" for="__palette_0" hidden>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 7a5 5 0 0 1 5 5 5 5 0 0 1-5 5 5 5 0 0 1-5-5 5 5 0 0 1 5-5m0 2a3 3 0 0 0-3 3 3 3 0 0 0 3 3 3 3 0 0 0 3-3 3 3 0 0 0-3-3m0-7 2.39 3.42C13.65 5.15 12.84 5 12 5s-1.65.15-2.39.42zM3.34 7l4.16-.35A7.2 7.2 0 0 0 5.94 8.5c-.44.74-.69 1.5-.83 2.29zm.02 10 1.76-3.77a7.131 7.131 0 0 0 2.38 4.14zM20.65 7l-1.77 3.79a7.02 7.02 0 0 0-2.38-4.15zm-.01 10-4.14.36c.59-.51 1.12-1.14 1.54-1.86.42-.73.69-1.5.83-2.29zM12 22l-2.41-3.44c.74.27 1.55.44 2.41.44.82 0 1.63-.17 2.37-.44z"/></svg>
</label>
</form>
<script>var palette=__md_get("__palette");if(palette&&palette.color){if("(prefers-color-scheme)"===palette.color.media){var media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']");palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent")}for(var[key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script>
<label class="md-header__button md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
</label>
<div class="md-search" data-md-component="search" role="dialog">
<label class="md-search__overlay" for="__search"></label>
<div class="md-search__inner" role="search">
<form class="md-search__form" name="search">
<input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
<label class="md-search__icon md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg>
</label>
<nav class="md-search__options" aria-label="Search">
<button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12z"/></svg>
</button>
</nav>
</form>
<div class="md-search__output">
<div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
<div class="md-search-result" data-md-component="search-result">
<div class="md-search-result__meta">
Initializing search
</div>
<ol class="md-search-result__list" role="presentation"></ol>
</div>
</div>
</div>
</div>
</div>
<div class="md-header__source">
<a href="https://github.com/CodeGraphContext/CodeGraphContext" title="Go to repository" class="md-source" data-md-component="source">
<div class="md-source__icon md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 7.1.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path d="M439.6 236.1 244 40.5c-5.4-5.5-12.8-8.5-20.4-8.5s-15 3-20.4 8.4L162.5 81l51.5 51.5c27.1-9.1 52.7 16.8 43.4 43.7l49.7 49.7c34.2-11.8 61.2 31 35.5 56.7-26.5 26.5-70.2-2.9-56-37.3L240.3 199v121.9c25.3 12.5 22.3 41.8 9.1 55-6.4 6.4-15.2 10.1-24.3 10.1s-17.8-3.6-24.3-10.1c-17.6-17.6-11.1-46.9 11.2-56v-123c-20.8-8.5-24.6-30.7-18.6-45L142.6 101 8.5 235.1C3 240.6 0 247.9 0 255.5s3 15 8.5 20.4l195.6 195.7c5.4 5.4 12.7 8.4 20.4 8.4s15-3 20.4-8.4l194.7-194.7c5.4-5.4 8.4-12.8 8.4-20.4s-3-15-8.4-20.4"/></svg>
</div>
<div class="md-source__repository">
CodeGraphContext/CodeGraphContext
</div>
</a>
</div>
</nav>
</header>
<div class="md-container" data-md-component="container">
<nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
<div class="md-grid">
<ul class="md-tabs__list">
<li class="md-tabs__item">
<a href=".." class="md-tabs__link">
Home
</a>
</li>
<li class="md-tabs__item">
<a href="../getting-started/prerequisites/" class="md-tabs__link">
Getting Started
</a>
</li>
<li class="md-tabs__item">
<a href="../use_cases_detailed/" class="md-tabs__link">
Usage
</a>
</li>
<li class="md-tabs__item">
<a href="../guides/setup_deep_dive/" class="md-tabs__link">
Guides
</a>
</li>
<li class="md-tabs__item">
<a href="../concepts/how_it_works/" class="md-tabs__link">
Core Concepts
</a>
</li>
<li class="md-tabs__item">
<a href="../reference/cli_master/" class="md-tabs__link">
CLI Reference
</a>
</li>
<li class="md-tabs__item">
<a href="../reference/mcp_master/" class="md-tabs__link">
MCP Reference
</a>
</li>
<li class="md-tabs__item">
<a href="../roadmap/" class="md-tabs__link">
Project Info
</a>
</li>
</ul>
</div>
</nav>
<main class="md-main" data-md-component="main">
<div class="md-main__inner md-grid">
<div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
<label class="md-nav__title" for="__drawer">
<a href=".." title="CodeGraphContext" class="md-nav__button md-logo" aria-label="CodeGraphContext" data-md-component="logo">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
</a>
CodeGraphContext
</label>
<div class="md-nav__source">
<a href="https://github.com/CodeGraphContext/CodeGraphContext" title="Go to repository" class="md-source" data-md-component="source">
<div class="md-source__icon md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 7.1.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path d="M439.6 236.1 244 40.5c-5.4-5.5-12.8-8.5-20.4-8.5s-15 3-20.4 8.4L162.5 81l51.5 51.5c27.1-9.1 52.7 16.8 43.4 43.7l49.7 49.7c34.2-11.8 61.2 31 35.5 56.7-26.5 26.5-70.2-2.9-56-37.3L240.3 199v121.9c25.3 12.5 22.3 41.8 9.1 55-6.4 6.4-15.2 10.1-24.3 10.1s-17.8-3.6-24.3-10.1c-17.6-17.6-11.1-46.9 11.2-56v-123c-20.8-8.5-24.6-30.7-18.6-45L142.6 101 8.5 235.1C3 240.6 0 247.9 0 255.5s3 15 8.5 20.4l195.6 195.7c5.4 5.4 12.7 8.4 20.4 8.4s15-3 20.4-8.4l194.7-194.7c5.4-5.4 8.4-12.8 8.4-20.4s-3-15-8.4-20.4"/></svg>
</div>
<div class="md-source__repository">
CodeGraphContext/CodeGraphContext
</div>
</a>
</div>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href=".." class="md-nav__link">
<span class="md-ellipsis">
Home
</span>
</a>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2" >
<label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
<span class="md-ellipsis">
Getting Started
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_2">
<span class="md-nav__icon md-icon"></span>
Getting Started
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../getting-started/prerequisites/" class="md-nav__link">
<span class="md-ellipsis">
Prerequisites & Context
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../getting-started/installation/" class="md-nav__link">
<span class="md-ellipsis">
Installation
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../getting-started/quickstart/" class="md-nav__link">
<span class="md-ellipsis">
Quickstart (5 min)
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
<span class="md-ellipsis">
Usage
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3">
<span class="md-nav__icon md-icon"></span>
Usage
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../use_cases_detailed/" class="md-nav__link">
<span class="md-ellipsis">
Real-World Scenarios (ROI)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../user_journeys/" class="md-nav__link">
<span class="md-ellipsis">
User Journeys (Stories)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../integration_guide/" class="md-nav__link">
<span class="md-ellipsis">
Integration & Workflows
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
<label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
<span class="md-ellipsis">
Guides
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_4">
<span class="md-nav__icon md-icon"></span>
Guides
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../guides/setup_deep_dive/" class="md-nav__link">
<span class="md-ellipsis">
Neo4j Setup Wizard
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../guides/mcp_guide/" class="md-nav__link">
<span class="md-ellipsis">
MCP Setup Wizard
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../guides/visualization/" class="md-nav__link">
<span class="md-ellipsis">
Visualizing the Graph
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../guides/bundles/" class="md-nav__link">
<span class="md-ellipsis">
Using On-Demand Bundles
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../guides/ci_cd/" class="md-nav__link">
<span class="md-ellipsis">
CI/CD & Advanced
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
<label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
<span class="md-ellipsis">
Core Concepts
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_5">
<span class="md-nav__icon md-icon"></span>
Core Concepts
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../concepts/how_it_works/" class="md-nav__link">
<span class="md-ellipsis">
How it Works
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../architecture/" class="md-nav__link">
<span class="md-ellipsis">
System Architecture
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../concepts/the_graph/" class="md-nav__link">
<span class="md-ellipsis">
The Graph Model
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../concepts/modes/" class="md-nav__link">
<span class="md-ellipsis">
CLI vs MCP Modes
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6" >
<label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
<span class="md-ellipsis">
CLI Reference
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_6">
<span class="md-nav__icon md-icon"></span>
CLI Reference
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../reference/cli_master/" class="md-nav__link">
<span class="md-ellipsis">
All Commands (Master List)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../reference/cli_indexing/" class="md-nav__link">
<span class="md-ellipsis">
Indexing & Management
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../reference/cli_analysis/" class="md-nav__link">
<span class="md-ellipsis">
Analysis & Querying
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../reference/cli_system/" class="md-nav__link">
<span class="md-ellipsis">
System & Config
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_7" >
<label class="md-nav__link" for="__nav_7" id="__nav_7_label" tabindex="0">
<span class="md-ellipsis">
MCP Reference
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_7">
<span class="md-nav__icon md-icon"></span>
MCP Reference
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../reference/mcp_master/" class="md-nav__link">
<span class="md-ellipsis">
All Tools (Master List)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../cookbook/" class="md-nav__link">
<span class="md-ellipsis">
Example Cookbook
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_8" >
<label class="md-nav__link" for="__nav_8" id="__nav_8_label" tabindex="0">
<span class="md-ellipsis">
Project Info
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_8_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_8">
<span class="md-nav__icon md-icon"></span>
Project Info
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../roadmap/" class="md-nav__link">
<span class="md-ellipsis">
Roadmap
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../contributing/" class="md-nav__link">
<span class="md-ellipsis">
Contributing
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../license/" class="md-nav__link">
<span class="md-ellipsis">
License
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../reference/configuration/" class="md-nav__link">
<span class="md-ellipsis">
Configuration
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../reference/cgcignore/" class="md-nav__link">
<span class="md-ellipsis">
.cgcignore Guide
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../reference/troubleshooting/" class="md-nav__link">
<span class="md-ellipsis">
Troubleshooting
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#option-1-recommended-setup-using-wsl" class="md-nav__link">
<span class="md-ellipsis">
Option 1 (Recommended): Setup Using WSL
</span>
</a>
<nav class="md-nav" aria-label="Option 1 (Recommended): Setup Using WSL">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#step-1-install-wsl" class="md-nav__link">
<span class="md-ellipsis">
Step 1: Install WSL
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#step-2-open-ubuntu-wsl-terminal" class="md-nav__link">
<span class="md-ellipsis">
Step 2: Open Ubuntu (WSL Terminal)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#step-3-install-python-312-recommended" class="md-nav__link">
<span class="md-ellipsis">
Step 3: Install Python (3.12+ Recommended)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#step-4-install-codegraphcontext" class="md-nav__link">
<span class="md-ellipsis">
Step 4: Install CodeGraphContext
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#step-5-index-a-project" class="md-nav__link">
<span class="md-ellipsis">
Step 5: Index a Project
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#step-6-optional-live-watch-mode" class="md-nav__link">
<span class="md-ellipsis">
Step 6 (Optional): Live Watch Mode
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#step-7-optional-mcp-setup-ai-integration" class="md-nav__link">
<span class="md-ellipsis">
Step 7 (Optional): MCP Setup (AI Integration)
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#option-2-native-windows-setup-using-neo4j" class="md-nav__link">
<span class="md-ellipsis">
Option 2: Native Windows Setup Using Neo4j
</span>
</a>
<nav class="md-nav" aria-label="Option 2: Native Windows Setup Using Neo4j">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#step-1-install-python-windows" class="md-nav__link">
<span class="md-ellipsis">
Step 1: Install Python (Windows)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#step-2-install-codegraphcontext" class="md-nav__link">
<span class="md-ellipsis">
Step 2: Install CodeGraphContext
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#step-3-install-run-neo4j" class="md-nav__link">
<span class="md-ellipsis">
Step 3: Install & Run Neo4j
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#step-4-configure-neo4j-in-codegraphcontext" class="md-nav__link">
<span class="md-ellipsis">
Step 4: Configure Neo4j in CodeGraphContext
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#step-5-index-a-project_1" class="md-nav__link">
<span class="md-ellipsis">
Step 5: Index a Project
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#ignoring-files-cgcignore" class="md-nav__link">
<span class="md-ellipsis">
Ignoring Files (.cgcignore)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#common-windows-issues" class="md-nav__link">
<span class="md-ellipsis">
Common Windows Issues
</span>
</a>
<nav class="md-nav" aria-label="Common Windows Issues">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#cgc-command-not-found" class="md-nav__link">
<span class="md-ellipsis">
'cgc' command not found
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#wsl-path-confusion" class="md-nav__link">
<span class="md-ellipsis">
WSL path confusion
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#neo4j-connection-issues" class="md-nav__link">
<span class="md-ellipsis">
Neo4j connection issues
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#verify-installation" class="md-nav__link">
<span class="md-ellipsis">
Verify Installation
</span>
</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-content" data-md-component="content">
<article class="md-content__inner md-typeset">
<h1 id="codegraphcontext-windows-setup-guide">CodeGraphContext – Windows Setup Guide</h1>
<p>This guide explains how to set up <strong>CodeGraphContext on Windows</strong>.</p>
<p>⚠️ <strong>Important Note for Windows Users</strong>
- <strong>FalkorDB Lite (redislite) is not supported natively on Windows</strong>
- Recommended approach: <strong>Use WSL (Windows Subsystem for Linux)</strong>
- Alternative: Use <strong>Neo4j</strong> as the database backend</p>
<hr />
<h2 id="option-1-recommended-setup-using-wsl">Option 1 (Recommended): Setup Using WSL</h2>
<p>WSL allows you to run CodeGraphContext in a Linux environment on Windows, enabling <strong>FalkorDB Lite</strong> and ensuring the smoothest setup experience.</p>
<hr />
<h3 id="step-1-install-wsl">Step 1: Install WSL</h3>
<p>Open <strong>PowerShell as Administrator</strong> and run:</p>
<div class="highlight"><pre><span></span><code><span class="n">wsl</span> <span class="p">-</span><span class="n">-install</span>
<span class="p">````</span>
<span class="n">Restart</span> <span class="n">your</span> <span class="n">system</span> <span class="k">if</span> <span class="n">prompted</span><span class="p">.</span>
<span class="n">Verify</span> <span class="n">WSL</span> <span class="n">installation</span><span class="p">:</span>
<span class="p">```</span><span class="n">powershell</span>
<span class="n">wsl</span> <span class="p">-</span><span class="n">-version</span>
</code></pre></div>
<hr />
<h3 id="step-2-open-ubuntu-wsl-terminal">Step 2: Open Ubuntu (WSL Terminal)</h3>
<p>After restart:</p>
<ul>
<li>Open the Start Menu</li>
<li>Search for <strong>Ubuntu</strong></li>
<li>Open it</li>
</ul>
<p>Update packages:</p>
<div class="highlight"><pre><span></span><code>sudo<span class="w"> </span>apt<span class="w"> </span>update
sudo<span class="w"> </span>apt<span class="w"> </span>upgrade<span class="w"> </span>-y
</code></pre></div>
<hr />
<h3 id="step-3-install-python-312-recommended">Step 3: Install Python (3.12+ Recommended)</h3>
<p>Inside the WSL terminal:</p>
<div class="highlight"><pre><span></span><code>sudo<span class="w"> </span>apt<span class="w"> </span>install<span class="w"> </span>python3.12<span class="w"> </span>python3-pip<span class="w"> </span>-y
</code></pre></div>
<p>Verify installation:</p>
<div class="highlight"><pre><span></span><code>python3<span class="w"> </span>--version
pip3<span class="w"> </span>--version
</code></pre></div>
<blockquote>
<p>CodeGraphContext supports <strong>Python 3.10 – 3.14</strong>.
<strong>FalkorDB Lite works best with Python 3.12+</strong>.</p>
</blockquote>
<hr />
<h3 id="step-4-install-codegraphcontext">Step 4: Install CodeGraphContext</h3>
<div class="highlight"><pre><span></span><code>pip<span class="w"> </span>install<span class="w"> </span>codegraphcontext
</code></pre></div>
<p>Verify installation:</p>
<div class="highlight"><pre><span></span><code>cgc<span class="w"> </span>--help
</code></pre></div>
<hr />
<h3 id="step-5-index-a-project">Step 5: Index a Project</h3>
<p>Navigate to your project directory.</p>
<p>Example (accessing Windows files from WSL):</p>
<div class="highlight"><pre><span></span><code><span class="nb">cd</span><span class="w"> </span>/mnt/c/Users/<yourname>/Desktop/<your-project-folder>
</code></pre></div>
<p>Index the codebase:</p>
<div class="highlight"><pre><span></span><code>cgc<span class="w"> </span>index<span class="w"> </span>.
</code></pre></div>
<hr />
<h3 id="step-6-optional-live-watch-mode">Step 6 (Optional): Live Watch Mode</h3>
<p>To automatically update the graph when files change:</p>
<div class="highlight"><pre><span></span><code>cgc<span class="w"> </span>watch<span class="w"> </span>.
</code></pre></div>
<hr />
<h3 id="step-7-optional-mcp-setup-ai-integration">Step 7 (Optional): MCP Setup (AI Integration)</h3>
<p>To use CodeGraphContext as an MCP server for AI assistants/IDEs:</p>
<div class="highlight"><pre><span></span><code>cgc<span class="w"> </span>mcp<span class="w"> </span>setup
</code></pre></div>
<p>Start the MCP server:</p>
<div class="highlight"><pre><span></span><code>cgc<span class="w"> </span>mcp<span class="w"> </span>start
</code></pre></div>
<hr />
<h2 id="option-2-native-windows-setup-using-neo4j">Option 2: Native Windows Setup Using Neo4j</h2>
<p>If you do not want WSL, CodeGraphContext can be configured to use <strong>Neo4j</strong> as its database backend.</p>
<hr />
<h3 id="step-1-install-python-windows">Step 1: Install Python (Windows)</h3>
<p>Download Python from:
<a href="https://www.python.org/downloads/">https://www.python.org/downloads/</a></p>
<p>During installation, ensure:
✅ <strong>Add Python to PATH</strong></p>
<p>Verify:</p>
<div class="highlight"><pre><span></span><code><span class="n">python</span> <span class="p">-</span><span class="n">-version</span>
<span class="n">pip</span> <span class="p">-</span><span class="n">-version</span>
</code></pre></div>
<hr />
<h3 id="step-2-install-codegraphcontext">Step 2: Install CodeGraphContext</h3>
<div class="highlight"><pre><span></span><code><span class="n">pip</span> <span class="n">install</span> <span class="n">codegraphcontext</span>
</code></pre></div>
<p>Verify:</p>
<div class="highlight"><pre><span></span><code><span class="n">cgc</span> <span class="p">-</span><span class="n">-help</span>
</code></pre></div>
<hr />
<h3 id="step-3-install-run-neo4j">Step 3: Install & Run Neo4j</h3>
<p>Neo4j can be installed using one of the following:</p>
<ul>
<li>Neo4j Desktop (GUI)</li>
<li>Neo4j via Docker (recommended)</li>
<li>Neo4j AuraDB (cloud)</li>
</ul>
<p>Ensure Neo4j is running and note:</p>
<ul>
<li>URI (example: <code>bolt://localhost:7687</code>)</li>
<li>Username</li>
<li>Password</li>
</ul>
<hr />
<h3 id="step-4-configure-neo4j-in-codegraphcontext">Step 4: Configure Neo4j in CodeGraphContext</h3>
<p>Run:</p>
<div class="highlight"><pre><span></span><code>cgc<span class="w"> </span>neo4j<span class="w"> </span>setup
</code></pre></div>
<p>Follow the prompts to enter your Neo4j credentials.</p>
<hr />
<h3 id="step-5-index-a-project_1">Step 5: Index a Project</h3>
<p>Navigate to your project:</p>
<div class="highlight"><pre><span></span><code><span class="nb">cd </span><span class="n">path</span><span class="p">\</span><span class="n">to</span><span class="p">\</span><span class="n">your</span><span class="p">\</span><span class="n">project</span>
</code></pre></div>
<p>Index the codebase:</p>
<div class="highlight"><pre><span></span><code><span class="n">cgc</span> <span class="n">index</span> <span class="p">.</span>
</code></pre></div>
<hr />
<h2 id="ignoring-files-cgcignore">Ignoring Files (<code>.cgcignore</code>)</h2>
<p>To ignore files and folders while indexing, create a <code>.cgcignore</code> file in your project root.</p>
<p>Example <code>.cgcignore</code>:</p>
<div class="highlight"><pre><span></span><code>/build/
/dist/
/node_modules/
/vendor/
*.log
</code></pre></div>
<hr />
<h2 id="common-windows-issues">Common Windows Issues</h2>
<h3 id="cgc-command-not-found"><code>'cgc' command not found</code></h3>
<ul>
<li>Restart your terminal after installation</li>
<li>Ensure Python Scripts directory is in PATH</li>
<li>Try: <code>python -m pip install codegraphcontext</code></li>
</ul>
<h3 id="wsl-path-confusion">WSL path confusion</h3>
<p>Windows drives can be accessed from WSL using:</p>
<div class="highlight"><pre><span></span><code><span class="nb">cd</span><span class="w"> </span>/mnt/c/
</code></pre></div>
<h3 id="neo4j-connection-issues">Neo4j connection issues</h3>
<ul>
<li>Ensure Neo4j is running</li>
<li>Check URI format: <code>bolt://localhost:7687</code></li>
<li>Double-check username/password</li>
</ul>
<hr />
<h2 id="verify-installation">Verify Installation</h2>
<p>Run:</p>
<p><div class="highlight"><pre><span></span><code>cgc<span class="w"> </span>list
</code></pre></div>
If no errors are shown, setup is complete </p>
</article>
</div>
<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
</div>
</main>
<footer class="md-footer">
<div class="md-footer-meta md-typeset">
<div class="md-footer-meta__inner md-grid">
<div class="md-copyright">
Made with
<a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
Material for MkDocs
</a>
</div>
</div>
</div>
</footer>
</div>
<div class="md-dialog" data-md-component="dialog">
<div class="md-dialog__inner md-typeset"></div>
</div>
<script id="__config" type="application/json">{"annotate": null, "base": "..", "features": ["navigation.tabs", "navigation.sections", "navigation.expand", "content.code.copy", "toc.follow"], "search": "../assets/javascripts/workers/search.2c215733.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
<script src="../assets/javascripts/bundle.79ae519e.min.js"></script>
</body>
</html>
