engramx 0.1.0

package/LICENSE

@@ -0,0 +1,189 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work.
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to the Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by the Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding any notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2026 Nicholas Ashkar
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,249 @@
+<p align="center">
+  <img src="assets/banner.png" alt="engram — AI coding memory" width="100%">
+</p>
+
+<p align="center">
+  <a href="#install"><strong>Install</strong></a> ·
+  <a href="#usage"><strong>Usage</strong></a> ·
+  <a href="#mcp-server"><strong>MCP Server</strong></a> ·
+  <a href="#how-it-works"><strong>How It Works</strong></a> ·
+  <a href="#contributing"><strong>Contributing</strong></a>
+</p>
+
+<p align="center">
+  <a href="https://github.com/NickCirv/engram/actions"><img src="https://github.com/NickCirv/engram/actions/workflows/ci.yml/badge.svg" alt="CI"></a>
+  <img src="https://img.shields.io/badge/license-Apache%202.0-blue" alt="License">
+  <img src="https://img.shields.io/badge/node-%3E%3D20-brightgreen" alt="Node">
+  <img src="https://img.shields.io/badge/tests-63%20passing-brightgreen" alt="Tests">
+  <img src="https://img.shields.io/badge/LLM%20cost-$0-green" alt="Zero LLM cost">
+  <img src="https://img.shields.io/badge/native%20deps-zero-green" alt="Zero native deps">
+</p>
+
+---
+
+**Your AI coding assistant forgets everything. We fixed that.**
+
+engram gives AI coding tools persistent memory. One command scans your codebase, builds a knowledge graph, and makes every session start where the last one left off.
+
+Zero LLM cost. Zero cloud. Works with Claude Code, Cursor, Codex, aider, and any MCP client.
+
+```bash
+npx engram init
+```
+
+```
+🔍 Scanning codebase...
+🌳 AST extraction complete (42ms, 0 tokens used)
+   60 nodes, 96 edges from 14 files (2,155 lines)
+
+📊 Token savings: 11x fewer tokens vs relevant files
+   Full corpus: ~15,445 tokens | Graph query: ~285 tokens
+
+✅ Ready. Your AI now has persistent memory.
+```
+
+## Why
+
+Every AI coding session starts from zero. Claude Code re-reads your files. Cursor reindexes. Copilot has no memory. CLAUDE.md is a sticky note you write by hand.
+
+engram fixes this with three things no other tool combines:
+
+1. **Persistent knowledge graph** — survives across sessions, stored in `.engram/graph.db`
+2. **Learns from every session** — decisions, patterns, mistakes are extracted and remembered
+3. **Universal protocol** — MCP server + CLI + auto-generates CLAUDE.md, .cursorrules, AGENTS.md
+
+## Install
+
+```bash
+npx engram-ai init
+```
+
+Or install globally:
+
+```bash
+npm install -g engram-ai
+engram init
+```
+
+Requires Node.js 20+. Zero native dependencies. No build tools needed.
+
+## Usage
+
+```bash
+engram init [path]              # Scan codebase, build knowledge graph
+engram query "how does auth"    # Query the graph (BFS, token-budgeted)
+engram query "auth" --dfs       # DFS traversal (trace specific paths)
+engram gods                     # Show most connected entities
+engram stats                    # Node/edge counts, token savings
+engram bench                    # Token reduction benchmark
+engram path "auth" "database"   # Shortest path between concepts
+engram learn "chose JWT..."     # Teach a decision or pattern
+engram gen                      # Generate CLAUDE.md section from graph
+engram hooks install            # Auto-rebuild on git commit
+```
+
+## How It Works
+
+engram runs three miners on your codebase. None of them use an LLM.
+
+**AST Miner** — Extracts code structure (classes, functions, imports, exports, call patterns) using pattern matching across 10 languages: TypeScript, JavaScript, Python, Go, Rust, Java, C, C++, Ruby, PHP. Zero tokens, deterministic, cached.
+
+**Git Miner** — Reads `git log` for co-change patterns (files that change together), hot files (most frequently modified), and authorship. Creates INFERRED edges between structurally coupled files.
+
+**Session Miner** — Scans CLAUDE.md, .cursorrules, AGENTS.md, and `.engram/sessions/` for decisions, patterns, and mistakes your team has documented. Stores these as queryable graph nodes.
+
+Results are stored in a local SQLite database (`.engram/graph.db`) and queryable via CLI, MCP server, or programmatic API.
+
+## MCP Server
+
+Connect engram to Claude Code, Windsurf, or any MCP client:
+
+```json
+{
+  "mcpServers": {
+    "engram": {
+      "command": "npx",
+      "args": ["-y", "engram-ai", "serve", "/path/to/your/project"]
+    }
+  }
+}
+```
+
+Or if installed globally:
+
+```json
+{
+  "mcpServers": {
+    "engram": {
+      "command": "engram-serve",
+      "args": ["/path/to/your/project"]
+    }
+  }
+}
+```
+
+**MCP Tools:**
+- `query_graph` — Search the knowledge graph with natural language
+- `god_nodes` — Core abstractions (most connected entities)
+- `graph_stats` — Node/edge counts, confidence breakdown
+- `shortest_path` — Trace connections between two concepts
+- `benchmark` — Token reduction measurement
+
+## Auto-Generated AI Instructions
+
+After building a graph, run:
+
+```bash
+engram gen                    # Auto-detect CLAUDE.md / .cursorrules / AGENTS.md
+engram gen --target claude    # Write to CLAUDE.md
+engram gen --target cursor    # Write to .cursorrules
+engram gen --target agents    # Write to AGENTS.md
+```
+
+This writes a structured codebase summary — god nodes, file structure, key dependencies, decisions — so your AI assistant navigates by structure instead of grepping.
+
+## How engram Compares
+
+| | engram | Mem0 | Graphify | aider repo-map | CLAUDE.md |
+|---|---|---|---|---|---|
+| **Code structure** | AST extraction (10 langs) | No | Yes (tree-sitter) | Yes (tree-sitter) | No |
+| **Persistent memory** | SQLite graph, survives sessions | Yes (vector + graph) | Static snapshot | Per-session only | Manual text file |
+| **Session learning** | Mines decisions, patterns, mistakes | Generic facts | No | No | You write it by hand |
+| **Universal** | MCP + CLI + auto-gen | API only | Claude Code only | aider only | Claude Code only |
+| **LLM cost** | $0 | $0 (self-host) / paid cloud | Tokens for docs/images | Per-session | $0 |
+| **Code-specific** | Built for codebases | Generic AI memory | Yes | Yes | No |
+| **Temporal** | Git history mining | No | No | No | No |
+
+**The gap nobody fills:** Code-structural understanding + persistent cross-session learning + temporal awareness + works with every AI tool. engram is the first to combine all four.
+
+## Confidence System
+
+Every relationship in the graph is tagged:
+
+| Tag | Meaning | Score |
+|-----|---------|-------|
+| **EXTRACTED** | Found directly in source code (import, function definition) | 1.0 |
+| **INFERRED** | Reasoned from patterns (git co-changes, session decisions) | 0.4-0.9 |
+| **AMBIGUOUS** | Uncertain, flagged for review | 0.1-0.3 |
+
+You always know what was found vs guessed.
+
+## Token Savings
+
+engram reports two honest baselines:
+
+- **vs relevant files** — compared to reading only the files that match your query. This is the fair comparison. Typical: **3-11x** fewer tokens.
+- **vs full corpus** — compared to sending your entire codebase. This is the worst case you're avoiding. Typical: **30-400x** fewer tokens.
+
+Both are reported transparently. No inflated claims.
+
+## Git Hooks
+
+Auto-rebuild the graph on every commit:
+
+```bash
+engram hooks install     # Install post-commit + post-checkout hooks
+engram hooks status      # Check installation
+engram hooks uninstall   # Remove hooks
+```
+
+Code changes trigger an instant AST rebuild (no LLM, <50ms). The graph stays fresh without manual re-runs.
+
+## Programmatic API
+
+```typescript
+import { init, query, godNodes, stats } from "engram";
+
+// Build the graph
+const result = await init("./my-project");
+console.log(`${result.nodes} nodes, ${result.edges} edges`);
+
+// Query it
+const answer = await query("./my-project", "how does auth work");
+console.log(answer.text);
+
+// Get god nodes
+const gods = await godNodes("./my-project");
+for (const g of gods) {
+  console.log(`${g.label} — ${g.degree} connections`);
+}
+```
+
+## Architecture
+
+```
+src/
+├── cli.ts                 CLI entry point
+├── core.ts                API surface (init, query, stats, learn)
+├── serve.ts               MCP server (5 tools, JSON-RPC stdio)
+├── hooks.ts               Git hook install/uninstall
+├── autogen.ts             CLAUDE.md / .cursorrules generation
+├── graph/
+│   ├── schema.ts          Types: nodes, edges, confidence
+│   ├── store.ts           SQLite persistence (sql.js, zero native deps)
+│   └── query.ts           BFS/DFS traversal, shortest path
+├── miners/
+│   ├── ast-miner.ts       Code structure extraction (10 languages)
+│   ├── git-miner.ts       Change patterns from git history
+│   └── session-miner.ts   Decisions/patterns from AI session docs
+└── intelligence/
+    └── token-tracker.ts   Cumulative token savings measurement
+```
+
+## Supported Languages
+
+TypeScript, JavaScript, Python, Go, Rust, Java, C, C++, Ruby, PHP.
+
+Tree-sitter WASM integration (20+ languages with full call-graph precision) is planned for v0.2.
+
+## Privacy
+
+Everything runs locally. No data leaves your machine. No telemetry. No cloud. The only network call is `npm install`.
+
+## License
+
+Apache 2.0
+
+## Contributing
+
+Issues and PRs welcome. Run `engram init` on a real codebase and share what it got right and wrong.