enigma-memory 0.1.14 → 0.1.16
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 +64 -84
- package/apps/cli/bin/enigma.mjs +3151 -3126
- package/apps/native-host/README.md +20 -0
- package/deploy/SIMULATION.md +34 -38
- package/deploy/docker-compose.local-production-simulation.yml +5 -2
- package/docs/benchmark-attestation-network.md +2 -2
- package/docs/benchmark-reproducibility.md +240 -228
- package/docs/browser-extension-install.md +9 -6
- package/docs/client-connectors.md +22 -52
- package/docs/demo-proof-network.md +3 -3
- package/docs/developer-ecosystem.md +205 -223
- package/docs/developer-proof-quickstart.md +3 -3
- package/docs/enigma-memory-ready-conformance.md +1 -1
- package/docs/hosted-cloud-product.md +2 -0
- package/docs/install-anywhere.md +61 -66
- package/docs/memory-benchmarks.md +6 -3
- package/docs/proof-network-build-notes.md +2 -2
- package/docs/proof-network.md +32 -7
- package/docs/sdk-api.md +1 -1
- package/docs/solana-devnet-acceptance.md +1 -1
- package/docs/solana-proof-rail.md +1 -1
- package/package.json +278 -272
- package/packages/connectors/src/index.js +13 -0
- package/packages/mcp-server/README.md +22 -0
- package/packages/mcp-server/src/index.js +1185 -1185
- package/scripts/build-benchmark-proof-release.mjs +106 -5
- package/scripts/build-cloudflare-token-policy.mjs +6 -2
- package/scripts/build-hosted-api-key-lifecycle.mjs +274 -274
- package/scripts/build-hosted-customer-lifecycle.mjs +456 -456
- package/scripts/build-installer-assets.mjs +389 -389
- package/scripts/build-production-handoff-packet.mjs +1 -1
- package/scripts/build-production-unblocker.mjs +409 -409
- package/scripts/build-production-workplan.mjs +3 -1
- package/scripts/build-proof-network-packet.mjs +213 -213
- package/scripts/check.mjs +3 -1
- package/scripts/cloudflare-ops.mjs +35 -0
- package/scripts/collect-hosted-backend-live-evidence.mjs +44 -2
- package/scripts/run-memory-benchmarks.mjs +5 -0
- package/scripts/run-standard-memory-benchmarks.mjs +1194 -1070
- package/scripts/stage-cloudflare-pages-artifact.mjs +145 -0
package/README.md
CHANGED
|
@@ -2,96 +2,25 @@
|
|
|
2
2
|
|
|
3
3
|
Enigma Memory is a local-first AI Memory Passport. It gives you one canonical local memory vault, receipt-backed proof for Enigma-controlled events, and MCP connections into assistants such as Claude Desktop, Cursor, Kimi Code, and generic MCP clients.
|
|
4
4
|
|
|
5
|
-
Start with `enigma
|
|
5
|
+
Start with `enigma setup --overwrite` below. You do not need to understand relay, gateway, mesh, browser, desktop, hosted infrastructure, or the proof network before trying Enigma locally.
|
|
6
6
|
|
|
7
7
|
The package path needs no database, provider credential, cloud credential, npm publishing token, or external account. Hosted cloud and BYOC operation are separate advanced modes that require real deployment credentials, domains, TLS, durable storage, KMS/secrets, monitoring, backups, and operator acceptance.
|
|
8
8
|
|
|
9
9
|
Enigma does not claim that a closed provider deleted internal data, that model weights forgot, or that provider-native memory disappeared. It proves facts about Enigma-controlled vault state, receipts, checkpoints, and declared boundary operations.
|
|
10
10
|
|
|
11
|
-
## First run: install and inspect the safe local plan
|
|
12
|
-
|
|
13
|
-
The top public path is the published npm package plus the first-run planner:
|
|
14
|
-
|
|
15
|
-
```sh
|
|
16
|
-
npm install -g enigma-memory
|
|
17
|
-
enigma init --dry-run
|
|
18
|
-
```
|
|
19
|
-
|
|
20
|
-
`enigma init --dry-run` prints a public-safe JSON plan with exact next commands. It does not write local artifacts or third-party client configs, does not require provider credentials, hosted Enigma SaaS, Solana, or a browser extension, and states `provider_credentials_required:false`, `hosted_saas_live:false`, and `raw_memory_printed:false`.
|
|
21
|
-
|
|
22
|
-
When the plan looks right, create the local Memory Passport artifacts:
|
|
23
|
-
|
|
24
|
-
```sh
|
|
25
|
-
enigma init --overwrite
|
|
26
|
-
```
|
|
27
|
-
|
|
28
|
-
The execute path writes only local Enigma artifacts under the workspace `.enigma` path by default. It still does not write Claude, Cursor, Kimi, or other third-party app configs unless you explicitly add `--connect`.
|
|
29
|
-
|
|
30
|
-
Public demo path, preserved for reviewers who want the isolated proof/demo bundle:
|
|
31
|
-
|
|
32
|
-
```sh
|
|
33
|
-
enigma test-drive --overwrite
|
|
34
|
-
```
|
|
35
|
-
|
|
36
|
-
`enigma test-drive --overwrite` needs no database, provider API key, cloud credential, npm publishing token, package registry account, or hosted Enigma account. It runs entirely on the local filesystem, does not call OpenAI, Anthropic, Cloudflare, hosted Enigma, or other external providers, and does not write Claude, Cursor, Kimi, or other third-party client configs.
|
|
37
|
-
|
|
38
|
-
By default the command writes an isolated demo under `.enigma/test-drive`. Use `--dry-run` to print the plan without writing, or `--out-dir <path>` to choose another isolated demo directory. The default bundle and proof artifacts live inside that directory.
|
|
39
|
-
|
|
40
|
-
The test-drive output is a single public-safe JSON summary. It points to the local setup artifacts, search/status output, cross-model demo report, and benchmark pointers, and it prints exact next commands for testers without printing raw private memory plaintext. The proof is bounded to the local demo: Enigma-controlled vault state, receipts, checkpoints, committed roots, exported bundle shape, and declared boundary operations. It is not evidence that hosted SaaS is live, that a closed provider deleted internal data, that model weights forgot, or that provider-native memory disappeared.
|
|
41
|
-
|
|
42
|
-
When you are ready to connect real local clients that are already installed or already configured:
|
|
43
|
-
|
|
44
|
-
```sh
|
|
45
|
-
enigma init --connect --overwrite
|
|
46
|
-
```
|
|
47
|
-
|
|
48
|
-
`--connect` is the explicit first-run client-config write path. With default client selection it skips missing client configs instead of creating every default client config.
|
|
49
|
-
|
|
50
|
-
## Enigma Proof Network
|
|
51
|
-
|
|
52
|
-
Enigma Proof Network is the public proof layer for AI memory: local tools can package privacy-preserving roots, refs, counts, signatures, scoped capability grants, revocations, and benchmark attestations without exposing raw memory, prompts, transcripts, completions, embeddings, tenant names, private keys, provider responses, or provider credentials.
|
|
53
|
-
|
|
54
|
-
The `enigma chain anchor|grant|revoke|attest|verify` commands are local planning and verification commands. They emit public-safe JSON with `transaction_submitted:false` and `raw_memory_on_chain:false`; they do not submit Solana transactions, deploy hosted SaaS, create accounts, or call external providers.
|
|
55
|
-
|
|
56
|
-
Start with the category narrative in [`docs/market-category-narrative.md`](docs/market-category-narrative.md), then read the technical overview in [`docs/proof-network.md`](docs/proof-network.md), use its [Solana role](docs/proof-network.md#solana-role) section for the Solana-ready anchoring boundary, and read [`docs/proof-network-faq.md`](docs/proof-network-faq.md) for claim boundaries.
|
|
57
|
-
|
|
58
11
|
## Install once, use everywhere
|
|
59
12
|
|
|
60
13
|
Prerequisites:
|
|
61
14
|
|
|
62
15
|
- Node.js `>=24`
|
|
63
|
-
- No database, package registry account, provider credential,
|
|
16
|
+
- No database, package registry account, provider credential, cloud credential, hosted Enigma account, or external account for the local setup path
|
|
64
17
|
- Git only when you choose the advanced source-checkout path
|
|
65
18
|
|
|
66
|
-
Use Enigma as a one-time AI Memory Passport setup: install the package,
|
|
19
|
+
Use Enigma as a one-time AI Memory Passport setup: install the package, create the local Enigma workspace once, then use the same memory/search/context/verify/connect loop from any supported client.
|
|
67
20
|
|
|
68
21
|
```sh
|
|
69
22
|
npm install -g enigma-memory
|
|
70
|
-
enigma
|
|
71
|
-
enigma init --overwrite
|
|
72
|
-
```
|
|
73
|
-
|
|
74
|
-
`enigma init --overwrite` is the safe default for creating a regular local workspace after reviewing the plan. It writes local Enigma artifacts under the workspace `.enigma` path and emits deterministic, public-safe JSON without printing raw memory plaintext. It does not write Claude, Cursor, Kimi, or other third-party app configs.
|
|
75
|
-
|
|
76
|
-
To let first-run setup detect installed or already-configured clients and show the connector plan without mutating client configs:
|
|
77
|
-
|
|
78
|
-
```sh
|
|
79
|
-
enigma init --client auto --dry-run
|
|
80
|
-
```
|
|
81
|
-
|
|
82
|
-
`--client auto` selects clients found by connector detection and falls back to the default setup client list when none are present. The init output lists which clients were selected, which were skipped, and why.
|
|
83
|
-
|
|
84
|
-
Only when you are ready to explicitly write connector entries for installed/config-present clients:
|
|
85
|
-
|
|
86
|
-
```sh
|
|
87
|
-
enigma init --connect --overwrite
|
|
88
|
-
```
|
|
89
|
-
|
|
90
|
-
`--connect` implies installed/config-present client selection when no explicit `--client` is supplied and is an explicit client-config write flag. It skips missing client configs instead of creating every default client config. Existing setup commands remain available: `enigma setup --overwrite`, `enigma setup --client auto --overwrite`, and `enigma setup --connect-installed --overwrite`. Existing explicit connector writes remain available through `enigma connect <client>` without `--dry-run`; keep `--dry-run` while reviewing a single planned MCP entry.
|
|
91
|
-
|
|
92
|
-
After init or setup, use the same local vault from the CLI or connected clients:
|
|
93
|
-
|
|
94
|
-
```sh
|
|
23
|
+
enigma setup --overwrite
|
|
95
24
|
enigma remember --text-file ./memory.txt
|
|
96
25
|
enigma search --query "..."
|
|
97
26
|
enigma context --query "..." --optimize
|
|
@@ -99,15 +28,18 @@ enigma verify --export ./.enigma/export.json
|
|
|
99
28
|
enigma connect claude-desktop --dry-run
|
|
100
29
|
```
|
|
101
30
|
|
|
102
|
-
`enigma
|
|
31
|
+
`enigma setup --overwrite` writes local Enigma artifacts under the workspace `.enigma` path and emits deterministic, public-safe JSON without printing raw memory plaintext. It does not write Claude, Cursor, Kimi, or other third-party app configs. Client config writes happen only when you explicitly run `enigma connect <client>` without `--dry-run`; keep `--dry-run` while reviewing the planned MCP entry.
|
|
103
32
|
|
|
104
33
|
The local Enigma vault remains canonical. Provider-native memory is non-canonical and should be treated as a convenience cache only. Enigma receipts prove Enigma-controlled vault state, receipts, checkpoints, and declared boundary operations; they do not prove provider deletion, provider model forgetting, provider-native memory removal, hosted availability, ROI/savings, or compliance certification.
|
|
105
34
|
|
|
106
|
-
|
|
35
|
+
## Enigma Proof Network
|
|
36
|
+
|
|
37
|
+
Enigma Proof Network is the public proof layer for AI memory: local tools can package privacy-preserving roots, refs, counts, signatures, scoped capability grants, revocations, and benchmark attestations without exposing raw memory, prompts, transcripts, completions, embeddings, tenant names, private keys, provider responses, or provider credentials.
|
|
38
|
+
|
|
39
|
+
The `enigma chain anchor|grant|revoke|attest|verify` commands are local planning and verification commands. They emit public-safe JSON with `transaction_submitted:false` and `raw_memory_on_chain:false`; they do not submit Solana transactions, deploy hosted SaaS, create accounts, or call external providers.
|
|
40
|
+
|
|
41
|
+
Start with the category narrative in [`docs/market-category-narrative.md`](docs/market-category-narrative.md), then read the technical overview in [`docs/proof-network.md`](docs/proof-network.md), use its [Solana role](docs/proof-network.md#solana-role) section for the Solana-ready anchoring boundary, and read [`docs/proof-network-faq.md`](docs/proof-network-faq.md) for claim boundaries.
|
|
107
42
|
|
|
108
|
-
```sh
|
|
109
|
-
npx --yes --package enigma-memory enigma test-drive --overwrite
|
|
110
|
-
```
|
|
111
43
|
|
|
112
44
|
## Advanced/source-only path
|
|
113
45
|
|
|
@@ -214,7 +146,7 @@ Supported connector profiles are:
|
|
|
214
146
|
- `opencode`
|
|
215
147
|
- `generic-mcp`
|
|
216
148
|
|
|
217
|
-
After `enigma
|
|
149
|
+
After `enigma setup --overwrite`, preview a client connection before writing anything:
|
|
218
150
|
|
|
219
151
|
```sh
|
|
220
152
|
enigma connect claude-desktop --dry-run
|
|
@@ -223,11 +155,59 @@ enigma connect kimi-code --dry-run
|
|
|
223
155
|
enigma connect generic-mcp --dry-run
|
|
224
156
|
```
|
|
225
157
|
|
|
226
|
-
|
|
158
|
+
Remove `--dry-run` from `enigma connect <client>` only after you are ready for Enigma to merge the `mcpServers.enigma` entry into that specific client config. The safe default setup command never writes third-party app configs.
|
|
159
|
+
|
|
160
|
+
Copy-paste MCP snippets:
|
|
161
|
+
|
|
162
|
+
Claude Desktop:
|
|
163
|
+
|
|
164
|
+
```json
|
|
165
|
+
{
|
|
166
|
+
"mcpServers": {
|
|
167
|
+
"enigma": {
|
|
168
|
+
"command": "enigma-mcp",
|
|
169
|
+
"args": [],
|
|
170
|
+
"env": {
|
|
171
|
+
"ENIGMA_BUNDLE": "/absolute/path/to/.enigma/bundle.json"
|
|
172
|
+
}
|
|
173
|
+
}
|
|
174
|
+
}
|
|
175
|
+
}
|
|
176
|
+
```
|
|
177
|
+
|
|
178
|
+
Cursor:
|
|
179
|
+
|
|
180
|
+
```json
|
|
181
|
+
{
|
|
182
|
+
"mcpServers": {
|
|
183
|
+
"enigma": {
|
|
184
|
+
"command": "enigma-mcp",
|
|
185
|
+
"args": [],
|
|
186
|
+
"env": {
|
|
187
|
+
"ENIGMA_BUNDLE": "/absolute/path/to/.enigma/bundle.json"
|
|
188
|
+
}
|
|
189
|
+
}
|
|
190
|
+
}
|
|
191
|
+
}
|
|
192
|
+
```
|
|
193
|
+
|
|
194
|
+
Kimi Code:
|
|
227
195
|
|
|
228
|
-
|
|
196
|
+
```json
|
|
197
|
+
{
|
|
198
|
+
"mcpServers": {
|
|
199
|
+
"enigma": {
|
|
200
|
+
"command": "enigma-mcp",
|
|
201
|
+
"args": [],
|
|
202
|
+
"env": {
|
|
203
|
+
"ENIGMA_BUNDLE": "/absolute/path/to/.enigma/bundle.json"
|
|
204
|
+
}
|
|
205
|
+
}
|
|
206
|
+
}
|
|
207
|
+
}
|
|
208
|
+
```
|
|
229
209
|
|
|
230
|
-
|
|
210
|
+
Generic MCP:
|
|
231
211
|
|
|
232
212
|
```json
|
|
233
213
|
{
|