@lorekit/cli 1.8.0 → 1.9.0

package/README.md

@@ -134,6 +134,45 @@ lorekit list --json          # structured { offline, remote } payload for script
 `--endpoint` / `--token` override the remote connection; `--store` overrides the
 local project-tier directory.
 
+### `lorekit search` (alias `grep`)
+
+Full-text search across the same applicable scopes and the same two stores as
+`list`, rendered in the same Offline / Remote split. A lesson matches when the
+query appears — **case-insensitively, as a literal substring** — in its **key or
+value**:
+
+```bash
+lorekit search sandbox            # both sections, only the matching lessons
+lorekit grep "flaky test"         # same, via the alias
+lorekit search migration --scope global
+lorekit search build --json       # { query, offline, remote } for scripts
+```
+
+The query is matched with a plain substring check, **never compiled as a regex**,
+so a term full of metacharacters (`a.*(b)`) matches those characters verbatim —
+no injection, no surprises. It is read-only, hides archived lessons, and degrades
+the remote section gracefully (an unconfigured remote is a note, not an error;
+the command still exits 0). An empty query is a usage error; no matches prints a
+friendly "no lessons match" note (exit 0). `--scope` narrows to one scope;
+`--endpoint` / `--token` / `--store` behave as in `list`.
+
+### `lorekit show`
+
+Inspect **one** lesson in full — its complete, **untruncated** value plus scope,
+key, updated date, tags, and which store(s) it lives in:
+
+```bash
+lorekit show global prefer-guard-clauses
+lorekit show project::widget build-flags --json
+```
+
+If the same `scope::key` exists in **both** the offline and remote stores —
+possibly with different values — both are shown and any divergence is flagged.
+When it lives in only one store, that copy is shown and the other is noted as
+missing. It exits **non-zero** when the key is found in no readable store, so it
+fits scripts. `--json` emits the full normalized record(s) and which store each
+came from. Both a scope and a key are required (else a usage error).
+
 ### `lorekit hook`
 
 The **shared hook engine** behind the Claude Code / Cursor / Codex plugins.
@@ -316,8 +355,8 @@ active deny constraints.
 | `--no-hooks` | Skip wiring the lifecycle hooks; skill + MCP only (`install`) |
 | `--force` | Overwrite existing skill files (`install`) |
 | `--deep` | Write/read/delete round-trip (`doctor`) |
-| `--json` | Machine-readable output (`list`) |
-| `--scope <scope>` | Restrict to a single scope (`list`; default: all applicable) |
+| `--json` | Machine-readable output (`list` / `search` / `show`) |
+| `--scope <scope>` | Restrict to a single scope (`list` / `search`; default: all applicable) |
 | `--adapter <name>` | Host framework for `hook`: `claude` / `cursor` / `codex` |
 | `--event <name>` | Host hook event for `hook` (else read from the stdin payload) |
 | `-h, --help` | Help |
@@ -402,7 +441,8 @@ forever. This reduces manual validation to a single capture pass per tool.
 
 ## Usage telemetry
 
-The human-facing commands (`install`, `uninstall`, `doctor`, `list`, `migrate`)
+The human-facing commands (`install`, `uninstall`, `doctor`, `list`, `search`,
+`show`, `migrate`)
 emit one OpenTelemetry span + one counter point per run so the maintainers can see which
 commands people use. It is zero-dependency (OTLP/JSON over `fetch`, no SDK) and
 deliberately narrow — it carries only the command name, a bounded set of boolean

package/bin/lorekit.mjs

@@ -7,6 +7,8 @@ import { install } from '../src/install.mjs';
 import { uninstall } from '../src/uninstall.mjs';
 import { doctor } from '../src/doctor.mjs';
 import { list } from '../src/list.mjs';
+import { search } from '../src/search.mjs';
+import { show } from '../src/show.mjs';
 import { hook } from '../src/hook.mjs';
 import { migrate } from '../src/migrate.mjs';
 import { mcpServer } from '../src/mcp-server.mjs';
@@ -40,6 +42,12 @@ ${c.bold('Commands')}
               an Offline section (local .lorekit/ + ~/.lorekit/) and a Remote
               section (hosted MCP). Groups by scope (project/branch/repo/global).
               --json for scripting, --scope <s> to narrow.
+  search      Full-text search the applicable lessons across both stores and all
+    (grep)    scopes (case-insensitive, literal substring over key + value),
+              rendered in the same Offline/Remote split. --json, --scope <s>.
+  show        Inspect one lesson in full: its complete value, scope, key, updated
+              date, tags, and which store(s) it lives in (noting any divergence
+              when it is in both). --json. Usage: show <scope> <key>.
   migrate     Relocate a LoreKit-format local store into the current layout.
               Dry-run by default; pass --yes to apply. Idempotent.
   hook        Hook engine for Claude Code / Cursor / Codex. Reads the host's
