enigma-memory 0.1.13 → 0.1.14
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 +36 -17
- package/apps/cli/bin/enigma.mjs +320 -42
- package/deploy/docker-compose.local-production-simulation.yml +10 -11
- package/docs/benchmark-attestation-network.md +487 -487
- package/docs/benchmark-reproducibility.md +10 -9
- package/docs/demo-proof-network.md +275 -275
- package/docs/developer-ecosystem.md +223 -223
- package/docs/developer-proof-quickstart.md +325 -325
- package/docs/enigma-memory-ready-conformance.md +376 -376
- package/docs/hosted-cloud-product.md +10 -0
- package/docs/install-anywhere.md +34 -17
- package/docs/installers-and-desktop.md +9 -7
- package/docs/proof-network-build-notes.md +240 -240
- package/docs/proof-network.md +257 -257
- package/docs/sdk-api.md +324 -324
- package/docs/solana-devnet-acceptance.md +48 -0
- package/docs/solana-proof-rail.md +453 -453
- package/examples/ci/github-actions.yml +6 -8
- package/package.json +8 -1
- package/packages/mcp-server/src/index.js +1 -1
- package/packages/passport/src/index.js +9 -5
- package/scripts/build-benchmark-proof-release.mjs +391 -0
- package/scripts/build-goal-completion-audit.mjs +11 -5
- package/scripts/build-hosted-api-key-lifecycle.mjs +1 -1
- package/scripts/build-hosted-customer-lifecycle.mjs +1 -1
- package/scripts/build-installer-assets.mjs +126 -10
- package/scripts/build-production-handoff-packet.mjs +7 -6
- package/scripts/build-production-unblocker.mjs +409 -0
- package/scripts/build-proof-network-packet.mjs +1 -1
- package/scripts/release-audit.mjs +71 -2
- package/scripts/run-standard-memory-benchmarks.mjs +1 -1
- package/scripts/wait-for-backend-ready.mjs +4 -2
|
@@ -49,6 +49,16 @@ Hosted cloud remains blocked until an operator wires and records evidence for al
|
|
|
49
49
|
|
|
50
50
|
A `provided` operator evidence ref means the contract can point to external evidence. It still does not by itself make hosted cloud sellable; an operator must complete the release checklist and issue go-live approval. A `blocked_external_dependency` ref is an explicit blocker, not fake evidence.
|
|
51
51
|
|
|
52
|
+
## Consolidated unblocker report
|
|
53
|
+
|
|
54
|
+
Before treating hosted cloud as sellable, run the consolidated public-safe unblocker report:
|
|
55
|
+
|
|
56
|
+
```sh
|
|
57
|
+
npm run production:unblocker -- --out .enigma/production-unblocker.json
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
The report emits `enigma.production_unblocker.v1` with hosted cloud, Solana proof rail, benchmark claim, installer distribution, npm install, and monitoring/ops status in one place. It is dry-run/planning by default, requires no credentials, and does not create accounts, deploy infrastructure, submit transactions, call providers, or mutate external systems. Hosted cloud should remain `blocked_external_dependency` until real external provider evidence and operator go-live approval exist.
|
|
61
|
+
|
|
52
62
|
## Customer lifecycle packet
|
|
53
63
|
|
|
54
64
|
`npm run production:hosted-customer -- --tenant <id> --domain <domain> --environment <env> --out <file>` builds `enigma.hosted_cloud.customer_lifecycle_packet.v1` readiness evidence for a tenant launch packet. Operators may pass repeatable `--evidence-ref <key=status:ref>` values and `--operator-go-live-ref <ref>` when real external evidence exists. The command writes public-safe validation evidence only: it creates no hosted account, tenant, vault, API key, invoice, support ticket, backup, Cloudflare resource, provider resource, secret, or deployment.
|
package/docs/install-anywhere.md
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
# Install Enigma anywhere
|
|
2
2
|
|
|
3
|
-
Start with the published npm package path for `enigma-memory`: install once, run
|
|
3
|
+
Start with the published npm package path for `enigma-memory`: install once, run `enigma init --dry-run` to inspect the local plan, then execute local setup and connect real local clients only when you explicitly choose to. Use a source checkout only when you need source-only docs, Docker assets, browser-extension scaffolding, package development, or release scripts.
|
|
4
4
|
|
|
5
|
-
Hosted cloud and BYOC operation require real deployment credentials, domains, TLS, durable storage, KMS/secrets, monitoring, backups, and operator/customer infrastructure; they are not activated by installing the package or running the test drive.
|
|
5
|
+
Hosted cloud and BYOC operation require real deployment credentials, domains, TLS, durable storage, KMS/secrets, monitoring, backups, and operator/customer infrastructure; they are not activated by installing the package, running init, or running the test drive.
|
|
6
6
|
|
|
7
7
|
## Requirements
|
|
8
8
|
|
|
@@ -12,12 +12,28 @@ Hosted cloud and BYOC operation require real deployment credentials, domains, TL
|
|
|
12
12
|
- Git only for the advanced source-checkout path
|
|
13
13
|
- Optional: Docker for source-checkout containerized relay/gateway operation
|
|
14
14
|
|
|
15
|
-
##
|
|
15
|
+
## First run: inspect the safe local plan
|
|
16
16
|
|
|
17
17
|
Use the published package as the primary path:
|
|
18
18
|
|
|
19
19
|
```sh
|
|
20
20
|
npm install -g enigma-memory
|
|
21
|
+
enigma init --dry-run
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
`enigma init --dry-run` emits a public-safe JSON plan with exact next commands. It writes no local artifacts, writes no third-party client configs, does not call external providers, does not contact hosted Enigma SaaS, and does not require provider credentials, Solana, or browser extension installation. The output states `provider_credentials_required:false`, `hosted_saas_live:false`, and `raw_memory_printed:false`.
|
|
25
|
+
|
|
26
|
+
When the plan looks right, create the regular local workspace:
|
|
27
|
+
|
|
28
|
+
```sh
|
|
29
|
+
enigma init --overwrite
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
`enigma init --overwrite` writes the local bundle, context pack, export, and verify report under `.enigma` by default. It does not write Claude, Cursor, Kimi, or other third-party client configs unless you explicitly add `--connect`.
|
|
33
|
+
|
|
34
|
+
The isolated proof/demo command is still available for public reviewers:
|
|
35
|
+
|
|
36
|
+
```sh
|
|
21
37
|
enigma test-drive --overwrite
|
|
22
38
|
```
|
|
23
39
|
|
|
@@ -30,31 +46,32 @@ Keep the claim bounded: the test drive proves local Enigma-controlled vault stat
|
|
|
30
46
|
To connect real local clients that are already installed or already configured:
|
|
31
47
|
|
|
32
48
|
```sh
|
|
33
|
-
enigma
|
|
49
|
+
enigma init --connect --overwrite
|
|
34
50
|
```
|
|
35
51
|
|
|
36
|
-
`--connect
|
|
52
|
+
`--connect` is the init-time write flag for client configs. With default client selection it skips missing client configs instead of creating every default client config.
|
|
37
53
|
|
|
38
54
|
## Default path: install once, use everywhere
|
|
39
55
|
|
|
40
|
-
After the
|
|
56
|
+
After reviewing the first-run plan, create a regular local workspace when you want to use Enigma day to day:
|
|
41
57
|
|
|
42
58
|
```sh
|
|
43
59
|
npm install -g enigma-memory
|
|
44
|
-
enigma
|
|
60
|
+
enigma init --dry-run
|
|
61
|
+
enigma init --overwrite
|
|
45
62
|
```
|
|
46
63
|
|
|
47
|
-
`enigma
|
|
64
|
+
`enigma init --overwrite` is the safe default for a regular local workspace. 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.
|
|
48
65
|
|
|
49
|
-
To let
|
|
66
|
+
To let init auto-detect installed or already-configured clients and show the connector plan without mutating client configs:
|
|
50
67
|
|
|
51
68
|
```sh
|
|
52
|
-
enigma
|
|
69
|
+
enigma init --client auto --dry-run
|
|
53
70
|
```
|
|
54
71
|
|
|
55
|
-
`--client auto` selects clients found by connector detection and falls back to the default setup client list when none are present. The
|
|
72
|
+
`--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. Existing setup commands remain available: `enigma setup --overwrite`, `enigma setup --client auto --overwrite`, and `enigma setup --connect-installed --overwrite`.
|
|
56
73
|
|
|
57
|
-
After setup, use the same local vault from the CLI or connected clients:
|
|
74
|
+
After init or setup, use the same local vault from the CLI or connected clients:
|
|
58
75
|
|
|
59
76
|
```sh
|
|
60
77
|
enigma remember --text-file ./memory.txt
|
|
@@ -213,13 +230,13 @@ Npm-first connector flow:
|
|
|
213
230
|
|
|
214
231
|
```sh
|
|
215
232
|
npm install -g enigma-memory
|
|
216
|
-
enigma
|
|
217
|
-
enigma
|
|
218
|
-
enigma
|
|
219
|
-
enigma
|
|
233
|
+
enigma init --dry-run
|
|
234
|
+
enigma init --overwrite
|
|
235
|
+
enigma init --client auto --dry-run
|
|
236
|
+
enigma init --connect --overwrite
|
|
220
237
|
```
|
|
221
238
|
|
|
222
|
-
Run `enigma
|
|
239
|
+
Run `enigma init --dry-run` first to inspect the safe local plan without credentials, hosted SaaS, provider calls, raw memory output, or client-config writes. Run `enigma init --overwrite` for a regular local workspace. Use `--client auto --dry-run` when you want init to report installed/config-present connector targets without writing client configs. Use `--connect` only when you explicitly want init to merge Enigma into installed/config-present client configs by default; missing configs are skipped with reasons instead of created. Existing `enigma setup --overwrite`, `enigma setup --client auto --overwrite`, `enigma setup --connect-installed --overwrite`, and `enigma setup --write-connectors` behavior remains available. For a single client, replace `claude-desktop` with `cursor`, `kimi-code`, `vscode-cline`, `roo`, `opencode`, or `generic-mcp` and run `enigma connect <client> --dry-run` before writing.
|
|
223
240
|
|
|
224
241
|
Copy-paste MCP entry for Claude Desktop, Cursor, Kimi Code, or a generic MCP client:
|
|
225
242
|
|
|
@@ -8,11 +8,13 @@ Use the published package path when you want the current supported local install
|
|
|
8
8
|
|
|
9
9
|
```sh
|
|
10
10
|
npm install -g enigma-memory
|
|
11
|
-
enigma
|
|
11
|
+
enigma test-drive --dry-run
|
|
12
|
+
enigma setup --overwrite
|
|
12
13
|
enigma doctor
|
|
14
|
+
enigma connect <client> --dry-run
|
|
13
15
|
```
|
|
14
16
|
|
|
15
|
-
The package exposes the CLI bins `enigma`, `enigma-verify`, `enigma-mcp`, `enigma-relay`, `enigma-gateway`, and `enigma-native-host`. Node.js `>=24` is required. The
|
|
17
|
+
The package exposes the CLI bins `enigma`, `enigma-verify`, `enigma-mcp`, `enigma-relay`, `enigma-gateway`, and `enigma-native-host`. Node.js `>=24` is required. The installer smoke path keeps `enigma test-drive --dry-run` and `enigma connect <client> --dry-run` non-mutating; `enigma setup --overwrite` writes Enigma-controlled local artifacts only and does not write third-party app configs. It does not prove provider deletion, model forgetting, hosted availability, compliance certification, savings, or provider-native memory removal.
|
|
16
18
|
|
|
17
19
|
## Tier 2: generated source installer assets
|
|
18
20
|
|
|
@@ -30,14 +32,14 @@ node scripts/build-installer-assets.mjs --out-dir dist/installer-assets --write
|
|
|
30
32
|
|
|
31
33
|
Generated asset paths are listed in deterministic code-point lexical order:
|
|
32
34
|
|
|
33
|
-
- `homebrew/enigma-memory.rb` — Homebrew formula draft. It is not submitted to a tap by the generator; release engineering must replace the source archive URL and SHA before any tap workflow.
|
|
34
|
-
- `install-linux.sh` — POSIX shell source installer. It previews by default and only mutates global npm/local
|
|
35
|
-
- `install-windows.ps1` — PowerShell source installer. It previews by default and only runs `npm install -g enigma-memory`, `enigma
|
|
35
|
+
- `homebrew/enigma-memory.rb` — Homebrew formula draft. It is not submitted to a tap by the generator; release engineering must replace the source archive URL and SHA before any tap workflow. Its test metadata exercises `enigma test-drive --dry-run`, `enigma setup --dry-run`, and `enigma doctor`, then prints the next client-connect preview command.
|
|
36
|
+
- `install-linux.sh` — POSIX shell source installer. It previews by default and only mutates global npm/local setup files when called with `--execute`. Its preview includes package install, `enigma test-drive --dry-run`, `enigma setup --bundle <bundle> --overwrite`, `enigma doctor`, and `enigma connect <client> --dry-run` as the next client-connect command.
|
|
37
|
+
- `install-windows.ps1` — PowerShell source installer. It previews by default and only runs `npm install -g enigma-memory`, `enigma test-drive --dry-run`, `enigma setup --bundle <bundle> --overwrite`, and `enigma doctor` when called with `-Execute`; it then prints `enigma connect <client> --dry-run` as the next client-connect command.
|
|
36
38
|
- `installer-assets-manifest.json` — deterministic public manifest with checksums for the generated source assets.
|
|
37
39
|
- `macos-pkgbuild/README.md` — macOS package source plan and blockers, not a signed package.
|
|
38
40
|
- `macos-pkgbuild/manifest.json` — macOS package source metadata and blockers, not a signed package.
|
|
39
41
|
|
|
40
|
-
The generator intentionally redacts the requested output directory in its public manifest as `<requested-output-dir>`. The generated content must not embed tokens, local absolute paths, account identifiers, raw memory, provider transcripts, signing identities, or hosted credentials.
|
|
42
|
+
The generator intentionally redacts the requested output directory in its public manifest as `<requested-output-dir>`. The manifest records only deterministic asset metadata, the public installer smoke commands, explicit execute gates, and blocker codes. The generated content must not embed tokens, local absolute paths, account identifiers, raw memory, provider transcripts, signing identities, or hosted credentials.
|
|
41
43
|
|
|
42
44
|
## Native `.exe` and `.pkg` blockers
|
|
43
45
|
|
|
@@ -60,7 +62,7 @@ Until those blockers are cleared, use npm or generated source scripts only.
|
|
|
60
62
|
|
|
61
63
|
## Homebrew path
|
|
62
64
|
|
|
63
|
-
The formula generated under `homebrew/enigma-memory.rb` is a draft for a future tap workflow. It records the intended package name, license, Node dependency, command shims, and test shape
|
|
65
|
+
The formula generated under `homebrew/enigma-memory.rb` is a draft for a future tap workflow. It records the intended package name, license, Node dependency, command shims, and installer smoke test shape: `enigma test-drive --dry-run`, `enigma setup --dry-run`, `enigma doctor`, and the printed next command `enigma connect <client> --dry-run`. Before publication, release engineering must replace the placeholder tarball URL and SHA with a real release archive and confirm the formula installs only the intended package files.
|
|
64
66
|
|
|
65
67
|
## Desktop tray model boundary
|
|
66
68
|
|