@kykiles/opencode-mem 13.10.2
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.
- package/LICENSE +202 -0
- package/README.md +429 -0
- package/dist/npx-cli/index.js +9798 -0
- package/dist/opencode-plugin/index.js +70 -0
- package/package.json +187 -0
- package/plugin/.mcp.json +12 -0
- package/plugin/bun.lock +160 -0
- package/plugin/hooks/bugfixes-2026-01-10.md +92 -0
- package/plugin/hooks/hooks.json +87 -0
- package/plugin/modes/code--ar.json +24 -0
- package/plugin/modes/code--bn.json +24 -0
- package/plugin/modes/code--chill.json +8 -0
- package/plugin/modes/code--cs.json +24 -0
- package/plugin/modes/code--da.json +24 -0
- package/plugin/modes/code--de.json +24 -0
- package/plugin/modes/code--el.json +24 -0
- package/plugin/modes/code--es.json +24 -0
- package/plugin/modes/code--fi.json +24 -0
- package/plugin/modes/code--fr.json +24 -0
- package/plugin/modes/code--he.json +24 -0
- package/plugin/modes/code--hi.json +24 -0
- package/plugin/modes/code--hu.json +24 -0
- package/plugin/modes/code--id.json +24 -0
- package/plugin/modes/code--it.json +24 -0
- package/plugin/modes/code--ja.json +24 -0
- package/plugin/modes/code--ko.json +24 -0
- package/plugin/modes/code--nl.json +24 -0
- package/plugin/modes/code--no.json +24 -0
- package/plugin/modes/code--pl.json +24 -0
- package/plugin/modes/code--pt-br.json +24 -0
- package/plugin/modes/code--ro.json +24 -0
- package/plugin/modes/code--ru.json +24 -0
- package/plugin/modes/code--sv.json +24 -0
- package/plugin/modes/code--th.json +24 -0
- package/plugin/modes/code--tr.json +24 -0
- package/plugin/modes/code--uk.json +24 -0
- package/plugin/modes/code--ur.json +25 -0
- package/plugin/modes/code--vi.json +24 -0
- package/plugin/modes/code--zh.json +24 -0
- package/plugin/modes/code.json +139 -0
- package/plugin/modes/email-investigation.json +120 -0
- package/plugin/modes/law-study--chill.json +7 -0
- package/plugin/modes/law-study-CLAUDE.md +85 -0
- package/plugin/modes/law-study.json +120 -0
- package/plugin/modes/meme-tokens.json +125 -0
- package/plugin/package.json +45 -0
- package/plugin/scripts/bun-runner.js +238 -0
- package/plugin/scripts/context-generator.cjs +825 -0
- package/plugin/scripts/mcp-server.cjs +249 -0
- package/plugin/scripts/server-service.cjs +9939 -0
- package/plugin/scripts/statusline-counts.js +40 -0
- package/plugin/scripts/transcript-watcher.cjs +29 -0
- package/plugin/scripts/version-check.js +193 -0
- package/plugin/scripts/worker-service.cjs +2238 -0
- package/plugin/scripts/worker-wrapper.cjs +2 -0
- package/plugin/skills/babysit/SKILL.md +87 -0
- package/plugin/skills/design-is/SKILL.md +312 -0
- package/plugin/skills/do/SKILL.md +45 -0
- package/plugin/skills/how-it-works/SKILL.md +22 -0
- package/plugin/skills/how-it-works/onboarding-explainer.md +17 -0
- package/plugin/skills/knowledge-agent/SKILL.md +80 -0
- package/plugin/skills/learn-codebase/SKILL.md +21 -0
- package/plugin/skills/make-plan/SKILL.md +67 -0
- package/plugin/skills/mem-search/SKILL.md +131 -0
- package/plugin/skills/oh-my-issues/SKILL.md +226 -0
- package/plugin/skills/pathfinder/SKILL.md +111 -0
- package/plugin/skills/smart-explore/SKILL.md +193 -0
- package/plugin/skills/standup/SKILL.md +142 -0
- package/plugin/skills/standup/agent-brief.md +47 -0
- package/plugin/skills/standup/standup.mjs +662 -0
- package/plugin/skills/timeline-report/SKILL.md +211 -0
- package/plugin/skills/version-bump/SKILL.md +74 -0
- package/plugin/skills/version-bump/scripts/generate_changelog.js +34 -0
- package/plugin/skills/weekly-digests/SKILL.md +262 -0
- package/plugin/skills/what-the/SKILL.md +6 -0
- package/plugin/skills/wowerpoint/SKILL.md +205 -0
- package/plugin/sqlite/SessionStore.js +764 -0
- package/plugin/sqlite/observations/files.js +10 -0
- package/plugin/ui/assets/fonts/monaspace-radon-var.woff +0 -0
- package/plugin/ui/assets/fonts/monaspace-radon-var.woff2 +0 -0
- package/plugin/ui/claude-mem-logo-for-dark-mode.webp +0 -0
- package/plugin/ui/claude-mem-logo-stylized.png +0 -0
- package/plugin/ui/claude-mem-logomark.webp +0 -0
- package/plugin/ui/icon-thick-completed.svg +8 -0
- package/plugin/ui/icon-thick-investigated.svg +8 -0
- package/plugin/ui/icon-thick-learned.svg +12 -0
- package/plugin/ui/icon-thick-next-steps.svg +8 -0
- package/plugin/ui/viewer-bundle.js +65 -0
- package/plugin/ui/viewer.html +2402 -0
package/LICENSE
ADDED
|
@@ -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.
|
package/README.md
ADDED
|
@@ -0,0 +1,429 @@
|
|
|
1
|
+
<h1 align="center">
|
|
2
|
+
<br>
|
|
3
|
+
<a href="https://github.com/kykiles/opencode-mem">
|
|
4
|
+
<picture>
|
|
5
|
+
<source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/kykiles/opencode-mem/main/docs/public/opencode-mem-logo-for-dark-mode.webp">
|
|
6
|
+
<source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/kykiles/opencode-mem/main/docs/public/opencode-mem-logo-for-light-mode.webp">
|
|
7
|
+
<img src="https://raw.githubusercontent.com/kykiles/opencode-mem/main/docs/public/opencode-mem-logo-for-light-mode.webp" alt="OpenCode-Mem" width="400">
|
|
8
|
+
</picture>
|
|
9
|
+
</a>
|
|
10
|
+
<br>
|
|
11
|
+
<a href="https://vercel.com/open-source-program">
|
|
12
|
+
<img alt="Vercel OSS Program" src="https://vercel.com/oss/program-badge-2026.svg" />
|
|
13
|
+
</a>
|
|
14
|
+
</h1>
|
|
15
|
+
|
|
16
|
+
<p align="center">
|
|
17
|
+
<a href="docs/i18n/README.zh.md">🇨🇳 中文</a> •
|
|
18
|
+
<a href="docs/i18n/README.zh-tw.md">🇹🇼 繁體中文</a> •
|
|
19
|
+
<a href="docs/i18n/README.ja.md">🇯🇵 日本語</a> •
|
|
20
|
+
<a href="docs/i18n/README.pt.md">🇵🇹 Português</a> •
|
|
21
|
+
<a href="docs/i18n/README.pt-br.md">🇧🇷 Português</a> •
|
|
22
|
+
<a href="docs/i18n/README.ko.md">🇰🇷 한국어</a> •
|
|
23
|
+
<a href="docs/i18n/README.es.md">🇪🇸 Español</a> •
|
|
24
|
+
<a href="docs/i18n/README.de.md">🇩🇪 Deutsch</a> •
|
|
25
|
+
<a href="docs/i18n/README.fr.md">🇫🇷 Français</a> •
|
|
26
|
+
<a href="docs/i18n/README.he.md">🇮🇱 עברית</a> •
|
|
27
|
+
<a href="docs/i18n/README.ar.md">🇸🇦 العربية</a> •
|
|
28
|
+
<a href="docs/i18n/README.ru.md">🇷🇺 Русский</a> •
|
|
29
|
+
<a href="docs/i18n/README.pl.md">🇵🇱 Polski</a> •
|
|
30
|
+
<a href="docs/i18n/README.cs.md">🇨🇿 Čeština</a> •
|
|
31
|
+
<a href="docs/i18n/README.nl.md">🇳🇱 Nederlands</a> •
|
|
32
|
+
<a href="docs/i18n/README.tr.md">🇹🇷 Türkçe</a> •
|
|
33
|
+
<a href="docs/i18n/README.uk.md">🇺🇦 Українська</a> •
|
|
34
|
+
<a href="docs/i18n/README.vi.md">🇻🇳 Tiếng Việt</a> •
|
|
35
|
+
<a href="docs/i18n/README.tl.md">🇵🇭 Tagalog</a> •
|
|
36
|
+
<a href="docs/i18n/README.id.md">🇮🇩 Indonesia</a> •
|
|
37
|
+
<a href="docs/i18n/README.th.md">🇹🇭 ไทย</a> •
|
|
38
|
+
<a href="docs/i18n/README.hi.md">🇮🇳 हिन्दी</a> •
|
|
39
|
+
<a href="docs/i18n/README.bn.md">🇧🇩 বাংলা</a> •
|
|
40
|
+
<a href="docs/i18n/README.ur.md">🇵🇰 اردو</a> •
|
|
41
|
+
<a href="docs/i18n/README.ro.md">🇷🇴 Română</a> •
|
|
42
|
+
<a href="docs/i18n/README.sv.md">🇸🇪 Svenska</a> •
|
|
43
|
+
<a href="docs/i18n/README.it.md">🇮🇹 Italiano</a> •
|
|
44
|
+
<a href="docs/i18n/README.el.md">🇬🇷 Ελληνικά</a> •
|
|
45
|
+
<a href="docs/i18n/README.hu.md">🇭🇺 Magyar</a> •
|
|
46
|
+
<a href="docs/i18n/README.fi.md">🇫🇮 Suomi</a> •
|
|
47
|
+
<a href="docs/i18n/README.da.md">🇩🇰 Dansk</a> •
|
|
48
|
+
<a href="docs/i18n/README.no.md">🇳🇴 Norsk</a>
|
|
49
|
+
</p>
|
|
50
|
+
|
|
51
|
+
<h4 align="center">Persistent memory compression system built for <a href="https://github.com/anomalyco/opencode" target="_blank">OpenCode</a>.</h4>
|
|
52
|
+
|
|
53
|
+
<p align="center">
|
|
54
|
+
<a href="LICENSE">
|
|
55
|
+
<img src="https://img.shields.io/badge/License-Apache%202.0-blue.svg" alt="License">
|
|
56
|
+
</a>
|
|
57
|
+
<a href="package.json">
|
|
58
|
+
<img src="https://img.shields.io/badge/version-13.4.0-green.svg" alt="Version">
|
|
59
|
+
</a>
|
|
60
|
+
<a href="package.json">
|
|
61
|
+
<img src="https://img.shields.io/badge/node-%3E%3D20.0.0-brightgreen.svg" alt="Node">
|
|
62
|
+
</a>
|
|
63
|
+
<a href="https://github.com/thedotmack/awesome-claude-code">
|
|
64
|
+
<img src="https://awesome.re/mentioned-badge.svg" alt="Mentioned in Awesome Claude Code">
|
|
65
|
+
</a>
|
|
66
|
+
</p>
|
|
67
|
+
|
|
68
|
+
<p align="center">
|
|
69
|
+
<a href="https://trendshift.io/repositories/15496" target="_blank">
|
|
70
|
+
<picture>
|
|
71
|
+
<source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/kykiles/opencode-mem/main/docs/public/trendshift-badge-dark.svg">
|
|
72
|
+
<source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/kykiles/opencode-mem/main/docs/public/trendshift-badge.svg">
|
|
73
|
+
<img src="https://raw.githubusercontent.com/kykiles/opencode-mem/main/docs/public/trendshift-badge.svg" alt="kykiles/opencode-mem | Trendshift" width="250" height="55"/>
|
|
74
|
+
</picture>
|
|
75
|
+
</a>
|
|
76
|
+
</p>
|
|
77
|
+
|
|
78
|
+
<br>
|
|
79
|
+
|
|
80
|
+
<table align="center">
|
|
81
|
+
<tr>
|
|
82
|
+
<td align="center">
|
|
83
|
+
<a href="https://github.com/kykiles/opencode-mem">
|
|
84
|
+
<picture>
|
|
85
|
+
<img
|
|
86
|
+
src="https://raw.githubusercontent.com/kykiles/opencode-mem/main/docs/public/cm-preview.gif"
|
|
87
|
+
alt="Claude-Mem Preview"
|
|
88
|
+
width="500"
|
|
89
|
+
>
|
|
90
|
+
</picture>
|
|
91
|
+
</a>
|
|
92
|
+
</td>
|
|
93
|
+
<td align="center">
|
|
94
|
+
<a href="https://www.star-history.com/#kykiles/opencode-mem&Date">
|
|
95
|
+
<picture>
|
|
96
|
+
<source
|
|
97
|
+
media="(prefers-color-scheme: dark)"
|
|
98
|
+
srcset="https://api.star-history.com/image?repos=kykiles/opencode-mem&type=date&theme=dark&legend=top-left"
|
|
99
|
+
/>
|
|
100
|
+
<source
|
|
101
|
+
media="(prefers-color-scheme: light)"
|
|
102
|
+
srcset="https://api.star-history.com/image?repos=kykiles/opencode-mem&type=date&legend=top-left"
|
|
103
|
+
/>
|
|
104
|
+
<img
|
|
105
|
+
alt="Star History Chart"
|
|
106
|
+
src="https://api.star-history.com/image?repos=kykiles/opencode-mem&type=date&legend=top-left"
|
|
107
|
+
width="500"
|
|
108
|
+
/>
|
|
109
|
+
</picture>
|
|
110
|
+
</a>
|
|
111
|
+
</td>
|
|
112
|
+
</tr>
|
|
113
|
+
</table>
|
|
114
|
+
|
|
115
|
+
<p align="center">
|
|
116
|
+
<a href="#quick-start">Quick Start</a> •
|
|
117
|
+
<a href="#how-it-works">How It Works</a> •
|
|
118
|
+
<a href="#mcp-search-tools">Search Tools</a> •
|
|
119
|
+
<a href="#documentation">Documentation</a> •
|
|
120
|
+
<a href="#configuration">Configuration</a> •
|
|
121
|
+
<a href="#troubleshooting">Troubleshooting</a> •
|
|
122
|
+
<a href="#license">License</a>
|
|
123
|
+
</p>
|
|
124
|
+
|
|
125
|
+
<p align="center">
|
|
126
|
+
OpenCode-Mem seamlessly preserves context across sessions by automatically capturing tool usage observations, generating semantic summaries, and making them available to future sessions. This enables OpenCode to maintain continuity of knowledge about projects even after sessions end or reconnect.
|
|
127
|
+
</p>
|
|
128
|
+
|
|
129
|
+
---
|
|
130
|
+
|
|
131
|
+
## Quick Start
|
|
132
|
+
|
|
133
|
+
Install with a single command:
|
|
134
|
+
|
|
135
|
+
```bash
|
|
136
|
+
npx opencode-mem install
|
|
137
|
+
```
|
|
138
|
+
|
|
139
|
+
Or install for OpenCode:
|
|
140
|
+
|
|
141
|
+
```bash
|
|
142
|
+
npx opencode-mem install --ide opencode
|
|
143
|
+
```
|
|
144
|
+
|
|
145
|
+
Or install for Antigravity CLI ([setup guide](https://docs.opencode-mem.ai/antigravity-cli/setup)):
|
|
146
|
+
|
|
147
|
+
```bash
|
|
148
|
+
npx opencode-mem install --ide antigravity
|
|
149
|
+
```
|
|
150
|
+
|
|
151
|
+
Or install from the plugin marketplace inside Claude Code:
|
|
152
|
+
|
|
153
|
+
```bash
|
|
154
|
+
/plugin marketplace add kykiles/opencode-mem
|
|
155
|
+
|
|
156
|
+
/plugin install opencode-mem
|
|
157
|
+
```
|
|
158
|
+
|
|
159
|
+
Restart Claude Code. Context from previous sessions will automatically appear in new sessions.
|
|
160
|
+
|
|
161
|
+
> **Note:** Claude-Mem is also published on npm, but `npm install -g opencode-mem` installs the **SDK/library only** — it does not register the plugin hooks or set up the worker service. Always install via `npx opencode-mem install` or the `/plugin` commands above.
|
|
162
|
+
|
|
163
|
+
### 🦞 OpenClaw Gateway
|
|
164
|
+
|
|
165
|
+
Install opencode-mem as a persistent memory plugin on [OpenClaw](https://openclaw.ai) gateways with a single command:
|
|
166
|
+
|
|
167
|
+
```bash
|
|
168
|
+
curl -fsSL https://install.cmem.ai/openclaw.sh | bash
|
|
169
|
+
```
|
|
170
|
+
|
|
171
|
+
The installer handles dependencies, plugin setup, AI provider configuration, worker startup, and optional real-time observation feeds to Telegram, Discord, Slack, and more. See the [OpenClaw Integration Guide](https://docs.opencode-mem.ai/openclaw-integration) for details.
|
|
172
|
+
|
|
173
|
+
**Key Features:**
|
|
174
|
+
|
|
175
|
+
- 🧠 **Persistent Memory** - Context survives across sessions
|
|
176
|
+
- 📊 **Progressive Disclosure** - Layered memory retrieval with token cost visibility
|
|
177
|
+
- 🔍 **Skill-Based Search** - Query your project history with mem-search skill
|
|
178
|
+
- 🖥️ **Web Viewer UI** - Real-time memory stream at the worker URL printed on startup
|
|
179
|
+
- 💻 **Claude Desktop Skill** - Search memory from Claude Desktop conversations
|
|
180
|
+
- 🔒 **Privacy Control** - Use `<private>` tags to exclude sensitive content from storage
|
|
181
|
+
- ⚙️ **Context Configuration** - Fine-grained control over what context gets injected
|
|
182
|
+
- 🤖 **Automatic Operation** - No manual intervention required
|
|
183
|
+
- 🔗 **Citations** - Reference past observations with IDs through the worker API or view all in the web viewer
|
|
184
|
+
|
|
185
|
+
---
|
|
186
|
+
|
|
187
|
+
## Documentation
|
|
188
|
+
|
|
189
|
+
📚 **[View Full Documentation](https://docs.opencode-mem.ai/)** - Browse on official website
|
|
190
|
+
|
|
191
|
+
### Getting Started
|
|
192
|
+
|
|
193
|
+
- **[Installation Guide](https://docs.opencode-mem.ai/installation)** - Quick start & advanced installation
|
|
194
|
+
- **[Usage Guide](https://docs.opencode-mem.ai/usage/getting-started)** - How Claude-Mem works automatically
|
|
195
|
+
- **[Search Tools](https://docs.opencode-mem.ai/usage/search-tools)** - Query your project history with natural language
|
|
196
|
+
|
|
197
|
+
### Best Practices
|
|
198
|
+
|
|
199
|
+
- **[Context Engineering](https://docs.opencode-mem.ai/context-engineering)** - AI agent context optimization principles
|
|
200
|
+
- **[Progressive Disclosure](https://docs.opencode-mem.ai/progressive-disclosure)** - Philosophy behind Claude-Mem's context priming strategy
|
|
201
|
+
|
|
202
|
+
### Architecture
|
|
203
|
+
|
|
204
|
+
- **[Overview](https://docs.opencode-mem.ai/architecture/overview)** - System components & data flow
|
|
205
|
+
- **[Architecture Evolution](https://docs.opencode-mem.ai/architecture-evolution)** - The journey from v3 to v5
|
|
206
|
+
- **[Hooks Architecture](https://docs.opencode-mem.ai/hooks-architecture)** - How Claude-Mem uses lifecycle hooks
|
|
207
|
+
- **[Hooks Reference](https://docs.opencode-mem.ai/architecture/hooks)** - 7 hook scripts explained
|
|
208
|
+
- **[Worker Service](https://docs.opencode-mem.ai/architecture/worker-service)** - HTTP API & Bun management
|
|
209
|
+
- **[Database](https://docs.opencode-mem.ai/architecture/database)** - SQLite schema & FTS5 search
|
|
210
|
+
- **[Search Architecture](https://docs.opencode-mem.ai/architecture/search-architecture)** - Hybrid search with Chroma vector database
|
|
211
|
+
|
|
212
|
+
### Configuration & Development
|
|
213
|
+
|
|
214
|
+
- **[Configuration](https://docs.opencode-mem.ai/configuration)** - Environment variables & settings
|
|
215
|
+
- **[Development](https://docs.opencode-mem.ai/development)** - Building, testing, contributing
|
|
216
|
+
- **[Release Branches](https://docs.opencode-mem.ai/branches)** - Stable, core-dev, and community-edge branch flow
|
|
217
|
+
- **[Troubleshooting](https://docs.opencode-mem.ai/troubleshooting)** - Common issues & solutions
|
|
218
|
+
|
|
219
|
+
---
|
|
220
|
+
|
|
221
|
+
## How It Works
|
|
222
|
+
|
|
223
|
+
**Core Components:**
|
|
224
|
+
|
|
225
|
+
1. **5 Lifecycle Hooks** - SessionStart, UserPromptSubmit, PostToolUse, Stop, SessionEnd (6 hook scripts)
|
|
226
|
+
2. **Smart Install** - Cached dependency checker (pre-hook script, not a lifecycle hook)
|
|
227
|
+
3. **Worker Service** - Local HTTP API with web viewer UI and search endpoints, managed by Bun
|
|
228
|
+
4. **SQLite Database** - Stores sessions, observations, summaries
|
|
229
|
+
5. **mem-search Skill** - Natural language queries with progressive disclosure
|
|
230
|
+
6. **Chroma Vector Database** - Hybrid semantic + keyword search for intelligent context retrieval
|
|
231
|
+
|
|
232
|
+
See [Architecture Overview](https://docs.opencode-mem.ai/architecture/overview) for details.
|
|
233
|
+
|
|
234
|
+
---
|
|
235
|
+
|
|
236
|
+
## MCP Search Tools
|
|
237
|
+
|
|
238
|
+
Claude-Mem provides intelligent memory search through **4 MCP tools** following a token-efficient **3-layer workflow pattern**:
|
|
239
|
+
|
|
240
|
+
**The 3-Layer Workflow:**
|
|
241
|
+
|
|
242
|
+
1. **`search`** - Get compact index with IDs (~50-100 tokens/result)
|
|
243
|
+
2. **`timeline`** - Get chronological context around interesting results
|
|
244
|
+
3. **`get_observations`** - Fetch full details ONLY for filtered IDs (~500-1,000 tokens/result)
|
|
245
|
+
|
|
246
|
+
**How It Works:**
|
|
247
|
+
- Claude uses MCP tools to search your memory
|
|
248
|
+
- Start with `search` to get an index of results
|
|
249
|
+
- Use `timeline` to see what was happening around specific observations
|
|
250
|
+
- Use `get_observations` to fetch full details for relevant IDs
|
|
251
|
+
- **~10x token savings** by filtering before fetching details
|
|
252
|
+
|
|
253
|
+
**Available MCP Tools:**
|
|
254
|
+
|
|
255
|
+
1. **`search`** - Search memory index with full-text queries, filters by type/date/project
|
|
256
|
+
2. **`timeline`** - Get chronological context around a specific observation or query
|
|
257
|
+
3. **`get_observations`** - Fetch full observation details by IDs (always batch multiple IDs)
|
|
258
|
+
|
|
259
|
+
**Example Usage:**
|
|
260
|
+
|
|
261
|
+
```typescript
|
|
262
|
+
// Step 1: Search for index
|
|
263
|
+
search(query="authentication bug", type="bugfix", limit=10)
|
|
264
|
+
|
|
265
|
+
// Step 2: Review index, identify relevant IDs (e.g., #123, #456)
|
|
266
|
+
|
|
267
|
+
// Step 3: Fetch full details
|
|
268
|
+
get_observations(ids=[123, 456])
|
|
269
|
+
```
|
|
270
|
+
|
|
271
|
+
See [Search Tools Guide](https://docs.opencode-mem.ai/usage/search-tools) for detailed examples.
|
|
272
|
+
|
|
273
|
+
---
|
|
274
|
+
|
|
275
|
+
## Release Branches
|
|
276
|
+
|
|
277
|
+
Stable releases ship from `main` and are published to npm. `core-dev` and
|
|
278
|
+
`community-edge` are source-run branches for early reliability fixes and
|
|
279
|
+
community integrations. See **[Release Branches](https://docs.opencode-mem.ai/branches)**
|
|
280
|
+
for the branch flow and non-stable run instructions.
|
|
281
|
+
|
|
282
|
+
---
|
|
283
|
+
|
|
284
|
+
## System Requirements
|
|
285
|
+
|
|
286
|
+
- **Node.js**: 20.0.0 or higher
|
|
287
|
+
- **Claude Code**: Latest version with plugin support
|
|
288
|
+
- **Bun**: JavaScript runtime and process manager (auto-installed if missing)
|
|
289
|
+
- **uv**: Python package manager for vector search (auto-installed if missing)
|
|
290
|
+
- **SQLite 3**: For persistent storage (bundled)
|
|
291
|
+
|
|
292
|
+
---
|
|
293
|
+
### Windows Setup Notes
|
|
294
|
+
|
|
295
|
+
If you see an error like:
|
|
296
|
+
|
|
297
|
+
```powershell
|
|
298
|
+
npm : The term 'npm' is not recognized as the name of a cmdlet
|
|
299
|
+
```
|
|
300
|
+
|
|
301
|
+
Make sure Node.js and npm are installed and added to your PATH. Download the latest Node.js installer from https://nodejs.org and restart your terminal after installation.
|
|
302
|
+
|
|
303
|
+
---
|
|
304
|
+
|
|
305
|
+
## Configuration
|
|
306
|
+
|
|
307
|
+
Settings are managed in `~/.opencode-mem/settings.json` (auto-created with defaults on first run). Configure AI model, worker port, data directory, log level, and context injection settings.
|
|
308
|
+
|
|
309
|
+
See the **[Configuration Guide](https://docs.opencode-mem.ai/configuration)** for all available settings and examples.
|
|
310
|
+
|
|
311
|
+
### Mode & Language Configuration
|
|
312
|
+
|
|
313
|
+
Claude-Mem supports multiple workflow modes and languages via the `OPENCODE_MEM_MODE` setting.
|
|
314
|
+
|
|
315
|
+
This option controls both:
|
|
316
|
+
- The workflow behavior (e.g. code, chill, investigation)
|
|
317
|
+
- The language used in generated observations
|
|
318
|
+
|
|
319
|
+
#### How to Configure
|
|
320
|
+
|
|
321
|
+
Edit your settings file at `~/.opencode-mem/settings.json`:
|
|
322
|
+
|
|
323
|
+
```json
|
|
324
|
+
{
|
|
325
|
+
"OPENCODE_MEM_MODE": "code--zh"
|
|
326
|
+
}
|
|
327
|
+
```
|
|
328
|
+
|
|
329
|
+
Modes are defined in `plugin/modes/`. To see all available modes locally:
|
|
330
|
+
|
|
331
|
+
```bash
|
|
332
|
+
ls ~/.claude/plugins/marketplaces/thedotmack/plugin/modes/
|
|
333
|
+
```
|
|
334
|
+
|
|
335
|
+
#### Available Modes
|
|
336
|
+
|
|
337
|
+
| Mode | Description |
|
|
338
|
+
|------------|-------------------------|
|
|
339
|
+
| `code` | Default English mode |
|
|
340
|
+
| `code--zh` | Simplified Chinese mode |
|
|
341
|
+
| `code--ja` | Japanese mode |
|
|
342
|
+
|
|
343
|
+
Language-specific modes follow the pattern `code--[lang]` where `[lang]` is the ISO 639-1 language code (e.g., `zh` for Chinese, `ja` for Japanese, `es` for Spanish).
|
|
344
|
+
|
|
345
|
+
> Note: `code--zh` (Simplified Chinese) is already built-in — no additional installation or plugin update is required.
|
|
346
|
+
|
|
347
|
+
#### After Changing Mode
|
|
348
|
+
|
|
349
|
+
Restart Claude Code to apply the new mode configuration.
|
|
350
|
+
---
|
|
351
|
+
|
|
352
|
+
## Development
|
|
353
|
+
|
|
354
|
+
See the **[Development Guide](https://docs.opencode-mem.ai/development)** for build instructions, testing, and contribution workflow.
|
|
355
|
+
|
|
356
|
+
---
|
|
357
|
+
|
|
358
|
+
## Troubleshooting
|
|
359
|
+
|
|
360
|
+
If experiencing issues, describe the problem to Claude and the troubleshoot skill will automatically diagnose and provide fixes.
|
|
361
|
+
|
|
362
|
+
See the **[Troubleshooting Guide](https://docs.opencode-mem.ai/troubleshooting)** for common issues and solutions.
|
|
363
|
+
|
|
364
|
+
---
|
|
365
|
+
|
|
366
|
+
## Bug Reports
|
|
367
|
+
|
|
368
|
+
Create comprehensive bug reports with the automated generator:
|
|
369
|
+
|
|
370
|
+
```bash
|
|
371
|
+
cd ~/.claude/plugins/marketplaces/thedotmack
|
|
372
|
+
npm run bug-report
|
|
373
|
+
```
|
|
374
|
+
|
|
375
|
+
## Contributing
|
|
376
|
+
|
|
377
|
+
Contributions are welcome! Please:
|
|
378
|
+
|
|
379
|
+
1. Fork the repository
|
|
380
|
+
2. Create a feature branch
|
|
381
|
+
3. Make your changes with tests
|
|
382
|
+
4. Update documentation
|
|
383
|
+
5. Submit a Pull Request
|
|
384
|
+
|
|
385
|
+
Claude-Mem ships from three branches: `main` (stable), `core-dev`, and
|
|
386
|
+
`community-edge`. Only `main` is published to npm; the others are run from
|
|
387
|
+
source. See [Release Branches](https://docs.opencode-mem.ai/branches) for the
|
|
388
|
+
strategy and local run instructions.
|
|
389
|
+
|
|
390
|
+
See [Development Guide](https://docs.opencode-mem.ai/development) for contribution workflow.
|
|
391
|
+
|
|
392
|
+
---
|
|
393
|
+
|
|
394
|
+
## License
|
|
395
|
+
|
|
396
|
+
Claude-Mem is licensed under the Apache License 2.0.
|
|
397
|
+
|
|
398
|
+
We chose Apache-2.0 because durable agentic memory should be easy to embed in
|
|
399
|
+
developer tools, local agents, MCP servers, enterprise systems, robotics stacks,
|
|
400
|
+
and production agent harnesses.
|
|
401
|
+
|
|
402
|
+
See the [LICENSE](LICENSE) file for full details. See [docs/license.md](docs/license.md)
|
|
403
|
+
and [docs/ip-boundary.md](docs/ip-boundary.md) for licensing scope and the
|
|
404
|
+
open/commercial boundary.
|
|
405
|
+
|
|
406
|
+
**Note on Ragtime**: The `ragtime/` directory is licensed under the **Apache License 2.0**. See [ragtime/LICENSE](ragtime/LICENSE) for details.
|
|
407
|
+
|
|
408
|
+
---
|
|
409
|
+
|
|
410
|
+
## Support
|
|
411
|
+
|
|
412
|
+
- **Documentation**: [docs/](docs/)
|
|
413
|
+
- **Issues**: [GitHub Issues](https://github.com/kykiles/opencode-mem/issues)
|
|
414
|
+
- **Repository**: [github.com/kykiles/opencode-mem](https://github.com/kykiles/opencode-mem)
|
|
415
|
+
- **Official X Account**: [@Claude_Memory](https://x.com/Claude_Memory)
|
|
416
|
+
- **Official Discord**: [Join Discord](https://discord.com/invite/J4wttp9vDu)
|
|
417
|
+
- **Author**: Alex Newman ([@thedotmack](https://github.com/thedotmack))
|
|
418
|
+
|
|
419
|
+
---
|
|
420
|
+
|
|
421
|
+
**Built with Claude Agent SDK** | **Works with Claude Code** | **Made with TypeScript**
|
|
422
|
+
|
|
423
|
+
---
|
|
424
|
+
|
|
425
|
+
### What About CMEM?
|
|
426
|
+
|
|
427
|
+
CMEM is a token created by a 3rd party but officially embraced by the creator of Claude-Mem (Alex Newman, @thedotmack). The token acts as a community catalyst for growth and a vehicle for bringing CMEM to the developers and knowledge workers that need it most.
|
|
428
|
+
|
|
429
|
+
Official BASE CA: 0x76b1967eec0ccaeb001bbbb2b40dc4badba31ba3
|