@@ -58,8 +66,8 @@ ${c.bold('Options')}
   -t, --token <token>     LoreKit token (lk_rw_* to allow writes, lk_ro_* read-only)
       --mode <mode>       Memory mode: off | local | remote (doctor override)
       --store <path>      Local project-tier store directory (default: .lorekit)
-      --json              Machine-readable output (list)
-      --scope <scope>     Restrict to a single scope (list)
+      --json              Machine-readable output (list / search / show)
+      --scope <scope>     Restrict to a single scope (list / search)
       --from <path>       Source store to migrate from (migrate)
       --to <tier>         Migration destination tier: home | project (migrate;
                           default routes each entry by scope)
@@ -187,6 +195,51 @@ ${c.bold('Examples')}
   npx @lorekit/cli list
   npx @lorekit/cli list --json
   npx @lorekit/cli list --scope global
+`,
+  search: `${c.bold('lorekit search')} — full-text search the applicable lessons ${c.dim('(alias: grep)')}
+
+${c.bold('Usage')}
+  npx @lorekit/cli search <query> [options]
+
+Searches every lesson for the current directory's scopes (project/branch/repo/
+global) across both stores, matching the query case-insensitively as a LITERAL
+substring of a lesson's key or value (regex metacharacters are matched verbatim,
+never interpreted). Results are shown in the same Offline / Remote split as
+\`list\`; an unconfigured remote degrades to a short note, never an error.
+
+${c.bold('Options')}
+  -d, --dir <path>        Target project root (default: current directory)
+      --scope <scope>     Restrict to a single scope (default: all applicable)
+      --json              Machine-readable output
+  -e, --endpoint <url>    Remote endpoint override (else .mcp.json / LOREKIT_MCP_URL)
+  -t, --token <token>     Remote token override (else .mcp.json / LOREKIT_TOKEN)
+      --store <path>      Local project-tier store directory (default: .lorekit)
+
+${c.bold('Examples')}
+  npx @lorekit/cli search sandbox
+  npx @lorekit/cli grep "flaky test" --json
+  npx @lorekit/cli search migration --scope global
+`,
+  show: `${c.bold('lorekit show')} — inspect one lesson in full
+
+${c.bold('Usage')}
+  npx @lorekit/cli show <scope> <key> [options]
+
+Prints one lesson's complete (untruncated) value, scope, key, updated date, tags,
+and which store(s) it lives in. If the same scope::key exists in both the offline
+and remote stores, both are shown and any divergence in their values is flagged.
+Exits non-zero when the key is found in neither readable store.
+
+${c.bold('Options')}
+  -d, --dir <path>        Target project root (default: current directory)
+      --json              Machine-readable output (the full normalized record(s))
+  -e, --endpoint <url>    Remote endpoint override (else .mcp.json / LOREKIT_MCP_URL)
+  -t, --token <token>     Remote token override (else .mcp.json / LOREKIT_TOKEN)
+      --store <path>      Local project-tier store directory (default: .lorekit)
+
+${c.bold('Examples')}
+  npx @lorekit/cli show global prefer-guard-clauses
+  npx @lorekit/cli show project::widget build-flags --json
 `,
   migrate: `${c.bold('lorekit migrate')} — relocate a LoreKit-format local store into the current layout
 
@@ -246,11 +299,13 @@ const KNOWN_FLAGS = [
 // Commands that write to disk / talk to the network on a human's behalf. These
 // reject unknown flags; the machine-facing `hook` / `mcp` do not (they must
 // never fail on a stray flag, and only ever receive flags we control).
-const HUMAN_COMMANDS = new Set(['install', 'uninstall', 'doctor', 'list', 'migrate']);
+const HUMAN_COMMANDS = new Set([
+  'install', 'uninstall', 'doctor', 'list', 'search', 'show', 'migrate',
+]);
 
 // Command aliases — canonicalized before help / dispatch so `lorekit ls --help`
 // and telemetry both resolve to the real command name.
-const COMMAND_ALIASES = { ls: 'list' };
+const COMMAND_ALIASES = { ls: 'list', grep: 'search' };
 
 async function main() {
   // Load a `.env` from the current directory (if any) before anything reads the
@@ -321,6 +376,10 @@ async function main() {
       return traceCommand('doctor', args, VERSION, () => doctor(args));
     case 'list':
       return traceCommand('list', args, VERSION, () => list(args));
+    case 'search':
+      return traceCommand('search', args, VERSION, () => search(args));
+    case 'show':
+      return traceCommand('show', args, VERSION, () => show(args));
     case 'migrate':
       return traceCommand('migrate', args, VERSION, () => migrate(args));
     default:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lorekit/cli",
-  "version": "1.8.0",
+  "version": "1.9.0",
   "description": "Install the LoreKit shared-memory skill and run health checks for the LoreKit MCP server.",
   "license": "MIT",
   "repository": {

package/src/search.mjs

@@ -0,0 +1,132 @@
+// `lorekit search <query>` — full-text search the lessons that apply to the
+// current directory, across BOTH stores and every applicable scope, rendered in
+// the same Offline / Remote split as `list`. A lesson matches when the query
+// appears (case-insensitively, as a LITERAL substring) in its key or value.
+//
+// Why filter `gather()` rather than call each store's `search()`: the two stores
+// disagree on search semantics — the local store does a literal substring match,
+// the remote store delegates to server-side FTS (ranking, stemming). To give one
+// deterministic, spec-defined behaviour across both — and to guarantee a query
+// full of regex metacharacters is matched verbatim — the match runs here, over
+// the exact same `gather()` seam `list` uses, via the pure `matchesQuery` filter.
+//
+// Graceful by design (mirrors `list`): an unconfigured remote is a short note,
+// never an error; a per-scope read failure is a warning, not a crash. Read-only,
+// archived hidden. Human-facing, so the bin wraps it in `traceCommand`.
+import process from 'node:process';
+import { resolveProjectRoot } from './config.mjs';
+import { deriveScope } from './scope.mjs';
+import { loadControl } from './control.mjs';
+import { resolveStores, remoteUnavailableReason } from './stores.mjs';
+import { scopeList, gather, filterGroups, renderSection } from './lessons-view.mjs';
+import { log, err, heading, c } from './util.mjs';
+
+export async function search(args) {
+  const root = resolveProjectRoot(args.dir);
+  const env = { ...process.env };
+  if (args.store) env.LOREKIT_STORE = args.store;
+
+  // The query is the first positional after the command name. An empty/missing
+  // query is a usage error (non-zero exit) — searching for nothing is meaningless
+  // and would otherwise degrade to `list`.
+  const query = typeof args._[1] === 'string' ? args._[1] : '';
+  if (!query.trim()) {
+    err(`${c.red('Usage:')} lorekit search <query> [--scope <s>] [--json]`);
+    err(`Provide a search term. Run ${c.cyan('lorekit search --help')} for options.`);
+    return 1;
+  }
+
+  const scopeInfo = deriveScope(root);
+  // Default to every applicable scope; `--scope <s>` narrows to one (an explicit
+  // scope outside the applicable set is honoured — the user asked for it).
+  const scopes = args.scope && typeof args.scope === 'string' ? [args.scope] : scopeList(scopeInfo);
+
+  const { local, remote, connection } = resolveStores(root, {
+    env,
+    endpoint: args.endpoint,
+    token: args.token,
+  });
+
+  // Deny-wins section suppression, identical to `list`.
+  const control = loadControl(root, { env });
+  const deny = (mode) => control.denies.find((d) => d.mode === mode) || null;
+  const localDenied = deny('local');
+  const remoteDenied = deny('remote');
+
+  const offline = localDenied
+    ? { groups: [], total: 0 }
+    : filterGroups(await gather(local, scopes), query);
+  const remoteAvailable = !remoteDenied && remote.usable();
+  const remoteResult = remoteAvailable
+    ? filterGroups(await gather(remote, scopes), query)
+    : { groups: [], total: 0 };
+
+  const offlineSection = localDenied
+    ? { available: false, reason: `disabled by deny constraint (${localDenied.source})` }
+    : { available: true, ...offline };
+  const remoteSection = remoteAvailable
+    ? { available: true, ...remoteResult }
+    : {
+        available: false,
+        reason: remoteDenied
+          ? `disabled by deny constraint (${remoteDenied.source})`
+          : remoteUnavailableReason(connection),
+      };
+
+  if (args.json) {
+    log(JSON.stringify(buildJson({ root, query, scopes, offlineSection, remoteSection }), null, 2));
+  } else {
+    heading('LoreKit search');
+    log(`  query:   ${c.dim(query)}`);
+    log(`  scopes:  ${scopes.join('  →  ')}`);
+
+    const empty = 'no lessons match';
+    renderSection({ title: 'Offline', empty }, offlineSection);
+    renderSection(
+      { title: 'Remote', subtitle: remoteAvailable ? connection.endpoint : undefined, empty },
+      remoteSection,
+    );
+
+    log('');
+  }
+
+  // Bounded, non-PII telemetry extras — counts + a boolean, never the query, a
+  // scope string, key, path, or token.
+  return {
+    exitCode: 0,
+    'lorekit.cli.search.scope_count': scopes.length,
+    'lorekit.cli.search.offline_matches': offline.total,
+    'lorekit.cli.search.remote_matches': remoteResult.total,
+    'lorekit.cli.search.remote_available': remoteAvailable,
+  };
+}
+
+// The `--json` payload: `{ query, root, scopes, offline, remote }` — normalized
+// per-scope groups per section so a script gets the same shape regardless of
+// which store a match came from (the exact shape `list --json` emits, plus the
+// query echoed back).
+function buildJson({ root, query, scopes, offlineSection, remoteSection }) {
+  return {
+    query,
+    root,
+    scopes,
+    offline: sectionJson(offlineSection),
+    remote: sectionJson(remoteSection),
+  };
+}
+
+function sectionJson(section) {
+  if (!section.available) {
+    return { available: false, reason: section.reason, total: 0, groups: [] };
+  }
+  return {
+    available: true,
+    total: section.total,
+    groups: (section.groups || []).map((g) => ({
+      scope: g.scope,
+      error: g.error || null,
+      // `gather()` already normalized these entries; the filter preserved them.
+      entries: g.entries,
+    })),
+  };
+}

package/src/show.mjs

@@ -0,0 +1,167 @@
+// `lorekit show <scope> <key>` — inspect ONE lesson in full: its complete
+// (untruncated) value, scope, key, updated timestamp, tags, and which store(s)
+// it lives in. When the same scope::key exists in BOTH the offline and remote
+// stores — possibly with different values — both are shown and the divergence is
+// flagged.
+//
+// Uses each store's real `read({scope, key})` method (both stores expose it),
+// not a filtered `list` — a single-record lookup is what `read` is for, and it
+// already hides archived entries. Graceful by design (mirrors `list`/`search`):
+// an unconfigured remote is a short note, never an error. Read-only. Human-facing,
+// so the bin wraps it in `traceCommand`.
+import process from 'node:process';
+import { resolveProjectRoot } from './config.mjs';
+import { loadControl } from './control.mjs';
+import { resolveStores, remoteUnavailableReason } from './stores.mjs';
+import { normalizeEntry, shortDate, describeError, recordsDiverge } from './lessons-view.mjs';
+import { log, err, heading, status, c } from './util.mjs';
+
+// Read one scope::key from a store, normalizing the result into a small,
+// uniform shape: { available:true, found, record } on success, or
+// { available:true, found:false, error } when the read itself failed (network /
+// server). A per-store read failure is captured, never thrown, so one bad store
+// never aborts the other section.
+async function readOne(store, scope, key) {
+  let res;
+  try {
+    res = await store.read({ scope, key });
+  } catch (e) {
+    return { available: true, found: false, record: null, error: (e && e.message) || 'error' };
+  }
+  if (!res || res.ok === false) {
+    return { available: true, found: false, record: null, error: describeError(res) };
+  }
+  const record = res.entry ? normalizeEntry(res.entry) : null;
+  return { available: true, found: Boolean(record), record, error: null };
+}
+
+export async function show(args) {
+  const root = resolveProjectRoot(args.dir);
+  const env = { ...process.env };
+  if (args.store) env.LOREKIT_STORE = args.store;
+
+  // Both positionals are required: `show <scope> <key>`.
+  const scope = typeof args._[1] === 'string' ? args._[1] : '';
+  const key = typeof args._[2] === 'string' ? args._[2] : '';
+  if (!scope || !key) {
+    err(`${c.red('Usage:')} lorekit show <scope> <key> [--json]`);
+    err(`Both a scope and a key are required. Run ${c.cyan('lorekit show --help')} for options.`);
+    return 1;
+  }
+
+  const { local, remote, connection } = resolveStores(root, {
+    env,
+    endpoint: args.endpoint,
+    token: args.token,
+  });
+
+  // Deny-wins section suppression, identical to `list`/`search`.
+  const control = loadControl(root, { env });
+  const deny = (mode) => control.denies.find((d) => d.mode === mode) || null;
+  const localDenied = deny('local');
+  const remoteDenied = deny('remote');
+
+  const offline = localDenied
+    ? { available: false, reason: `disabled by deny constraint (${localDenied.source})` }
+    : await readOne(local, scope, key);
+
+  const remoteAvailable = !remoteDenied && remote.usable();
+  const remote_ = remoteDenied
+    ? { available: false, reason: `disabled by deny constraint (${remoteDenied.source})` }
+    : remoteAvailable
+      ? await readOne(remote, scope, key)
+      : { available: false, reason: remoteUnavailableReason(connection) };
+
+  const foundOffline = Boolean(offline.available && offline.found);
+  const foundRemote = Boolean(remote_.available && remote_.found);
+  const diverged = foundOffline && foundRemote && recordsDiverge(offline.record, remote_.record);
+  // "Not found" is only definitive across the stores we could actually consult.
+  const found = foundOffline || foundRemote;
+
+  if (args.json) {
+    log(JSON.stringify(buildJson({ scope, key, offline, remote_, diverged }), null, 2));
+  } else {
+    heading('LoreKit lesson');
+    log(`  scope:  ${c.dim(scope)}`);
+    log(`  key:    ${c.dim(key)}`);
+
+    renderRecordSection('Offline', offline);
+    renderRecordSection(
+      'Remote',
+      remote_,
+      remoteAvailable ? connection.endpoint : undefined,
+    );
+
+    if (diverged) {
+      log('');
+      status('warn', 'divergence', 'the offline and remote values differ');
+    }
+    if (!found) {
+      log('');
+      log(`  ${c.dim(`no lesson found for ${scope}::${key} in the readable store(s)`)}`);
+    }
+    log('');
+  }
+
+  // Bounded, non-PII telemetry — booleans only, never the scope string or key.
+  return {
+    exitCode: found ? 0 : 1,
+    'lorekit.cli.show.found_offline': foundOffline,
+    'lorekit.cli.show.found_remote': foundRemote,
+    'lorekit.cli.show.diverged': diverged,
+  };
+}
+
+// Render one store's slot: an unavailable note, a "no such key here" line, or the
+// full record (untruncated value).
+function renderRecordSection(title, section, subtitle) {
+  heading(title);
+  if (subtitle) log(`  ${c.dim(subtitle)}`);
+
+  if (!section.available) {
+    status('warn', 'unavailable', section.reason);
+    return;
+  }
+  if (section.error) {
+    status('warn', 'unreadable', section.error);
+    return;
+  }
+  if (!section.found) {
+    log(`  ${c.dim('no such key in this store')}`);
+    return;
+  }
+
+  const e = section.record;
+  if (e.updated) log(`  ${c.dim('updated')} ${shortDate(e.updated)}`);
+  if (e.tags && e.tags.length) log(`  ${c.dim('tags')}    ${e.tags.join(', ')}`);
+  log(`  ${c.dim('value')}`);
+  // The full, untruncated body — indented, line by line, so multi-line lessons
+  // read as written.
+  for (const line of String(e.value ?? '').split('\n')) {
+    log(`    ${line}`);
+  }
+}
+
+// The `--json` payload: the full normalized record(s) plus which store each came
+// from and whether they diverge.
+function buildJson({ scope, key, offline, remote_, diverged }) {
+  return {
+    scope,
+    key,
+    offline: recordJson(offline),
+    remote: recordJson(remote_),
+    diverged,
+  };
+}
+
+function recordJson(section) {
+  if (!section.available) {
+    return { available: false, reason: section.reason, found: false, record: null };
+  }
+  return {
+    available: true,
+    found: Boolean(section.found),
+    record: section.record || null,
+    ...(section.error ? { error: section.error } : {}),
+  };
+}

package/src/telemetry.mjs

@@ -4,8 +4,8 @@
 // mirrors the Edge Function's SDK-free approach (supabase/functions/_shared/
 // otel.ts): OTLP/JSON over the global fetch (Node 18+), no @opentelemetry/*
 // packages. One span + one counter data point per human-facing command
-// (install / doctor / migrate), fired to Dash0 so the maintainers can see
-// which commands people actually run.
+// (install / uninstall / doctor / list / search / show / migrate), fired to
+// Dash0 so the maintainers can see which commands people actually run.
 //
 // Privacy — this runs on end-users' machines, so it is deliberately narrow:
 //   • Opt-out honored: LOREKIT_TELEMETRY=0|off|false|no|disable, or the
@@ -274,7 +274,7 @@ function normalizeExitCode(result) {
  * counter point. Returns the command's exit code unchanged. Telemetry failures
  * are swallowed — the command result is never affected.
  *
- * @param {string} command  bounded: install | doctor | migrate
+ * @param {string} command  bounded: install | uninstall | doctor | list | search | show | migrate
  * @param {object} args     parsed CLI args (read for allow-listed flags only)
  * @param {string} version  CLI version (from package.json)
  * @param {() => Promise<number>} run  the command handler