CodeGraphContext
index.html•23.1 kB
<!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="../architecture/">
<link rel="next" href="../server/">
<link rel="icon" href="../assets/images/favicon.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.21">
<title>CLI Reference - CodeGraphContext</title>
<link rel="stylesheet" href="../assets/stylesheets/main.2a3383ac.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">
<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="#cli-reference" class="md-skip">
Skip to content
</a>
</div>
<div data-md-component="announce">
</div>
<header class="md-header md-header--shadow" 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">
CLI Reference
</span>
</div>
</div>
</div>
<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>
</nav>
</header>
<div class="md-container" data-md-component="container">
<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" 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>
<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">
<a href="../installation/" class="md-nav__link">
<span class="md-ellipsis">
Installation
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../use_cases/" class="md-nav__link">
<span class="md-ellipsis">
Use Cases
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../architecture/" class="md-nav__link">
<span class="md-ellipsis">
Architecture
</span>
</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">
<span class="md-ellipsis">
CLI Reference
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<a href="./" class="md-nav__link md-nav__link--active">
<span class="md-ellipsis">
CLI Reference
</span>
</a>
<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="#cgc-setup" class="md-nav__link">
<span class="md-ellipsis">
cgc setup
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#cgc-start" class="md-nav__link">
<span class="md-ellipsis">
cgc start
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#cgc-index-path" class="md-nav__link">
<span class="md-ellipsis">
cgc index [PATH]
</span>
</a>
<nav class="md-nav" aria-label="cgc index [PATH]">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#ignoring-files-cgcignore" class="md-nav__link">
<span class="md-ellipsis">
Ignoring Files (.cgcignore)
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#cgc-delete-path" class="md-nav__link">
<span class="md-ellipsis">
cgc delete <PATH>
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#cgc-visualize-query" class="md-nav__link">
<span class="md-ellipsis">
cgc visualize [QUERY]
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#cgc-list_repos" class="md-nav__link">
<span class="md-ellipsis">
cgc list_repos
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#cgc-add_package-package_name" class="md-nav__link">
<span class="md-ellipsis">
cgc add_package <PACKAGE_NAME>
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#cgc-cypher-query" class="md-nav__link">
<span class="md-ellipsis">
cgc cypher <QUERY>
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#cgc-list_mcp_tools" class="md-nav__link">
<span class="md-ellipsis">
cgc list_mcp_tools
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#cgc-help" class="md-nav__link">
<span class="md-ellipsis">
cgc help
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#cgc-version" class="md-nav__link">
<span class="md-ellipsis">
cgc version
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="../server/" class="md-nav__link">
<span class="md-ellipsis">
Server
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../core/" class="md-nav__link">
<span class="md-ellipsis">
Core Concepts
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../tools/" class="md-nav__link">
<span class="md-ellipsis">
Tools
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../cookbook/" class="md-nav__link">
<span class="md-ellipsis">
Cookbook
</span>
</a>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_10" >
<label class="md-nav__link" for="__nav_10" id="__nav_10_label" tabindex="0">
<span class="md-ellipsis">
Contributing
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_10_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_10">
<span class="md-nav__icon md-icon"></span>
Contributing
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../contributing/" class="md-nav__link">
<span class="md-ellipsis">
Overview
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../contributing_languages/" class="md-nav__link">
<span class="md-ellipsis">
Adding New Languages
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="../troubleshooting/" class="md-nav__link">
<span class="md-ellipsis">
Troubleshooting
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../future_work/" class="md-nav__link">
<span class="md-ellipsis">
Future Work
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../license/" class="md-nav__link">
<span class="md-ellipsis">
License
</span>
</a>
</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="#cgc-setup" class="md-nav__link">
<span class="md-ellipsis">
cgc setup
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#cgc-start" class="md-nav__link">
<span class="md-ellipsis">
cgc start
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#cgc-index-path" class="md-nav__link">
<span class="md-ellipsis">
cgc index [PATH]
</span>
</a>
<nav class="md-nav" aria-label="cgc index [PATH]">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#ignoring-files-cgcignore" class="md-nav__link">
<span class="md-ellipsis">
Ignoring Files (.cgcignore)
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#cgc-delete-path" class="md-nav__link">
<span class="md-ellipsis">
cgc delete <PATH>
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#cgc-visualize-query" class="md-nav__link">
<span class="md-ellipsis">
cgc visualize [QUERY]
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#cgc-list_repos" class="md-nav__link">
<span class="md-ellipsis">
cgc list_repos
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#cgc-add_package-package_name" class="md-nav__link">
<span class="md-ellipsis">
cgc add_package <PACKAGE_NAME>
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#cgc-cypher-query" class="md-nav__link">
<span class="md-ellipsis">
cgc cypher <QUERY>
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#cgc-list_mcp_tools" class="md-nav__link">
<span class="md-ellipsis">
cgc list_mcp_tools
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#cgc-help" class="md-nav__link">
<span class="md-ellipsis">
cgc help
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#cgc-version" class="md-nav__link">
<span class="md-ellipsis">
cgc version
</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="cli-reference">CLI Reference</h1>
<p>The CodeGraphContext CLI provides a set of commands to manage the server, index your code, and interact with the code graph.</p>
<h2 id="cgc-setup"><code>cgc setup</code></h2>
<p>Runs the interactive setup wizard to configure the server and database connection. This helps users set up a local Docker-based Neo4j instance or connect to a remote one.</p>
<p><strong>Usage:</strong></p>
<pre><code class="language-bash">cgc setup
</code></pre>
<h2 id="cgc-start"><code>cgc start</code></h2>
<p>Starts the CodeGraphContext MCP server, which listens for JSON-RPC requests from stdin.</p>
<p><strong>Usage:</strong></p>
<pre><code class="language-bash">cgc start
</code></pre>
<h2 id="cgc-index-path"><code>cgc index [PATH]</code></h2>
<p>Indexes a directory or file by adding it to the code graph. If no path is provided, it indexes the current directory.</p>
<p><strong>Arguments:</strong>
* <code>PATH</code> (optional): Path to the directory or file to index. Defaults to the current directory.</p>
<p><strong>Usage:</strong></p>
<pre><code class="language-bash">cgc index /path/to/your/project
</code></pre>
<h3 id="ignoring-files-cgcignore">Ignoring Files (<code>.cgcignore</code>)</h3>
<p>You can tell CodeGraphContext to ignore specific files and directories by creating a <code>.cgcignore</code> file in the root of your project. This file uses the same syntax as <code>.gitignore</code>.</p>
<p>When you run <code>cgc index</code>, the command will look for a <code>.cgcignore</code> file in the directory being indexed and exclude any files or directories that match the patterns in the file.</p>
<p><strong>Example <code>.cgcignore</code> file:</strong></p>
<pre><code># Ignore build artifacts
/build/
/dist/
# Ignore dependencies
/node_modules/
/vendor/
# Ignore logs
*.log
</code></pre>
<h2 id="cgc-delete-path"><code>cgc delete <PATH></code></h2>
<p>Deletes a repository from the code graph.</p>
<p><strong>Arguments:</strong>
* <code>PATH</code> (required): Path of the repository to delete from the code graph.</p>
<p><strong>Usage:</strong></p>
<pre><code class="language-bash">cgc delete /path/to/your/project
</code></pre>
<h2 id="cgc-visualize-query"><code>cgc visualize [QUERY]</code></h2>
<p>Generates a URL to visualize a Cypher query in the Neo4j Browser. If no query is provided, a default query will be used.</p>
<p><strong>Arguments:</strong>
* <code>QUERY</code> (optional): The Cypher query to visualize.</p>
<p><strong>Usage:</strong></p>
<pre><code class="language-bash">cgc visualize "MATCH (n) RETURN n"
</code></pre>
<h2 id="cgc-list_repos"><code>cgc list_repos</code></h2>
<p>Lists all indexed repositories.</p>
<p><strong>Usage:</strong></p>
<pre><code class="language-bash">cgc list_repos
</code></pre>
<h2 id="cgc-add_package-package_name"><code>cgc add_package <PACKAGE_NAME></code></h2>
<p>Adds a Python package to the code graph.</p>
<p><strong>Arguments:</strong>
* <code>PACKAGE_NAME</code> (required): Name of the Python package to add.</p>
<p><strong>Usage:</strong></p>
<pre><code class="language-bash">cgc add_package requests
</code></pre>
<h2 id="cgc-cypher-query"><code>cgc cypher <QUERY></code></h2>
<p>Executes a read-only Cypher query.</p>
<p><strong>Arguments:</strong>
* <code>QUERY</code> (required): The read-only Cypher query to execute.</p>
<p><strong>Usage:</strong></p>
<pre><code class="language-bash">cgc cypher "MATCH (n:Function) RETURN n.name"
</code></pre>
<h2 id="cgc-list_mcp_tools"><code>cgc list_mcp_tools</code></h2>
<p>Lists all available tools and their descriptions.</p>
<p><strong>Usage:</strong></p>
<pre><code class="language-bash">cgc list_mcp_tools
</code></pre>
<h2 id="cgc-help"><code>cgc help</code></h2>
<p>Show the main help message and exit.</p>
<p><strong>Usage:</strong></p>
<pre><code class="language-bash">cgc help
</code></pre>
<h2 id="cgc-version"><code>cgc version</code></h2>
<p>Show the application version.</p>
<p><strong>Usage:</strong></p>
<pre><code class="language-bash">cgc --version
</code></pre>
<p>or</p>
<pre><code class="language-bash">cgc version
</code></pre>
</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">{"base": "..", "features": [], "search": "../assets/javascripts/workers/search.973d3a69.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.f55a23d4.min.js"></script>
</body>
</html>
Latest Blog Posts
- MCP Moves to the Linux Foundation: Neutral Stewardship for Agentic InfrastructureBy Om-Shree-0709 on .mcpanthropicLinux Foundation
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