-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathindex.html
More file actions
334 lines (284 loc) · 16.7 KB
/
Copy pathindex.html
File metadata and controls
334 lines (284 loc) · 16.7 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
<!DOCTYPE HTML>
<html lang="en" class="light sidebar-visible" dir="ltr">
<head>
<!-- Book generated using mdBook -->
<meta charset="UTF-8">
<title>Home - Engram - Distributed Memory for AI Agents</title>
<!-- Custom HTML head -->
<meta name="description" content="A second brain for your software projects - capture context, reasoning, and knowledge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="theme-color" content="#ffffff">
<link rel="icon" href="favicon.svg">
<link rel="shortcut icon" href="favicon.png">
<link rel="stylesheet" href="css/variables.css">
<link rel="stylesheet" href="css/general.css">
<link rel="stylesheet" href="css/chrome.css">
<link rel="stylesheet" href="css/print.css" media="print">
<!-- Fonts -->
<link rel="stylesheet" href="FontAwesome/css/font-awesome.css">
<link rel="stylesheet" href="fonts/fonts.css">
<!-- Highlight.js Stylesheets -->
<link rel="stylesheet" id="highlight-css" href="highlight.css">
<link rel="stylesheet" id="tomorrow-night-css" href="tomorrow-night.css">
<link rel="stylesheet" id="ayu-highlight-css" href="ayu-highlight.css">
<!-- Custom theme stylesheets -->
<link rel="stylesheet" href="docs/theme/engram.css">
<!-- Provide site root and default themes to javascript -->
<script>
const path_to_root = "";
const default_light_theme = "light";
const default_dark_theme = "coal";
window.path_to_searchindex_js = "searchindex.js";
</script>
<!-- Start loading toc.js asap -->
<script src="toc.js"></script>
</head>
<body>
<div id="mdbook-help-container">
<div id="mdbook-help-popup">
<h2 class="mdbook-help-title">Keyboard shortcuts</h2>
<div>
<p>Press <kbd>←</kbd> or <kbd>→</kbd> to navigate between chapters</p>
<p>Press <kbd>S</kbd> or <kbd>/</kbd> to search in the book</p>
<p>Press <kbd>?</kbd> to show this help</p>
<p>Press <kbd>Esc</kbd> to hide this help</p>
</div>
</div>
</div>
<div id="body-container">
<!-- Work around some values being stored in localStorage wrapped in quotes -->
<script>
try {
let theme = localStorage.getItem('mdbook-theme');
let sidebar = localStorage.getItem('mdbook-sidebar');
if (theme.startsWith('"') && theme.endsWith('"')) {
localStorage.setItem('mdbook-theme', theme.slice(1, theme.length - 1));
}
if (sidebar.startsWith('"') && sidebar.endsWith('"')) {
localStorage.setItem('mdbook-sidebar', sidebar.slice(1, sidebar.length - 1));
}
} catch (e) { }
</script>
<!-- Set the theme before any content is loaded, prevents flash -->
<script>
const default_theme = window.matchMedia("(prefers-color-scheme: dark)").matches ? default_dark_theme : default_light_theme;
let theme;
try { theme = localStorage.getItem('mdbook-theme'); } catch(e) { }
if (theme === null || theme === undefined) { theme = default_theme; }
const html = document.documentElement;
html.classList.remove('light')
html.classList.add(theme);
html.classList.add("js");
</script>
<input type="checkbox" id="sidebar-toggle-anchor" class="hidden">
<!-- Hide / unhide sidebar before it is displayed -->
<script>
let sidebar = null;
const sidebar_toggle = document.getElementById("sidebar-toggle-anchor");
if (document.body.clientWidth >= 1080) {
try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { }
sidebar = sidebar || 'visible';
} else {
sidebar = 'hidden';
sidebar_toggle.checked = false;
}
if (sidebar === 'visible') {
sidebar_toggle.checked = true;
} else {
html.classList.remove('sidebar-visible');
}
</script>
<nav id="sidebar" class="sidebar" aria-label="Table of contents">
<!-- populated by js -->
<mdbook-sidebar-scrollbox class="sidebar-scrollbox"></mdbook-sidebar-scrollbox>
<noscript>
<iframe class="sidebar-iframe-outer" src="toc.html"></iframe>
</noscript>
<div id="sidebar-resize-handle" class="sidebar-resize-handle">
<div class="sidebar-resize-indicator"></div>
</div>
</nav>
<div id="page-wrapper" class="page-wrapper">
<div class="page">
<div id="menu-bar-hover-placeholder"></div>
<div id="menu-bar" class="menu-bar sticky">
<div class="left-buttons">
<label id="sidebar-toggle" class="icon-button" for="sidebar-toggle-anchor" title="Toggle Table of Contents" aria-label="Toggle Table of Contents" aria-controls="sidebar">
<i class="fa fa-bars"></i>
</label>
<button id="theme-toggle" class="icon-button" type="button" title="Change theme" aria-label="Change theme" aria-haspopup="true" aria-expanded="false" aria-controls="theme-list">
<i class="fa fa-paint-brush"></i>
</button>
<ul id="theme-list" class="theme-popup" aria-label="Themes" role="menu">
<li role="none"><button role="menuitem" class="theme" id="default_theme">Auto</button></li>
<li role="none"><button role="menuitem" class="theme" id="light">Light</button></li>
<li role="none"><button role="menuitem" class="theme" id="rust">Rust</button></li>
<li role="none"><button role="menuitem" class="theme" id="coal">Coal</button></li>
<li role="none"><button role="menuitem" class="theme" id="navy">Navy</button></li>
<li role="none"><button role="menuitem" class="theme" id="ayu">Ayu</button></li>
</ul>
<button id="search-toggle" class="icon-button" type="button" title="Search (`/`)" aria-label="Toggle Searchbar" aria-expanded="false" aria-keyshortcuts="/ s" aria-controls="searchbar">
<i class="fa fa-search"></i>
</button>
</div>
<h1 class="menu-title">Engram - Distributed Memory for AI Agents</h1>
<div class="right-buttons">
<a href="print.html" title="Print this book" aria-label="Print this book">
<i id="print-button" class="fa fa-print"></i>
</a>
<a href="https://github.com/vincents-ai/engram/edit/main/docs/../README.md" title="Suggest an edit" aria-label="Suggest an edit" rel="edit">
<i id="git-edit-button" class="fa fa-edit"></i>
</a>
</div>
</div>
<div id="search-wrapper" class="hidden">
<form id="searchbar-outer" class="searchbar-outer">
<div class="search-wrapper">
<input type="search" id="searchbar" name="searchbar" placeholder="Search this book ..." aria-controls="searchresults-outer" aria-describedby="searchresults-header">
<div class="spinner-wrapper">
<i class="fa fa-spinner fa-spin"></i>
</div>
</div>
</form>
<div id="searchresults-outer" class="searchresults-outer hidden">
<div id="searchresults-header" class="searchresults-header"></div>
<ul id="searchresults">
</ul>
</div>
</div>
<!-- Apply ARIA attributes after the sidebar and the sidebar toggle button are added to the DOM -->
<script>
document.getElementById('sidebar-toggle').setAttribute('aria-expanded', sidebar === 'visible');
document.getElementById('sidebar').setAttribute('aria-hidden', sidebar !== 'visible');
Array.from(document.querySelectorAll('#sidebar a')).forEach(function(link) {
link.setAttribute('tabIndex', sidebar === 'visible' ? 0 : -1);
});
</script>
<div id="content" class="content">
<main>
<h1 id="engram"><a class="header" href="#engram">Engram</a></h1>
<p><strong>Engram is a distributed memory system for AI agents and human operators.</strong></p>
<p>It acts as a “second brain” for your software projects, allowing you to capture context, plan tasks, track reasoning, and manage knowledge alongside your code. Unlike a simple todo list or a wiki, Engram is designed to be machine-readable, allowing AI agents to understand the full context of your work.</p>
<blockquote>
<p><strong>Note for Developers</strong>: If you are looking for build instructions, Rust implementation details, or contributing guidelines, please see <a href="DEVELOPMENT.html">DEVELOPMENT.md</a>.</p>
</blockquote>
<h2 id="why-engram"><a class="header" href="#why-engram">Why Engram?</a></h2>
<ul>
<li><strong>Context Persistence</strong>: Don’t lose the “why” behind your code changes. Store reasoning chains linked directly to tasks.</li>
<li><strong>Agent Ready</strong>: Your plans and context are structured so AI agents can instantly onboard and contribute effectively.</li>
<li><strong>Theory Building</strong>: Capture the mental model behind your code—concepts, design rationale, and invariants.</li>
<li><strong>Cognitive Dissonance</strong>: Detect when theory conflicts with reality and evolve your understanding.</li>
<li><strong>Git-Native Storage</strong>: Engram stores data directly in your <code>.git</code> database using custom references (<code>refs/engram/</code>). This means your project management is version-controlled without polluting your working directory.</li>
</ul>
<h2 id="quick-start"><a class="header" href="#quick-start">Quick Start</a></h2>
<h3 id="1-setup"><a class="header" href="#1-setup">1. Setup</a></h3>
<p>Run these commands in your project root to initialize Engram and set up your identity.</p>
<pre><code class="language-bash"># Initialize workspace
engram setup workspace
# Create your profile (replace name as needed)
engram setup agent --name "Human Operator" --agent-type operator
# (Optional) Install git hook to enforce task linking
engram validate hook install
</code></pre>
<h3 id="2-core-workflow"><a class="header" href="#2-core-workflow">2. Core Workflow</a></h3>
<p>The Engram workflow follows a simple cycle: <strong>Plan -> Execute -> Remember</strong>.</p>
<h4 id="plan"><a class="header" href="#plan">Plan</a></h4>
<p>Break down your work into trackable tasks.</p>
<pre><code class="language-bash"># Create a high-level task
engram task create --title "Add user authentication" --priority high
</code></pre>
<h4 id="execute--document"><a class="header" href="#execute--document">Execute & Document</a></h4>
<p>As you work, save relevant information.</p>
<pre><code class="language-bash"># Store context (e.g., docs)
engram context create --title "OAuth2 Spec" --source "https://oauth.net/2/"
# Link it to your task
engram relationship create --source-id <TASK_ID> --target-id <CONTEXT_ID> --type references
</code></pre>
<h4 id="remember-reasoning"><a class="header" href="#remember-reasoning">Remember (Reasoning)</a></h4>
<p>Record <em>why</em> you made specific decisions.</p>
<pre><code class="language-bash"># Record a decision
engram reasoning create --title "Chose JWT for stateless auth" --task-id <TASK_ID>
</code></pre>
<h2 id="features-at-a-glance"><a class="header" href="#features-at-a-glance">Features at a Glance</a></h2>
<ul>
<li><strong>Tasks</strong>: Hierarchical work items.</li>
<li><strong>Context</strong>: Background info, docs, and snippets.</li>
<li><strong>Reasoning</strong>: Decision logs and thought processes.</li>
<li><strong>Knowledge</strong>: Reusable patterns and learnings.</li>
<li><strong>Theory Building</strong>: Capture mental models from code (Naur, 1985).</li>
<li><strong>State Reflection</strong>: Detect cognitive dissonance and evolve theories.</li>
<li><strong>Workflows</strong>: Define state machines for your processes.</li>
<li><strong>Sessions</strong>: Track work periods with theory binding.</li>
</ul>
<h2 id="documentation"><a class="header" href="#documentation">Documentation</a></h2>
<ul>
<li><a href="docs/user-guide.html"><strong>User Guide</strong></a>: A comprehensive guide for human operators.</li>
<li><a href="book/index.html"><strong>Book (mdBook)</strong></a>: Full documentation with Theory Building and State Reflection guides.</li>
<li><a href="docs/engram/skills/using-engram.html"><strong>Using Engram (for Agents)</strong></a>: How AI agents interact with the system.</li>
</ul>
<h2 id="theory-building"><a class="header" href="#theory-building">Theory Building</a></h2>
<p>Based on Peter Naur’s “Programming as Theory Building” (1985), Engram allows agents to capture the mental model behind code:</p>
<pre><code class="language-bash"># Create a theory about a domain
engram theory create "User Authentication"
# Add concepts
engram theory update --id <ID> --concept "User: A person who authenticates to the system"
# Add system mappings
engram theory update --id <ID> --mapping "User: src/entities/user.rs (struct User)"
# Add invariants
engram theory update --id <ID> --invariant "User email must be unique"
</code></pre>
<h2 id="state-reflection"><a class="header" href="#state-reflection">State Reflection</a></h2>
<p>When code behavior conflicts with your theory, create a reflection:</p>
<pre><code class="language-bash"># Create a reflection when dissonance is detected
engram reflect create --theory <THEORY_ID> --observed "Test failed" --trigger-type test_failure
# Record the dissonance
engram reflect record-dissonance --id <ID> --description "Theory claims X but code does Y"
# Check if theory mutation is required (dissonance >= 0.7)
engram reflect requires-mutation --id <ID>
</code></pre>
<h2 id="license"><a class="header" href="#license">License</a></h2>
<p>AGPL-3.0-or-later OR Commercial - dual-licensed for open source and commercial use</p>
</main>
<nav class="nav-wrapper" aria-label="Page navigation">
<!-- Mobile navigation buttons -->
<a rel="next prefetch" href="development/DEVELOPMENT.html" class="mobile-nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
<i class="fa fa-angle-right"></i>
</a>
<div style="clear: both"></div>
</nav>
</div>
</div>
<nav class="nav-wide-wrapper" aria-label="Page navigation">
<a rel="next prefetch" href="development/DEVELOPMENT.html" class="nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
<i class="fa fa-angle-right"></i>
</a>
</nav>
</div>
<!-- Livereload script (if served using the cli tool) -->
<script>
const wsProtocol = location.protocol === 'https:' ? 'wss:' : 'ws:';
const wsAddress = wsProtocol + "//" + location.host + "/" + "__livereload";
const socket = new WebSocket(wsAddress);
socket.onmessage = function (event) {
if (event.data === "reload") {
socket.close();
location.reload();
}
};
window.onbeforeunload = function() {
socket.close();
}
</script>
<script>
window.playground_copyable = true;
</script>
<script src="elasticlunr.min.js"></script>
<script src="mark.min.js"></script>
<script src="searcher.js"></script>
<script src="clipboard.min.js"></script>
<script src="highlight.js"></script>
<script src="book.js"></script>
<!-- Custom JS scripts -->
</div>
</body>
</html>