@simonsbs/keylore 1.0.0-rc6 → 1.0.0
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 +11 -8
- package/dist/config.js +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -6,7 +6,7 @@ The design goal comes directly from the local `KeyLore.md` production spec used
|
|
|
6
6
|
|
|
7
7
|
## Status
|
|
8
8
|
|
|
9
|
-
This repository is
|
|
9
|
+
This repository is now public and open source. The repo already includes:
|
|
10
10
|
|
|
11
11
|
- an Apache-2.0 project license and `NOTICE`
|
|
12
12
|
- contributor and security policies
|
|
@@ -64,13 +64,14 @@ This repository is incubating privately today, but it is structured to be publis
|
|
|
64
64
|
|
|
65
65
|
## What is intentionally deferred
|
|
66
66
|
|
|
67
|
-
The full `KeyLore.md` specification is broader than a sane `v1.0.0
|
|
67
|
+
The full `KeyLore.md` specification is broader than a sane `v1.0.0` delivery. The main remaining work after `v1.0.0` is:
|
|
68
68
|
|
|
69
|
-
-
|
|
69
|
+
- continued UX refinement for context authoring
|
|
70
|
+
- stronger self-hosted production guidance for advanced deployments
|
|
70
71
|
|
|
71
72
|
Those items are tracked in [docs/roadmap.md](/home/simon/keylore/docs/roadmap.md) and mapped back to the spec in [docs/keylore-spec-map.md](/home/simon/keylore/docs/keylore-spec-map.md).
|
|
72
73
|
|
|
73
|
-
The active post-`v1.0.0
|
|
74
|
+
The active post-`v1.0.0` refocus is documented in [docs/core-mode-plan.md](/home/simon/keylore/docs/core-mode-plan.md): keep the default user journey "add secret, add context, connect MCP, use it" simple and push broader operator features behind an advanced path.
|
|
74
75
|
|
|
75
76
|
The handoff from local core mode to advanced self-hosted mode is documented in [docs/production-handoff.md](/home/simon/keylore/docs/production-handoff.md).
|
|
76
77
|
|
|
@@ -93,7 +94,7 @@ That starts KeyLore in the background. Use `keylore-http status`, `keylore-http
|
|
|
93
94
|
For a clean Linux VM install from npm instead of cloning the repo:
|
|
94
95
|
|
|
95
96
|
```bash
|
|
96
|
-
npm install -g @simonsbs/keylore
|
|
97
|
+
npm install -g @simonsbs/keylore
|
|
97
98
|
keylore-http start
|
|
98
99
|
```
|
|
99
100
|
|
|
@@ -120,9 +121,11 @@ If that local session bootstrap fails for any reason, use `Start working locally
|
|
|
120
121
|
|
|
121
122
|
4. In `Quick start`, follow the short path: add token, test token, then connect your AI tool.
|
|
122
123
|
|
|
123
|
-
5. In `Your tokens`, click `Add token`,
|
|
124
|
+
5. In `Your tokens`, click `Add token`, then fill in:
|
|
124
125
|
- `Name shown in KeyLore`
|
|
125
126
|
- `Token key`
|
|
127
|
+
- `Where to store the token`
|
|
128
|
+
- `Service name`
|
|
126
129
|
- `Paste token`
|
|
127
130
|
- `Where can it be used?`
|
|
128
131
|
- `Explain this token for people`
|
|
@@ -130,7 +133,7 @@ If that local session bootstrap fails for any reason, use `Start working locally
|
|
|
130
133
|
|
|
131
134
|
That stores the raw token outside the searchable catalogue and keeps only the metadata record in the credential catalogue.
|
|
132
135
|
|
|
133
|
-
6.
|
|
136
|
+
6. Use the inline `(i)` help beside each field and review `What the AI will see` to confirm the record is specific, useful, and secret-free. `LLM context` is the primary retrieval hint for agents. `User context` explains the human purpose of the token. `Token key` is the unique identifier for the token; if KeyLore says a token already exists, change that field and save again.
|
|
134
137
|
|
|
135
138
|
7. In `Saved tokens`, everything is now listed together in one place. Example records are marked as examples, and they can be edited or deleted from the same list.
|
|
136
139
|
|
|
@@ -234,7 +237,7 @@ Validate the Helm deployment path:
|
|
|
234
237
|
npm run ops:helm-validate
|
|
235
238
|
```
|
|
236
239
|
|
|
237
|
-
Run the release
|
|
240
|
+
Run the release gates:
|
|
238
241
|
|
|
239
242
|
```bash
|
|
240
243
|
npm run ops:release-verify
|
package/dist/config.js
CHANGED
|
@@ -205,7 +205,7 @@ export function loadConfig(cwd = process.cwd()) {
|
|
|
205
205
|
}
|
|
206
206
|
return {
|
|
207
207
|
appName: "keylore",
|
|
208
|
-
version: "1.0.0
|
|
208
|
+
version: "1.0.0",
|
|
209
209
|
dataDir,
|
|
210
210
|
bootstrapCatalogPath: path.resolve(runtimeRoot, "data", env.KEYLORE_CATALOG_FILE ?? "catalog.json"),
|
|
211
211
|
bootstrapPolicyPath: path.resolve(runtimeRoot, "data", env.KEYLORE_POLICY_FILE ?? "policies.json"),
|