@ngo-a/native-memory-citations 2026.6.1 → 2026.6.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/README.md CHANGED
@@ -23,6 +23,27 @@ access; it is operator-controlled retrieval with an audit trail.
23
23
  - Per-request output limits on fetched content.
24
24
  - Read-only operation: the plugin never creates, modifies, or deletes memory files.
25
25
 
26
+ ## Install
27
+
28
+ From npm (recommended):
29
+
30
+ openclaw plugins install @ngo-a/native-memory-citations
31
+
32
+ From a local checkout (development):
33
+
34
+ openclaw plugins install ./native-memory-citations
35
+
36
+ Reload the Gateway after installing so the plugin host exposes the tools.
37
+
38
+ ## Requirements
39
+
40
+ - Node.js 22.19.0 or newer.
41
+ - OpenClaw 2026.5.17 or newer (declared as a peer dependency).
42
+ - A local OpenClaw workspace containing text memory files.
43
+
44
+ Supported memory file types are `.md`, `.txt`, `.json`, `.jsonl`, `.yaml`, and
45
+ `.yml`. Files with other extensions are not scanned.
46
+
26
47
  ## Intended use
27
48
 
28
49
  Native Memory Citations is intended for OpenClaw deployments where an agent needs
@@ -118,14 +139,14 @@ Permitting larger files (4 MiB) and specifying a non-default workspace:
118
139
  ### Operational notes
119
140
 
120
141
  - `allowedRoots` replaces the default set; it does not extend it. A value of
121
- `["notes"]` makes `MEMORY.md`, `USER.md`, and the remaining defaults unreachable.
122
- List every path that should remain searchable.
142
+ `["notes"]` makes `MEMORY.md`, `USER.md`, and the remaining defaults unreachable.
143
+ List every path that should remain searchable.
123
144
  - `sharedMode` has no effect once `allowedRoots` is set; the explicit list takes
124
- precedence.
145
+ precedence.
125
146
  - Files exceeding `maxFileBytes` are skipped and logged rather than reported as
126
- errors. Set the limit to accommodate the largest memory files in use.
147
+ errors. Set the limit to accommodate the largest memory files in use.
127
148
  - Hidden directories, `..` segments, and absolute paths cannot be included. This is
128
- enforced by the access boundary.
149
+ enforced by the access boundary.
129
150
 
130
151
  ### Settings not exposed through configuration
131
152
 
@@ -152,10 +173,10 @@ To detect stale citations, pass the hash from a prior search hit:
152
173
 
153
174
  ```json
154
175
  {
155
- "sourceId": "memory/2026-06-17.md",
156
- "lineStart": 12,
157
- "lineEnd": 14,
158
- "expectedSha256": "..."
176
+ "sourceId": "memory/2026-06-17.md",
177
+ "lineStart": 12,
178
+ "lineEnd": 14,
179
+ "expectedSha256": "..."
159
180
  }
160
181
  ```
161
182
 
@@ -180,19 +201,7 @@ long tokens. Redaction is not an authorization or access-control boundary. It do
180
201
  not modify source files, and it does not affect citation hashes, which are computed
181
202
  from the original file text.
182
203
 
183
- To report a vulnerability, see [SECURITY.md](SECURITY.md).
184
-
185
- ## Install
186
-
187
- From npm (recommended):
188
-
189
- openclaw plugins install @ngo-a/native-memory-citations
190
-
191
- From a local checkout (development):
192
-
193
- openclaw plugins install ./native-memory-citations
194
-
195
- Reload the Gateway after installing so the plugin host exposes the tools.
204
+ To report a vulnerability, see [SECURITY.md](https://github.com/NGO-A/native-memory-citations/blob/master/SECURITY.md).
196
205
 
197
206
  ## Implementation notes
198
207
 
@@ -204,12 +213,12 @@ concurrency, and `AbortSignal` checks during the scan.
204
213
  ## Contributing
205
214
 
206
215
  Development setup, manifest generation, and the release process are documented in
207
- [CONTRIBUTING.md](CONTRIBUTING.md).
216
+ [CONTRIBUTING.md](https://github.com/NGO-A/native-memory-citations/blob/master/CONTRIBUTING.md).
208
217
 
209
218
  ## License
210
219
 
211
- MIT. See [LICENSE](LICENSE).
220
+ MIT. See [LICENSE](https://github.com/NGO-A/native-memory-citations/blob/master/LICENSE).
212
221
 
213
222
  ## Changelog
214
223
 
215
- See [CHANGELOG.md](CHANGELOG.md).
224
+ See [CHANGELOG.md](https://github.com/NGO-A/native-memory-citations/blob/master/CHANGELOG.md).
@@ -30,7 +30,7 @@
30
30
  },
31
31
  "additionalProperties": false
32
32
  },
33
- "version": "2026.6.1",
33
+ "version": "2026.6.2",
34
34
  "contracts": {
35
35
  "tools": [
36
36
  "native_memory_search",
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@ngo-a/native-memory-citations",
3
- "version": "2026.6.1",
3
+ "version": "2026.6.2",
4
4
  "type": "module",
5
5
  "description": "Native OpenClaw plugin for cited local memory search and retrieval.",
6
6
  "license": "MIT",