Mnemex
index.html•146 kB
<!doctype html>
<html lang="en" class="no-js">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<meta name="description" content="Memory persistence for AI assistants with temporal decay">
<meta name="author" content="prefrontal-systems">
<link rel="canonical" href="https://cortexgraph.dev/CONTRIBUTING/">
<link rel="prev" href="../security/">
<link rel="next" href="../ROADMAP/">
<link rel="icon" href="../assets/images/favicon.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.7.0">
<title>Contributing - CortexGraph Documentation</title>
<link rel="stylesheet" href="../assets/stylesheets/main.618322db.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="indigo" data-md-color-accent="indigo">
<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="#contributing-to-cortexgraph" 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="CortexGraph Documentation" class="md-header__button md-logo" aria-label="CortexGraph Documentation" 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">
CortexGraph Documentation
</span>
</div>
<div class="md-header__topic" data-md-component="header-topic">
<span class="md-ellipsis">
Contributing
</span>
</div>
</div>
</div>
<form class="md-header__option" data-md-component="palette">
<input class="md-option" data-md-color-media="(prefers-color-scheme: light)" data-md-color-scheme="default" data-md-color-primary="indigo" data-md-color-accent="indigo" 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="M12 8a4 4 0 0 0-4 4 4 4 0 0 0 4 4 4 4 0 0 0 4-4 4 4 0 0 0-4-4m0 10a6 6 0 0 1-6-6 6 6 0 0 1 6-6 6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12z"/></svg>
</label>
<input class="md-option" data-md-color-media="(prefers-color-scheme: dark)" data-md-color-scheme="slate" data-md-color-primary="indigo" data-md-color-accent="indigo" 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 18c-.89 0-1.74-.2-2.5-.55C11.56 16.5 13 14.42 13 12s-1.44-4.5-3.5-5.45C10.26 6.2 11.11 6 12 6a6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12z"/></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>
<div class="md-search__suggest" data-md-component="search-suggest"></div>
</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/prefrontal-systems/cortexgraph" 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 512 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="M173.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6m-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3m44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9M252.8 8C114.1 8 8 113.3 8 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C436.2 457.8 504 362.9 504 252 504 113.3 391.5 8 252.8 8M105.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1m-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7m32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1m-11.4-14.7c-1.6 1-1.6 3.6 0 5.9s4.3 3.3 5.6 2.3c1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2"/></svg>
</div>
<div class="md-source__repository">
prefrontal-systems/cortexgraph
</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="../installation/" class="md-tabs__link">
Getting Started
</a>
</li>
<li class="md-tabs__item">
<a href="../architecture/" class="md-tabs__link">
Documentation
</a>
</li>
<li class="md-tabs__item">
<a href="../deployment/" class="md-tabs__link">
Deployment
</a>
</li>
<li class="md-tabs__item md-tabs__item--active">
<a href="./" class="md-tabs__link">
Development
</a>
</li>
<li class="md-tabs__item">
<a href="../features/auto-recall-conversation/" class="md-tabs__link">
Features
</a>
</li>
<li class="md-tabs__item">
<a href="../LICENSE/" class="md-tabs__link">
About
</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="CortexGraph Documentation" class="md-nav__button md-logo" aria-label="CortexGraph Documentation" 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>
CortexGraph Documentation
</label>
<div class="md-nav__source">
<a href="https://github.com/prefrontal-systems/cortexgraph" 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 512 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="M173.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6m-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3m44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9M252.8 8C114.1 8 8 113.3 8 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C436.2 457.8 504 362.9 504 252 504 113.3 391.5 8 252.8 8M105.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1m-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7m32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1m-11.4-14.7c-1.6 1-1.6 3.6 0 5.9s4.3 3.3 5.6 2.3c1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2"/></svg>
</div>
<div class="md-source__repository">
prefrontal-systems/cortexgraph
</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="../installation/" class="md-nav__link">
<span class="md-ellipsis">
Installation
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../quickstart/" class="md-nav__link">
<span class="md-ellipsis">
Quick Start
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../configuration/" class="md-nav__link">
<span class="md-ellipsis">
Configuration
</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">
Documentation
</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>
Documentation
</label>
<ul class="md-nav__list" data-md-scrollfix>
<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">
<a href="../api/" class="md-nav__link">
<span class="md-ellipsis">
API Reference
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../graph_features/" class="md-nav__link">
<span class="md-ellipsis">
Knowledge Graph
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../scoring_algorithm/" class="md-nav__link">
<span class="md-ellipsis">
Scoring Algorithm
</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">
Deployment
</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>
Deployment
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../deployment/" class="md-nav__link">
<span class="md-ellipsis">
Deployment Guide
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../security/" class="md-nav__link">
<span class="md-ellipsis">
Security
</span>
</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_5" checked>
<label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="">
<span class="md-ellipsis">
Development
</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="true">
<label class="md-nav__title" for="__nav_5">
<span class="md-nav__icon md-icon"></span>
Development
</label>
<ul class="md-nav__list" data-md-scrollfix>
<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">
Contributing
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<a href="./" class="md-nav__link md-nav__link--active">
<span class="md-ellipsis">
Contributing
</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="#table-of-contents" class="md-nav__link">
<span class="md-ellipsis">
Table of Contents
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#help-needed-windows-linux-testers" class="md-nav__link">
<span class="md-ellipsis">
🚨 Help Needed: Windows & Linux Testers
</span>
</a>
<nav class="md-nav" aria-label="🚨 Help Needed: Windows & Linux Testers">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#why-this-matters" class="md-nav__link">
<span class="md-ellipsis">
Why This Matters
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#what-i-need-help-with" class="md-nav__link">
<span class="md-ellipsis">
What I Need Help With
</span>
</a>
<nav class="md-nav" aria-label="What I Need Help With">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#high-priority" class="md-nav__link">
<span class="md-ellipsis">
High Priority 🔥
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#medium-priority" class="md-nav__link">
<span class="md-ellipsis">
Medium Priority
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#how-to-help" class="md-nav__link">
<span class="md-ellipsis">
How to Help
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#where-to-report" class="md-nav__link">
<span class="md-ellipsis">
Where to Report
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#current-status" class="md-nav__link">
<span class="md-ellipsis">
Current Status
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#prerequisites" class="md-nav__link">
<span class="md-ellipsis">
Prerequisites
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#platform-specific-setup" class="md-nav__link">
<span class="md-ellipsis">
Platform-Specific Setup
</span>
</a>
<nav class="md-nav" aria-label="Platform-Specific Setup">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#windows" class="md-nav__link">
<span class="md-ellipsis">
Windows
</span>
</a>
<nav class="md-nav" aria-label="Windows">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#1-install-python" class="md-nav__link">
<span class="md-ellipsis">
1. Install Python
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#2-install-git" class="md-nav__link">
<span class="md-ellipsis">
2. Install Git
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#3-install-uv-package-manager" class="md-nav__link">
<span class="md-ellipsis">
3. Install UV Package Manager
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#4-clone-the-repository" class="md-nav__link">
<span class="md-ellipsis">
4. Clone the Repository
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#5-set-up-development-environment" class="md-nav__link">
<span class="md-ellipsis">
5. Set Up Development Environment
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#6-configure-environment" class="md-nav__link">
<span class="md-ellipsis">
6. Configure Environment
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#7-running-tests-on-windows" class="md-nav__link">
<span class="md-ellipsis">
7. Running Tests on Windows
</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>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#linux" class="md-nav__link">
<span class="md-ellipsis">
Linux
</span>
</a>
<nav class="md-nav" aria-label="Linux">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#1-install-python_1" class="md-nav__link">
<span class="md-ellipsis">
1. Install Python
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#2-install-uv-package-manager" class="md-nav__link">
<span class="md-ellipsis">
2. Install UV Package Manager
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#3-clone-the-repository" class="md-nav__link">
<span class="md-ellipsis">
3. Clone the Repository
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#4-set-up-development-environment" class="md-nav__link">
<span class="md-ellipsis">
4. Set Up Development Environment
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#5-configure-environment" class="md-nav__link">
<span class="md-ellipsis">
5. Configure Environment
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#6-running-tests-on-linux" class="md-nav__link">
<span class="md-ellipsis">
6. Running Tests on Linux
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#common-linux-issues" class="md-nav__link">
<span class="md-ellipsis">
Common Linux Issues
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#macos" class="md-nav__link">
<span class="md-ellipsis">
macOS
</span>
</a>
<nav class="md-nav" aria-label="macOS">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#1-install-homebrew-if-not-installed" class="md-nav__link">
<span class="md-ellipsis">
1. Install Homebrew (if not installed)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#2-install-python-and-git" class="md-nav__link">
<span class="md-ellipsis">
2. Install Python and Git
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#3-install-uv-package-manager_1" class="md-nav__link">
<span class="md-ellipsis">
3. Install UV Package Manager
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#4-clone-the-repository_1" class="md-nav__link">
<span class="md-ellipsis">
4. Clone the Repository
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#5-set-up-development-environment_1" class="md-nav__link">
<span class="md-ellipsis">
5. Set Up Development Environment
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#6-configure-environment_1" class="md-nav__link">
<span class="md-ellipsis">
6. Configure Environment
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#7-running-tests-on-macos" class="md-nav__link">
<span class="md-ellipsis">
7. Running Tests on macOS
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#development-workflow" class="md-nav__link">
<span class="md-ellipsis">
Development Workflow
</span>
</a>
<nav class="md-nav" aria-label="Development Workflow">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#making-changes" class="md-nav__link">
<span class="md-ellipsis">
Making Changes
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#commit-message-format" class="md-nav__link">
<span class="md-ellipsis">
Commit Message Format
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#testing" class="md-nav__link">
<span class="md-ellipsis">
Testing
</span>
</a>
<nav class="md-nav" aria-label="Testing">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#test-structure" class="md-nav__link">
<span class="md-ellipsis">
Test Structure
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#writing-tests" class="md-nav__link">
<span class="md-ellipsis">
Writing Tests
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#running-specific-tests" class="md-nav__link">
<span class="md-ellipsis">
Running Specific Tests
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#coverage-requirements" class="md-nav__link">
<span class="md-ellipsis">
Coverage Requirements
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#code-style" class="md-nav__link">
<span class="md-ellipsis">
Code Style
</span>
</a>
<nav class="md-nav" aria-label="Code Style">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#python-style-guidelines" class="md-nav__link">
<span class="md-ellipsis">
Python Style Guidelines
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#type-hints" class="md-nav__link">
<span class="md-ellipsis">
Type Hints
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#docstrings" class="md-nav__link">
<span class="md-ellipsis">
Docstrings
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#code-organization" class="md-nav__link">
<span class="md-ellipsis">
Code Organization
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#submitting-changes" class="md-nav__link">
<span class="md-ellipsis">
Submitting Changes
</span>
</a>
<nav class="md-nav" aria-label="Submitting Changes">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#before-submitting" class="md-nav__link">
<span class="md-ellipsis">
Before Submitting
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#creating-a-pull-request" class="md-nav__link">
<span class="md-ellipsis">
Creating a Pull Request
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#code-review-process" class="md-nav__link">
<span class="md-ellipsis">
Code Review Process
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#reporting-issues" class="md-nav__link">
<span class="md-ellipsis">
Reporting Issues
</span>
</a>
<nav class="md-nav" aria-label="Reporting Issues">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#before-opening-an-issue" class="md-nav__link">
<span class="md-ellipsis">
Before Opening an Issue
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#bug-report-template" class="md-nav__link">
<span class="md-ellipsis">
Bug Report Template
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#feature-requests" class="md-nav__link">
<span class="md-ellipsis">
Feature Requests
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#getting-help" class="md-nav__link">
<span class="md-ellipsis">
Getting Help
</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>
</li>
<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="../future_roadmap/" class="md-nav__link">
<span class="md-ellipsis">
Future Plans
</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">
Features
</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>
Features
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../features/auto-recall-conversation/" class="md-nav__link">
<span class="md-ellipsis">
Auto-Recall
</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">
About
</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>
About
</label>
<ul class="md-nav__list" data-md-scrollfix>
<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="../CHANGELOG/" class="md-nav__link">
<span class="md-ellipsis">
Changelog
</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="#table-of-contents" class="md-nav__link">
<span class="md-ellipsis">
Table of Contents
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#help-needed-windows-linux-testers" class="md-nav__link">
<span class="md-ellipsis">
🚨 Help Needed: Windows & Linux Testers
</span>
</a>
<nav class="md-nav" aria-label="🚨 Help Needed: Windows & Linux Testers">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#why-this-matters" class="md-nav__link">
<span class="md-ellipsis">
Why This Matters
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#what-i-need-help-with" class="md-nav__link">
<span class="md-ellipsis">
What I Need Help With
</span>
</a>
<nav class="md-nav" aria-label="What I Need Help With">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#high-priority" class="md-nav__link">
<span class="md-ellipsis">
High Priority 🔥
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#medium-priority" class="md-nav__link">
<span class="md-ellipsis">
Medium Priority
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#how-to-help" class="md-nav__link">
<span class="md-ellipsis">
How to Help
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#where-to-report" class="md-nav__link">
<span class="md-ellipsis">
Where to Report
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#current-status" class="md-nav__link">
<span class="md-ellipsis">
Current Status
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#prerequisites" class="md-nav__link">
<span class="md-ellipsis">
Prerequisites
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#platform-specific-setup" class="md-nav__link">
<span class="md-ellipsis">
Platform-Specific Setup
</span>
</a>
<nav class="md-nav" aria-label="Platform-Specific Setup">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#windows" class="md-nav__link">
<span class="md-ellipsis">
Windows
</span>
</a>
<nav class="md-nav" aria-label="Windows">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#1-install-python" class="md-nav__link">
<span class="md-ellipsis">
1. Install Python
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#2-install-git" class="md-nav__link">
<span class="md-ellipsis">
2. Install Git
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#3-install-uv-package-manager" class="md-nav__link">
<span class="md-ellipsis">
3. Install UV Package Manager
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#4-clone-the-repository" class="md-nav__link">
<span class="md-ellipsis">
4. Clone the Repository
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#5-set-up-development-environment" class="md-nav__link">
<span class="md-ellipsis">
5. Set Up Development Environment
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#6-configure-environment" class="md-nav__link">
<span class="md-ellipsis">
6. Configure Environment
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#7-running-tests-on-windows" class="md-nav__link">
<span class="md-ellipsis">
7. Running Tests on Windows
</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>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#linux" class="md-nav__link">
<span class="md-ellipsis">
Linux
</span>
</a>
<nav class="md-nav" aria-label="Linux">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#1-install-python_1" class="md-nav__link">
<span class="md-ellipsis">
1. Install Python
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#2-install-uv-package-manager" class="md-nav__link">
<span class="md-ellipsis">
2. Install UV Package Manager
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#3-clone-the-repository" class="md-nav__link">
<span class="md-ellipsis">
3. Clone the Repository
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#4-set-up-development-environment" class="md-nav__link">
<span class="md-ellipsis">
4. Set Up Development Environment
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#5-configure-environment" class="md-nav__link">
<span class="md-ellipsis">
5. Configure Environment
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#6-running-tests-on-linux" class="md-nav__link">
<span class="md-ellipsis">
6. Running Tests on Linux
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#common-linux-issues" class="md-nav__link">
<span class="md-ellipsis">
Common Linux Issues
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#macos" class="md-nav__link">
<span class="md-ellipsis">
macOS
</span>
</a>
<nav class="md-nav" aria-label="macOS">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#1-install-homebrew-if-not-installed" class="md-nav__link">
<span class="md-ellipsis">
1. Install Homebrew (if not installed)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#2-install-python-and-git" class="md-nav__link">
<span class="md-ellipsis">
2. Install Python and Git
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#3-install-uv-package-manager_1" class="md-nav__link">
<span class="md-ellipsis">
3. Install UV Package Manager
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#4-clone-the-repository_1" class="md-nav__link">
<span class="md-ellipsis">
4. Clone the Repository
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#5-set-up-development-environment_1" class="md-nav__link">
<span class="md-ellipsis">
5. Set Up Development Environment
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#6-configure-environment_1" class="md-nav__link">
<span class="md-ellipsis">
6. Configure Environment
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#7-running-tests-on-macos" class="md-nav__link">
<span class="md-ellipsis">
7. Running Tests on macOS
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#development-workflow" class="md-nav__link">
<span class="md-ellipsis">
Development Workflow
</span>
</a>
<nav class="md-nav" aria-label="Development Workflow">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#making-changes" class="md-nav__link">
<span class="md-ellipsis">
Making Changes
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#commit-message-format" class="md-nav__link">
<span class="md-ellipsis">
Commit Message Format
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#testing" class="md-nav__link">
<span class="md-ellipsis">
Testing
</span>
</a>
<nav class="md-nav" aria-label="Testing">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#test-structure" class="md-nav__link">
<span class="md-ellipsis">
Test Structure
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#writing-tests" class="md-nav__link">
<span class="md-ellipsis">
Writing Tests
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#running-specific-tests" class="md-nav__link">
<span class="md-ellipsis">
Running Specific Tests
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#coverage-requirements" class="md-nav__link">
<span class="md-ellipsis">
Coverage Requirements
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#code-style" class="md-nav__link">
<span class="md-ellipsis">
Code Style
</span>
</a>
<nav class="md-nav" aria-label="Code Style">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#python-style-guidelines" class="md-nav__link">
<span class="md-ellipsis">
Python Style Guidelines
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#type-hints" class="md-nav__link">
<span class="md-ellipsis">
Type Hints
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#docstrings" class="md-nav__link">
<span class="md-ellipsis">
Docstrings
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#code-organization" class="md-nav__link">
<span class="md-ellipsis">
Code Organization
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#submitting-changes" class="md-nav__link">
<span class="md-ellipsis">
Submitting Changes
</span>
</a>
<nav class="md-nav" aria-label="Submitting Changes">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#before-submitting" class="md-nav__link">
<span class="md-ellipsis">
Before Submitting
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#creating-a-pull-request" class="md-nav__link">
<span class="md-ellipsis">
Creating a Pull Request
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#code-review-process" class="md-nav__link">
<span class="md-ellipsis">
Code Review Process
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#reporting-issues" class="md-nav__link">
<span class="md-ellipsis">
Reporting Issues
</span>
</a>
<nav class="md-nav" aria-label="Reporting Issues">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#before-opening-an-issue" class="md-nav__link">
<span class="md-ellipsis">
Before Opening an Issue
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#bug-report-template" class="md-nav__link">
<span class="md-ellipsis">
Bug Report Template
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#feature-requests" class="md-nav__link">
<span class="md-ellipsis">
Feature Requests
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#getting-help" class="md-nav__link">
<span class="md-ellipsis">
Getting Help
</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-content" data-md-component="content">
<article class="md-content__inner md-typeset">
<a href="https://github.com/prefrontal-systems/cortexgraph/edit/main/docs/CONTRIBUTING.md" title="Edit this page" class="md-content__button md-icon" rel="edit">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M10 20H6V4h7v5h5v3.1l2-2V8l-6-6H6c-1.1 0-2 .9-2 2v16c0 1.1.9 2 2 2h4zm10.2-7c.1 0 .3.1.4.2l1.3 1.3c.2.2.2.6 0 .8l-1 1-2.1-2.1 1-1c.1-.1.2-.2.4-.2m0 3.9L14.1 23H12v-2.1l6.1-6.1z"/></svg>
</a>
<h1 id="contributing-to-cortexgraph">Contributing to CortexGraph<a class="headerlink" href="#contributing-to-cortexgraph" title="Permanent link">¶</a></h1>
<p>Thank you for your interest in contributing to CortexGraph! This guide will help you get started with development on Windows, Linux, or macOS.</p>
<h2 id="table-of-contents">Table of Contents<a class="headerlink" href="#table-of-contents" title="Permanent link">¶</a></h2>
<ul>
<li><a href="#-help-needed-windows--linux-testers">🚨 Help Needed: Windows & Linux Testers</a></li>
<li><a href="#prerequisites">Prerequisites</a></li>
<li><a href="#platform-specific-setup">Platform-Specific Setup</a></li>
<li><a href="#windows">Windows</a></li>
<li><a href="#linux">Linux</a></li>
<li><a href="#macos">macOS</a></li>
<li><a href="#development-workflow">Development Workflow</a></li>
<li><a href="#testing">Testing</a></li>
<li><a href="#code-style">Code Style</a></li>
<li><a href="#submitting-changes">Submitting Changes</a></li>
<li><a href="#reporting-issues">Reporting Issues</a></li>
</ul>
<hr />
<h2 id="help-needed-windows-linux-testers">🚨 Help Needed: Windows & Linux Testers<a class="headerlink" href="#help-needed-windows-linux-testers" title="Permanent link">¶</a></h2>
<p><strong>I develop CortexGraph on macOS and need help testing on Windows and Linux!</strong></p>
<h3 id="why-this-matters">Why This Matters<a class="headerlink" href="#why-this-matters" title="Permanent link">¶</a></h3>
<p>While I've written platform-specific instructions based on best practices, <strong>I can't personally test</strong>:
- Windows installation and setup
- Windows path handling and environment variables
- Linux distributions (Ubuntu, Fedora, Arch, etc.)
- Platform-specific edge cases and bugs</p>
<h3 id="what-i-need-help-with">What I Need Help With<a class="headerlink" href="#what-i-need-help-with" title="Permanent link">¶</a></h3>
<h4 id="high-priority">High Priority 🔥<a class="headerlink" href="#high-priority" title="Permanent link">¶</a></h4>
<ol>
<li><strong>Installation Testing</strong></li>
<li>Does <code>uv tool install</code> work smoothly?</li>
<li>Are the setup instructions clear and accurate?</li>
<li>
<p>Do the paths work correctly (<code>~/.config/cortexgraph/</code> on Linux, <code>C:/Users/.../</code> on Windows)?</p>
</li>
<li>
<p><strong>Running the Server</strong></p>
</li>
<li>Does <code>cortexgraph</code> command work after installation?</li>
<li>Do all 7 CLI commands work (<code>cortexgraph-search</code>, <code>cortexgraph-maintenance</code>, etc.)?</li>
<li>
<p>Can you connect via Claude Desktop or other MCP clients?</p>
</li>
<li>
<p><strong>Testing Suite</strong></p>
</li>
<li>Do all tests pass? (<code>uv run python -m pytest</code>)</li>
<li>Does coverage reporting work?</li>
<li>
<p>Are there any platform-specific test failures?</p>
</li>
<li>
<p><strong>File Operations</strong></p>
</li>
<li>Does JSONL storage work correctly?</li>
<li>Do file paths with spaces or special characters work?</li>
<li>Does the maintenance CLI (<code>cortexgraph-maintenance</code>) work?</li>
</ol>
<h4 id="medium-priority">Medium Priority<a class="headerlink" href="#medium-priority" title="Permanent link">¶</a></h4>
<ol>
<li><strong>Development Workflow</strong></li>
<li>Can you clone and set up for development?</li>
<li>Do <code>ruff</code> and <code>mypy</code> work correctly?</li>
<li>
<p>Can you run tests in your IDE/editor?</p>
</li>
<li>
<p><strong>Edge Cases</strong></p>
</li>
<li>Long file paths (Windows issue)</li>
<li>Non-ASCII characters in paths</li>
<li>Different filesystem types</li>
<li>Permission issues</li>
</ol>
<h3 id="how-to-help">How to Help<a class="headerlink" href="#how-to-help" title="Permanent link">¶</a></h3>
<p><strong>Quick Testing (30 minutes):</strong></p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="c1"># Install and verify</span>
<a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a>uv<span class="w"> </span>tool<span class="w"> </span>install<span class="w"> </span>git+https://github.com/prefrontal-systems/cortexgraph.git
<a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a>cortexgraph<span class="w"> </span>--version
<a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a>
<a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a><span class="c1"># Run basic tests</span>
<a id="__codelineno-0-6" name="__codelineno-0-6" href="#__codelineno-0-6"></a><span class="nb">cd</span><span class="w"> </span><span class="k">$(</span>mktemp<span class="w"> </span>-d<span class="k">)</span>
<a id="__codelineno-0-7" name="__codelineno-0-7" href="#__codelineno-0-7"></a>cortexgraph-maintenance<span class="w"> </span>stats
<a id="__codelineno-0-8" name="__codelineno-0-8" href="#__codelineno-0-8"></a>cortexgraph-search<span class="w"> </span><span class="s2">"test"</span><span class="w"> </span>--verbose
</code></pre></div>
<p>Then report:
- ✅ What worked
- ❌ What failed (with error messages)
- ⚠️ Any warnings or unexpected behavior
- 💡 Suggestions for improving the docs</p>
<p><strong>Full Testing (1-2 hours):</strong></p>
<p>Follow the platform-specific setup guide in this file, then:</p>
<ol>
<li>Install from source</li>
<li>Run the full test suite</li>
<li>Try creating memories and searching</li>
<li>Test consolidation feature</li>
<li>Report your findings</li>
</ol>
<h3 id="where-to-report">Where to Report<a class="headerlink" href="#where-to-report" title="Permanent link">¶</a></h3>
<p><strong><a href="https://github.com/prefrontal-systems/cortexgraph/issues/new">Open an issue</a></strong> with:</p>
<p><div class="highlight"><pre><span></span><code><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a><span class="gs">**Platform:**</span> [Windows 11 / Ubuntu 22.04 / etc.]
<a id="__codelineno-1-2" name="__codelineno-1-2" href="#__codelineno-1-2"></a><span class="gs">**Test Type:**</span> [Quick / Full]
<a id="__codelineno-1-3" name="__codelineno-1-3" href="#__codelineno-1-3"></a>
<a id="__codelineno-1-4" name="__codelineno-1-4" href="#__codelineno-1-4"></a><span class="gs">**What I Tested:**</span>
<a id="__codelineno-1-5" name="__codelineno-1-5" href="#__codelineno-1-5"></a><span class="k">- [ ]</span> Installation
<a id="__codelineno-1-6" name="__codelineno-1-6" href="#__codelineno-1-6"></a><span class="k">- [ ]</span> Running server
<a id="__codelineno-1-7" name="__codelineno-1-7" href="#__codelineno-1-7"></a><span class="k">- [ ]</span> CLI commands
<a id="__codelineno-1-8" name="__codelineno-1-8" href="#__codelineno-1-8"></a><span class="k">- [ ]</span> Test suite
<a id="__codelineno-1-9" name="__codelineno-1-9" href="#__codelineno-1-9"></a><span class="k">- [ ]</span> File operations
<a id="__codelineno-1-10" name="__codelineno-1-10" href="#__codelineno-1-10"></a>
<a id="__codelineno-1-11" name="__codelineno-1-11" href="#__codelineno-1-11"></a><span class="gs">**Results:**</span>
<a id="__codelineno-1-12" name="__codelineno-1-12" href="#__codelineno-1-12"></a>✅ Working: [list what worked]
<a id="__codelineno-1-13" name="__codelineno-1-13" href="#__codelineno-1-13"></a>❌ Failed: [list failures with errors]
<a id="__codelineno-1-14" name="__codelineno-1-14" href="#__codelineno-1-14"></a>⚠️ Issues: [list concerns or warnings]
<a id="__codelineno-1-15" name="__codelineno-1-15" href="#__codelineno-1-15"></a>
<a id="__codelineno-1-16" name="__codelineno-1-16" href="#__codelineno-1-16"></a><span class="gs">**Logs:**</span>
</code></pre></div>
[paste relevant error messages or logs]
<div class="highlight"><pre><span></span><code><a id="__codelineno-2-1" name="__codelineno-2-1" href="#__codelineno-2-1"></a>**Suggestions:**
<a id="__codelineno-2-2" name="__codelineno-2-2" href="#__codelineno-2-2"></a>[any improvements to docs or setup]
</code></pre></div></p>
<h3 id="current-status">Current Status<a class="headerlink" href="#current-status" title="Permanent link">¶</a></h3>
<table>
<thead>
<tr>
<th>Platform</th>
<th>Installation</th>
<th>Tests</th>
<th>CLI Tools</th>
<th>File Ops</th>
<th>Status</th>
</tr>
</thead>
<tbody>
<tr>
<td><strong>macOS</strong></td>
<td>✅ Tested</td>
<td>✅ Passing</td>
<td>✅ Working</td>
<td>✅ Working</td>
<td>Fully tested</td>
</tr>
<tr>
<td><strong>Windows</strong></td>
<td>❓ Untested</td>
<td>❓ Unknown</td>
<td>❓ Unknown</td>
<td>❓ Unknown</td>
<td><strong>Need testers!</strong></td>
</tr>
<tr>
<td><strong>Linux (Ubuntu)</strong></td>
<td>❓ Untested</td>
<td>❓ Unknown</td>
<td>❓ Unknown</td>
<td>❓ Unknown</td>
<td><strong>Need testers!</strong></td>
</tr>
<tr>
<td><strong>Linux (Fedora)</strong></td>
<td>❓ Untested</td>
<td>❓ Unknown</td>
<td>❓ Unknown</td>
<td>❓ Unknown</td>
<td><strong>Need testers!</strong></td>
</tr>
<tr>
<td><strong>Linux (Arch)</strong></td>
<td>❓ Untested</td>
<td>❓ Unknown</td>
<td>❓ Unknown</td>
<td>❓ Unknown</td>
<td><strong>Need testers!</strong></td>
</tr>
</tbody>
</table>
<p><strong>Thank you for helping make CortexGraph work reliably across all platforms!</strong> 🙏</p>
<hr />
<h2 id="prerequisites">Prerequisites<a class="headerlink" href="#prerequisites" title="Permanent link">¶</a></h2>
<p>Before you begin, ensure you have:</p>
<ul>
<li><strong>Python 3.10 or higher</strong></li>
<li><strong>Git</strong></li>
<li><strong>UV package manager</strong> (recommended) or pip</li>
</ul>
<hr />
<h2 id="platform-specific-setup">Platform-Specific Setup<a class="headerlink" href="#platform-specific-setup" title="Permanent link">¶</a></h2>
<h3 id="windows">Windows<a class="headerlink" href="#windows" title="Permanent link">¶</a></h3>
<h4 id="1-install-python">1. Install Python<a class="headerlink" href="#1-install-python" title="Permanent link">¶</a></h4>
<p>Download and install Python from <a href="https://www.python.org/downloads/">python.org</a>:</p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-3-1" name="__codelineno-3-1" href="#__codelineno-3-1"></a><span class="c"># Verify installation</span>
<a id="__codelineno-3-2" name="__codelineno-3-2" href="#__codelineno-3-2"></a><span class="n">python</span> <span class="p">-</span><span class="n">-version</span>
<a id="__codelineno-3-3" name="__codelineno-3-3" href="#__codelineno-3-3"></a><span class="c"># Should show Python 3.10 or higher</span>
</code></pre></div>
<p><strong>Important:</strong> During installation, check "Add Python to PATH"</p>
<h4 id="2-install-git">2. Install Git<a class="headerlink" href="#2-install-git" title="Permanent link">¶</a></h4>
<p>Download and install from <a href="https://git-scm.com/download/win">git-scm.com</a></p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-4-1" name="__codelineno-4-1" href="#__codelineno-4-1"></a><span class="c"># Verify installation</span>
<a id="__codelineno-4-2" name="__codelineno-4-2" href="#__codelineno-4-2"></a><span class="n">git</span> <span class="p">-</span><span class="n">-version</span>
</code></pre></div>
<h4 id="3-install-uv-package-manager">3. Install UV Package Manager<a class="headerlink" href="#3-install-uv-package-manager" title="Permanent link">¶</a></h4>
<div class="highlight"><pre><span></span><code><a id="__codelineno-5-1" name="__codelineno-5-1" href="#__codelineno-5-1"></a><span class="c"># Using PowerShell (recommended)</span>
<a id="__codelineno-5-2" name="__codelineno-5-2" href="#__codelineno-5-2"></a><span class="n">powershell</span> <span class="n">-c</span> <span class="s2">"irm https://astral.sh/uv/install.ps1 | iex"</span>
<a id="__codelineno-5-3" name="__codelineno-5-3" href="#__codelineno-5-3"></a>
<a id="__codelineno-5-4" name="__codelineno-5-4" href="#__codelineno-5-4"></a><span class="c"># Or using pip</span>
<a id="__codelineno-5-5" name="__codelineno-5-5" href="#__codelineno-5-5"></a><span class="n">pip</span> <span class="n">install</span> <span class="n">uv</span>
<a id="__codelineno-5-6" name="__codelineno-5-6" href="#__codelineno-5-6"></a>
<a id="__codelineno-5-7" name="__codelineno-5-7" href="#__codelineno-5-7"></a><span class="c"># Verify installation</span>
<a id="__codelineno-5-8" name="__codelineno-5-8" href="#__codelineno-5-8"></a><span class="n">uv</span> <span class="p">-</span><span class="n">-version</span>
</code></pre></div>
<h4 id="4-clone-the-repository">4. Clone the Repository<a class="headerlink" href="#4-clone-the-repository" title="Permanent link">¶</a></h4>
<div class="highlight"><pre><span></span><code><a id="__codelineno-6-1" name="__codelineno-6-1" href="#__codelineno-6-1"></a><span class="c"># Using Command Prompt or PowerShell</span>
<a id="__codelineno-6-2" name="__codelineno-6-2" href="#__codelineno-6-2"></a><span class="n">git</span> <span class="n">clone</span> <span class="n">https</span><span class="p">://</span><span class="n">github</span><span class="p">.</span><span class="n">com</span><span class="p">/</span><span class="n">prefrontal-systems</span><span class="p">/</span><span class="n">cortexgraph</span><span class="p">.</span><span class="n">git</span>
<a id="__codelineno-6-3" name="__codelineno-6-3" href="#__codelineno-6-3"></a><span class="nb">cd </span><span class="n">cortexgraph</span>
</code></pre></div>
<h4 id="5-set-up-development-environment">5. Set Up Development Environment<a class="headerlink" href="#5-set-up-development-environment" title="Permanent link">¶</a></h4>
<div class="highlight"><pre><span></span><code><a id="__codelineno-7-1" name="__codelineno-7-1" href="#__codelineno-7-1"></a><span class="c"># Install dependencies (including dev dependencies)</span>
<a id="__codelineno-7-2" name="__codelineno-7-2" href="#__codelineno-7-2"></a><span class="n">uv</span> <span class="n">sync</span> <span class="p">-</span><span class="n">-all-extras</span>
<a id="__codelineno-7-3" name="__codelineno-7-3" href="#__codelineno-7-3"></a>
<a id="__codelineno-7-4" name="__codelineno-7-4" href="#__codelineno-7-4"></a><span class="c"># Verify installation</span>
<a id="__codelineno-7-5" name="__codelineno-7-5" href="#__codelineno-7-5"></a><span class="n">uv</span> <span class="n">run</span> <span class="n">python</span> <span class="n">-c</span> <span class="s2">"import cortexgraph; print('CortexGraph installed successfully!')"</span>
</code></pre></div>
<h4 id="6-configure-environment">6. Configure Environment<a class="headerlink" href="#6-configure-environment" title="Permanent link">¶</a></h4>
<div class="highlight"><pre><span></span><code><a id="__codelineno-8-1" name="__codelineno-8-1" href="#__codelineno-8-1"></a><span class="c"># Copy example config</span>
<a id="__codelineno-8-2" name="__codelineno-8-2" href="#__codelineno-8-2"></a><span class="nb">copy </span><span class="p">.</span><span class="n">env</span><span class="p">.</span><span class="n">example</span> <span class="p">.</span><span class="n">env</span>
<a id="__codelineno-8-3" name="__codelineno-8-3" href="#__codelineno-8-3"></a>
<a id="__codelineno-8-4" name="__codelineno-8-4" href="#__codelineno-8-4"></a><span class="c"># Edit .env with your preferred text editor</span>
<a id="__codelineno-8-5" name="__codelineno-8-5" href="#__codelineno-8-5"></a><span class="n">notepad</span> <span class="p">.</span><span class="n">env</span>
</code></pre></div>
<p><strong>Windows-specific config (<code>~/.config/cortexgraph/.env</code> or project <code>.env</code>):</strong></p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-9-1" name="__codelineno-9-1" href="#__codelineno-9-1"></a><span class="c1"># Use Windows paths with forward slashes or escaped backslashes</span>
<a id="__codelineno-9-2" name="__codelineno-9-2" href="#__codelineno-9-2"></a><span class="nv">CORTEXGRAPH_STORAGE_PATH</span><span class="o">=</span>C:/Users/YourUsername/.config/cortexgraph/jsonl
<a id="__codelineno-9-3" name="__codelineno-9-3" href="#__codelineno-9-3"></a><span class="c1"># Or with escaped backslashes</span>
<a id="__codelineno-9-4" name="__codelineno-9-4" href="#__codelineno-9-4"></a><span class="c1"># CORTEXGRAPH_STORAGE_PATH=C:\\Users\\YourUsername\\.config\\cortexgraph\\jsonl</span>
<a id="__codelineno-9-5" name="__codelineno-9-5" href="#__codelineno-9-5"></a>
<a id="__codelineno-9-6" name="__codelineno-9-6" href="#__codelineno-9-6"></a><span class="c1"># Optional: LTM vault path</span>
<a id="__codelineno-9-7" name="__codelineno-9-7" href="#__codelineno-9-7"></a><span class="nv">LTM_VAULT_PATH</span><span class="o">=</span>C:/Users/YourUsername/Documents/Obsidian/Vault
</code></pre></div>
<h4 id="7-running-tests-on-windows">7. Running Tests on Windows<a class="headerlink" href="#7-running-tests-on-windows" title="Permanent link">¶</a></h4>
<div class="highlight"><pre><span></span><code><a id="__codelineno-10-1" name="__codelineno-10-1" href="#__codelineno-10-1"></a><span class="c"># Run all tests</span>
<a id="__codelineno-10-2" name="__codelineno-10-2" href="#__codelineno-10-2"></a><span class="n">uv</span> <span class="n">run</span> <span class="n">python</span> <span class="n">-m</span> <span class="n">pytest</span>
<a id="__codelineno-10-3" name="__codelineno-10-3" href="#__codelineno-10-3"></a>
<a id="__codelineno-10-4" name="__codelineno-10-4" href="#__codelineno-10-4"></a><span class="c"># Run with coverage</span>
<a id="__codelineno-10-5" name="__codelineno-10-5" href="#__codelineno-10-5"></a><span class="n">uv</span> <span class="n">run</span> <span class="n">python</span> <span class="n">-m</span> <span class="n">pytest</span> <span class="p">-</span><span class="n">-cov</span><span class="p">=</span><span class="n">cortexgraph</span> <span class="p">-</span><span class="n">-cov-report</span><span class="p">=</span><span class="n">html</span>
<a id="__codelineno-10-6" name="__codelineno-10-6" href="#__codelineno-10-6"></a>
<a id="__codelineno-10-7" name="__codelineno-10-7" href="#__codelineno-10-7"></a><span class="c"># Open coverage report</span>
<a id="__codelineno-10-8" name="__codelineno-10-8" href="#__codelineno-10-8"></a><span class="nb">start </span><span class="n">htmlcov</span><span class="p">\</span><span class="n">index</span><span class="p">.</span><span class="n">html</span>
<a id="__codelineno-10-9" name="__codelineno-10-9" href="#__codelineno-10-9"></a>
<a id="__codelineno-10-10" name="__codelineno-10-10" href="#__codelineno-10-10"></a><span class="c"># Run specific test file</span>
<a id="__codelineno-10-11" name="__codelineno-10-11" href="#__codelineno-10-11"></a><span class="n">uv</span> <span class="n">run</span> <span class="n">python</span> <span class="n">-m</span> <span class="n">pytest</span> <span class="n">tests</span><span class="p">/</span><span class="n">test_consolidation</span><span class="p">.</span><span class="n">py</span> <span class="n">-v</span>
<a id="__codelineno-10-12" name="__codelineno-10-12" href="#__codelineno-10-12"></a>
<a id="__codelineno-10-13" name="__codelineno-10-13" href="#__codelineno-10-13"></a><span class="c"># Run tests matching a pattern</span>
<a id="__codelineno-10-14" name="__codelineno-10-14" href="#__codelineno-10-14"></a><span class="n">uv</span> <span class="n">run</span> <span class="n">python</span> <span class="n">-m</span> <span class="n">pytest</span> <span class="n">-k</span> <span class="s2">"test_merge"</span> <span class="n">-v</span>
</code></pre></div>
<h4 id="common-windows-issues">Common Windows Issues<a class="headerlink" href="#common-windows-issues" title="Permanent link">¶</a></h4>
<p><strong>Issue: <code>ModuleNotFoundError</code></strong>
<div class="highlight"><pre><span></span><code><a id="__codelineno-11-1" name="__codelineno-11-1" href="#__codelineno-11-1"></a><span class="c"># Ensure you're in the project directory</span>
<a id="__codelineno-11-2" name="__codelineno-11-2" href="#__codelineno-11-2"></a><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">cortexgraph</span>
<a id="__codelineno-11-3" name="__codelineno-11-3" href="#__codelineno-11-3"></a>
<a id="__codelineno-11-4" name="__codelineno-11-4" href="#__codelineno-11-4"></a><span class="c"># Reinstall dependencies</span>
<a id="__codelineno-11-5" name="__codelineno-11-5" href="#__codelineno-11-5"></a><span class="n">uv</span> <span class="n">sync</span> <span class="p">-</span><span class="n">-all-extras</span>
</code></pre></div></p>
<p><strong>Issue: Path too long errors</strong>
<div class="highlight"><pre><span></span><code><a id="__codelineno-12-1" name="__codelineno-12-1" href="#__codelineno-12-1"></a><span class="c"># Enable long paths in Windows 10/11</span>
<a id="__codelineno-12-2" name="__codelineno-12-2" href="#__codelineno-12-2"></a><span class="c"># Run as Administrator:</span>
<a id="__codelineno-12-3" name="__codelineno-12-3" href="#__codelineno-12-3"></a><span class="n">reg</span> <span class="n">add</span> <span class="n">HKLM</span><span class="p">\</span><span class="n">SYSTEM</span><span class="p">\</span><span class="n">CurrentControlSet</span><span class="p">\</span><span class="n">Control</span><span class="p">\</span><span class="n">FileSystem</span> <span class="p">/</span><span class="n">v</span> <span class="n">LongPathsEnabled</span> <span class="p">/</span><span class="n">t</span> <span class="n">REG_DWORD</span> <span class="p">/</span><span class="n">d</span> <span class="n">1</span> <span class="p">/</span><span class="n">f</span>
</code></pre></div></p>
<p><strong>Issue: Permission errors</strong>
<div class="highlight"><pre><span></span><code><a id="__codelineno-13-1" name="__codelineno-13-1" href="#__codelineno-13-1"></a><span class="c"># Run PowerShell as Administrator or use:</span>
<a id="__codelineno-13-2" name="__codelineno-13-2" href="#__codelineno-13-2"></a><span class="nb">Set-ExecutionPolicy</span> <span class="n">-ExecutionPolicy</span> <span class="n">RemoteSigned</span> <span class="n">-Scope</span> <span class="n">CurrentUser</span>
</code></pre></div></p>
<hr />
<h3 id="linux">Linux<a class="headerlink" href="#linux" title="Permanent link">¶</a></h3>
<h4 id="1-install-python_1">1. Install Python<a class="headerlink" href="#1-install-python_1" title="Permanent link">¶</a></h4>
<p><strong>Ubuntu/Debian:</strong>
<div class="highlight"><pre><span></span><code><a id="__codelineno-14-1" name="__codelineno-14-1" href="#__codelineno-14-1"></a>sudo<span class="w"> </span>apt<span class="w"> </span>update
<a id="__codelineno-14-2" name="__codelineno-14-2" href="#__codelineno-14-2"></a>sudo<span class="w"> </span>apt<span class="w"> </span>install<span class="w"> </span>python3.10<span class="w"> </span>python3.10-venv<span class="w"> </span>python3-pip<span class="w"> </span>git
<a id="__codelineno-14-3" name="__codelineno-14-3" href="#__codelineno-14-3"></a>
<a id="__codelineno-14-4" name="__codelineno-14-4" href="#__codelineno-14-4"></a><span class="c1"># Verify installation</span>
<a id="__codelineno-14-5" name="__codelineno-14-5" href="#__codelineno-14-5"></a>python3<span class="w"> </span>--version
</code></pre></div></p>
<p><strong>Fedora/RHEL:</strong>
<div class="highlight"><pre><span></span><code><a id="__codelineno-15-1" name="__codelineno-15-1" href="#__codelineno-15-1"></a>sudo<span class="w"> </span>dnf<span class="w"> </span>install<span class="w"> </span>python3.10<span class="w"> </span>python3-pip<span class="w"> </span>git
<a id="__codelineno-15-2" name="__codelineno-15-2" href="#__codelineno-15-2"></a>
<a id="__codelineno-15-3" name="__codelineno-15-3" href="#__codelineno-15-3"></a><span class="c1"># Verify installation</span>
<a id="__codelineno-15-4" name="__codelineno-15-4" href="#__codelineno-15-4"></a>python3<span class="w"> </span>--version
</code></pre></div></p>
<p><strong>Arch Linux:</strong>
<div class="highlight"><pre><span></span><code><a id="__codelineno-16-1" name="__codelineno-16-1" href="#__codelineno-16-1"></a>sudo<span class="w"> </span>pacman<span class="w"> </span>-S<span class="w"> </span>python<span class="w"> </span>python-pip<span class="w"> </span>git
<a id="__codelineno-16-2" name="__codelineno-16-2" href="#__codelineno-16-2"></a>
<a id="__codelineno-16-3" name="__codelineno-16-3" href="#__codelineno-16-3"></a><span class="c1"># Verify installation</span>
<a id="__codelineno-16-4" name="__codelineno-16-4" href="#__codelineno-16-4"></a>python<span class="w"> </span>--version
</code></pre></div></p>
<h4 id="2-install-uv-package-manager">2. Install UV Package Manager<a class="headerlink" href="#2-install-uv-package-manager" title="Permanent link">¶</a></h4>
<div class="highlight"><pre><span></span><code><a id="__codelineno-17-1" name="__codelineno-17-1" href="#__codelineno-17-1"></a><span class="c1"># Using curl (recommended)</span>
<a id="__codelineno-17-2" name="__codelineno-17-2" href="#__codelineno-17-2"></a>curl<span class="w"> </span>-LsSf<span class="w"> </span>https://astral.sh/uv/install.sh<span class="w"> </span><span class="p">|</span><span class="w"> </span>sh
<a id="__codelineno-17-3" name="__codelineno-17-3" href="#__codelineno-17-3"></a>
<a id="__codelineno-17-4" name="__codelineno-17-4" href="#__codelineno-17-4"></a><span class="c1"># Or using pip</span>
<a id="__codelineno-17-5" name="__codelineno-17-5" href="#__codelineno-17-5"></a>pip<span class="w"> </span>install<span class="w"> </span>uv
<a id="__codelineno-17-6" name="__codelineno-17-6" href="#__codelineno-17-6"></a>
<a id="__codelineno-17-7" name="__codelineno-17-7" href="#__codelineno-17-7"></a><span class="c1"># Add to PATH (if needed)</span>
<a id="__codelineno-17-8" name="__codelineno-17-8" href="#__codelineno-17-8"></a><span class="nb">export</span><span class="w"> </span><span class="nv">PATH</span><span class="o">=</span><span class="s2">"</span><span class="nv">$HOME</span><span class="s2">/.local/bin:</span><span class="nv">$PATH</span><span class="s2">"</span>
<a id="__codelineno-17-9" name="__codelineno-17-9" href="#__codelineno-17-9"></a><span class="nb">echo</span><span class="w"> </span><span class="s1">'export PATH="$HOME/.local/bin:$PATH"'</span><span class="w"> </span>>><span class="w"> </span>~/.bashrc
<a id="__codelineno-17-10" name="__codelineno-17-10" href="#__codelineno-17-10"></a><span class="nb">source</span><span class="w"> </span>~/.bashrc
<a id="__codelineno-17-11" name="__codelineno-17-11" href="#__codelineno-17-11"></a>
<a id="__codelineno-17-12" name="__codelineno-17-12" href="#__codelineno-17-12"></a><span class="c1"># Verify installation</span>
<a id="__codelineno-17-13" name="__codelineno-17-13" href="#__codelineno-17-13"></a>uv<span class="w"> </span>--version
</code></pre></div>
<h4 id="3-clone-the-repository">3. Clone the Repository<a class="headerlink" href="#3-clone-the-repository" title="Permanent link">¶</a></h4>
<div class="highlight"><pre><span></span><code><a id="__codelineno-18-1" name="__codelineno-18-1" href="#__codelineno-18-1"></a>git<span class="w"> </span>clone<span class="w"> </span>https://github.com/prefrontal-systems/cortexgraph.git
<a id="__codelineno-18-2" name="__codelineno-18-2" href="#__codelineno-18-2"></a><span class="nb">cd</span><span class="w"> </span>cortexgraph
</code></pre></div>
<h4 id="4-set-up-development-environment">4. Set Up Development Environment<a class="headerlink" href="#4-set-up-development-environment" title="Permanent link">¶</a></h4>
<div class="highlight"><pre><span></span><code><a id="__codelineno-19-1" name="__codelineno-19-1" href="#__codelineno-19-1"></a><span class="c1"># Install dependencies (including dev dependencies)</span>
<a id="__codelineno-19-2" name="__codelineno-19-2" href="#__codelineno-19-2"></a>uv<span class="w"> </span>sync<span class="w"> </span>--all-extras
<a id="__codelineno-19-3" name="__codelineno-19-3" href="#__codelineno-19-3"></a>
<a id="__codelineno-19-4" name="__codelineno-19-4" href="#__codelineno-19-4"></a><span class="c1"># Verify installation</span>
<a id="__codelineno-19-5" name="__codelineno-19-5" href="#__codelineno-19-5"></a>uv<span class="w"> </span>run<span class="w"> </span>python<span class="w"> </span>-c<span class="w"> </span><span class="s2">"import cortexgraph; print('CortexGraph installed successfully!')"</span>
</code></pre></div>
<h4 id="5-configure-environment">5. Configure Environment<a class="headerlink" href="#5-configure-environment" title="Permanent link">¶</a></h4>
<div class="highlight"><pre><span></span><code><a id="__codelineno-20-1" name="__codelineno-20-1" href="#__codelineno-20-1"></a><span class="c1"># Copy example config</span>
<a id="__codelineno-20-2" name="__codelineno-20-2" href="#__codelineno-20-2"></a>cp<span class="w"> </span>.env.example<span class="w"> </span>.env
<a id="__codelineno-20-3" name="__codelineno-20-3" href="#__codelineno-20-3"></a>
<a id="__codelineno-20-4" name="__codelineno-20-4" href="#__codelineno-20-4"></a><span class="c1"># Edit with your preferred editor</span>
<a id="__codelineno-20-5" name="__codelineno-20-5" href="#__codelineno-20-5"></a>nano<span class="w"> </span>.env
<a id="__codelineno-20-6" name="__codelineno-20-6" href="#__codelineno-20-6"></a><span class="c1"># or</span>
<a id="__codelineno-20-7" name="__codelineno-20-7" href="#__codelineno-20-7"></a>vim<span class="w"> </span>.env
<a id="__codelineno-20-8" name="__codelineno-20-8" href="#__codelineno-20-8"></a><span class="c1"># or</span>
<a id="__codelineno-20-9" name="__codelineno-20-9" href="#__codelineno-20-9"></a>code<span class="w"> </span>.env<span class="w"> </span><span class="c1"># VS Code</span>
</code></pre></div>
<p><strong>Linux-specific config (<code>~/.config/cortexgraph/.env</code> or project <code>.env</code>):</strong></p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-21-1" name="__codelineno-21-1" href="#__codelineno-21-1"></a><span class="c1"># Standard XDG paths</span>
<a id="__codelineno-21-2" name="__codelineno-21-2" href="#__codelineno-21-2"></a><span class="nv">CORTEXGRAPH_STORAGE_PATH</span><span class="o">=</span>~/.config/cortexgraph/jsonl
<a id="__codelineno-21-3" name="__codelineno-21-3" href="#__codelineno-21-3"></a>
<a id="__codelineno-21-4" name="__codelineno-21-4" href="#__codelineno-21-4"></a><span class="c1"># Optional: LTM vault path</span>
<a id="__codelineno-21-5" name="__codelineno-21-5" href="#__codelineno-21-5"></a><span class="nv">LTM_VAULT_PATH</span><span class="o">=</span>~/Documents/Obsidian/Vault
<a id="__codelineno-21-6" name="__codelineno-21-6" href="#__codelineno-21-6"></a>
<a id="__codelineno-21-7" name="__codelineno-21-7" href="#__codelineno-21-7"></a><span class="c1"># Decay parameters</span>
<a id="__codelineno-21-8" name="__codelineno-21-8" href="#__codelineno-21-8"></a><span class="nv">CORTEXGRAPH_DECAY_MODEL</span><span class="o">=</span>power_law
<a id="__codelineno-21-9" name="__codelineno-21-9" href="#__codelineno-21-9"></a><span class="nv">CORTEXGRAPH_PL_ALPHA</span><span class="o">=</span><span class="m">1</span>.1
<a id="__codelineno-21-10" name="__codelineno-21-10" href="#__codelineno-21-10"></a><span class="nv">CORTEXGRAPH_PL_HALFLIFE_DAYS</span><span class="o">=</span><span class="m">3</span>.0
<a id="__codelineno-21-11" name="__codelineno-21-11" href="#__codelineno-21-11"></a><span class="nv">CORTEXGRAPH_DECAY_BETA</span><span class="o">=</span><span class="m">0</span>.6
<a id="__codelineno-21-12" name="__codelineno-21-12" href="#__codelineno-21-12"></a>
<a id="__codelineno-21-13" name="__codelineno-21-13" href="#__codelineno-21-13"></a><span class="c1"># Thresholds</span>
<a id="__codelineno-21-14" name="__codelineno-21-14" href="#__codelineno-21-14"></a><span class="nv">CORTEXGRAPH_FORGET_THRESHOLD</span><span class="o">=</span><span class="m">0</span>.05
<a id="__codelineno-21-15" name="__codelineno-21-15" href="#__codelineno-21-15"></a><span class="nv">CORTEXGRAPH_PROMOTE_THRESHOLD</span><span class="o">=</span><span class="m">0</span>.65
</code></pre></div>
<h4 id="6-running-tests-on-linux">6. Running Tests on Linux<a class="headerlink" href="#6-running-tests-on-linux" title="Permanent link">¶</a></h4>
<div class="highlight"><pre><span></span><code><a id="__codelineno-22-1" name="__codelineno-22-1" href="#__codelineno-22-1"></a><span class="c1"># Run all tests</span>
<a id="__codelineno-22-2" name="__codelineno-22-2" href="#__codelineno-22-2"></a>uv<span class="w"> </span>run<span class="w"> </span>python<span class="w"> </span>-m<span class="w"> </span>pytest
<a id="__codelineno-22-3" name="__codelineno-22-3" href="#__codelineno-22-3"></a>
<a id="__codelineno-22-4" name="__codelineno-22-4" href="#__codelineno-22-4"></a><span class="c1"># Run with coverage</span>
<a id="__codelineno-22-5" name="__codelineno-22-5" href="#__codelineno-22-5"></a>uv<span class="w"> </span>run<span class="w"> </span>python<span class="w"> </span>-m<span class="w"> </span>pytest<span class="w"> </span>--cov<span class="o">=</span>cortexgraph<span class="w"> </span>--cov-report<span class="o">=</span>html
<a id="__codelineno-22-6" name="__codelineno-22-6" href="#__codelineno-22-6"></a>
<a id="__codelineno-22-7" name="__codelineno-22-7" href="#__codelineno-22-7"></a><span class="c1"># Open coverage report</span>
<a id="__codelineno-22-8" name="__codelineno-22-8" href="#__codelineno-22-8"></a>xdg-open<span class="w"> </span>htmlcov/index.html
<a id="__codelineno-22-9" name="__codelineno-22-9" href="#__codelineno-22-9"></a>
<a id="__codelineno-22-10" name="__codelineno-22-10" href="#__codelineno-22-10"></a><span class="c1"># Run specific test file</span>
<a id="__codelineno-22-11" name="__codelineno-22-11" href="#__codelineno-22-11"></a>uv<span class="w"> </span>run<span class="w"> </span>python<span class="w"> </span>-m<span class="w"> </span>pytest<span class="w"> </span>tests/test_consolidation.py<span class="w"> </span>-v
<a id="__codelineno-22-12" name="__codelineno-22-12" href="#__codelineno-22-12"></a>
<a id="__codelineno-22-13" name="__codelineno-22-13" href="#__codelineno-22-13"></a><span class="c1"># Run tests matching a pattern</span>
<a id="__codelineno-22-14" name="__codelineno-22-14" href="#__codelineno-22-14"></a>uv<span class="w"> </span>run<span class="w"> </span>python<span class="w"> </span>-m<span class="w"> </span>pytest<span class="w"> </span>-k<span class="w"> </span><span class="s2">"test_merge"</span><span class="w"> </span>-v
<a id="__codelineno-22-15" name="__codelineno-22-15" href="#__codelineno-22-15"></a>
<a id="__codelineno-22-16" name="__codelineno-22-16" href="#__codelineno-22-16"></a><span class="c1"># Run tests in parallel (faster for large test suites)</span>
<a id="__codelineno-22-17" name="__codelineno-22-17" href="#__codelineno-22-17"></a>uv<span class="w"> </span>run<span class="w"> </span>python<span class="w"> </span>-m<span class="w"> </span>pytest<span class="w"> </span>-n<span class="w"> </span>auto
</code></pre></div>
<h4 id="common-linux-issues">Common Linux Issues<a class="headerlink" href="#common-linux-issues" title="Permanent link">¶</a></h4>
<p><strong>Issue: Permission denied</strong>
<div class="highlight"><pre><span></span><code><a id="__codelineno-23-1" name="__codelineno-23-1" href="#__codelineno-23-1"></a><span class="c1"># Make sure scripts are executable</span>
<a id="__codelineno-23-2" name="__codelineno-23-2" href="#__codelineno-23-2"></a>chmod<span class="w"> </span>+x<span class="w"> </span>.venv/bin/*
<a id="__codelineno-23-3" name="__codelineno-23-3" href="#__codelineno-23-3"></a>
<a id="__codelineno-23-4" name="__codelineno-23-4" href="#__codelineno-23-4"></a><span class="c1"># Or use uv run instead</span>
<a id="__codelineno-23-5" name="__codelineno-23-5" href="#__codelineno-23-5"></a>uv<span class="w"> </span>run<span class="w"> </span>cortexgraph<span class="w"> </span>--help
</code></pre></div></p>
<p><strong>Issue: <code>ModuleNotFoundError</code></strong>
<div class="highlight"><pre><span></span><code><a id="__codelineno-24-1" name="__codelineno-24-1" href="#__codelineno-24-1"></a><span class="c1"># Ensure you're in the project directory</span>
<a id="__codelineno-24-2" name="__codelineno-24-2" href="#__codelineno-24-2"></a><span class="nb">cd</span><span class="w"> </span>/path/to/cortexgraph
<a id="__codelineno-24-3" name="__codelineno-24-3" href="#__codelineno-24-3"></a>
<a id="__codelineno-24-4" name="__codelineno-24-4" href="#__codelineno-24-4"></a><span class="c1"># Reinstall dependencies</span>
<a id="__codelineno-24-5" name="__codelineno-24-5" href="#__codelineno-24-5"></a>uv<span class="w"> </span>sync<span class="w"> </span>--all-extras
</code></pre></div></p>
<p><strong>Issue: Can't find Python 3.10+</strong>
<div class="highlight"><pre><span></span><code><a id="__codelineno-25-1" name="__codelineno-25-1" href="#__codelineno-25-1"></a><span class="c1"># Ubuntu: Use deadsnakes PPA</span>
<a id="__codelineno-25-2" name="__codelineno-25-2" href="#__codelineno-25-2"></a>sudo<span class="w"> </span>add-apt-repository<span class="w"> </span>ppa:deadsnakes/ppa
<a id="__codelineno-25-3" name="__codelineno-25-3" href="#__codelineno-25-3"></a>sudo<span class="w"> </span>apt<span class="w"> </span>update
<a id="__codelineno-25-4" name="__codelineno-25-4" href="#__codelineno-25-4"></a>sudo<span class="w"> </span>apt<span class="w"> </span>install<span class="w"> </span>python3.10<span class="w"> </span>python3.10-venv
<a id="__codelineno-25-5" name="__codelineno-25-5" href="#__codelineno-25-5"></a>
<a id="__codelineno-25-6" name="__codelineno-25-6" href="#__codelineno-25-6"></a><span class="c1"># Or use pyenv</span>
<a id="__codelineno-25-7" name="__codelineno-25-7" href="#__codelineno-25-7"></a>curl<span class="w"> </span>https://pyenv.run<span class="w"> </span><span class="p">|</span><span class="w"> </span>bash
<a id="__codelineno-25-8" name="__codelineno-25-8" href="#__codelineno-25-8"></a>pyenv<span class="w"> </span>install<span class="w"> </span><span class="m">3</span>.10.13
<a id="__codelineno-25-9" name="__codelineno-25-9" href="#__codelineno-25-9"></a>pyenv<span class="w"> </span><span class="nb">local</span><span class="w"> </span><span class="m">3</span>.10.13
</code></pre></div></p>
<hr />
<h3 id="macos">macOS<a class="headerlink" href="#macos" title="Permanent link">¶</a></h3>
<h4 id="1-install-homebrew-if-not-installed">1. Install Homebrew (if not installed)<a class="headerlink" href="#1-install-homebrew-if-not-installed" title="Permanent link">¶</a></h4>
<div class="highlight"><pre><span></span><code><a id="__codelineno-26-1" name="__codelineno-26-1" href="#__codelineno-26-1"></a>/bin/bash<span class="w"> </span>-c<span class="w"> </span><span class="s2">"</span><span class="k">$(</span>curl<span class="w"> </span>-fsSL<span class="w"> </span>https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh<span class="k">)</span><span class="s2">"</span>
</code></pre></div>
<h4 id="2-install-python-and-git">2. Install Python and Git<a class="headerlink" href="#2-install-python-and-git" title="Permanent link">¶</a></h4>
<div class="highlight"><pre><span></span><code><a id="__codelineno-27-1" name="__codelineno-27-1" href="#__codelineno-27-1"></a>brew<span class="w"> </span>install<span class="w"> </span>python@3.10<span class="w"> </span>git
<a id="__codelineno-27-2" name="__codelineno-27-2" href="#__codelineno-27-2"></a>
<a id="__codelineno-27-3" name="__codelineno-27-3" href="#__codelineno-27-3"></a><span class="c1"># Verify installation</span>
<a id="__codelineno-27-4" name="__codelineno-27-4" href="#__codelineno-27-4"></a>python3<span class="w"> </span>--version
<a id="__codelineno-27-5" name="__codelineno-27-5" href="#__codelineno-27-5"></a>git<span class="w"> </span>--version
</code></pre></div>
<h4 id="3-install-uv-package-manager_1">3. Install UV Package Manager<a class="headerlink" href="#3-install-uv-package-manager_1" title="Permanent link">¶</a></h4>
<div class="highlight"><pre><span></span><code><a id="__codelineno-28-1" name="__codelineno-28-1" href="#__codelineno-28-1"></a><span class="c1"># Using curl (recommended)</span>
<a id="__codelineno-28-2" name="__codelineno-28-2" href="#__codelineno-28-2"></a>curl<span class="w"> </span>-LsSf<span class="w"> </span>https://astral.sh/uv/install.sh<span class="w"> </span><span class="p">|</span><span class="w"> </span>sh
<a id="__codelineno-28-3" name="__codelineno-28-3" href="#__codelineno-28-3"></a>
<a id="__codelineno-28-4" name="__codelineno-28-4" href="#__codelineno-28-4"></a><span class="c1"># Or using Homebrew</span>
<a id="__codelineno-28-5" name="__codelineno-28-5" href="#__codelineno-28-5"></a>brew<span class="w"> </span>install<span class="w"> </span>uv
<a id="__codelineno-28-6" name="__codelineno-28-6" href="#__codelineno-28-6"></a>
<a id="__codelineno-28-7" name="__codelineno-28-7" href="#__codelineno-28-7"></a><span class="c1"># Verify installation</span>
<a id="__codelineno-28-8" name="__codelineno-28-8" href="#__codelineno-28-8"></a>uv<span class="w"> </span>--version
</code></pre></div>
<h4 id="4-clone-the-repository_1">4. Clone the Repository<a class="headerlink" href="#4-clone-the-repository_1" title="Permanent link">¶</a></h4>
<div class="highlight"><pre><span></span><code><a id="__codelineno-29-1" name="__codelineno-29-1" href="#__codelineno-29-1"></a>git<span class="w"> </span>clone<span class="w"> </span>https://github.com/prefrontal-systems/cortexgraph.git
<a id="__codelineno-29-2" name="__codelineno-29-2" href="#__codelineno-29-2"></a><span class="nb">cd</span><span class="w"> </span>cortexgraph
</code></pre></div>
<h4 id="5-set-up-development-environment_1">5. Set Up Development Environment<a class="headerlink" href="#5-set-up-development-environment_1" title="Permanent link">¶</a></h4>
<div class="highlight"><pre><span></span><code><a id="__codelineno-30-1" name="__codelineno-30-1" href="#__codelineno-30-1"></a><span class="c1"># Install dependencies (including dev dependencies)</span>
<a id="__codelineno-30-2" name="__codelineno-30-2" href="#__codelineno-30-2"></a>uv<span class="w"> </span>sync<span class="w"> </span>--all-extras
<a id="__codelineno-30-3" name="__codelineno-30-3" href="#__codelineno-30-3"></a>
<a id="__codelineno-30-4" name="__codelineno-30-4" href="#__codelineno-30-4"></a><span class="c1"># Verify installation</span>
<a id="__codelineno-30-5" name="__codelineno-30-5" href="#__codelineno-30-5"></a>uv<span class="w"> </span>run<span class="w"> </span>python<span class="w"> </span>-c<span class="w"> </span><span class="s2">"import cortexgraph; print('CortexGraph installed successfully!')"</span>
</code></pre></div>
<h4 id="6-configure-environment_1">6. Configure Environment<a class="headerlink" href="#6-configure-environment_1" title="Permanent link">¶</a></h4>
<div class="highlight"><pre><span></span><code><a id="__codelineno-31-1" name="__codelineno-31-1" href="#__codelineno-31-1"></a><span class="c1"># Copy example config</span>
<a id="__codelineno-31-2" name="__codelineno-31-2" href="#__codelineno-31-2"></a>cp<span class="w"> </span>.env.example<span class="w"> </span>.env
<a id="__codelineno-31-3" name="__codelineno-31-3" href="#__codelineno-31-3"></a>
<a id="__codelineno-31-4" name="__codelineno-31-4" href="#__codelineno-31-4"></a><span class="c1"># Edit with your preferred editor</span>
<a id="__codelineno-31-5" name="__codelineno-31-5" href="#__codelineno-31-5"></a>nano<span class="w"> </span>.env
<a id="__codelineno-31-6" name="__codelineno-31-6" href="#__codelineno-31-6"></a><span class="c1"># or</span>
<a id="__codelineno-31-7" name="__codelineno-31-7" href="#__codelineno-31-7"></a>open<span class="w"> </span>-e<span class="w"> </span>.env<span class="w"> </span><span class="c1"># TextEdit</span>
</code></pre></div>
<p><strong>macOS-specific config (<code>~/.config/cortexgraph/.env</code> or project <code>.env</code>):</strong></p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-32-1" name="__codelineno-32-1" href="#__codelineno-32-1"></a><span class="c1"># Standard macOS paths</span>
<a id="__codelineno-32-2" name="__codelineno-32-2" href="#__codelineno-32-2"></a><span class="nv">CORTEXGRAPH_STORAGE_PATH</span><span class="o">=</span>~/.config/cortexgraph/jsonl
<a id="__codelineno-32-3" name="__codelineno-32-3" href="#__codelineno-32-3"></a>
<a id="__codelineno-32-4" name="__codelineno-32-4" href="#__codelineno-32-4"></a><span class="c1"># Optional: LTM vault path</span>
<a id="__codelineno-32-5" name="__codelineno-32-5" href="#__codelineno-32-5"></a><span class="nv">LTM_VAULT_PATH</span><span class="o">=</span>~/Documents/Obsidian/Vault
</code></pre></div>
<h4 id="7-running-tests-on-macos">7. Running Tests on macOS<a class="headerlink" href="#7-running-tests-on-macos" title="Permanent link">¶</a></h4>
<div class="highlight"><pre><span></span><code><a id="__codelineno-33-1" name="__codelineno-33-1" href="#__codelineno-33-1"></a><span class="c1"># Run all tests</span>
<a id="__codelineno-33-2" name="__codelineno-33-2" href="#__codelineno-33-2"></a>uv<span class="w"> </span>run<span class="w"> </span>python<span class="w"> </span>-m<span class="w"> </span>pytest
<a id="__codelineno-33-3" name="__codelineno-33-3" href="#__codelineno-33-3"></a>
<a id="__codelineno-33-4" name="__codelineno-33-4" href="#__codelineno-33-4"></a><span class="c1"># Run with coverage</span>
<a id="__codelineno-33-5" name="__codelineno-33-5" href="#__codelineno-33-5"></a>uv<span class="w"> </span>run<span class="w"> </span>python<span class="w"> </span>-m<span class="w"> </span>pytest<span class="w"> </span>--cov<span class="o">=</span>cortexgraph<span class="w"> </span>--cov-report<span class="o">=</span>html
<a id="__codelineno-33-6" name="__codelineno-33-6" href="#__codelineno-33-6"></a>
<a id="__codelineno-33-7" name="__codelineno-33-7" href="#__codelineno-33-7"></a><span class="c1"># Open coverage report</span>
<a id="__codelineno-33-8" name="__codelineno-33-8" href="#__codelineno-33-8"></a>open<span class="w"> </span>htmlcov/index.html
<a id="__codelineno-33-9" name="__codelineno-33-9" href="#__codelineno-33-9"></a>
<a id="__codelineno-33-10" name="__codelineno-33-10" href="#__codelineno-33-10"></a><span class="c1"># Run specific test file</span>
<a id="__codelineno-33-11" name="__codelineno-33-11" href="#__codelineno-33-11"></a>uv<span class="w"> </span>run<span class="w"> </span>python<span class="w"> </span>-m<span class="w"> </span>pytest<span class="w"> </span>tests/test_consolidation.py<span class="w"> </span>-v
</code></pre></div>
<hr />
<h2 id="development-workflow">Development Workflow<a class="headerlink" href="#development-workflow" title="Permanent link">¶</a></h2>
<h3 id="making-changes">Making Changes<a class="headerlink" href="#making-changes" title="Permanent link">¶</a></h3>
<ol>
<li><strong>Create a new branch:</strong></li>
</ol>
<div class="highlight"><pre><span></span><code><a id="__codelineno-34-1" name="__codelineno-34-1" href="#__codelineno-34-1"></a>git<span class="w"> </span>checkout<span class="w"> </span>-b<span class="w"> </span>feature/your-feature-name
<a id="__codelineno-34-2" name="__codelineno-34-2" href="#__codelineno-34-2"></a><span class="c1"># or</span>
<a id="__codelineno-34-3" name="__codelineno-34-3" href="#__codelineno-34-3"></a>git<span class="w"> </span>checkout<span class="w"> </span>-b<span class="w"> </span>fix/bug-description
</code></pre></div>
<ol>
<li>
<p><strong>Make your changes</strong> following the code style guidelines below</p>
</li>
<li>
<p><strong>Run tests</strong> to ensure nothing broke:</p>
</li>
</ol>
<div class="highlight"><pre><span></span><code><a id="__codelineno-35-1" name="__codelineno-35-1" href="#__codelineno-35-1"></a><span class="c1"># All tests</span>
<a id="__codelineno-35-2" name="__codelineno-35-2" href="#__codelineno-35-2"></a>uv<span class="w"> </span>run<span class="w"> </span>python<span class="w"> </span>-m<span class="w"> </span>pytest
<a id="__codelineno-35-3" name="__codelineno-35-3" href="#__codelineno-35-3"></a>
<a id="__codelineno-35-4" name="__codelineno-35-4" href="#__codelineno-35-4"></a><span class="c1"># With coverage</span>
<a id="__codelineno-35-5" name="__codelineno-35-5" href="#__codelineno-35-5"></a>uv<span class="w"> </span>run<span class="w"> </span>python<span class="w"> </span>-m<span class="w"> </span>pytest<span class="w"> </span>--cov<span class="o">=</span>cortexgraph
</code></pre></div>
<ol>
<li><strong>Run linters:</strong></li>
</ol>
<div class="highlight"><pre><span></span><code><a id="__codelineno-36-1" name="__codelineno-36-1" href="#__codelineno-36-1"></a><span class="c1"># Check code style</span>
<a id="__codelineno-36-2" name="__codelineno-36-2" href="#__codelineno-36-2"></a>uv<span class="w"> </span>run<span class="w"> </span>ruff<span class="w"> </span>check<span class="w"> </span>src/cortexgraph<span class="w"> </span>tests
<a id="__codelineno-36-3" name="__codelineno-36-3" href="#__codelineno-36-3"></a>
<a id="__codelineno-36-4" name="__codelineno-36-4" href="#__codelineno-36-4"></a><span class="c1"># Format code</span>
<a id="__codelineno-36-5" name="__codelineno-36-5" href="#__codelineno-36-5"></a>uv<span class="w"> </span>run<span class="w"> </span>ruff<span class="w"> </span>format<span class="w"> </span>src/cortexgraph<span class="w"> </span>tests
<a id="__codelineno-36-6" name="__codelineno-36-6" href="#__codelineno-36-6"></a>
<a id="__codelineno-36-7" name="__codelineno-36-7" href="#__codelineno-36-7"></a><span class="c1"># Type checking</span>
<a id="__codelineno-36-8" name="__codelineno-36-8" href="#__codelineno-36-8"></a>uv<span class="w"> </span>run<span class="w"> </span>mypy<span class="w"> </span>src/cortexgraph
</code></pre></div>
<ol>
<li><strong>Commit your changes:</strong></li>
</ol>
<div class="highlight"><pre><span></span><code><a id="__codelineno-37-1" name="__codelineno-37-1" href="#__codelineno-37-1"></a>git<span class="w"> </span>add<span class="w"> </span>.
<a id="__codelineno-37-2" name="__codelineno-37-2" href="#__codelineno-37-2"></a>git<span class="w"> </span>commit<span class="w"> </span>-m<span class="w"> </span><span class="s2">"feat: add new feature"</span>
<a id="__codelineno-37-3" name="__codelineno-37-3" href="#__codelineno-37-3"></a><span class="c1"># or</span>
<a id="__codelineno-37-4" name="__codelineno-37-4" href="#__codelineno-37-4"></a>git<span class="w"> </span>commit<span class="w"> </span>-m<span class="w"> </span><span class="s2">"fix: resolve bug in consolidation"</span>
</code></pre></div>
<h3 id="commit-message-format">Commit Message Format<a class="headerlink" href="#commit-message-format" title="Permanent link">¶</a></h3>
<p>Use conventional commits:</p>
<ul>
<li><code>feat:</code> - New feature</li>
<li><code>fix:</code> - Bug fix</li>
<li><code>docs:</code> - Documentation changes</li>
<li><code>test:</code> - Adding or updating tests</li>
<li><code>refactor:</code> - Code refactoring</li>
<li><code>chore:</code> - Maintenance tasks</li>
<li><code>perf:</code> - Performance improvements</li>
</ul>
<p><strong>Examples:</strong>
<div class="highlight"><pre><span></span><code><a id="__codelineno-38-1" name="__codelineno-38-1" href="#__codelineno-38-1"></a>feat: add spaced repetition scheduling
<a id="__codelineno-38-2" name="__codelineno-38-2" href="#__codelineno-38-2"></a>fix: handle empty cluster in consolidation
<a id="__codelineno-38-3" name="__codelineno-38-3" href="#__codelineno-38-3"></a>docs: update installation guide for Windows
<a id="__codelineno-38-4" name="__codelineno-38-4" href="#__codelineno-38-4"></a>test: add tests for decay calculation edge cases
</code></pre></div></p>
<hr />
<h2 id="testing">Testing<a class="headerlink" href="#testing" title="Permanent link">¶</a></h2>
<h3 id="test-structure">Test Structure<a class="headerlink" href="#test-structure" title="Permanent link">¶</a></h3>
<p>Tests are organized in the <code>tests/</code> directory:</p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-39-1" name="__codelineno-39-1" href="#__codelineno-39-1"></a>tests/
<a id="__codelineno-39-2" name="__codelineno-39-2" href="#__codelineno-39-2"></a>├── test_consolidation.py # Consolidation logic tests
<a id="__codelineno-39-3" name="__codelineno-39-3" href="#__codelineno-39-3"></a>├── test_decay.py # Decay algorithm tests
<a id="__codelineno-39-4" name="__codelineno-39-4" href="#__codelineno-39-4"></a>├── test_decay_models.py # Decay model tests
<a id="__codelineno-39-5" name="__codelineno-39-5" href="#__codelineno-39-5"></a>├── test_ltm_index.py # LTM index tests
<a id="__codelineno-39-6" name="__codelineno-39-6" href="#__codelineno-39-6"></a>├── test_search_unified.py # Unified search tests
<a id="__codelineno-39-7" name="__codelineno-39-7" href="#__codelineno-39-7"></a>└── test_storage.py # Storage layer tests
</code></pre></div>
<h3 id="writing-tests">Writing Tests<a class="headerlink" href="#writing-tests" title="Permanent link">¶</a></h3>
<p>Follow these guidelines when writing tests:</p>
<ol>
<li>
<p><strong>Use descriptive names:</strong>
<div class="highlight"><pre><span></span><code><a id="__codelineno-40-1" name="__codelineno-40-1" href="#__codelineno-40-1"></a><span class="k">def</span><span class="w"> </span><span class="nf">test_merge_content_preserves_unique_information</span><span class="p">():</span>
<a id="__codelineno-40-2" name="__codelineno-40-2" href="#__codelineno-40-2"></a><span class="w"> </span><span class="sd">"""Test that content merging keeps unique info from all memories."""</span>
<a id="__codelineno-40-3" name="__codelineno-40-3" href="#__codelineno-40-3"></a> <span class="c1"># Test implementation</span>
</code></pre></div></p>
</li>
<li>
<p><strong>Use fixtures for common setup:</strong>
<div class="highlight"><pre><span></span><code><a id="__codelineno-41-1" name="__codelineno-41-1" href="#__codelineno-41-1"></a><span class="nd">@pytest</span><span class="o">.</span><span class="n">fixture</span>
<a id="__codelineno-41-2" name="__codelineno-41-2" href="#__codelineno-41-2"></a><span class="k">def</span><span class="w"> </span><span class="nf">sample_memories</span><span class="p">():</span>
<a id="__codelineno-41-3" name="__codelineno-41-3" href="#__codelineno-41-3"></a><span class="w"> </span><span class="sd">"""Create sample memories for testing."""</span>
<a id="__codelineno-41-4" name="__codelineno-41-4" href="#__codelineno-41-4"></a> <span class="k">return</span> <span class="p">[</span>
<a id="__codelineno-41-5" name="__codelineno-41-5" href="#__codelineno-41-5"></a> <span class="n">Memory</span><span class="p">(</span><span class="nb">id</span><span class="o">=</span><span class="s2">"mem-1"</span><span class="p">,</span> <span class="n">content</span><span class="o">=</span><span class="s2">"Test content 1"</span><span class="p">),</span>
<a id="__codelineno-41-6" name="__codelineno-41-6" href="#__codelineno-41-6"></a> <span class="n">Memory</span><span class="p">(</span><span class="nb">id</span><span class="o">=</span><span class="s2">"mem-2"</span><span class="p">,</span> <span class="n">content</span><span class="o">=</span><span class="s2">"Test content 2"</span><span class="p">),</span>
<a id="__codelineno-41-7" name="__codelineno-41-7" href="#__codelineno-41-7"></a> <span class="p">]</span>
<a id="__codelineno-41-8" name="__codelineno-41-8" href="#__codelineno-41-8"></a>
<a id="__codelineno-41-9" name="__codelineno-41-9" href="#__codelineno-41-9"></a><span class="k">def</span><span class="w"> </span><span class="nf">test_something</span><span class="p">(</span><span class="n">sample_memories</span><span class="p">):</span>
<a id="__codelineno-41-10" name="__codelineno-41-10" href="#__codelineno-41-10"></a> <span class="c1"># Use the fixture</span>
<a id="__codelineno-41-11" name="__codelineno-41-11" href="#__codelineno-41-11"></a> <span class="k">assert</span> <span class="nb">len</span><span class="p">(</span><span class="n">sample_memories</span><span class="p">)</span> <span class="o">==</span> <span class="mi">2</span>
</code></pre></div></p>
</li>
<li>
<p><strong>Test edge cases:</strong>
<div class="highlight"><pre><span></span><code><a id="__codelineno-42-1" name="__codelineno-42-1" href="#__codelineno-42-1"></a><span class="k">def</span><span class="w"> </span><span class="nf">test_merge_content_empty</span><span class="p">():</span>
<a id="__codelineno-42-2" name="__codelineno-42-2" href="#__codelineno-42-2"></a><span class="w"> </span><span class="sd">"""Test merging with empty list."""</span>
<a id="__codelineno-42-3" name="__codelineno-42-3" href="#__codelineno-42-3"></a> <span class="n">result</span> <span class="o">=</span> <span class="n">merge_content_smart</span><span class="p">([])</span>
<a id="__codelineno-42-4" name="__codelineno-42-4" href="#__codelineno-42-4"></a> <span class="k">assert</span> <span class="n">result</span> <span class="o">==</span> <span class="s2">""</span>
<a id="__codelineno-42-5" name="__codelineno-42-5" href="#__codelineno-42-5"></a>
<a id="__codelineno-42-6" name="__codelineno-42-6" href="#__codelineno-42-6"></a><span class="k">def</span><span class="w"> </span><span class="nf">test_merge_content_single</span><span class="p">():</span>
<a id="__codelineno-42-7" name="__codelineno-42-7" href="#__codelineno-42-7"></a><span class="w"> </span><span class="sd">"""Test merging with single memory."""</span>
<a id="__codelineno-42-8" name="__codelineno-42-8" href="#__codelineno-42-8"></a> <span class="n">memories</span> <span class="o">=</span> <span class="p">[</span><span class="n">Memory</span><span class="p">(</span><span class="nb">id</span><span class="o">=</span><span class="s2">"1"</span><span class="p">,</span> <span class="n">content</span><span class="o">=</span><span class="s2">"Single"</span><span class="p">)]</span>
<a id="__codelineno-42-9" name="__codelineno-42-9" href="#__codelineno-42-9"></a> <span class="n">result</span> <span class="o">=</span> <span class="n">merge_content_smart</span><span class="p">(</span><span class="n">memories</span><span class="p">)</span>
<a id="__codelineno-42-10" name="__codelineno-42-10" href="#__codelineno-42-10"></a> <span class="k">assert</span> <span class="n">result</span> <span class="o">==</span> <span class="s2">"Single"</span>
</code></pre></div></p>
</li>
<li>
<p><strong>Use parametrize for multiple cases:</strong>
<div class="highlight"><pre><span></span><code><a id="__codelineno-43-1" name="__codelineno-43-1" href="#__codelineno-43-1"></a><span class="nd">@pytest</span><span class="o">.</span><span class="n">mark</span><span class="o">.</span><span class="n">parametrize</span><span class="p">(</span><span class="s2">"use_count,expected"</span><span class="p">,</span> <span class="p">[</span>
<a id="__codelineno-43-2" name="__codelineno-43-2" href="#__codelineno-43-2"></a> <span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="mf">1.0</span><span class="p">),</span>
<a id="__codelineno-43-3" name="__codelineno-43-3" href="#__codelineno-43-3"></a> <span class="p">(</span><span class="mi">5</span><span class="p">,</span> <span class="mf">2.6</span><span class="p">),</span>
<a id="__codelineno-43-4" name="__codelineno-43-4" href="#__codelineno-43-4"></a> <span class="p">(</span><span class="mi">10</span><span class="p">,</span> <span class="mf">4.0</span><span class="p">),</span>
<a id="__codelineno-43-5" name="__codelineno-43-5" href="#__codelineno-43-5"></a><span class="p">])</span>
<a id="__codelineno-43-6" name="__codelineno-43-6" href="#__codelineno-43-6"></a><span class="k">def</span><span class="w"> </span><span class="nf">test_use_count_boost</span><span class="p">(</span><span class="n">use_count</span><span class="p">,</span> <span class="n">expected</span><span class="p">):</span>
<a id="__codelineno-43-7" name="__codelineno-43-7" href="#__codelineno-43-7"></a> <span class="n">boost</span> <span class="o">=</span> <span class="n">calculate_boost</span><span class="p">(</span><span class="n">use_count</span><span class="p">)</span>
<a id="__codelineno-43-8" name="__codelineno-43-8" href="#__codelineno-43-8"></a> <span class="k">assert</span> <span class="nb">abs</span><span class="p">(</span><span class="n">boost</span> <span class="o">-</span> <span class="n">expected</span><span class="p">)</span> <span class="o"><</span> <span class="mf">0.1</span>
</code></pre></div></p>
</li>
</ol>
<h3 id="running-specific-tests">Running Specific Tests<a class="headerlink" href="#running-specific-tests" title="Permanent link">¶</a></h3>
<div class="highlight"><pre><span></span><code><a id="__codelineno-44-1" name="__codelineno-44-1" href="#__codelineno-44-1"></a><span class="c1"># Run a specific test file</span>
<a id="__codelineno-44-2" name="__codelineno-44-2" href="#__codelineno-44-2"></a>uv<span class="w"> </span>run<span class="w"> </span>python<span class="w"> </span>-m<span class="w"> </span>pytest<span class="w"> </span>tests/test_consolidation.py
<a id="__codelineno-44-3" name="__codelineno-44-3" href="#__codelineno-44-3"></a>
<a id="__codelineno-44-4" name="__codelineno-44-4" href="#__codelineno-44-4"></a><span class="c1"># Run a specific test</span>
<a id="__codelineno-44-5" name="__codelineno-44-5" href="#__codelineno-44-5"></a>uv<span class="w"> </span>run<span class="w"> </span>python<span class="w"> </span>-m<span class="w"> </span>pytest<span class="w"> </span>tests/test_consolidation.py::test_merge_tags
<a id="__codelineno-44-6" name="__codelineno-44-6" href="#__codelineno-44-6"></a>
<a id="__codelineno-44-7" name="__codelineno-44-7" href="#__codelineno-44-7"></a><span class="c1"># Run tests matching a pattern</span>
<a id="__codelineno-44-8" name="__codelineno-44-8" href="#__codelineno-44-8"></a>uv<span class="w"> </span>run<span class="w"> </span>python<span class="w"> </span>-m<span class="w"> </span>pytest<span class="w"> </span>-k<span class="w"> </span><span class="s2">"consolidation"</span>
<a id="__codelineno-44-9" name="__codelineno-44-9" href="#__codelineno-44-9"></a>
<a id="__codelineno-44-10" name="__codelineno-44-10" href="#__codelineno-44-10"></a><span class="c1"># Run with verbose output</span>
<a id="__codelineno-44-11" name="__codelineno-44-11" href="#__codelineno-44-11"></a>uv<span class="w"> </span>run<span class="w"> </span>python<span class="w"> </span>-m<span class="w"> </span>pytest<span class="w"> </span>-v
<a id="__codelineno-44-12" name="__codelineno-44-12" href="#__codelineno-44-12"></a>
<a id="__codelineno-44-13" name="__codelineno-44-13" href="#__codelineno-44-13"></a><span class="c1"># Run with detailed output on failures</span>
<a id="__codelineno-44-14" name="__codelineno-44-14" href="#__codelineno-44-14"></a>uv<span class="w"> </span>run<span class="w"> </span>python<span class="w"> </span>-m<span class="w"> </span>pytest<span class="w"> </span>-vv
<a id="__codelineno-44-15" name="__codelineno-44-15" href="#__codelineno-44-15"></a>
<a id="__codelineno-44-16" name="__codelineno-44-16" href="#__codelineno-44-16"></a><span class="c1"># Stop on first failure</span>
<a id="__codelineno-44-17" name="__codelineno-44-17" href="#__codelineno-44-17"></a>uv<span class="w"> </span>run<span class="w"> </span>python<span class="w"> </span>-m<span class="w"> </span>pytest<span class="w"> </span>-x
<a id="__codelineno-44-18" name="__codelineno-44-18" href="#__codelineno-44-18"></a>
<a id="__codelineno-44-19" name="__codelineno-44-19" href="#__codelineno-44-19"></a><span class="c1"># Show local variables on failure</span>
<a id="__codelineno-44-20" name="__codelineno-44-20" href="#__codelineno-44-20"></a>uv<span class="w"> </span>run<span class="w"> </span>python<span class="w"> </span>-m<span class="w"> </span>pytest<span class="w"> </span>-l
<a id="__codelineno-44-21" name="__codelineno-44-21" href="#__codelineno-44-21"></a>
<a id="__codelineno-44-22" name="__codelineno-44-22" href="#__codelineno-44-22"></a><span class="c1"># Run tests in parallel (requires pytest-xdist)</span>
<a id="__codelineno-44-23" name="__codelineno-44-23" href="#__codelineno-44-23"></a>uv<span class="w"> </span>run<span class="w"> </span>python<span class="w"> </span>-m<span class="w"> </span>pytest<span class="w"> </span>-n<span class="w"> </span>auto
</code></pre></div>
<h3 id="coverage-requirements">Coverage Requirements<a class="headerlink" href="#coverage-requirements" title="Permanent link">¶</a></h3>
<ul>
<li>Aim for <strong>80%+ code coverage</strong> for new features</li>
<li>Critical paths (decay, storage, consolidation) should have <strong>95%+ coverage</strong></li>
<li>Check coverage with:</li>
</ul>
<div class="highlight"><pre><span></span><code><a id="__codelineno-45-1" name="__codelineno-45-1" href="#__codelineno-45-1"></a>uv<span class="w"> </span>run<span class="w"> </span>python<span class="w"> </span>-m<span class="w"> </span>pytest<span class="w"> </span>--cov<span class="o">=</span>cortexgraph<span class="w"> </span>--cov-report<span class="o">=</span>term-missing
</code></pre></div>
<hr />
<h2 id="code-style">Code Style<a class="headerlink" href="#code-style" title="Permanent link">¶</a></h2>
<h3 id="python-style-guidelines">Python Style Guidelines<a class="headerlink" href="#python-style-guidelines" title="Permanent link">¶</a></h3>
<p>We use <strong>Ruff</strong> for linting and formatting (no Black):</p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-46-1" name="__codelineno-46-1" href="#__codelineno-46-1"></a><span class="c1"># Check for style issues</span>
<a id="__codelineno-46-2" name="__codelineno-46-2" href="#__codelineno-46-2"></a>uv<span class="w"> </span>run<span class="w"> </span>ruff<span class="w"> </span>check<span class="w"> </span>src/cortexgraph<span class="w"> </span>tests
<a id="__codelineno-46-3" name="__codelineno-46-3" href="#__codelineno-46-3"></a>
<a id="__codelineno-46-4" name="__codelineno-46-4" href="#__codelineno-46-4"></a><span class="c1"># Auto-fix issues</span>
<a id="__codelineno-46-5" name="__codelineno-46-5" href="#__codelineno-46-5"></a>uv<span class="w"> </span>run<span class="w"> </span>ruff<span class="w"> </span>check<span class="w"> </span>--fix<span class="w"> </span>src/cortexgraph<span class="w"> </span>tests
<a id="__codelineno-46-6" name="__codelineno-46-6" href="#__codelineno-46-6"></a>
<a id="__codelineno-46-7" name="__codelineno-46-7" href="#__codelineno-46-7"></a><span class="c1"># Format code</span>
<a id="__codelineno-46-8" name="__codelineno-46-8" href="#__codelineno-46-8"></a>uv<span class="w"> </span>run<span class="w"> </span>ruff<span class="w"> </span>format<span class="w"> </span>src/cortexgraph<span class="w"> </span>tests
</code></pre></div>
<h3 id="type-hints">Type Hints<a class="headerlink" href="#type-hints" title="Permanent link">¶</a></h3>
<p>All functions must have type hints:</p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-47-1" name="__codelineno-47-1" href="#__codelineno-47-1"></a><span class="c1"># Good ✓</span>
<a id="__codelineno-47-2" name="__codelineno-47-2" href="#__codelineno-47-2"></a><span class="k">def</span><span class="w"> </span><span class="nf">calculate_score</span><span class="p">(</span><span class="n">use_count</span><span class="p">:</span> <span class="nb">int</span><span class="p">,</span> <span class="n">last_used</span><span class="p">:</span> <span class="nb">int</span><span class="p">,</span> <span class="n">strength</span><span class="p">:</span> <span class="nb">float</span><span class="p">)</span> <span class="o">-></span> <span class="nb">float</span><span class="p">:</span>
<a id="__codelineno-47-3" name="__codelineno-47-3" href="#__codelineno-47-3"></a><span class="w"> </span><span class="sd">"""Calculate memory score."""</span>
<a id="__codelineno-47-4" name="__codelineno-47-4" href="#__codelineno-47-4"></a> <span class="k">return</span> <span class="p">(</span><span class="n">use_count</span> <span class="o">**</span> <span class="mf">0.6</span><span class="p">)</span> <span class="o">*</span> <span class="n">math</span><span class="o">.</span><span class="n">exp</span><span class="p">(</span><span class="o">-</span><span class="mf">0.0001</span> <span class="o">*</span> <span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">())</span> <span class="o">*</span> <span class="n">strength</span>
<a id="__codelineno-47-5" name="__codelineno-47-5" href="#__codelineno-47-5"></a>
<a id="__codelineno-47-6" name="__codelineno-47-6" href="#__codelineno-47-6"></a><span class="c1"># Bad ✗</span>
<a id="__codelineno-47-7" name="__codelineno-47-7" href="#__codelineno-47-7"></a><span class="k">def</span><span class="w"> </span><span class="nf">calculate_score</span><span class="p">(</span><span class="n">use_count</span><span class="p">,</span> <span class="n">last_used</span><span class="p">,</span> <span class="n">strength</span><span class="p">):</span>
<a id="__codelineno-47-8" name="__codelineno-47-8" href="#__codelineno-47-8"></a> <span class="k">return</span> <span class="p">(</span><span class="n">use_count</span> <span class="o">**</span> <span class="mf">0.6</span><span class="p">)</span> <span class="o">*</span> <span class="n">math</span><span class="o">.</span><span class="n">exp</span><span class="p">(</span><span class="o">-</span><span class="mf">0.0001</span> <span class="o">*</span> <span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">())</span> <span class="o">*</span> <span class="n">strength</span>
</code></pre></div>
<p>Run type checker:</p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-48-1" name="__codelineno-48-1" href="#__codelineno-48-1"></a>uv<span class="w"> </span>run<span class="w"> </span>mypy<span class="w"> </span>src/cortexgraph
</code></pre></div>
<h3 id="docstrings">Docstrings<a class="headerlink" href="#docstrings" title="Permanent link">¶</a></h3>
<p>Use Google-style docstrings:</p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-49-1" name="__codelineno-49-1" href="#__codelineno-49-1"></a><span class="k">def</span><span class="w"> </span><span class="nf">merge_content_smart</span><span class="p">(</span><span class="n">memories</span><span class="p">:</span> <span class="nb">list</span><span class="p">[</span><span class="n">Memory</span><span class="p">])</span> <span class="o">-></span> <span class="nb">str</span><span class="p">:</span>
<a id="__codelineno-49-2" name="__codelineno-49-2" href="#__codelineno-49-2"></a><span class="w"> </span><span class="sd">"""</span>
<a id="__codelineno-49-3" name="__codelineno-49-3" href="#__codelineno-49-3"></a><span class="sd"> Intelligently merge content from multiple memories.</span>
<a id="__codelineno-49-4" name="__codelineno-49-4" href="#__codelineno-49-4"></a>
<a id="__codelineno-49-5" name="__codelineno-49-5" href="#__codelineno-49-5"></a><span class="sd"> Strategy:</span>
<a id="__codelineno-49-6" name="__codelineno-49-6" href="#__codelineno-49-6"></a><span class="sd"> - If very similar (duplicates), keep the longest/most detailed version</span>
<a id="__codelineno-49-7" name="__codelineno-49-7" href="#__codelineno-49-7"></a><span class="sd"> - If related but distinct, combine with clear separation</span>
<a id="__codelineno-49-8" name="__codelineno-49-8" href="#__codelineno-49-8"></a><span class="sd"> - Preserve unique information from each memory</span>
<a id="__codelineno-49-9" name="__codelineno-49-9" href="#__codelineno-49-9"></a>
<a id="__codelineno-49-10" name="__codelineno-49-10" href="#__codelineno-49-10"></a><span class="sd"> Args:</span>
<a id="__codelineno-49-11" name="__codelineno-49-11" href="#__codelineno-49-11"></a><span class="sd"> memories: List of memories to merge</span>
<a id="__codelineno-49-12" name="__codelineno-49-12" href="#__codelineno-49-12"></a>
<a id="__codelineno-49-13" name="__codelineno-49-13" href="#__codelineno-49-13"></a><span class="sd"> Returns:</span>
<a id="__codelineno-49-14" name="__codelineno-49-14" href="#__codelineno-49-14"></a><span class="sd"> Merged content string</span>
<a id="__codelineno-49-15" name="__codelineno-49-15" href="#__codelineno-49-15"></a>
<a id="__codelineno-49-16" name="__codelineno-49-16" href="#__codelineno-49-16"></a><span class="sd"> Example:</span>
<a id="__codelineno-49-17" name="__codelineno-49-17" href="#__codelineno-49-17"></a><span class="sd"> >>> memories = [Memory(id="1", content="Python is great")]</span>
<a id="__codelineno-49-18" name="__codelineno-49-18" href="#__codelineno-49-18"></a><span class="sd"> >>> merge_content_smart(memories)</span>
<a id="__codelineno-49-19" name="__codelineno-49-19" href="#__codelineno-49-19"></a><span class="sd"> 'Python is great'</span>
<a id="__codelineno-49-20" name="__codelineno-49-20" href="#__codelineno-49-20"></a><span class="sd"> """</span>
<a id="__codelineno-49-21" name="__codelineno-49-21" href="#__codelineno-49-21"></a> <span class="c1"># Implementation</span>
</code></pre></div>
<h3 id="code-organization">Code Organization<a class="headerlink" href="#code-organization" title="Permanent link">¶</a></h3>
<ul>
<li><strong>4-space indentation</strong> (no tabs)</li>
<li><strong>Line length: 100 characters max</strong></li>
<li><strong>Module organization:</strong>
<div class="highlight"><pre><span></span><code><a id="__codelineno-50-1" name="__codelineno-50-1" href="#__codelineno-50-1"></a><span class="c1"># Standard library imports</span>
<a id="__codelineno-50-2" name="__codelineno-50-2" href="#__codelineno-50-2"></a><span class="kn">import</span><span class="w"> </span><span class="nn">time</span>
<a id="__codelineno-50-3" name="__codelineno-50-3" href="#__codelineno-50-3"></a><span class="kn">from</span><span class="w"> </span><span class="nn">pathlib</span><span class="w"> </span><span class="kn">import</span> <span class="n">Path</span>
<a id="__codelineno-50-4" name="__codelineno-50-4" href="#__codelineno-50-4"></a>
<a id="__codelineno-50-5" name="__codelineno-50-5" href="#__codelineno-50-5"></a><span class="c1"># Third-party imports</span>
<a id="__codelineno-50-6" name="__codelineno-50-6" href="#__codelineno-50-6"></a><span class="kn">from</span><span class="w"> </span><span class="nn">pydantic</span><span class="w"> </span><span class="kn">import</span> <span class="n">BaseModel</span>
<a id="__codelineno-50-7" name="__codelineno-50-7" href="#__codelineno-50-7"></a>
<a id="__codelineno-50-8" name="__codelineno-50-8" href="#__codelineno-50-8"></a><span class="c1"># Local imports</span>
<a id="__codelineno-50-9" name="__codelineno-50-9" href="#__codelineno-50-9"></a><span class="kn">from</span><span class="w"> </span><span class="nn">..storage.models</span><span class="w"> </span><span class="kn">import</span> <span class="n">Memory</span>
<a id="__codelineno-50-10" name="__codelineno-50-10" href="#__codelineno-50-10"></a><span class="kn">from</span><span class="w"> </span><span class="nn">..config</span><span class="w"> </span><span class="kn">import</span> <span class="n">get_config</span>
</code></pre></div></li>
</ul>
<hr />
<h2 id="submitting-changes">Submitting Changes<a class="headerlink" href="#submitting-changes" title="Permanent link">¶</a></h2>
<h3 id="before-submitting">Before Submitting<a class="headerlink" href="#before-submitting" title="Permanent link">¶</a></h3>
<ol>
<li>
<p><strong>Ensure all tests pass:</strong>
<div class="highlight"><pre><span></span><code><a id="__codelineno-51-1" name="__codelineno-51-1" href="#__codelineno-51-1"></a>uv<span class="w"> </span>run<span class="w"> </span>python<span class="w"> </span>-m<span class="w"> </span>pytest
</code></pre></div></p>
</li>
<li>
<p><strong>Check code style:</strong>
<div class="highlight"><pre><span></span><code><a id="__codelineno-52-1" name="__codelineno-52-1" href="#__codelineno-52-1"></a>uv<span class="w"> </span>run<span class="w"> </span>ruff<span class="w"> </span>check<span class="w"> </span>src/cortexgraph<span class="w"> </span>tests
<a id="__codelineno-52-2" name="__codelineno-52-2" href="#__codelineno-52-2"></a>uv<span class="w"> </span>run<span class="w"> </span>ruff<span class="w"> </span>format<span class="w"> </span>src/cortexgraph<span class="w"> </span>tests
<a id="__codelineno-52-3" name="__codelineno-52-3" href="#__codelineno-52-3"></a>uv<span class="w"> </span>run<span class="w"> </span>mypy<span class="w"> </span>src/cortexgraph
</code></pre></div></p>
</li>
<li>
<p><strong>Update documentation</strong> if you:</p>
</li>
<li>Added a new feature</li>
<li>Changed an API</li>
<li>
<p>Modified configuration options</p>
</li>
<li>
<p><strong>Add tests</strong> for new functionality</p>
</li>
</ol>
<h3 id="creating-a-pull-request">Creating a Pull Request<a class="headerlink" href="#creating-a-pull-request" title="Permanent link">¶</a></h3>
<ol>
<li>
<p><strong>Push your branch:</strong>
<div class="highlight"><pre><span></span><code><a id="__codelineno-53-1" name="__codelineno-53-1" href="#__codelineno-53-1"></a>git<span class="w"> </span>push<span class="w"> </span>origin<span class="w"> </span>feature/your-feature-name
</code></pre></div></p>
</li>
<li>
<p><strong>Create PR on GitHub</strong></p>
</li>
<li>
<p><strong>PR Description should include:</strong></p>
</li>
<li><strong>What</strong> changed</li>
<li><strong>Why</strong> the change was needed</li>
<li><strong>How</strong> to test it</li>
<li>Any <strong>breaking changes</strong></li>
</ol>
<p><strong>Example PR template:</strong></p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-54-1" name="__codelineno-54-1" href="#__codelineno-54-1"></a><span class="gu">## Description</span>
<a id="__codelineno-54-2" name="__codelineno-54-2" href="#__codelineno-54-2"></a>Implement spaced repetition scheduling for memory review.
<a id="__codelineno-54-3" name="__codelineno-54-3" href="#__codelineno-54-3"></a>
<a id="__codelineno-54-4" name="__codelineno-54-4" href="#__codelineno-54-4"></a><span class="gu">## Motivation</span>
<a id="__codelineno-54-5" name="__codelineno-54-5" href="#__codelineno-54-5"></a>Users requested a way to get reminders for reviewing important memories
<a id="__codelineno-54-6" name="__codelineno-54-6" href="#__codelineno-54-6"></a>before they decay too much.
<a id="__codelineno-54-7" name="__codelineno-54-7" href="#__codelineno-54-7"></a>
<a id="__codelineno-54-8" name="__codelineno-54-8" href="#__codelineno-54-8"></a><span class="gu">## Changes</span>
<a id="__codelineno-54-9" name="__codelineno-54-9" href="#__codelineno-54-9"></a><span class="k">-</span><span class="w"> </span>Add <span class="sb">`calculate_next_review()`</span> function to core/scheduling.py
<a id="__codelineno-54-10" name="__codelineno-54-10" href="#__codelineno-54-10"></a><span class="k">-</span><span class="w"> </span>Add <span class="sb">`get_review_queue()`</span> MCP tool
<a id="__codelineno-54-11" name="__codelineno-54-11" href="#__codelineno-54-11"></a><span class="k">-</span><span class="w"> </span>Add tests in tests/test_scheduling.py (100% coverage)
<a id="__codelineno-54-12" name="__codelineno-54-12" href="#__codelineno-54-12"></a><span class="k">-</span><span class="w"> </span>Update README.md with usage examples
<a id="__codelineno-54-13" name="__codelineno-54-13" href="#__codelineno-54-13"></a>
<a id="__codelineno-54-14" name="__codelineno-54-14" href="#__codelineno-54-14"></a><span class="gu">## Testing</span>
<a id="__codelineno-54-15" name="__codelineno-54-15" href="#__codelineno-54-15"></a><span class="k">-</span><span class="w"> </span>All existing tests pass
<a id="__codelineno-54-16" name="__codelineno-54-16" href="#__codelineno-54-16"></a><span class="k">-</span><span class="w"> </span>Added 12 new tests for scheduling logic
<a id="__codelineno-54-17" name="__codelineno-54-17" href="#__codelineno-54-17"></a><span class="k">-</span><span class="w"> </span>Tested manually with 100+ memories
<a id="__codelineno-54-18" name="__codelineno-54-18" href="#__codelineno-54-18"></a>
<a id="__codelineno-54-19" name="__codelineno-54-19" href="#__codelineno-54-19"></a><span class="gu">## Breaking Changes</span>
<a id="__codelineno-54-20" name="__codelineno-54-20" href="#__codelineno-54-20"></a>None - this is a new feature with no API changes.
</code></pre></div>
<h3 id="code-review-process">Code Review Process<a class="headerlink" href="#code-review-process" title="Permanent link">¶</a></h3>
<ul>
<li>Maintainers will review your PR</li>
<li>Address any feedback</li>
<li>Once approved, your PR will be merged</li>
</ul>
<hr />
<h2 id="reporting-issues">Reporting Issues<a class="headerlink" href="#reporting-issues" title="Permanent link">¶</a></h2>
<h3 id="before-opening-an-issue">Before Opening an Issue<a class="headerlink" href="#before-opening-an-issue" title="Permanent link">¶</a></h3>
<ol>
<li><strong>Search existing issues</strong> to avoid duplicates</li>
<li><strong>Try the latest version</strong> - your issue might be fixed</li>
<li><strong>Gather information:</strong></li>
<li>CortexGraph version (<code>cortexgraph --version</code> or check <code>pyproject.toml</code>)</li>
<li>Python version (<code>python --version</code>)</li>
<li>Operating system and version</li>
<li>Steps to reproduce</li>
</ol>
<h3 id="bug-report-template">Bug Report Template<a class="headerlink" href="#bug-report-template" title="Permanent link">¶</a></h3>
<p><div class="highlight"><pre><span></span><code><a id="__codelineno-55-1" name="__codelineno-55-1" href="#__codelineno-55-1"></a><span class="gs">**Describe the bug**</span>
<a id="__codelineno-55-2" name="__codelineno-55-2" href="#__codelineno-55-2"></a>A clear description of what the bug is.
<a id="__codelineno-55-3" name="__codelineno-55-3" href="#__codelineno-55-3"></a>
<a id="__codelineno-55-4" name="__codelineno-55-4" href="#__codelineno-55-4"></a><span class="gs">**To Reproduce**</span>
<a id="__codelineno-55-5" name="__codelineno-55-5" href="#__codelineno-55-5"></a>Steps to reproduce:
<a id="__codelineno-55-6" name="__codelineno-55-6" href="#__codelineno-55-6"></a><span class="k">1.</span> Install CortexGraph with <span class="sb">`uv tool install...`</span>
<a id="__codelineno-55-7" name="__codelineno-55-7" href="#__codelineno-55-7"></a><span class="k">2.</span> Configure with these settings: ...
<a id="__codelineno-55-8" name="__codelineno-55-8" href="#__codelineno-55-8"></a><span class="k">3.</span> Run command <span class="sb">`...`</span>
<a id="__codelineno-55-9" name="__codelineno-55-9" href="#__codelineno-55-9"></a><span class="k">4.</span> See error
<a id="__codelineno-55-10" name="__codelineno-55-10" href="#__codelineno-55-10"></a>
<a id="__codelineno-55-11" name="__codelineno-55-11" href="#__codelineno-55-11"></a><span class="gs">**Expected behavior**</span>
<a id="__codelineno-55-12" name="__codelineno-55-12" href="#__codelineno-55-12"></a>What you expected to happen.
<a id="__codelineno-55-13" name="__codelineno-55-13" href="#__codelineno-55-13"></a>
<a id="__codelineno-55-14" name="__codelineno-55-14" href="#__codelineno-55-14"></a><span class="gs">**Actual behavior**</span>
<a id="__codelineno-55-15" name="__codelineno-55-15" href="#__codelineno-55-15"></a>What actually happened.
<a id="__codelineno-55-16" name="__codelineno-55-16" href="#__codelineno-55-16"></a>
<a id="__codelineno-55-17" name="__codelineno-55-17" href="#__codelineno-55-17"></a><span class="gs">**Environment:**</span>
<a id="__codelineno-55-18" name="__codelineno-55-18" href="#__codelineno-55-18"></a><span class="k">-</span><span class="w"> </span>OS: [e.g., Windows 11, Ubuntu 22.04, macOS 14]
<a id="__codelineno-55-19" name="__codelineno-55-19" href="#__codelineno-55-19"></a><span class="k">-</span><span class="w"> </span>Python version: [e.g., 3.10.13]
<a id="__codelineno-55-20" name="__codelineno-55-20" href="#__codelineno-55-20"></a><span class="k">-</span><span class="w"> </span>CortexGraph version: [e.g., 1.0.0]
<a id="__codelineno-55-21" name="__codelineno-55-21" href="#__codelineno-55-21"></a><span class="k">-</span><span class="w"> </span>Installation method: [uv tool install / editable]
<a id="__codelineno-55-22" name="__codelineno-55-22" href="#__codelineno-55-22"></a>
<a id="__codelineno-55-23" name="__codelineno-55-23" href="#__codelineno-55-23"></a><span class="gs">**Logs/Screenshots**</span>
</code></pre></div>
[Paste any error messages or logs here]
<div class="highlight"><pre><span></span><code><a id="__codelineno-56-1" name="__codelineno-56-1" href="#__codelineno-56-1"></a>**Additional context**
<a id="__codelineno-56-2" name="__codelineno-56-2" href="#__codelineno-56-2"></a>Any other information that might help.
</code></pre></div></p>
<h3 id="feature-requests">Feature Requests<a class="headerlink" href="#feature-requests" title="Permanent link">¶</a></h3>
<div class="highlight"><pre><span></span><code><a id="__codelineno-57-1" name="__codelineno-57-1" href="#__codelineno-57-1"></a><span class="gs">**Feature description**</span>
<a id="__codelineno-57-2" name="__codelineno-57-2" href="#__codelineno-57-2"></a>A clear description of the feature you'd like.
<a id="__codelineno-57-3" name="__codelineno-57-3" href="#__codelineno-57-3"></a>
<a id="__codelineno-57-4" name="__codelineno-57-4" href="#__codelineno-57-4"></a><span class="gs">**Use case**</span>
<a id="__codelineno-57-5" name="__codelineno-57-5" href="#__codelineno-57-5"></a>Why would this feature be useful? What problem does it solve?
<a id="__codelineno-57-6" name="__codelineno-57-6" href="#__codelineno-57-6"></a>
<a id="__codelineno-57-7" name="__codelineno-57-7" href="#__codelineno-57-7"></a><span class="gs">**Proposed solution**</span>
<a id="__codelineno-57-8" name="__codelineno-57-8" href="#__codelineno-57-8"></a>If you have ideas on how to implement it.
<a id="__codelineno-57-9" name="__codelineno-57-9" href="#__codelineno-57-9"></a>
<a id="__codelineno-57-10" name="__codelineno-57-10" href="#__codelineno-57-10"></a><span class="gs">**Alternatives considered**</span>
<a id="__codelineno-57-11" name="__codelineno-57-11" href="#__codelineno-57-11"></a>Other approaches you've thought about.
</code></pre></div>
<hr />
<h2 id="getting-help">Getting Help<a class="headerlink" href="#getting-help" title="Permanent link">¶</a></h2>
<ul>
<li><strong>Documentation:</strong> <a href="docs/">docs/</a> directory</li>
<li><strong>Issues:</strong> <a href="https://github.com/prefrontal-systems/cortexgraph/issues">GitHub Issues</a></li>
<li><strong>Roadmap:</strong> <a href="../future_roadmap/">future_roadmap.md</a></li>
</ul>
<hr />
<h2 id="license">License<a class="headerlink" href="#license" title="Permanent link">¶</a></h2>
<p>By contributing, you agree that your contributions will be licensed under the MIT License.</p>
<p>Thank you for contributing to CortexGraph! 🎉</p>
</article>
</div>
<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
</div>
<button type="button" class="md-top md-icon" data-md-component="top" hidden>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8z"/></svg>
Back to top
</button>
</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 class="md-social">
<a href="https://github.com/prefrontal-systems/cortexgraph" target="_blank" rel="noopener" title="github.com" class="md-social__link">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 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="M173.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6m-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3m44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9M252.8 8C114.1 8 8 113.3 8 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C436.2 457.8 504 362.9 504 252 504 113.3 391.5 8 252.8 8M105.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1m-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7m32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1m-11.4-14.7c-1.6 1-1.6 3.6 0 5.9s4.3 3.3 5.6 2.3c1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2"/></svg>
</a>
<a href="https://github.com/prefrontal-systems/cortexgraph/discussions" target="_blank" rel="noopener" title="github.com" class="md-social__link">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 576 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="M384 144c0 97.2-86 176-192 176-26.7 0-52.1-5-75.2-14l-81.6 43.2c-9.3 4.9-20.7 3.2-28.2-4.2s-9.2-18.9-4.2-28.2l35.6-67.2C14.3 220.2 0 183.6 0 144 0 46.8 86-32 192-32s192 78.8 192 176m0 368c-94.1 0-172.4-62.1-188.8-144 120-1.5 224.3-86.9 235.8-202.7 83.3 19.2 145 88.3 145 170.7 0 39.6-14.3 76.2-38.4 105.6l35.6 67.2c4.9 9.3 3.2 20.7-4.2 28.2s-18.9 9.2-28.2 4.2L459.2 498c-23.1 9-48.5 14-75.2 14"/></svg>
</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.instant", "navigation.tracking", "navigation.tabs", "navigation.sections", "navigation.expand", "navigation.top", "search.suggest", "search.highlight", "content.code.copy", "content.code.annotate", "content.action.edit"], "search": "../assets/javascripts/workers/search.7a47a382.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.e71a0d61.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/prefrontalsys/mnemex'
If you have feedback or need assistance with the MCP directory API, please join our Discord server