CodeGraphContext

Overview Schema Related Servers Score Discussions

CodeGraphContext
docs
site
integration_guide

index.html

index.html•97.1 KiB

<!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="prev" href="../user_journeys/"> <link rel="next" href="../guides/setup_deep_dive/"> <link rel="icon" href="../assets/images/favicon.png"> <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.7.1"> <title>Integration & Workflows - 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="#integration-guide-codegraphcontext" 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"> CodeGraphContext </div> <div class="md-header__topic" data-md-component="header-topic"> Integration & Workflows </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"><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 md-tabs__item--active"> <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"><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"> Home </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"> Getting Started </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"> 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"> Prerequisites & Context </a> </li> <li class="md-nav__item"> <a href="../getting-started/installation/" class="md-nav__link"> Installation </a> </li> <li class="md-nav__item"> <a href="../getting-started/quickstart/" class="md-nav__link"> Quickstart (5 min) </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3" checked> <label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex=""> Usage </label> <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="true"> <label class="md-nav__title" for="__nav_3"> Usage </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../use_cases_detailed/" class="md-nav__link"> Real-World Scenarios (ROI) </a> </li> <li class="md-nav__item"> <a href="../user_journeys/" class="md-nav__link"> User Journeys (Stories) </a> </li> <li class="md-nav__item md-nav__item--active"> <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc"> <label class="md-nav__link md-nav__link--active" for="__toc"> Integration & Workflows </label> <a href="./" class="md-nav__link md-nav__link--active"> Integration & Workflows </a> <nav class="md-nav md-nav--secondary" aria-label="Table of contents"> <label class="md-nav__title" for="__toc"> Table of contents </label> <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix> <li class="md-nav__item"> <a href="#table-of-contents" class="md-nav__link"> Table of Contents </a> </li> <li class="md-nav__item"> <a href="#philosophy-integration-vs-step-out" class="md-nav__link"> Philosophy: Integration vs Step-Out </a> <nav class="md-nav" aria-label="Philosophy: Integration vs Step-Out"> <ul class="md-nav__list"> <li class="md-nav__item"> <a href="#step-out-workflow-what-we-avoid" class="md-nav__link"> ❌ Step-Out Workflow (What We Avoid) </a> </li> <li class="md-nav__item"> <a href="#integrated-workflow-what-cgc-provides" class="md-nav__link"> ✅ Integrated Workflow (What CGC Provides) </a> </li> </ul> </nav> </li> <li class="md-nav__item"> <a href="#ide-integration-primary-workflow" class="md-nav__link"> IDE Integration (Primary Workflow) </a> <nav class="md-nav" aria-label="IDE Integration (Primary Workflow)"> <ul class="md-nav__list"> <li class="md-nav__item"> <a href="#cursor-ide-recommended" class="md-nav__link"> Cursor IDE (Recommended) </a> <nav class="md-nav" aria-label="Cursor IDE (Recommended)"> <ul class="md-nav__list"> <li class="md-nav__item"> <a href="#setup-one-time-5-minutes" class="md-nav__link"> Setup (One-Time, 5 minutes) </a> </li> <li class="md-nav__item"> <a href="#daily-workflow-zero-extra-steps" class="md-nav__link"> Daily Workflow (Zero Extra Steps) </a> </li> </ul> </nav> </li> <li class="md-nav__item"> <a href="#vs-code-with-continuedev" class="md-nav__link"> VS Code (with Continue.dev) </a> <nav class="md-nav" aria-label="VS Code (with Continue.dev)"> <ul class="md-nav__list"> <li class="md-nav__item"> <a href="#setup" class="md-nav__link"> Setup </a> </li> <li class="md-nav__item"> <a href="#integration-points" class="md-nav__link"> Integration Points </a> </li> </ul> </nav> </li> <li class="md-nav__item"> <a href="#jetbrains-ides-intellij-pycharm-etc" class="md-nav__link"> JetBrains IDEs (IntelliJ, PyCharm, etc.) </a> <nav class="md-nav" aria-label="JetBrains IDEs (IntelliJ, PyCharm, etc.)"> <ul class="md-nav__list"> <li class="md-nav__item"> <a href="#setup_1" class="md-nav__link"> Setup </a> </li> <li class="md-nav__item"> <a href="#integration-points_1" class="md-nav__link"> Integration Points </a> </li> </ul> </nav> </li> </ul> </nav> </li> <li class="md-nav__item"> <a href="#cicd-integration" class="md-nav__link"> CI/CD Integration </a> <nav class="md-nav" aria-label="CI/CD Integration"> <ul class="md-nav__list"> <li class="md-nav__item"> <a href="#github-actions" class="md-nav__link"> GitHub Actions </a> </li> <li class="md-nav__item"> <a href="#gitlab-ci" class="md-nav__link"> GitLab CI </a> </li> </ul> </nav> </li> <li class="md-nav__item"> <a href="#git-workflow-integration" class="md-nav__link"> Git Workflow Integration </a> <nav class="md-nav" aria-label="Git Workflow Integration"> <ul class="md-nav__list"> <li class="md-nav__item"> <a href="#pre-commit-hooks" class="md-nav__link"> Pre-Commit Hooks </a> </li> <li class="md-nav__item"> <a href="#git-aliases" class="md-nav__link"> Git Aliases </a> </li> </ul> </nav> </li> <li class="md-nav__item"> <a href="#code-review-integration" class="md-nav__link"> Code Review Integration </a> <nav class="md-nav" aria-label="Code Review Integration"> <ul class="md-nav__list"> <li class="md-nav__item"> <a href="#github-pr-template" class="md-nav__link"> GitHub PR Template </a> </li> <li class="md-nav__item"> <a href="#review-checklist-script" class="md-nav__link"> Review Checklist Script </a> </li> </ul> </nav> </li> <li class="md-nav__item"> <a href="#documentation-integration" class="md-nav__link"> Documentation Integration </a> <nav class="md-nav" aria-label="Documentation Integration"> <ul class="md-nav__list"> <li class="md-nav__item"> <a href="#auto-generated-architecture-docs" class="md-nav__link"> Auto-Generated Architecture Docs </a> </li> </ul> </nav> </li> <li class="md-nav__item"> <a href="#team-collaboration-integration" class="md-nav__link"> Team Collaboration Integration </a> <nav class="md-nav" aria-label="Team Collaboration Integration"> <ul class="md-nav__list"> <li class="md-nav__item"> <a href="#slack-integration" class="md-nav__link"> Slack Integration </a> </li> <li class="md-nav__item"> <a href="#shared-graph-database" class="md-nav__link"> Shared Graph Database </a> </li> </ul> </nav> </li> <li class="md-nav__item"> <a href="#comparison-cgc-vs-alternatives" class="md-nav__link"> Comparison: CGC vs Alternatives </a> <nav class="md-nav" aria-label="Comparison: CGC vs Alternatives"> <ul class="md-nav__list"> <li class="md-nav__item"> <a href="#cgc-vs-ide-built-in-tools" class="md-nav__link"> CGC vs IDE Built-in Tools </a> </li> <li class="md-nav__item"> <a href="#cgc-vs-sourcegraph" class="md-nav__link"> CGC vs SourceGraph </a> </li> <li class="md-nav__item"> <a href="#cgc-vs-context7-mcp" class="md-nav__link"> CGC vs Context7 (MCP) </a> </li> </ul> </nav> </li> <li class="md-nav__item"> <a href="#integration-best-practices" class="md-nav__link"> Integration Best Practices </a> <nav class="md-nav" aria-label="Integration Best Practices"> <ul class="md-nav__list"> <li class="md-nav__item"> <a href="#1-start-small" class="md-nav__link"> 1. Start Small </a> </li> <li class="md-nav__item"> <a href="#2-make-it-automatic" class="md-nav__link"> 2. Make it Automatic </a> </li> <li class="md-nav__item"> <a href="#3-integrate-where-you-work" class="md-nav__link"> 3. Integrate Where You Work </a> </li> <li class="md-nav__item"> <a href="#4-provide-value-immediately" class="md-nav__link"> 4. Provide Value Immediately </a> </li> </ul> </nav> </li> <li class="md-nav__item"> <a href="#summary-integration-philosophy" class="md-nav__link"> Summary: Integration Philosophy </a> <nav class="md-nav" aria-label="Summary: Integration Philosophy"> <ul class="md-nav__list"> <li class="md-nav__item"> <a href="#what-cgc-is-not" class="md-nav__link"> ❌ What CGC is NOT: </a> </li> <li class="md-nav__item"> <a href="#what-cgc-is" class="md-nav__link"> ✅ What CGC IS: </a> </li> <li class="md-nav__item"> <a href="#the-goal" class="md-nav__link"> The Goal: </a> </li> </ul> </nav> </li> <li class="md-nav__item"> <a href="#next-steps" class="md-nav__link"> Next Steps </a> </li> </ul> </nav> </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"> Guides </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"> 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"> Neo4j Setup Wizard </a> </li> <li class="md-nav__item"> <a href="../guides/mcp_guide/" class="md-nav__link"> MCP Setup Wizard </a> </li> <li class="md-nav__item"> <a href="../guides/visualization/" class="md-nav__link"> Visualizing the Graph </a> </li> <li class="md-nav__item"> <a href="../guides/bundles/" class="md-nav__link"> Using On-Demand Bundles </a> </li> <li class="md-nav__item"> <a href="../guides/ci_cd/" class="md-nav__link"> CI/CD & Advanced </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"> Core Concepts </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"> 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"> How it Works </a> </li> <li class="md-nav__item"> <a href="../architecture/" class="md-nav__link"> System Architecture </a> </li> <li class="md-nav__item"> <a href="../concepts/the_graph/" class="md-nav__link"> The Graph Model </a> </li> <li class="md-nav__item"> <a href="../concepts/modes/" class="md-nav__link"> CLI vs MCP Modes </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"> CLI Reference </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"> 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"> All Commands (Master List) </a> </li> <li class="md-nav__item"> <a href="../reference/cli_indexing/" class="md-nav__link"> Indexing & Management </a> </li> <li class="md-nav__item"> <a href="../reference/cli_analysis/" class="md-nav__link"> Analysis & Querying </a> </li> <li class="md-nav__item"> <a href="../reference/cli_system/" class="md-nav__link"> System & Config </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"> MCP Reference </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"> 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"> All Tools (Master List) </a> </li> <li class="md-nav__item"> <a href="../cookbook/" class="md-nav__link"> Example Cookbook </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"> Project Info </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"> Project Info </label> <ul class="md-nav__list" data-md-scrollfix> <li class="md-nav__item"> <a href="../roadmap/" class="md-nav__link"> Roadmap </a> </li> <li class="md-nav__item"> <a href="../contributing/" class="md-nav__link"> Contributing </a> </li> <li class="md-nav__item"> <a href="../license/" class="md-nav__link"> License </a> </li> <li class="md-nav__item"> <a href="../reference/configuration/" class="md-nav__link"> Configuration </a> </li> <li class="md-nav__item"> <a href="../reference/cgcignore/" class="md-nav__link"> .cgcignore Guide </a> </li> <li class="md-nav__item"> <a href="../reference/troubleshooting/" class="md-nav__link"> Troubleshooting </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"> Table of contents </label> <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix> <li class="md-nav__item"> <a href="#table-of-contents" class="md-nav__link"> Table of Contents </a> </li> <li class="md-nav__item"> <a href="#philosophy-integration-vs-step-out" class="md-nav__link"> Philosophy: Integration vs Step-Out </a> <nav class="md-nav" aria-label="Philosophy: Integration vs Step-Out"> <ul class="md-nav__list"> <li class="md-nav__item"> <a href="#step-out-workflow-what-we-avoid" class="md-nav__link"> ❌ Step-Out Workflow (What We Avoid) </a> </li> <li class="md-nav__item"> <a href="#integrated-workflow-what-cgc-provides" class="md-nav__link"> ✅ Integrated Workflow (What CGC Provides) </a> </li> </ul> </nav> </li> <li class="md-nav__item"> <a href="#ide-integration-primary-workflow" class="md-nav__link"> IDE Integration (Primary Workflow) </a> <nav class="md-nav" aria-label="IDE Integration (Primary Workflow)"> <ul class="md-nav__list"> <li class="md-nav__item"> <a href="#cursor-ide-recommended" class="md-nav__link"> Cursor IDE (Recommended) </a> <nav class="md-nav" aria-label="Cursor IDE (Recommended)"> <ul class="md-nav__list"> <li class="md-nav__item"> <a href="#setup-one-time-5-minutes" class="md-nav__link"> Setup (One-Time, 5 minutes) </a> </li> <li class="md-nav__item"> <a href="#daily-workflow-zero-extra-steps" class="md-nav__link"> Daily Workflow (Zero Extra Steps) </a> </li> </ul> </nav> </li> <li class="md-nav__item"> <a href="#vs-code-with-continuedev" class="md-nav__link"> VS Code (with Continue.dev) </a> <nav class="md-nav" aria-label="VS Code (with Continue.dev)"> <ul class="md-nav__list"> <li class="md-nav__item"> <a href="#setup" class="md-nav__link"> Setup </a> </li> <li class="md-nav__item"> <a href="#integration-points" class="md-nav__link"> Integration Points </a> </li> </ul> </nav> </li> <li class="md-nav__item"> <a href="#jetbrains-ides-intellij-pycharm-etc" class="md-nav__link"> JetBrains IDEs (IntelliJ, PyCharm, etc.) </a> <nav class="md-nav" aria-label="JetBrains IDEs (IntelliJ, PyCharm, etc.)"> <ul class="md-nav__list"> <li class="md-nav__item"> <a href="#setup_1" class="md-nav__link"> Setup </a> </li> <li class="md-nav__item"> <a href="#integration-points_1" class="md-nav__link"> Integration Points </a> </li> </ul> </nav> </li> </ul> </nav> </li> <li class="md-nav__item"> <a href="#cicd-integration" class="md-nav__link"> CI/CD Integration </a> <nav class="md-nav" aria-label="CI/CD Integration"> <ul class="md-nav__list"> <li class="md-nav__item"> <a href="#github-actions" class="md-nav__link"> GitHub Actions </a> </li> <li class="md-nav__item"> <a href="#gitlab-ci" class="md-nav__link"> GitLab CI </a> </li> </ul> </nav> </li> <li class="md-nav__item"> <a href="#git-workflow-integration" class="md-nav__link"> Git Workflow Integration </a> <nav class="md-nav" aria-label="Git Workflow Integration"> <ul class="md-nav__list"> <li class="md-nav__item"> <a href="#pre-commit-hooks" class="md-nav__link"> Pre-Commit Hooks </a> </li> <li class="md-nav__item"> <a href="#git-aliases" class="md-nav__link"> Git Aliases </a> </li> </ul> </nav> </li> <li class="md-nav__item"> <a href="#code-review-integration" class="md-nav__link"> Code Review Integration </a> <nav class="md-nav" aria-label="Code Review Integration"> <ul class="md-nav__list"> <li class="md-nav__item"> <a href="#github-pr-template" class="md-nav__link"> GitHub PR Template </a> </li> <li class="md-nav__item"> <a href="#review-checklist-script" class="md-nav__link"> Review Checklist Script </a> </li> </ul> </nav> </li> <li class="md-nav__item"> <a href="#documentation-integration" class="md-nav__link"> Documentation Integration </a> <nav class="md-nav" aria-label="Documentation Integration"> <ul class="md-nav__list"> <li class="md-nav__item"> <a href="#auto-generated-architecture-docs" class="md-nav__link"> Auto-Generated Architecture Docs </a> </li> </ul> </nav> </li> <li class="md-nav__item"> <a href="#team-collaboration-integration" class="md-nav__link"> Team Collaboration Integration </a> <nav class="md-nav" aria-label="Team Collaboration Integration"> <ul class="md-nav__list"> <li class="md-nav__item"> <a href="#slack-integration" class="md-nav__link"> Slack Integration </a> </li> <li class="md-nav__item"> <a href="#shared-graph-database" class="md-nav__link"> Shared Graph Database </a> </li> </ul> </nav> </li> <li class="md-nav__item"> <a href="#comparison-cgc-vs-alternatives" class="md-nav__link"> Comparison: CGC vs Alternatives </a> <nav class="md-nav" aria-label="Comparison: CGC vs Alternatives"> <ul class="md-nav__list"> <li class="md-nav__item"> <a href="#cgc-vs-ide-built-in-tools" class="md-nav__link"> CGC vs IDE Built-in Tools </a> </li> <li class="md-nav__item"> <a href="#cgc-vs-sourcegraph" class="md-nav__link"> CGC vs SourceGraph </a> </li> <li class="md-nav__item"> <a href="#cgc-vs-context7-mcp" class="md-nav__link"> CGC vs Context7 (MCP) </a> </li> </ul> </nav> </li> <li class="md-nav__item"> <a href="#integration-best-practices" class="md-nav__link"> Integration Best Practices </a> <nav class="md-nav" aria-label="Integration Best Practices"> <ul class="md-nav__list"> <li class="md-nav__item"> <a href="#1-start-small" class="md-nav__link"> 1. Start Small </a> </li> <li class="md-nav__item"> <a href="#2-make-it-automatic" class="md-nav__link"> 2. Make it Automatic </a> </li> <li class="md-nav__item"> <a href="#3-integrate-where-you-work" class="md-nav__link"> 3. Integrate Where You Work </a> </li> <li class="md-nav__item"> <a href="#4-provide-value-immediately" class="md-nav__link"> 4. Provide Value Immediately </a> </li> </ul> </nav> </li> <li class="md-nav__item"> <a href="#summary-integration-philosophy" class="md-nav__link"> Summary: Integration Philosophy </a> <nav class="md-nav" aria-label="Summary: Integration Philosophy"> <ul class="md-nav__list"> <li class="md-nav__item"> <a href="#what-cgc-is-not" class="md-nav__link"> ❌ What CGC is NOT: </a> </li> <li class="md-nav__item"> <a href="#what-cgc-is" class="md-nav__link"> ✅ What CGC IS: </a> </li> <li class="md-nav__item"> <a href="#the-goal" class="md-nav__link"> The Goal: </a> </li> </ul> </nav> </li> <li class="md-nav__item"> <a href="#next-steps" class="md-nav__link"> Next Steps </a> </li> </ul> </nav> </div> </div> </div> <div class="md-content" data-md-component="content"> <article class="md-content__inner md-typeset"> <h1 id="integration-guide-codegraphcontext">Integration Guide - CodeGraphContext</h1> This document explains how CodeGraphContext integrates seamlessly into typical developer workflows, rather than requiring "step-outs" or context switching. <hr /> <h2 id="table-of-contents">Table of Contents</h2> <ol> <li><a href="#philosophy-integration-vs-step-out">Philosophy: Integration vs Step-Out</a></li> <li><a href="#ide-integration-primary-workflow">IDE Integration (Primary Workflow)</a></li> <li><a href="#cicd-integration">CI/CD Integration</a></li> <li><a href="#git-workflow-integration">Git Workflow Integration</a></li> <li><a href="#code-review-integration">Code Review Integration</a></li> <li><a href="#documentation-integration">Documentation Integration</a></li> <li><a href="#team-collaboration-integration">Team Collaboration Integration</a></li> <li><a href="#comparison-cgc-vs-alternatives">Comparison: CGC vs Alternatives</a></li> </ol> <hr /> <h2 id="philosophy-integration-vs-step-out">Philosophy: Integration vs Step-Out</h2> <h3 id="step-out-workflow-what-we-avoid">❌ Step-Out Workflow (What We Avoid)</h3> Traditional code analysis tools require context switching: <div class="highlight"><pre><code>Developer Workflow (Broken): 1. Writing code in IDE 2. ❌ STOP - Open terminal 3. ❌ Run analysis tool 4. ❌ Read output in terminal 5. ❌ Switch back to IDE 6. ❌ Remember what you were doing 7. Continue coding (context lost) </code></pre></div> Problems: - Context switching kills productivity - Interrupts flow state - Requires remembering to use the tool - Separate from where you work <h3 id="integrated-workflow-what-cgc-provides">✅ Integrated Workflow (What CGC Provides)</h3> CGC integrates into your existing tools: <div class="highlight"><pre><code>Developer Workflow (Seamless): 1. Writing code in IDE 2. ✅ Ask AI assistant (already in IDE) 3. ✅ AI uses CGC automatically (invisible) 4. ✅ Get answer in same context 5. Continue coding (flow maintained) </code></pre></div> Benefits: - No context switching - Natural language interface - Automatic, not manual - Integrated where you already work <hr /> <h2 id="ide-integration-primary-workflow">IDE Integration (Primary Workflow)</h2> <h3 id="cursor-ide-recommended">Cursor IDE (Recommended)</h3> <h4 id="setup-one-time-5-minutes">Setup (One-Time, 5 minutes)</h4> <div class="highlight"><pre><code># 1. Install CGC pip install codegraphcontext # 2. Index your project cd ~/projects/my-project cgc index . # 3. Setup MCP cgc mcp setup # Select: Cursor # 4. Start MCP server (auto-start recommended) cgc mcp start & # 5. Restart Cursor </code></pre></div> <h4 id="daily-workflow-zero-extra-steps">Daily Workflow (Zero Extra Steps)</h4> Scenario 1: Understanding Code <div class="highlight"><pre><code>You're reading unfamiliar code: // You see this function call processPayment(order, user); // You wonder: "What does this do?" Traditional Approach: 1. ❌ Search for function definition 2. ❌ Open file 3. ❌ Read code 4. ❌ Find what IT calls 5. ❌ Repeat... CGC Integrated Approach: 1. ✅ Highlight "processPayment" 2. ✅ Ask AI: "What does this function do?" 3. ✅ AI uses CGC, shows: - Function definition - What it calls - Who calls it - Full execution flow 4. ✅ Continue reading (no context switch) </code></pre></div> Scenario 2: Before Refactoring <div class="highlight"><pre><code>You want to rename a function: Traditional Approach: 1. ❌ Open terminal 2. ❌ Run: grep -r "oldFunction" . 3. ❌ Read 100+ lines of output 4. ❌ Manually filter false positives 5. ❌ Switch back to IDE 6. ❌ Start refactoring (hope you didn't miss anything) CGC Integrated Approach: 1. ✅ Right-click function name 2. ✅ Ask AI: "What will break if I rename this?" 3. ✅ AI uses CGC, shows: - All 23 callers - Files affected - Test coverage 4. ✅ IDE refactor tool with confidence 5. ✅ No terminal, no context switch </code></pre></div> Scenario 3: Code Review <div class="highlight"><pre><code>You're reviewing a PR: Traditional Approach: 1. ❌ Read PR diff 2. ❌ Open terminal 3. ❌ Run analysis commands 4. ❌ Switch back to GitHub 5. ❌ Write review 6. ❌ Repeat for each file CGC Integrated Approach: 1. ✅ Open PR in Cursor 2. ✅ Ask AI: "Analyze the impact of this PR" 3. ✅ AI uses CGC, provides: - Functions affected - Test coverage - Risk assessment 4. ✅ Write review in same window 5. ✅ No context switch </code></pre></div> <h3 id="vs-code-with-continuedev">VS Code (with Continue.dev)</h3> <h4 id="setup">Setup</h4> <div class="highlight"><pre><code># 1-3: Same as Cursor # 4. Setup MCP for Continue cgc mcp setup # Select: VS Code (Continue.dev) # 5. Restart VS Code </code></pre></div> <h4 id="integration-points">Integration Points</h4> 1. Inline Chat (Cmd+I) <div class="highlight"><pre><code>While editing code: 1. Press Cmd+I (inline chat) 2. Ask: "Who calls this function?" 3. Get answer inline 4. Continue editing </code></pre></div> 2. Sidebar Chat <div class="highlight"><pre><code>While exploring codebase: 1. Open Continue sidebar 2. Ask: "Show me the architecture of the auth module" 3. Get visualization 4. Click through to files </code></pre></div> 3. Code Actions <div class="highlight"><pre><code>Right-click on function: 1. "Ask Continue: Find callers" 2. "Ask Continue: Show call chain" 3. "Ask Continue: Check complexity" </code></pre></div> <h3 id="jetbrains-ides-intellij-pycharm-etc">JetBrains IDEs (IntelliJ, PyCharm, etc.)</h3> <h4 id="setup_1">Setup</h4> <div class="highlight"><pre><code># 1-3: Same as above # 4. Setup MCP for JetBrains cgc mcp setup # Select: JetBrains (AI Assistant) # 5. Restart IDE </code></pre></div> <h4 id="integration-points_1">Integration Points</h4> 1. AI Assistant Panel <div class="highlight"><pre><code>While coding: 1. Open AI Assistant (Alt+Enter) 2. Ask questions about code 3. AI uses CGC automatically </code></pre></div> 2. Quick Actions <div class="highlight"><pre><code>Right-click on code: 1. "AI Assistant: Analyze Impact" 2. "AI Assistant: Find Usages (Deep)" 3. "AI Assistant: Show Architecture" </code></pre></div> <hr /> <h2 id="cicd-integration">CI/CD Integration</h2> <h3 id="github-actions">GitHub Actions</h3> Automatic Code Quality Checks <div class="highlight"><pre><code># .github/workflows/code-quality.yml name: Code Quality on: [pull_request] jobs: analyze: runs-on: ubuntu-latest steps: - uses: actions/checkout@v3 - name: Setup Python uses: actions/setup-python@v4 with: python-version: '3.10' - name: Install CodeGraphContext run: pip install codegraphcontext - name: Index codebase run: cgc index . - name: Find dead code run: | cgc analyze dead-code --exclude-decorated @api.route > dead-code.txt if [ -s dead-code.txt ]; then echo "⚠️ Dead code found:" cat dead-code.txt echo "::warning::Dead code detected. Consider cleanup." fi - name: Check complexity run: | cgc analyze complexity --limit 10 --threshold 15 > complex.txt if [ -s complex.txt ]; then echo "⚠️ Complex functions found:" cat complex.txt echo "::warning::High complexity detected. Consider refactoring." fi - name: Find circular dependencies run: | cgc query " MATCH (m1:Module)-[:IMPORTS]->(m2:Module)-[:IMPORTS]->(m1) RETURN m1.name, m2.name " > circular.txt if [ -s circular.txt ]; then echo "❌ Circular dependencies found:" cat circular.txt echo "::error::Circular dependencies detected!" exit 1 fi - name: Comment on PR uses: actions/github-script@v6 with: script: | const fs = require('fs'); const deadCode = fs.readFileSync('dead-code.txt', 'utf8'); const complex = fs.readFileSync('complex.txt', 'utf8'); let comment = '## Code Quality Report\n\n'; if (deadCode) { comment += '### ⚠️ Dead Code\n```\n' + deadCode + '\n```\n\n'; } if (complex) { comment += '### ⚠️ Complex Functions\n```\n' + complex + '\n```\n\n'; } if (!deadCode && !complex) { comment += '✅ No issues found!\n'; } github.rest.issues.createComment({ issue_number: context.issue.number, owner: context.repo.owner, repo: context.repo.repo, body: comment }); </code></pre></div> Result: Every PR automatically gets code quality feedback <h3 id="gitlab-ci">GitLab CI</h3> <div class="highlight"><pre><code># .gitlab-ci.yml code_quality: stage: test image: python:3.10 script: - pip install codegraphcontext - cgc index . - cgc analyze dead-code > dead-code.txt || true - cgc analyze complexity --limit 10 > complexity.txt || true artifacts: reports: codequality: - dead-code.txt - complexity.txt only: - merge_requests </code></pre></div> <hr /> <h2 id="git-workflow-integration">Git Workflow Integration</h2> <h3 id="pre-commit-hooks">Pre-Commit Hooks</h3> Automatic checks before every commit <div class="highlight"><pre><code># .git/hooks/pre-commit #!/bin/bash # Index changed files only (fast) cgc reindex # Check if commit introduces dead code DEAD_CODE=$(cgc analyze dead-code --changed-only) if [ -n "$DEAD_CODE" ]; then echo "⚠️ Warning: This commit may introduce dead code:" echo "$DEAD_CODE" read -p "Continue anyway? (y/n) " -n 1 -r echo if [[ ! $REPLY =~ ^[Yy]$ ]]; then exit 1 fi fi # Check if commit introduces high complexity COMPLEX=$(cgc analyze complexity --changed-only --threshold 15) if [ -n "$COMPLEX" ]; then echo "⚠️ Warning: This commit introduces complex functions:" echo "$COMPLEX" read -p "Continue anyway? (y/n) " -n 1 -r echo if [[ ! $REPLY =~ ^[Yy]$ ]]; then exit 1 fi fi exit 0 </code></pre></div> Make it executable: <div class="highlight"><pre><code>chmod +x .git/hooks/pre-commit </code></pre></div> <h3 id="git-aliases">Git Aliases</h3> Add CGC commands to git workflow <div class="highlight"><pre><code># ~/.gitconfig [alias] # Show impact of current changes impact = !cgc analyze callers $(git diff --name-only | xargs cgc find --files) # Find dead code in current branch dead = !cgc analyze dead-code --branch $(git branch --show-current) # Show architecture diff between branches arch-diff = !cgc visualize --branch main && cgc visualize --branch $(git branch --show-current) && echo "Compare: main_arch.html vs current_arch.html" # Check complexity of changed functions complexity = !cgc analyze complexity --changed-only </code></pre></div> Usage: <div class="highlight"><pre><code>git impact # See what your changes affect git dead # Find dead code in your branch git arch-diff # Compare architecture git complexity # Check if you're adding complex code </code></pre></div> <hr /> <h2 id="code-review-integration">Code Review Integration</h2> <h3 id="github-pr-template">GitHub PR Template</h3> Automatic CGC analysis in PR description <div class="highlight"><pre><code> ## Description  ## Impact Analysis  **Functions Modified:** - [ ] `function_name` - X callers, Y files affected **Test Coverage:** - [ ] All modified functions have tests - [ ] No new dead code introduced - [ ] Complexity within acceptable limits ## CGC Checks  - [ ] No circular dependencies - [ ] No high-complexity functions (>15) - [ ] No dead code introduced ## Checklist - [ ] Code follows style guidelines - [ ] Self-review completed - [ ] Comments added for complex logic - [ ] Documentation updated - [ ] Tests pass locally - [ ] CGC analysis reviewed </code></pre></div> <h3 id="review-checklist-script">Review Checklist Script</h3> <div class="highlight"><pre><code>#!/bin/bash # scripts/review-pr.sh PR_BRANCH=$1 echo "🔍 Analyzing PR: $PR_BRANCH" echo # Get changed files CHANGED_FILES=$(git diff main...$PR_BRANCH --name-only --diff-filter=M | grep '\.py$') echo "📝 Changed Files:" echo "$CHANGED_FILES" echo # For each changed file, find modified functions for file in $CHANGED_FILES; do echo "📄 Analyzing: $file" # Find functions in this file FUNCTIONS=$(cgc find --file $file --type function) # For each function, check impact echo "$FUNCTIONS" | while read func; do echo " Function: $func" CALLERS=$(cgc analyze callers $func --count-only) echo " Callers: $CALLERS" done echo done # Check for new dead code echo "🧹 Checking for dead code..." cgc analyze dead-code --branch $PR_BRANCH # Check complexity echo "📊 Checking complexity..." cgc analyze complexity --branch $PR_BRANCH --threshold 15 # Check for circular dependencies echo "🔄 Checking for circular dependencies..." cgc query " MATCH (m1:Module)-[:IMPORTS]->(m2:Module)-[:IMPORTS]->(m1) RETURN m1.name, m2.name " echo echo "✅ Review complete!" </code></pre></div> Usage: <div class="highlight"><pre><code>./scripts/review-pr.sh feature-branch </code></pre></div> <hr /> <h2 id="documentation-integration">Documentation Integration</h2> <h3 id="auto-generated-architecture-docs">Auto-Generated Architecture Docs</h3> Keep docs in sync with code <div class="highlight"><pre><code># scripts/update-docs.sh #!/bin/bash echo "📚 Updating documentation..." # Generate architecture diagram cgc visualize --output docs/architecture.html # Generate module dependency graph cgc analyze deps --all --output docs/dependencies.md # Generate complexity report cgc analyze complexity --limit 20 --output docs/complexity.md # Generate API surface area cgc find --type function --decorated @api.route --output docs/api-endpoints.md echo "✅ Documentation updated!" </code></pre></div> Add to CI: <div class="highlight"><pre><code># .github/workflows/docs.yml name: Update Docs on: push: branches: [main] jobs: docs: runs-on: ubuntu-latest steps: - uses: actions/checkout@v3 - run: pip install codegraphcontext - run: cgc index . - run: ./scripts/update-docs.sh - uses: stefanzweifel/git-auto-commit-action@v4 with: commit_message: "docs: auto-update architecture docs" file_pattern: docs/* </code></pre></div> Result: Documentation automatically updates with every commit <hr /> <h2 id="team-collaboration-integration">Team Collaboration Integration</h2> <h3 id="slack-integration">Slack Integration</h3> Share CGC insights in Slack <div class="highlight"><pre><code># scripts/slack-bot.py import os from slack_sdk import WebClient from slack_sdk.errors import SlackApiError import subprocess client = WebClient(token=os.environ['SLACK_BOT_TOKEN']) def handle_cgc_command(channel, command): """Handle /cgc slash command in Slack""" # Run CGC command result = subprocess.run( ['cgc'] + command.split(), capture_output=True, text=True ) # Post result to Slack try: client.chat_postMessage( channel=channel, text=f"```\n{result.stdout}\n```" ) except SlackApiError as e: print(f"Error: {e}") # Example usage: # /cgc analyze callers processPayment # /cgc find "authentication" --type function # /cgc analyze dead-code </code></pre></div> <h3 id="shared-graph-database">Shared Graph Database</h3> Team shares one graph (optional) <div class="highlight"><pre><code># Setup shared Neo4j instance cgc neo4j setup --host team-neo4j.company.com # All team members connect to same graph cgc config set db.host team-neo4j.company.com cgc config set db.user team cgc config set db.password <shared-password> # Now everyone sees the same graph # Updates from one developer visible to all </code></pre></div> Benefits: - Consistent view of codebase - No duplicate indexing - Faster onboarding (graph already built) <hr /> <h2 id="comparison-cgc-vs-alternatives">Comparison: CGC vs Alternatives</h2> <h3 id="cgc-vs-ide-built-in-tools">CGC vs IDE Built-in Tools</h3> <table> <thead> <tr> <th>Feature</th> <th>IDE Built-in</th> <th>CodeGraphContext</th> </tr> </thead> <tbody> <tr> <td>Find References</td> <td>✅ Direct only</td> <td>✅ Direct + Indirect</td> </tr> <tr> <td>Call Hierarchy</td> <td>✅ Limited</td> <td>✅ Complete graph</td> </tr> <tr> <td>Cross-language</td> <td>❌ No</td> <td>✅ Yes</td> </tr> <tr> <td>Dead Code</td> <td>❌ No</td> <td>✅ Yes</td> </tr> <tr> <td>Complexity</td> <td>❌ No</td> <td>✅ Yes</td> </tr> <tr> <td>Architecture</td> <td>❌ No</td> <td>✅ Yes</td> </tr> <tr> <td>AI Integration</td> <td>❌ No</td> <td>✅ Yes (MCP)</td> </tr> <tr> <td>CI/CD</td> <td>❌ No</td> <td>✅ Yes</td> </tr> </tbody> </table> Verdict: CGC complements IDE tools, doesn't replace them <h3 id="cgc-vs-sourcegraph">CGC vs SourceGraph</h3> <table> <thead> <tr> <th>Feature</th> <th>SourceGraph</th> <th>CodeGraphContext</th> </tr> </thead> <tbody> <tr> <td>Code Search</td> <td>✅ Excellent</td> <td>✅ Good</td> </tr> <tr> <td>Graph Analysis</td> <td>⚠️ Limited</td> <td>✅ Complete</td> </tr> <tr> <td>Local Use</td> <td>❌ No</td> <td>✅ Yes</td> </tr> <tr> <td>AI Integration</td> <td>❌ No</td> <td>✅ Yes (MCP)</td> </tr> <tr> <td>Open Source</td> <td>⚠️ Limited</td> <td>✅ Yes</td> </tr> <tr> <td>Cost</td> <td>💰 $$</td> <td>✅ Free</td> </tr> <tr> <td>GitHub Only</td> <td>✅ Yes</td> <td>✅ Any repo</td> </tr> </tbody> </table> Verdict: CGC better for local, AI-integrated workflows <h3 id="cgc-vs-context7-mcp">CGC vs Context7 (MCP)</h3> <table> <thead> <tr> <th>Feature</th> <th>Context7</th> <th>CodeGraphContext</th> </tr> </thead> <tbody> <tr> <td>Context Type</td> <td>Docstrings only</td> <td>Full graph</td> </tr> <tr> <td>Relationships</td> <td>❌ No</td> <td>✅ Yes</td> </tr> <tr> <td>Call Chains</td> <td>❌ No</td> <td>✅ Yes</td> </tr> <tr> <td>Dead Code</td> <td>❌ No</td> <td>✅ Yes</td> </tr> <tr> <td>Architecture</td> <td>❌ No</td> <td>✅ Yes</td> </tr> <tr> <td>Accuracy</td> <td>⚠️ Depends on docs</td> <td>✅ Code-based</td> </tr> </tbody> </table> Verdict: CGC provides structural intelligence, not just text <hr /> <h2 id="integration-best-practices">Integration Best Practices</h2> <h3 id="1-start-small">1. Start Small</h3> <div class="highlight"><pre><code># Day 1: Just index cgc index . # Day 2: Add MCP cgc mcp setup cgc mcp start & # Week 1: Add to git hooks # Week 2: Add to CI/CD # Month 1: Team adoption </code></pre></div> <h3 id="2-make-it-automatic">2. Make it Automatic</h3> <div class="highlight"><pre><code># Auto-start MCP server echo 'cgc mcp start &' >> ~/.bashrc # Auto-reindex on file changes cgc watch . # Auto-update docs # Add to CI/CD pipeline </code></pre></div> <h3 id="3-integrate-where-you-work">3. Integrate Where You Work</h3> <ul> <li>✅ Use MCP in IDE (primary)</li> <li>✅ Add to git workflow (secondary)</li> <li>✅ Add to CI/CD (automated)</li> <li>❌ Don't require manual terminal commands</li> </ul> <h3 id="4-provide-value-immediately">4. Provide Value Immediately</h3> <ul> <li>First use should solve a real problem</li> <li>Show time savings concretely</li> <li>Integrate into existing workflows</li> <li>Don't require behavior change</li> </ul> <hr /> <h2 id="summary-integration-philosophy">Summary: Integration Philosophy</h2> <h3 id="what-cgc-is-not">❌ What CGC is NOT:</h3> <ul> <li>Not a separate tool you "switch to"</li> <li>Not a manual process you "remember to run"</li> <li>Not a terminal-only tool</li> <li>Not a replacement for your IDE</li> </ul> <h3 id="what-cgc-is">✅ What CGC IS:</h3> <ul> <li>Invisible enhancement to your AI assistant</li> <li>Automatic analysis in your CI/CD</li> <li>Integrated intelligence in your IDE</li> <li>Seamless addition to your workflow</li> </ul> <h3 id="the-goal">The Goal:</h3> You shouldn't think about CGC. You should just get better answers, faster reviews, and safer refactorings—automatically. <hr /> <h2 id="next-steps">Next Steps</h2> <ul> <li>Setup MCP integration → <a href="../setup_workflows/">SETUP_WORKFLOWS.md</a></li> <li>See it in action → <a href="../user_journeys/">USER_JOURNEYS.md</a></li> <li>Detailed use cases → <a href="../use_cases_detailed/">USE_CASES_DETAILED.md</a></li> <li>CLI reference → <a href="../reference/cli_master/">CLI Reference</a></li> <li>MCP reference → <a href="../reference/mcp_master/">MCP Reference</a></li> </ul> </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>

Loading blob content...

Latest Blog Posts

Redis vs ioredis vs valkey-glide
By punkpeye on January 26, 2026.
benchmark
Redis
valkey
Quickstart: Publish an MCP Server to the MCP Registry
By punkpeye on January 24, 2026.
mcp
official reference mirror
Official MCP Registry Server.json Requirements
By punkpeye on January 24, 2026.
mcp
official reference mirror

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/Shashankss1205/CodeGraphContext'

If you have feedback or need assistance with the MCP directory API, please join our Discord server

index.html•97.1 KiB