@mrciphersmith/keryx 0.2.16 → 0.2.18

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.
Files changed (3) hide show
  1. package/README.md +38 -0
  2. package/dist/cli.js +3097 -1777
  3. package/package.json +1 -1
package/README.md CHANGED
@@ -166,6 +166,32 @@ keryx shell --chat # chat without tools
166
166
  keryx shell --provider ollama --model gemma4:e4b # fully local
167
167
  ```
168
168
 
169
+ ### Version update advisory
170
+
171
+ `keryx shell` starts one bounded, non-blocking version check in the background.
172
+ It shows a notice only when the registry returns a strictly newer validated
173
+ version; it never installs anything and never blocks the shell or project work.
174
+ The same check is available to humans and agents with:
175
+
176
+ ```bash
177
+ keryx version check [--json]
178
+ ```
179
+
180
+ Successful metadata is cached for 24 hours, failed checks are suppressed for 15
181
+ minutes, and each registry request times out after 2 seconds. When an update is
182
+ available, the exact command is:
183
+
184
+ ```bash
185
+ npm install -g @mrciphersmith/keryx@latest
186
+ ```
187
+
188
+ Offline, timed-out, unknown, or otherwise unavailable results remain advisory
189
+ and do not stop work. The generated `.metaproject/index.md` instruction is
190
+ prompt guidance rather than enforcement, and existing installations from
191
+ before the first feature-bearing release cannot discover that release through
192
+ code they do not yet contain; existing projects gain the guidance only after
193
+ their index is regenerated or updated.
194
+
169
195
  Here it is answering a blast-radius question through the project graph rather
170
196
  than by reading files and guessing — one tool call, twelve seconds:
171
197
 
@@ -315,6 +341,13 @@ Alternative install paths — the managed installer (`~/.keryx` with a wrapper i
315
341
  Bare `keryx` prints the main commands; `keryx shell` starts the agent harness
316
342
  described [above](#the-agent-harness).
317
343
 
344
+ Agent mode protects each user turn with nested unique-signature budgets: `48`
345
+ total, including at most `40` risk-`read` signatures and `8` non-read (or
346
+ unknown-risk) signatures. An identical `tool + normalized input` may retry up
347
+ to three times while occupying one unique slot. Reaching a limit exactly still
348
+ gives the model a normal round to answer; only a new signature beyond a pool or
349
+ a no-progress repeat loop forces the final tool-free wrap-up.
350
+
318
351
  ## Agent integrations
319
352
 
320
353
  | Runtime | Integration |
@@ -328,6 +361,11 @@ After `init`, agents follow the root `AGENTS.md`/`CLAUDE.md` pointer to
328
361
  `.metaproject/index.md`, which routes them to the right capability. Two commands
329
362
  sharpen that routing:
330
363
 
364
+ `keryx orient` emits a bounded excerpt of the launch project's own
365
+ `.metaproject/index.md`, followed by the graph map and wiki index. The excerpt
366
+ directs the agent to read the full project-root entrypoint; it does not discover
367
+ or substitute an ancestor Metaproject.
368
+
331
369
  ```bash
332
370
  keryx orient install-hook --runtime codex # graph + wiki map at turn start
333
371
  keryx agents bootstrap install --runtime claude