ildan-memforge 0.3.1__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- ildan_memforge-0.3.1/LICENSE +202 -0
- ildan_memforge-0.3.1/PKG-INFO +175 -0
- ildan_memforge-0.3.1/README.md +155 -0
- ildan_memforge-0.3.1/pyproject.toml +54 -0
- ildan_memforge-0.3.1/setup.cfg +4 -0
- ildan_memforge-0.3.1/src/ildan_memforge.egg-info/PKG-INFO +175 -0
- ildan_memforge-0.3.1/src/ildan_memforge.egg-info/SOURCES.txt +36 -0
- ildan_memforge-0.3.1/src/ildan_memforge.egg-info/dependency_links.txt +1 -0
- ildan_memforge-0.3.1/src/ildan_memforge.egg-info/entry_points.txt +16 -0
- ildan_memforge-0.3.1/src/ildan_memforge.egg-info/requires.txt +9 -0
- ildan_memforge-0.3.1/src/ildan_memforge.egg-info/top_level.txt +1 -0
- ildan_memforge-0.3.1/src/memforge/__init__.py +26 -0
- ildan_memforge-0.3.1/src/memforge/cli/__init__.py +7 -0
- ildan_memforge-0.3.1/src/memforge/cli/agents_md_gen.py +407 -0
- ildan_memforge-0.3.1/src/memforge/cli/audit.py +408 -0
- ildan_memforge-0.3.1/src/memforge/cli/audit_deep.py +275 -0
- ildan_memforge-0.3.1/src/memforge/cli/audit_log.py +368 -0
- ildan_memforge-0.3.1/src/memforge/cli/cluster_suggest.py +325 -0
- ildan_memforge-0.3.1/src/memforge/cli/dedup.py +281 -0
- ildan_memforge-0.3.1/src/memforge/cli/dlp_scan.py +347 -0
- ildan_memforge-0.3.1/src/memforge/cli/frontmatter_backfill.py +326 -0
- ildan_memforge-0.3.1/src/memforge/cli/index_gen.py +426 -0
- ildan_memforge-0.3.1/src/memforge/cli/link_rewriter.py +531 -0
- ildan_memforge-0.3.1/src/memforge/cli/preamble_extract.py +162 -0
- ildan_memforge-0.3.1/src/memforge/cli/promote.py +192 -0
- ildan_memforge-0.3.1/src/memforge/cli/query.py +248 -0
- ildan_memforge-0.3.1/src/memforge/cli/rollup.py +338 -0
- ildan_memforge-0.3.1/src/memforge/cli/watch.py +198 -0
- ildan_memforge-0.3.1/src/memforge/discovery.py +50 -0
- ildan_memforge-0.3.1/src/memforge/frontmatter.py +100 -0
- ildan_memforge-0.3.1/src/memforge/models.py +58 -0
- ildan_memforge-0.3.1/src/memforge/paths.py +25 -0
- ildan_memforge-0.3.1/tests/test_audit_log.py +158 -0
- ildan_memforge-0.3.1/tests/test_discovery.py +106 -0
- ildan_memforge-0.3.1/tests/test_frontmatter.py +179 -0
- ildan_memforge-0.3.1/tests/test_memory_dedup.py +171 -0
- ildan_memforge-0.3.1/tests/test_models.py +75 -0
- ildan_memforge-0.3.1/tests/test_paths.py +41 -0
|
@@ -0,0 +1,202 @@
|
|
|
1
|
+
|
|
2
|
+
Apache License
|
|
3
|
+
Version 2.0, January 2004
|
|
4
|
+
http://www.apache.org/licenses/
|
|
5
|
+
|
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
7
|
+
|
|
8
|
+
1. Definitions.
|
|
9
|
+
|
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
12
|
+
|
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
14
|
+
the copyright owner that is granting the License.
|
|
15
|
+
|
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
17
|
+
other entities that control, are controlled by, or are under common
|
|
18
|
+
control with that entity. For the purposes of this definition,
|
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
20
|
+
direction or management of such entity, whether by contract or
|
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
23
|
+
|
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
25
|
+
exercising permissions granted by this License.
|
|
26
|
+
|
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
28
|
+
including but not limited to software source code, documentation
|
|
29
|
+
source, and configuration files.
|
|
30
|
+
|
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
|
32
|
+
transformation or translation of a Source form, including but
|
|
33
|
+
not limited to compiled object code, generated documentation,
|
|
34
|
+
and conversions to other media types.
|
|
35
|
+
|
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
37
|
+
Object form, made available under the License, as indicated by a
|
|
38
|
+
copyright notice that is included in or attached to the work
|
|
39
|
+
(an example is provided in the Appendix below).
|
|
40
|
+
|
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
+
the Work and Derivative Works thereof.
|
|
48
|
+
|
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
|
50
|
+
the original version of the Work and any modifications or additions
|
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
62
|
+
|
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
65
|
+
subsequently incorporated within the Work.
|
|
66
|
+
|
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
|
73
|
+
|
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
+
where such license applies only to those patent claims licensable
|
|
80
|
+
by such Contributor that are necessarily infringed by their
|
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
+
institute patent litigation against any entity (including a
|
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
+
or contributory patent infringement, then any patent licenses
|
|
87
|
+
granted to You under this License for that Work shall terminate
|
|
88
|
+
as of the date such litigation is filed.
|
|
89
|
+
|
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
+
modifications, and in Source or Object form, provided that You
|
|
93
|
+
meet the following conditions:
|
|
94
|
+
|
|
95
|
+
(a) You must give any other recipients of the Work or
|
|
96
|
+
Derivative Works a copy of this License; and
|
|
97
|
+
|
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
|
99
|
+
stating that You changed the files; and
|
|
100
|
+
|
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
|
103
|
+
attribution notices from the Source form of the Work,
|
|
104
|
+
excluding those notices that do not pertain to any part of
|
|
105
|
+
the Derivative Works; and
|
|
106
|
+
|
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
|
109
|
+
include a readable copy of the attribution notices contained
|
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
|
112
|
+
of the following places: within a NOTICE text file distributed
|
|
113
|
+
as part of the Derivative Works; within the Source form or
|
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
|
115
|
+
within a display generated by the Derivative Works, if and
|
|
116
|
+
wherever such third-party notices normally appear. The contents
|
|
117
|
+
of the NOTICE file are for informational purposes only and
|
|
118
|
+
do not modify the License. You may add Your own attribution
|
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
+
that such additional attribution notices cannot be construed
|
|
122
|
+
as modifying the License.
|
|
123
|
+
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
125
|
+
may provide additional or different license terms and conditions
|
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
+
the conditions stated in this License.
|
|
130
|
+
|
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
+
this License, without any additional terms or conditions.
|
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
+
the terms of any separate license agreement you may have executed
|
|
137
|
+
with Licensor regarding such Contributions.
|
|
138
|
+
|
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
+
except as required for reasonable and customary use in describing the
|
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
+
|
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
|
153
|
+
|
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
|
159
|
+
incidental, or consequential damages of any character arising as a
|
|
160
|
+
result of this License or out of the use or inability to use the
|
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
+
other commercial damages or losses), even if such Contributor
|
|
164
|
+
has been advised of the possibility of such damages.
|
|
165
|
+
|
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
+
or other liability obligations and/or rights consistent with this
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
|
176
|
+
|
|
177
|
+
END OF TERMS AND CONDITIONS
|
|
178
|
+
|
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
180
|
+
|
|
181
|
+
To apply the Apache License to your work, attach the following
|
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
183
|
+
replaced with your own identifying information. (Don't include
|
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
185
|
+
comment syntax for the file format. We also recommend that a
|
|
186
|
+
file or class name and description of purpose be included on the
|
|
187
|
+
same "printed page" as the copyright notice for easier
|
|
188
|
+
identification within third-party archives.
|
|
189
|
+
|
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
|
191
|
+
|
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
193
|
+
you may not use this file except in compliance with the License.
|
|
194
|
+
You may obtain a copy of the License at
|
|
195
|
+
|
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
197
|
+
|
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
201
|
+
See the License for the specific language governing permissions and
|
|
202
|
+
limitations under the License.
|
|
@@ -0,0 +1,175 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: ildan-memforge
|
|
3
|
+
Version: 0.3.1
|
|
4
|
+
Summary: MemForge: portable, agent-neutral persistent memory for coding agents (ILDAN).
|
|
5
|
+
Author: ILDAN
|
|
6
|
+
License: Apache-2.0
|
|
7
|
+
Project-URL: Homepage, https://github.com/ildan-ai/memforge
|
|
8
|
+
Project-URL: Issues, https://github.com/ildan-ai/memforge/issues
|
|
9
|
+
Requires-Python: >=3.10
|
|
10
|
+
Description-Content-Type: text/markdown
|
|
11
|
+
License-File: LICENSE
|
|
12
|
+
Requires-Dist: PyYAML>=6.0
|
|
13
|
+
Requires-Dist: watchdog>=4.0
|
|
14
|
+
Provides-Extra: dlp
|
|
15
|
+
Requires-Dist: detect-secrets>=1.5; extra == "dlp"
|
|
16
|
+
Provides-Extra: dev
|
|
17
|
+
Requires-Dist: pytest>=8; extra == "dev"
|
|
18
|
+
Requires-Dist: pip-audit>=2.7; extra == "dev"
|
|
19
|
+
Dynamic: license-file
|
|
20
|
+
|
|
21
|
+
# MemForge
|
|
22
|
+
|
|
23
|
+
**Typed, git-native, dynamic memory for coding agents.** A markdown folder + a small spec + reference tooling. Works across Claude Code, Cursor, Aider, Codex, and GitHub Copilot Chat through thin adapters.
|
|
24
|
+
|
|
25
|
+
> **Status: pre-1.0; external PRs paused.** Issues and Discussions are open. External pull requests are paused until the Contributor License Agreement infrastructure lands; the CLA flow will land in a v0.3.x patch release. See [CONTRIBUTING.md](./CONTRIBUTING.md). Security reports go through the private channel in [SECURITY.md](./SECURITY.md).
|
|
26
|
+
|
|
27
|
+
## The gap MemForge fills
|
|
28
|
+
|
|
29
|
+
Coding agents have static instruction surfaces (AGENTS.md, `.cursorrules`, `CONVENTIONS.md`, `.github/copilot-instructions.md`, Claude Code's auto-memory) for things you want the agent to read at the start of every session. They handle the "always-true" half well.
|
|
30
|
+
|
|
31
|
+
What they don't handle: the **changing** half. The fact that you decided to use `bun` not `npm` last Tuesday. The reason you rejected the obvious database schema. The post-incident rule about not mocking the staging API. The seven things you've told four different agents the same way and are tired of repeating.
|
|
32
|
+
|
|
33
|
+
That state belongs in *memory*: typed entries that the agent can read, write, audit, and version-control alongside the code. MemForge is the format for that memory and a small set of tools that keep it healthy.
|
|
34
|
+
|
|
35
|
+
## What you get
|
|
36
|
+
|
|
37
|
+
- **A folder of markdown files** with YAML frontmatter. Hand-editable, diffable, code-reviewable.
|
|
38
|
+
- **Four memory types:** `user` (facts about the developer), `feedback` (rules they have given), `project` (state about ongoing work), `reference` (pointers to external systems).
|
|
39
|
+
- **A `MEMORY.md` index** any agent loads at session start.
|
|
40
|
+
- **Rollup subfolders** for topic clusters of five or more memories, so the index stays scannable.
|
|
41
|
+
- **Audit + integrity tooling** that runs in CI: schema checks, link integrity, DLP scan, tamper-evident audit log.
|
|
42
|
+
- **Adapters** for Claude Code, Cursor, Aider, OpenAI Codex, and GitHub Copilot Chat (VS Code).
|
|
43
|
+
|
|
44
|
+
## 60-second install
|
|
45
|
+
|
|
46
|
+
```bash
|
|
47
|
+
pip install memforge # publish target; not yet on PyPI as of v0.3.0
|
|
48
|
+
# Or, until then:
|
|
49
|
+
pip install git+https://github.com/ildan-ai/memforge.git
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
Pick a folder for your memory. The defaults the tooling assumes:
|
|
53
|
+
|
|
54
|
+
```
|
|
55
|
+
~/.claude/global-memory/ # cross-project rules
|
|
56
|
+
~/.claude/projects/<USER>-claude-projects/memory/ # per-cwd state
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
Other layouts work too; the tooling takes a `--path` argument everywhere.
|
|
60
|
+
|
|
61
|
+
## A memory file, end-to-end
|
|
62
|
+
|
|
63
|
+
```markdown
|
|
64
|
+
---
|
|
65
|
+
name: Use bun, not npm
|
|
66
|
+
description: Bun is the package manager for this monorepo
|
|
67
|
+
type: feedback
|
|
68
|
+
tags: [topic:tooling, topic:javascript]
|
|
69
|
+
status: active
|
|
70
|
+
created: 2026-04-12
|
|
71
|
+
---
|
|
72
|
+
|
|
73
|
+
When installing or running scripts in this repo, use `bun` and `bunx`. Lockfile is `bun.lockb`.
|
|
74
|
+
|
|
75
|
+
**Why:** the workspace setup at `apps/web/package.json` relies on bun's workspace resolver; npm pulls a slightly different dependency tree and the build fails downstream.
|
|
76
|
+
|
|
77
|
+
**How to apply:** any time you reach for `npm install`, `npx`, or a `package-lock.json`, stop and use bun instead. If a script in the README still says `npm run`, treat that as a docs bug, not a directive.
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
That file is the unit. Every tool, every adapter, every check operates on files of exactly this shape.
|
|
81
|
+
|
|
82
|
+
## When MemForge is the right tool
|
|
83
|
+
|
|
84
|
+
- You move between coding agents and want them to share the same notes.
|
|
85
|
+
- You want memory entries reviewable in pull requests, like code.
|
|
86
|
+
- You want the operator to *see* what the agent has written about them and edit it freely.
|
|
87
|
+
- You want CI gates on memory hygiene (broken links, secret leakage, schema drift).
|
|
88
|
+
|
|
89
|
+
## When it is not
|
|
90
|
+
|
|
91
|
+
- **Not a vector database.** No embeddings, no similarity search at runtime. Use `mem0` or `letta` if that is the shape you need.
|
|
92
|
+
- **Not a secrets store.** The DLP scanner refuses files that look like they leak credentials, but the format is human-readable plain text. Keep secrets in a vault.
|
|
93
|
+
- **Not a runtime memory layer.** MemForge is the *file format and the discipline*, not a service. Adapters load files into agent context at session start; nothing runs continuously.
|
|
94
|
+
- **Not a replacement for AGENTS.md.** AGENTS.md is the README for agents (static, repo-level, project setup). MemForge is the working notebook (dynamic, evolving, often per-developer). They coexist.
|
|
95
|
+
|
|
96
|
+
## How it compares
|
|
97
|
+
|
|
98
|
+
| | **MemForge** | mem0 | letta | `.cursorrules` / `AGENTS.md` |
|
|
99
|
+
|---|---|---|---|---|
|
|
100
|
+
| Storage | Markdown files in git | Hosted vector store | Hosted agent state | Single text file |
|
|
101
|
+
| Typed entries | Yes (4 types + status) | No | Partial | No |
|
|
102
|
+
| Cross-agent | Yes (adapters) | Per-SDK | Per-SDK | Per-agent |
|
|
103
|
+
| Reviewable in PRs | Yes (diff = the file) | No (opaque store) | No | Yes |
|
|
104
|
+
| Runtime cost | Zero (load at session start) | Per-query embedding cost | Per-query | Zero |
|
|
105
|
+
| Best for | Long-lived rules + decisions | Conversational recall | Stateful agent loops | Project-level setup |
|
|
106
|
+
|
|
107
|
+
The honest summary: if your agent is a long-running service that needs to remember a thousand things from yesterday's chat, you want a vector store. If your agent is a coding session that needs to remember the rules and decisions a human cares about across sessions, you want MemForge.
|
|
108
|
+
|
|
109
|
+
## Architecture
|
|
110
|
+
|
|
111
|
+
```mermaid
|
|
112
|
+
flowchart LR
|
|
113
|
+
Dev[Developer] -->|edits| Folder[Memory folder<br/>markdown + YAML]
|
|
114
|
+
Folder -->|read at session start| AdapterCC[Claude Code adapter]
|
|
115
|
+
Folder -->|read at session start| AdapterCursor[Cursor adapter]
|
|
116
|
+
Folder -->|read at session start| AdapterAider[Aider adapter]
|
|
117
|
+
Folder -->|read at session start| AdapterCodex[Codex adapter]
|
|
118
|
+
Folder -->|read at session start| AdapterCopilot[Copilot Chat adapter]
|
|
119
|
+
AdapterCC --> Agent1[Claude Code]
|
|
120
|
+
AdapterCursor --> Agent2[Cursor]
|
|
121
|
+
AdapterAider --> Agent3[Aider]
|
|
122
|
+
AdapterCodex --> Agent4[OpenAI Codex]
|
|
123
|
+
AdapterCopilot --> Agent5[GitHub Copilot Chat]
|
|
124
|
+
Folder -->|CI gate| Tools[memory-audit<br/>memory-dlp-scan<br/>memory-link-rewriter<br/>memory-audit-log]
|
|
125
|
+
Tools -->|fail PR on violation| GH[GitHub Actions]
|
|
126
|
+
Folder -->|append-only| ChainLog[(.memforge-audit-log.jsonl<br/>tamper-evident chain)]
|
|
127
|
+
```
|
|
128
|
+
|
|
129
|
+
Adapters are thin: they translate "load this folder at session start" into the agent's native rules surface. Adding an agent means writing a new adapter, not changing the format.
|
|
130
|
+
|
|
131
|
+
## Key tools
|
|
132
|
+
|
|
133
|
+
Run `--help` on any of them.
|
|
134
|
+
|
|
135
|
+
| Tool | What it does |
|
|
136
|
+
|---|---|
|
|
137
|
+
| `memory-audit` | Schema + integrity check. Pass `--strict` in CI. |
|
|
138
|
+
| `memory-audit-deep` | Recursive audit: UID uniqueness, taxonomy membership, supersedes resolution, link integrity. |
|
|
139
|
+
| `memory-index-gen` | Build `MEMORY.md` from frontmatter as a CI artifact. RBAC-aware filtering for shared folders. |
|
|
140
|
+
| `memory-cluster-suggest` | Suggest rollup subfolders when a topic accumulates five or more memories. |
|
|
141
|
+
| `memory-dlp-scan` | Pre-commit scanner for secrets, credentials, and PII in memory bodies. |
|
|
142
|
+
| `memory-link-rewriter` | UID-based cross-folder link integrity (`check`, `rename`, `rename-batch`, `upgrade`). |
|
|
143
|
+
| `memory-audit-log` | Append-only tamper-evident hash chain. JSONL on disk, exports CEF for SIEM. |
|
|
144
|
+
| `memory-dedup` | LLM-backed near-duplicate detection. Local-only by default; reports candidates, never writes. |
|
|
145
|
+
| `memory-rollup` | Bulk-move primitive: create / undo / list. Maintains an undo ledger. |
|
|
146
|
+
| `memory-query` | Filter memories by topic, type, tag, status, owner, date range, or text. |
|
|
147
|
+
| `memory-watch` | Filesystem watcher (Linux + macOS via watchdog). |
|
|
148
|
+
| `memory-promote` | Move a memory between folders with index fixup. |
|
|
149
|
+
|
|
150
|
+
The `tools/README.md` has the long-form reference.
|
|
151
|
+
|
|
152
|
+
## Spec
|
|
153
|
+
|
|
154
|
+
Format invariants are in [`spec/SPEC.md`](./spec/SPEC.md). Topic taxonomy is in [`spec/taxonomy.yaml`](./spec/taxonomy.yaml). The current package version is in `pyproject.toml`; the on-disk format version is in [`spec/VERSION`](./spec/VERSION). They track separately on purpose: a tooling release does not always shift the format, and a format bump is a deliberate event.
|
|
155
|
+
|
|
156
|
+
## Status
|
|
157
|
+
|
|
158
|
+
| Version | Date | Headline |
|
|
159
|
+
|---|---|---|
|
|
160
|
+
| v0.1.0 | 2026-04-19 | First spec release. |
|
|
161
|
+
| v0.2.0 | | Sensitivity classification (4 levels) + consumer obligations. |
|
|
162
|
+
| v0.3.0 | 2026-05-07 | Schema expansion (uid, tier, tags, owner, last_reviewed, status), rollup-with-subfolder formalization, access labels, controlled topic taxonomy, full Phase 1 tooling, audit log, DLP scan. |
|
|
163
|
+
| v0.4.0 | planned | Make `uid`, `tier`, `tags`, `owner`, `status`, `created` required (breaking). |
|
|
164
|
+
|
|
165
|
+
The reference implementation is running in production. External adoption is welcome once the CLA flow is live.
|
|
166
|
+
|
|
167
|
+
## License
|
|
168
|
+
|
|
169
|
+
Apache-2.0. See [`LICENSE`](./LICENSE).
|
|
170
|
+
|
|
171
|
+
The "MemForge" name and logo are subject to pending trademark filings; the Apache-2.0 grant does not cover the marks. A trademark policy will land alongside the v0.3.x CLA release.
|
|
172
|
+
|
|
173
|
+
## Contributing
|
|
174
|
+
|
|
175
|
+
External pull requests are paused. Issues and Discussions are open. See [CONTRIBUTING.md](./CONTRIBUTING.md) for the current model and the post-CLA contributor flow.
|
|
@@ -0,0 +1,155 @@
|
|
|
1
|
+
# MemForge
|
|
2
|
+
|
|
3
|
+
**Typed, git-native, dynamic memory for coding agents.** A markdown folder + a small spec + reference tooling. Works across Claude Code, Cursor, Aider, Codex, and GitHub Copilot Chat through thin adapters.
|
|
4
|
+
|
|
5
|
+
> **Status: pre-1.0; external PRs paused.** Issues and Discussions are open. External pull requests are paused until the Contributor License Agreement infrastructure lands; the CLA flow will land in a v0.3.x patch release. See [CONTRIBUTING.md](./CONTRIBUTING.md). Security reports go through the private channel in [SECURITY.md](./SECURITY.md).
|
|
6
|
+
|
|
7
|
+
## The gap MemForge fills
|
|
8
|
+
|
|
9
|
+
Coding agents have static instruction surfaces (AGENTS.md, `.cursorrules`, `CONVENTIONS.md`, `.github/copilot-instructions.md`, Claude Code's auto-memory) for things you want the agent to read at the start of every session. They handle the "always-true" half well.
|
|
10
|
+
|
|
11
|
+
What they don't handle: the **changing** half. The fact that you decided to use `bun` not `npm` last Tuesday. The reason you rejected the obvious database schema. The post-incident rule about not mocking the staging API. The seven things you've told four different agents the same way and are tired of repeating.
|
|
12
|
+
|
|
13
|
+
That state belongs in *memory*: typed entries that the agent can read, write, audit, and version-control alongside the code. MemForge is the format for that memory and a small set of tools that keep it healthy.
|
|
14
|
+
|
|
15
|
+
## What you get
|
|
16
|
+
|
|
17
|
+
- **A folder of markdown files** with YAML frontmatter. Hand-editable, diffable, code-reviewable.
|
|
18
|
+
- **Four memory types:** `user` (facts about the developer), `feedback` (rules they have given), `project` (state about ongoing work), `reference` (pointers to external systems).
|
|
19
|
+
- **A `MEMORY.md` index** any agent loads at session start.
|
|
20
|
+
- **Rollup subfolders** for topic clusters of five or more memories, so the index stays scannable.
|
|
21
|
+
- **Audit + integrity tooling** that runs in CI: schema checks, link integrity, DLP scan, tamper-evident audit log.
|
|
22
|
+
- **Adapters** for Claude Code, Cursor, Aider, OpenAI Codex, and GitHub Copilot Chat (VS Code).
|
|
23
|
+
|
|
24
|
+
## 60-second install
|
|
25
|
+
|
|
26
|
+
```bash
|
|
27
|
+
pip install memforge # publish target; not yet on PyPI as of v0.3.0
|
|
28
|
+
# Or, until then:
|
|
29
|
+
pip install git+https://github.com/ildan-ai/memforge.git
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
Pick a folder for your memory. The defaults the tooling assumes:
|
|
33
|
+
|
|
34
|
+
```
|
|
35
|
+
~/.claude/global-memory/ # cross-project rules
|
|
36
|
+
~/.claude/projects/<USER>-claude-projects/memory/ # per-cwd state
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
Other layouts work too; the tooling takes a `--path` argument everywhere.
|
|
40
|
+
|
|
41
|
+
## A memory file, end-to-end
|
|
42
|
+
|
|
43
|
+
```markdown
|
|
44
|
+
---
|
|
45
|
+
name: Use bun, not npm
|
|
46
|
+
description: Bun is the package manager for this monorepo
|
|
47
|
+
type: feedback
|
|
48
|
+
tags: [topic:tooling, topic:javascript]
|
|
49
|
+
status: active
|
|
50
|
+
created: 2026-04-12
|
|
51
|
+
---
|
|
52
|
+
|
|
53
|
+
When installing or running scripts in this repo, use `bun` and `bunx`. Lockfile is `bun.lockb`.
|
|
54
|
+
|
|
55
|
+
**Why:** the workspace setup at `apps/web/package.json` relies on bun's workspace resolver; npm pulls a slightly different dependency tree and the build fails downstream.
|
|
56
|
+
|
|
57
|
+
**How to apply:** any time you reach for `npm install`, `npx`, or a `package-lock.json`, stop and use bun instead. If a script in the README still says `npm run`, treat that as a docs bug, not a directive.
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
That file is the unit. Every tool, every adapter, every check operates on files of exactly this shape.
|
|
61
|
+
|
|
62
|
+
## When MemForge is the right tool
|
|
63
|
+
|
|
64
|
+
- You move between coding agents and want them to share the same notes.
|
|
65
|
+
- You want memory entries reviewable in pull requests, like code.
|
|
66
|
+
- You want the operator to *see* what the agent has written about them and edit it freely.
|
|
67
|
+
- You want CI gates on memory hygiene (broken links, secret leakage, schema drift).
|
|
68
|
+
|
|
69
|
+
## When it is not
|
|
70
|
+
|
|
71
|
+
- **Not a vector database.** No embeddings, no similarity search at runtime. Use `mem0` or `letta` if that is the shape you need.
|
|
72
|
+
- **Not a secrets store.** The DLP scanner refuses files that look like they leak credentials, but the format is human-readable plain text. Keep secrets in a vault.
|
|
73
|
+
- **Not a runtime memory layer.** MemForge is the *file format and the discipline*, not a service. Adapters load files into agent context at session start; nothing runs continuously.
|
|
74
|
+
- **Not a replacement for AGENTS.md.** AGENTS.md is the README for agents (static, repo-level, project setup). MemForge is the working notebook (dynamic, evolving, often per-developer). They coexist.
|
|
75
|
+
|
|
76
|
+
## How it compares
|
|
77
|
+
|
|
78
|
+
| | **MemForge** | mem0 | letta | `.cursorrules` / `AGENTS.md` |
|
|
79
|
+
|---|---|---|---|---|
|
|
80
|
+
| Storage | Markdown files in git | Hosted vector store | Hosted agent state | Single text file |
|
|
81
|
+
| Typed entries | Yes (4 types + status) | No | Partial | No |
|
|
82
|
+
| Cross-agent | Yes (adapters) | Per-SDK | Per-SDK | Per-agent |
|
|
83
|
+
| Reviewable in PRs | Yes (diff = the file) | No (opaque store) | No | Yes |
|
|
84
|
+
| Runtime cost | Zero (load at session start) | Per-query embedding cost | Per-query | Zero |
|
|
85
|
+
| Best for | Long-lived rules + decisions | Conversational recall | Stateful agent loops | Project-level setup |
|
|
86
|
+
|
|
87
|
+
The honest summary: if your agent is a long-running service that needs to remember a thousand things from yesterday's chat, you want a vector store. If your agent is a coding session that needs to remember the rules and decisions a human cares about across sessions, you want MemForge.
|
|
88
|
+
|
|
89
|
+
## Architecture
|
|
90
|
+
|
|
91
|
+
```mermaid
|
|
92
|
+
flowchart LR
|
|
93
|
+
Dev[Developer] -->|edits| Folder[Memory folder<br/>markdown + YAML]
|
|
94
|
+
Folder -->|read at session start| AdapterCC[Claude Code adapter]
|
|
95
|
+
Folder -->|read at session start| AdapterCursor[Cursor adapter]
|
|
96
|
+
Folder -->|read at session start| AdapterAider[Aider adapter]
|
|
97
|
+
Folder -->|read at session start| AdapterCodex[Codex adapter]
|
|
98
|
+
Folder -->|read at session start| AdapterCopilot[Copilot Chat adapter]
|
|
99
|
+
AdapterCC --> Agent1[Claude Code]
|
|
100
|
+
AdapterCursor --> Agent2[Cursor]
|
|
101
|
+
AdapterAider --> Agent3[Aider]
|
|
102
|
+
AdapterCodex --> Agent4[OpenAI Codex]
|
|
103
|
+
AdapterCopilot --> Agent5[GitHub Copilot Chat]
|
|
104
|
+
Folder -->|CI gate| Tools[memory-audit<br/>memory-dlp-scan<br/>memory-link-rewriter<br/>memory-audit-log]
|
|
105
|
+
Tools -->|fail PR on violation| GH[GitHub Actions]
|
|
106
|
+
Folder -->|append-only| ChainLog[(.memforge-audit-log.jsonl<br/>tamper-evident chain)]
|
|
107
|
+
```
|
|
108
|
+
|
|
109
|
+
Adapters are thin: they translate "load this folder at session start" into the agent's native rules surface. Adding an agent means writing a new adapter, not changing the format.
|
|
110
|
+
|
|
111
|
+
## Key tools
|
|
112
|
+
|
|
113
|
+
Run `--help` on any of them.
|
|
114
|
+
|
|
115
|
+
| Tool | What it does |
|
|
116
|
+
|---|---|
|
|
117
|
+
| `memory-audit` | Schema + integrity check. Pass `--strict` in CI. |
|
|
118
|
+
| `memory-audit-deep` | Recursive audit: UID uniqueness, taxonomy membership, supersedes resolution, link integrity. |
|
|
119
|
+
| `memory-index-gen` | Build `MEMORY.md` from frontmatter as a CI artifact. RBAC-aware filtering for shared folders. |
|
|
120
|
+
| `memory-cluster-suggest` | Suggest rollup subfolders when a topic accumulates five or more memories. |
|
|
121
|
+
| `memory-dlp-scan` | Pre-commit scanner for secrets, credentials, and PII in memory bodies. |
|
|
122
|
+
| `memory-link-rewriter` | UID-based cross-folder link integrity (`check`, `rename`, `rename-batch`, `upgrade`). |
|
|
123
|
+
| `memory-audit-log` | Append-only tamper-evident hash chain. JSONL on disk, exports CEF for SIEM. |
|
|
124
|
+
| `memory-dedup` | LLM-backed near-duplicate detection. Local-only by default; reports candidates, never writes. |
|
|
125
|
+
| `memory-rollup` | Bulk-move primitive: create / undo / list. Maintains an undo ledger. |
|
|
126
|
+
| `memory-query` | Filter memories by topic, type, tag, status, owner, date range, or text. |
|
|
127
|
+
| `memory-watch` | Filesystem watcher (Linux + macOS via watchdog). |
|
|
128
|
+
| `memory-promote` | Move a memory between folders with index fixup. |
|
|
129
|
+
|
|
130
|
+
The `tools/README.md` has the long-form reference.
|
|
131
|
+
|
|
132
|
+
## Spec
|
|
133
|
+
|
|
134
|
+
Format invariants are in [`spec/SPEC.md`](./spec/SPEC.md). Topic taxonomy is in [`spec/taxonomy.yaml`](./spec/taxonomy.yaml). The current package version is in `pyproject.toml`; the on-disk format version is in [`spec/VERSION`](./spec/VERSION). They track separately on purpose: a tooling release does not always shift the format, and a format bump is a deliberate event.
|
|
135
|
+
|
|
136
|
+
## Status
|
|
137
|
+
|
|
138
|
+
| Version | Date | Headline |
|
|
139
|
+
|---|---|---|
|
|
140
|
+
| v0.1.0 | 2026-04-19 | First spec release. |
|
|
141
|
+
| v0.2.0 | | Sensitivity classification (4 levels) + consumer obligations. |
|
|
142
|
+
| v0.3.0 | 2026-05-07 | Schema expansion (uid, tier, tags, owner, last_reviewed, status), rollup-with-subfolder formalization, access labels, controlled topic taxonomy, full Phase 1 tooling, audit log, DLP scan. |
|
|
143
|
+
| v0.4.0 | planned | Make `uid`, `tier`, `tags`, `owner`, `status`, `created` required (breaking). |
|
|
144
|
+
|
|
145
|
+
The reference implementation is running in production. External adoption is welcome once the CLA flow is live.
|
|
146
|
+
|
|
147
|
+
## License
|
|
148
|
+
|
|
149
|
+
Apache-2.0. See [`LICENSE`](./LICENSE).
|
|
150
|
+
|
|
151
|
+
The "MemForge" name and logo are subject to pending trademark filings; the Apache-2.0 grant does not cover the marks. A trademark policy will land alongside the v0.3.x CLA release.
|
|
152
|
+
|
|
153
|
+
## Contributing
|
|
154
|
+
|
|
155
|
+
External pull requests are paused. Issues and Discussions are open. See [CONTRIBUTING.md](./CONTRIBUTING.md) for the current model and the post-CLA contributor flow.
|
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
[build-system]
|
|
2
|
+
requires = ["setuptools>=68", "wheel"]
|
|
3
|
+
build-backend = "setuptools.build_meta"
|
|
4
|
+
|
|
5
|
+
[project]
|
|
6
|
+
name = "ildan-memforge"
|
|
7
|
+
version = "0.3.1"
|
|
8
|
+
description = "MemForge: portable, agent-neutral persistent memory for coding agents (ILDAN)."
|
|
9
|
+
readme = "README.md"
|
|
10
|
+
license = { text = "Apache-2.0" }
|
|
11
|
+
authors = [
|
|
12
|
+
{ name = "ILDAN" },
|
|
13
|
+
]
|
|
14
|
+
requires-python = ">=3.10"
|
|
15
|
+
dependencies = [
|
|
16
|
+
"PyYAML>=6.0",
|
|
17
|
+
"watchdog>=4.0",
|
|
18
|
+
]
|
|
19
|
+
|
|
20
|
+
[project.optional-dependencies]
|
|
21
|
+
dlp = [
|
|
22
|
+
"detect-secrets>=1.5",
|
|
23
|
+
]
|
|
24
|
+
dev = [
|
|
25
|
+
"pytest>=8",
|
|
26
|
+
"pip-audit>=2.7",
|
|
27
|
+
]
|
|
28
|
+
|
|
29
|
+
[project.urls]
|
|
30
|
+
Homepage = "https://github.com/ildan-ai/memforge"
|
|
31
|
+
Issues = "https://github.com/ildan-ai/memforge/issues"
|
|
32
|
+
|
|
33
|
+
[project.scripts]
|
|
34
|
+
memory-audit = "memforge.cli.audit:main"
|
|
35
|
+
memory-audit-deep = "memforge.cli.audit_deep:main"
|
|
36
|
+
memory-promote = "memforge.cli.promote:main"
|
|
37
|
+
memory-audit-log = "memforge.cli.audit_log:main"
|
|
38
|
+
memory-cluster-suggest = "memforge.cli.cluster_suggest:main"
|
|
39
|
+
memory-dedup = "memforge.cli.dedup:main"
|
|
40
|
+
memory-dlp-scan = "memforge.cli.dlp_scan:main"
|
|
41
|
+
memory-frontmatter-backfill = "memforge.cli.frontmatter_backfill:main"
|
|
42
|
+
memory-index-gen = "memforge.cli.index_gen:main"
|
|
43
|
+
memory-link-rewriter = "memforge.cli.link_rewriter:main"
|
|
44
|
+
memory-preamble-extract = "memforge.cli.preamble_extract:main"
|
|
45
|
+
memory-query = "memforge.cli.query:main"
|
|
46
|
+
memory-rollup = "memforge.cli.rollup:main"
|
|
47
|
+
memory-watch = "memforge.cli.watch:main"
|
|
48
|
+
agents-md-gen = "memforge.cli.agents_md_gen:main"
|
|
49
|
+
|
|
50
|
+
[tool.setuptools.packages.find]
|
|
51
|
+
where = ["src"]
|
|
52
|
+
|
|
53
|
+
[tool.setuptools.package-data]
|
|
54
|
+
memforge = ["py.typed"]
|