forgememo 0.1.13__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.
- forgememo-0.1.13/LICENSE +201 -0
- forgememo-0.1.13/MANIFEST.in +19 -0
- forgememo-0.1.13/PKG-INFO +163 -0
- forgememo-0.1.13/README.md +132 -0
- forgememo-0.1.13/forgememo/__init__.py +9 -0
- forgememo-0.1.13/forgememo/api.py +1042 -0
- forgememo-0.1.13/forgememo/cli.py +1455 -0
- forgememo-0.1.13/forgememo/config.py +153 -0
- forgememo-0.1.13/forgememo/core.py +611 -0
- forgememo-0.1.13/forgememo/daemon.py +112 -0
- forgememo-0.1.13/forgememo/inference.py +224 -0
- forgememo-0.1.13/forgememo/mcp_server.py +504 -0
- forgememo-0.1.13/forgememo/query_tool.py +405 -0
- forgememo-0.1.13/forgememo/scanner.py +412 -0
- forgememo-0.1.13/forgememo/skills/claude.md +79 -0
- forgememo-0.1.13/forgememo/skills/codex.json +49 -0
- forgememo-0.1.13/forgememo/skills/gemini.md +43 -0
- forgememo-0.1.13/forgememo.egg-info/PKG-INFO +163 -0
- forgememo-0.1.13/forgememo.egg-info/SOURCES.txt +23 -0
- forgememo-0.1.13/forgememo.egg-info/dependency_links.txt +1 -0
- forgememo-0.1.13/forgememo.egg-info/entry_points.txt +2 -0
- forgememo-0.1.13/forgememo.egg-info/requires.txt +7 -0
- forgememo-0.1.13/forgememo.egg-info/top_level.txt +3 -0
- forgememo-0.1.13/pyproject.toml +66 -0
- forgememo-0.1.13/setup.cfg +4 -0
forgememo-0.1.13/LICENSE
ADDED
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright [yyyy] [name of copyright owner]
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
include LICENSE
|
|
2
|
+
include README.md
|
|
3
|
+
recursive-exclude tests *
|
|
4
|
+
recursive-exclude webapp *
|
|
5
|
+
recursive-exclude server *
|
|
6
|
+
recursive-exclude e2e *
|
|
7
|
+
recursive-exclude docs *
|
|
8
|
+
recursive-exclude .gstack *
|
|
9
|
+
recursive-exclude .playwright-mcp *
|
|
10
|
+
global-exclude *.sh
|
|
11
|
+
global-exclude *.pyc
|
|
12
|
+
global-exclude __pycache__
|
|
13
|
+
global-exclude .gitignore
|
|
14
|
+
global-exclude .ruff_cache
|
|
15
|
+
global-exclude .env*
|
|
16
|
+
global-exclude *.pem
|
|
17
|
+
global-exclude *.key
|
|
18
|
+
global-exclude *secrets*
|
|
19
|
+
global-exclude md_scan_hashes.json
|
|
@@ -0,0 +1,163 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: forgememo
|
|
3
|
+
Version: 0.1.13
|
|
4
|
+
Summary: Persistent memory for AI agents — cross-session context that actually sticks
|
|
5
|
+
Author: Forgemem Contributors
|
|
6
|
+
License-Expression: Apache-2.0
|
|
7
|
+
Project-URL: Homepage, https://github.com/intelogroup/forgememo
|
|
8
|
+
Project-URL: Documentation, https://github.com/intelogroup/forgememo#readme
|
|
9
|
+
Project-URL: Bug Tracker, https://github.com/intelogroup/forgememo/issues
|
|
10
|
+
Keywords: mcp,ai,memory,claude,llm,agents,cli
|
|
11
|
+
Classifier: Development Status :: 3 - Alpha
|
|
12
|
+
Classifier: Environment :: Console
|
|
13
|
+
Classifier: Intended Audience :: Developers
|
|
14
|
+
Classifier: Programming Language :: Python :: 3
|
|
15
|
+
Classifier: Programming Language :: Python :: 3.10
|
|
16
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
17
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
18
|
+
Classifier: Topic :: Software Development :: Libraries :: Python Modules
|
|
19
|
+
Classifier: Topic :: Utilities
|
|
20
|
+
Requires-Python: >=3.10
|
|
21
|
+
Description-Content-Type: text/markdown
|
|
22
|
+
License-File: LICENSE
|
|
23
|
+
Requires-Dist: anthropic>=0.28.0
|
|
24
|
+
Requires-Dist: fastmcp>=2.0.0
|
|
25
|
+
Requires-Dist: flask>=2.3.0
|
|
26
|
+
Requires-Dist: requests>=2.31.0
|
|
27
|
+
Requires-Dist: typer>=0.12.0
|
|
28
|
+
Requires-Dist: rich>=13.0.0
|
|
29
|
+
Requires-Dist: questionary>=2.0.0
|
|
30
|
+
Dynamic: license-file
|
|
31
|
+
|
|
32
|
+
# Forgemem
|
|
33
|
+
|
|
34
|
+
**Persistent long-term memory for AI agents — cross-session context that actually sticks.**
|
|
35
|
+
|
|
36
|
+
[](https://pypi.org/project/forgemem/)
|
|
37
|
+
[](https://pypi.org/project/forgemem/)
|
|
38
|
+
[](LICENSE)
|
|
39
|
+
|
|
40
|
+
Forgemem mines your git history, session traces, and project notes to extract what actually happened — failures, successes, plans, and hard-won lessons. It stores them locally in SQLite and exposes them to AI agents via MCP so they start every session informed instead of blind.
|
|
41
|
+
|
|
42
|
+
---
|
|
43
|
+
|
|
44
|
+
## The Problem
|
|
45
|
+
|
|
46
|
+
Every new agent session starts from zero. It doesn't know you already tried the Zod 4 schema approach and it broke. It doesn't know that wildcard CORS killed auth in production last quarter. It doesn't know which approach you abandoned and why.
|
|
47
|
+
|
|
48
|
+
Without Forgemem, agents repeat your mistakes. With it, they skip straight to what works.
|
|
49
|
+
|
|
50
|
+
---
|
|
51
|
+
|
|
52
|
+
## Installation
|
|
53
|
+
|
|
54
|
+
```bash
|
|
55
|
+
pip install forgemem
|
|
56
|
+
forgemem init
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
`forgemem init` now requires a real TTY on first run so the user must choose an inference provider interactively. Agents cannot bypass that step with `--yes` or a piped session. After `init` completes, it auto-starts the MCP server; then **restart your AI agent** (Claude Code, Gemini CLI, or Codex) to pick up the new MCP connection.
|
|
60
|
+
|
|
61
|
+
---
|
|
62
|
+
|
|
63
|
+
## How It Works
|
|
64
|
+
|
|
65
|
+
1. **Mine** — scans git repos and session notes, extracts failure/success/plan traces, saves them with an impact score
|
|
66
|
+
2. **Store** — all traces and distilled principles live locally at `~/.forgemem/forgemem_memory.db`
|
|
67
|
+
3. **Serve** — an MCP server exposes the database to agents via the Model Context Protocol
|
|
68
|
+
|
|
69
|
+
Agents call `retrieve_memories` before starting any task. That one call surfaces the top matching failures and principles from your history — so they don't burn tokens re-learning what you already know.
|
|
70
|
+
|
|
71
|
+
---
|
|
72
|
+
|
|
73
|
+
## Quick Start
|
|
74
|
+
|
|
75
|
+
```bash
|
|
76
|
+
# Install
|
|
77
|
+
pip install forgemem
|
|
78
|
+
|
|
79
|
+
# Initialize (interactive on first run)
|
|
80
|
+
forgemem init
|
|
81
|
+
|
|
82
|
+
# Optionally: also schedule background mining every hour
|
|
83
|
+
forgemem start --mine
|
|
84
|
+
|
|
85
|
+
# Restart your agent, then verify
|
|
86
|
+
forgemem status
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
---
|
|
90
|
+
|
|
91
|
+
## Agent Support
|
|
92
|
+
|
|
93
|
+
| Agent | Auto-detected | Skill file written |
|
|
94
|
+
|-------|:---:|:---:|
|
|
95
|
+
| Claude Code | ✓ | `~/.claude/skills/forgemem.md` |
|
|
96
|
+
| Gemini CLI | ✓ | `~/.gemini/forgemem-skill.md` |
|
|
97
|
+
| OpenAI Codex | ✓ | `~/.codex/forgemem-skill.json` |
|
|
98
|
+
|
|
99
|
+
`forgemem init` detects which agents are installed and writes the appropriate skill file automatically. Agents use `retrieve_memories` and `save_trace` via MCP — no extra configuration needed.
|
|
100
|
+
|
|
101
|
+
---
|
|
102
|
+
|
|
103
|
+
## MCP Tools
|
|
104
|
+
|
|
105
|
+
| Tool | Description |
|
|
106
|
+
|------|-------------|
|
|
107
|
+
| `retrieve_memories` | Search principles and traces by keyword before starting a task |
|
|
108
|
+
| `save_trace` | Save a failure, success, plan, or note during or after a session |
|
|
109
|
+
| `mine_session` | Agent-driven mining — no API key required, the agent is the LLM |
|
|
110
|
+
| `distill_session` | Condense raw traces into durable principles |
|
|
111
|
+
| `forgemem_stats` | Summary of DB contents and server health |
|
|
112
|
+
|
|
113
|
+
---
|
|
114
|
+
|
|
115
|
+
## CLI Reference
|
|
116
|
+
|
|
117
|
+
```bash
|
|
118
|
+
forgemem init # Initialize DB, choose provider, register MCP, write skill files
|
|
119
|
+
forgemem start # Start MCP server (background daemon on macOS)
|
|
120
|
+
forgemem start --mine # Also install a scheduled mining agent (hourly)
|
|
121
|
+
forgemem stop # Stop the daemon
|
|
122
|
+
forgemem status # Show DB stats, server health, skill status
|
|
123
|
+
forgemem store "<text>" # Save a memory trace manually
|
|
124
|
+
forgemem search "<query>" # Search stored memories
|
|
125
|
+
forgemem mine # Scan repos and session files for new learnings
|
|
126
|
+
forgemem distill # Condense undistilled traces into principles
|
|
127
|
+
forgemem config # Set inference provider (anthropic / ollama / gemini / …)
|
|
128
|
+
forgemem auth login # Authenticate for managed inference (no BYOK needed)
|
|
129
|
+
```
|
|
130
|
+
|
|
131
|
+
---
|
|
132
|
+
|
|
133
|
+
## Inference Providers
|
|
134
|
+
|
|
135
|
+
Forgemem uses an LLM for mining and distillation. Three options:
|
|
136
|
+
|
|
137
|
+
| Provider | Setup | Cost |
|
|
138
|
+
|----------|-------|------|
|
|
139
|
+
| **Forgemem managed** | choose it in `forgemem init`, then run `forgemem auth login` | Free tier + paid plans |
|
|
140
|
+
| **Ollama** (local) | choose it in `forgemem init` | Free, fully private |
|
|
141
|
+
| **BYOK** (Anthropic / OpenAI / Gemini) | `forgemem config <provider> --key <key>` | Your API costs |
|
|
142
|
+
|
|
143
|
+
`forgemem init` now requires the user to choose a provider interactively on first run. The `mine_session` and `distill_session` MCP tools still work with any subscription — no separate key needed since the agent itself is the LLM.
|
|
144
|
+
|
|
145
|
+
---
|
|
146
|
+
|
|
147
|
+
## Platform Support
|
|
148
|
+
|
|
149
|
+
| Platform | Daemon | Auto-start |
|
|
150
|
+
|----------|--------|------------|
|
|
151
|
+
| macOS | LaunchAgent (`launchctl`) | On login |
|
|
152
|
+
| Linux | systemd user service (instructions printed) | Manual |
|
|
153
|
+
| Windows | Task Scheduler (command printed) | Manual |
|
|
154
|
+
|
|
155
|
+
---
|
|
156
|
+
|
|
157
|
+
## Licensing
|
|
158
|
+
|
|
159
|
+
Forgemem is **Apache-2.0** for community use.
|
|
160
|
+
|
|
161
|
+
- **Community** — Apache-2.0, permissive, local-first, commercial-friendly
|
|
162
|
+
- **Enterprise** — hosted terms with SLA, SSO/SAML, audit logs, priority support, and private hosting
|
|
163
|
+
- **Contributing** — all contributors must sign the [CLA](CLA.md) by adding their name to [CONTRIBUTORS.md](CONTRIBUTORS.md) in their first PR
|
|
@@ -0,0 +1,132 @@
|
|
|
1
|
+
# Forgemem
|
|
2
|
+
|
|
3
|
+
**Persistent long-term memory for AI agents — cross-session context that actually sticks.**
|
|
4
|
+
|
|
5
|
+
[](https://pypi.org/project/forgemem/)
|
|
6
|
+
[](https://pypi.org/project/forgemem/)
|
|
7
|
+
[](LICENSE)
|
|
8
|
+
|
|
9
|
+
Forgemem mines your git history, session traces, and project notes to extract what actually happened — failures, successes, plans, and hard-won lessons. It stores them locally in SQLite and exposes them to AI agents via MCP so they start every session informed instead of blind.
|
|
10
|
+
|
|
11
|
+
---
|
|
12
|
+
|
|
13
|
+
## The Problem
|
|
14
|
+
|
|
15
|
+
Every new agent session starts from zero. It doesn't know you already tried the Zod 4 schema approach and it broke. It doesn't know that wildcard CORS killed auth in production last quarter. It doesn't know which approach you abandoned and why.
|
|
16
|
+
|
|
17
|
+
Without Forgemem, agents repeat your mistakes. With it, they skip straight to what works.
|
|
18
|
+
|
|
19
|
+
---
|
|
20
|
+
|
|
21
|
+
## Installation
|
|
22
|
+
|
|
23
|
+
```bash
|
|
24
|
+
pip install forgemem
|
|
25
|
+
forgemem init
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
`forgemem init` now requires a real TTY on first run so the user must choose an inference provider interactively. Agents cannot bypass that step with `--yes` or a piped session. After `init` completes, it auto-starts the MCP server; then **restart your AI agent** (Claude Code, Gemini CLI, or Codex) to pick up the new MCP connection.
|
|
29
|
+
|
|
30
|
+
---
|
|
31
|
+
|
|
32
|
+
## How It Works
|
|
33
|
+
|
|
34
|
+
1. **Mine** — scans git repos and session notes, extracts failure/success/plan traces, saves them with an impact score
|
|
35
|
+
2. **Store** — all traces and distilled principles live locally at `~/.forgemem/forgemem_memory.db`
|
|
36
|
+
3. **Serve** — an MCP server exposes the database to agents via the Model Context Protocol
|
|
37
|
+
|
|
38
|
+
Agents call `retrieve_memories` before starting any task. That one call surfaces the top matching failures and principles from your history — so they don't burn tokens re-learning what you already know.
|
|
39
|
+
|
|
40
|
+
---
|
|
41
|
+
|
|
42
|
+
## Quick Start
|
|
43
|
+
|
|
44
|
+
```bash
|
|
45
|
+
# Install
|
|
46
|
+
pip install forgemem
|
|
47
|
+
|
|
48
|
+
# Initialize (interactive on first run)
|
|
49
|
+
forgemem init
|
|
50
|
+
|
|
51
|
+
# Optionally: also schedule background mining every hour
|
|
52
|
+
forgemem start --mine
|
|
53
|
+
|
|
54
|
+
# Restart your agent, then verify
|
|
55
|
+
forgemem status
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
---
|
|
59
|
+
|
|
60
|
+
## Agent Support
|
|
61
|
+
|
|
62
|
+
| Agent | Auto-detected | Skill file written |
|
|
63
|
+
|-------|:---:|:---:|
|
|
64
|
+
| Claude Code | ✓ | `~/.claude/skills/forgemem.md` |
|
|
65
|
+
| Gemini CLI | ✓ | `~/.gemini/forgemem-skill.md` |
|
|
66
|
+
| OpenAI Codex | ✓ | `~/.codex/forgemem-skill.json` |
|
|
67
|
+
|
|
68
|
+
`forgemem init` detects which agents are installed and writes the appropriate skill file automatically. Agents use `retrieve_memories` and `save_trace` via MCP — no extra configuration needed.
|
|
69
|
+
|
|
70
|
+
---
|
|
71
|
+
|
|
72
|
+
## MCP Tools
|
|
73
|
+
|
|
74
|
+
| Tool | Description |
|
|
75
|
+
|------|-------------|
|
|
76
|
+
| `retrieve_memories` | Search principles and traces by keyword before starting a task |
|
|
77
|
+
| `save_trace` | Save a failure, success, plan, or note during or after a session |
|
|
78
|
+
| `mine_session` | Agent-driven mining — no API key required, the agent is the LLM |
|
|
79
|
+
| `distill_session` | Condense raw traces into durable principles |
|
|
80
|
+
| `forgemem_stats` | Summary of DB contents and server health |
|
|
81
|
+
|
|
82
|
+
---
|
|
83
|
+
|
|
84
|
+
## CLI Reference
|
|
85
|
+
|
|
86
|
+
```bash
|
|
87
|
+
forgemem init # Initialize DB, choose provider, register MCP, write skill files
|
|
88
|
+
forgemem start # Start MCP server (background daemon on macOS)
|
|
89
|
+
forgemem start --mine # Also install a scheduled mining agent (hourly)
|
|
90
|
+
forgemem stop # Stop the daemon
|
|
91
|
+
forgemem status # Show DB stats, server health, skill status
|
|
92
|
+
forgemem store "<text>" # Save a memory trace manually
|
|
93
|
+
forgemem search "<query>" # Search stored memories
|
|
94
|
+
forgemem mine # Scan repos and session files for new learnings
|
|
95
|
+
forgemem distill # Condense undistilled traces into principles
|
|
96
|
+
forgemem config # Set inference provider (anthropic / ollama / gemini / …)
|
|
97
|
+
forgemem auth login # Authenticate for managed inference (no BYOK needed)
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
---
|
|
101
|
+
|
|
102
|
+
## Inference Providers
|
|
103
|
+
|
|
104
|
+
Forgemem uses an LLM for mining and distillation. Three options:
|
|
105
|
+
|
|
106
|
+
| Provider | Setup | Cost |
|
|
107
|
+
|----------|-------|------|
|
|
108
|
+
| **Forgemem managed** | choose it in `forgemem init`, then run `forgemem auth login` | Free tier + paid plans |
|
|
109
|
+
| **Ollama** (local) | choose it in `forgemem init` | Free, fully private |
|
|
110
|
+
| **BYOK** (Anthropic / OpenAI / Gemini) | `forgemem config <provider> --key <key>` | Your API costs |
|
|
111
|
+
|
|
112
|
+
`forgemem init` now requires the user to choose a provider interactively on first run. The `mine_session` and `distill_session` MCP tools still work with any subscription — no separate key needed since the agent itself is the LLM.
|
|
113
|
+
|
|
114
|
+
---
|
|
115
|
+
|
|
116
|
+
## Platform Support
|
|
117
|
+
|
|
118
|
+
| Platform | Daemon | Auto-start |
|
|
119
|
+
|----------|--------|------------|
|
|
120
|
+
| macOS | LaunchAgent (`launchctl`) | On login |
|
|
121
|
+
| Linux | systemd user service (instructions printed) | Manual |
|
|
122
|
+
| Windows | Task Scheduler (command printed) | Manual |
|
|
123
|
+
|
|
124
|
+
---
|
|
125
|
+
|
|
126
|
+
## Licensing
|
|
127
|
+
|
|
128
|
+
Forgemem is **Apache-2.0** for community use.
|
|
129
|
+
|
|
130
|
+
- **Community** — Apache-2.0, permissive, local-first, commercial-friendly
|
|
131
|
+
- **Enterprise** — hosted terms with SLA, SSO/SAML, audit logs, priority support, and private hosting
|
|
132
|
+
- **Contributing** — all contributors must sign the [CLA](CLA.md) by adding their name to [CONTRIBUTORS.md](CONTRIBUTORS.md) in their first PR
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
"""Forgememo — persistent memory for AI agents."""
|
|
2
|
+
|
|
3
|
+
from importlib.metadata import version, PackageNotFoundError
|
|
4
|
+
|
|
5
|
+
try:
|
|
6
|
+
__version__ = version("forgememo")
|
|
7
|
+
except PackageNotFoundError:
|
|
8
|
+
# Package not installed (running from source checkout)
|
|
9
|
+
__version__ = "0.0.0+dev"
|