@catheadowl/ukp 0.2.3 → 0.2.5

package/README.md

@@ -61,7 +61,9 @@ predictable scope, and a single command surface. Use UKP when:
   Requirements). `read` and `nav` are derived defaults of every local
   Service.
 - Run base lexical search with `rg` across endpoint files — no search
-  provider needed, on by default, shaped into `read`-ready references.
+  provider needed, on by default, shaped into `read`-ready references —
+  or enumerate them with `rg --files` (a tree walk: empty and binary files
+  included, hidden files behind `-- --hidden`).
 - Search indexed content, QMD-backed: one endpoint, the workspace default
   scope, or the whole local Registry. `--recursive` additionally searches
   the endpoints a Service declares in its manifest `dependencies` —
@@ -143,7 +145,7 @@ Endpoint commands:
 | `ukp search` | Indexed search through the endpoint's provider (QMD today); `--recursive` expands the manifest's declared `dependencies`. Results hand off via docid session keys and verified `ukp://` references. |
 | `ukp read` | Reads an endpoint-scoped resource — exact path, `ukp://` URI, or a `docid` handed off by search results. |
 | `ukp nav` | Markdown outline of an endpoint (`--depth`, respects `.gitignore`); on by default, configurable via `[capabilities.nav]`. |
-| `ukp rg` | Lexical grep (ripgrep) across endpoint files — provider-free, on by default; results become `read`-ready `ukp://` references. A missing rg binary skips the endpoint with a warning. |
+| `ukp rg` | Lexical grep (ripgrep) across endpoint files — provider-free, on by default; `--files` enumerates them instead of searching. Results become `read`-ready `ukp://` references. A missing rg binary skips the endpoint with a warning. |
 | `ukp propose` | Submits an idempotent change proposal (suggestion box — the owner decides what happens next). Created/unchanged/updated; the revision bumps only on `updated`. |
 
 Registry commands:
@@ -171,6 +173,7 @@ Help commands:
 | `ukp guide service` | Provider-agnostic Service setup path. |
 | `ukp guide service qmd` | Provider-owned setup for the QMD provider. |
 | `ukp guide client` | How a workspace uses registered Services by default. |
+| `ukp guide rg` | The rg quickstart: modes, glob semantics, visibility tiers. |
 | `ukp guide remote` | How to serve and consume endpoints across machines. |
 | `ukp guide propose` | The propose quickstart. |
 

package/bin/ukp.js

@@ -12,7 +12,7 @@ import { spawnSync } from "node:child_process";
 import { existsSync } from "node:fs";
 import { homedir } from "node:os";
 import { dirname, join } from "node:path";
-import { fileURLToPath } from "node:url";
+import { fileURLToPath, pathToFileURL } from "node:url";
 
 const here = dirname(fileURLToPath(import.meta.url));
 const cli = join(here, "..", "src", "cli.ts");
@@ -68,15 +68,35 @@ function fail(detail) {
 
 const bunPath = bunCandidates().find((candidate) => existsSync(candidate));
 if (bunPath === undefined) {
-  fail("looked for UKP_BUN, the standard install locations, and PATH");
+  fail("looked at UKP_BUN, the standard install locations, and PATH");
 }
-const result = spawnSync(bunPath, [cli, ...process.argv.slice(2)], {
-  stdio: "inherit",
-  env: process.env,
-});
-if (result.error) {
-  // bunPath existed on disk a moment ago; a spawn failure here is exotic,
-  // but it must still land in the remedy, never a stack trace.
-  fail(`spawning '${bunPath}' failed: ${String(result.error.message ?? result.error)}`);
+
+// In-process handoff when this launcher already runs under bun (bun's own
+// bin links and `bunx`): importing the CLI keeps it in THIS process, where
+// stdout/stderr keep their real TTY identity (columns, isTTY) — a spawnSync
+// grandchild re-inherits duplicated handles, and on some hosts that layer
+// degraded TTY detection (the third dogfood round: progress/wrap silently
+// skipped while a direct run on the same console had both). One process
+// also starts faster. The node-interpreted path (npm shims) keeps spawning.
+if (runningUnderBun) {
+  const { runCli } = await import(pathToFileURL(cli).href);
+  const exit = runCli(process.argv.slice(2));
+  if (exit instanceof Promise) {
+    exit.then((code) => {
+      process.exitCode = code;
+    });
+  } else {
+    process.exitCode = exit;
+  }
+} else {
+  const result = spawnSync(bunPath, [cli, ...process.argv.slice(2)], {
+    stdio: "inherit",
+    env: process.env,
+  });
+  if (result.error) {
+    // bunPath existed on disk a moment ago; a spawn failure here is exotic,
+    // but it must still land in the remedy, never a stack trace.
+    fail(`spawning '${bunPath}' failed: ${String(result.error.message ?? result.error)}`);
+  }
+  process.exit(result.status === null ? (result.signal !== null ? 130 : 1) : result.status);
 }
-process.exit(result.status === null ? (result.signal !== null ? 130 : 1) : result.status);

package/docs/remote-deployment.md

@@ -65,6 +65,13 @@ Notes:
   wake — the client chooses the door port per invocation, which a fixed
   forced command cannot express.
 
+Windows note: some antivirus setups (Windows Defender behavioral inspection
+included) delay a process spawned directly by the runtime by several seconds
+per call — 5-10s per ssh/rg spawn was measured before ukp routed its
+Windows tool spawns through a one-level relay. ukp does this automatically;
+if you also add your own exclusion for your package manager's runtimes the
+residual per-call cost is just the real ssh handshake plus the door spawn.
+
 Windows hosts work out of the box: when the host's OpenSSH default shell
 (cmd.exe) rejects the POSIX wake form, the client detects the signature and
 resends the pinned cmd.exe form automatically — nothing to configure beyond

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@catheadowl/ukp",
-  "version": "0.2.3",
+  "version": "0.2.5",
   "type": "module",
   "engines": {
     "bun": ">=1.3.14"

package/src/capabilities/propose.ts

@@ -442,7 +442,7 @@ export function runPropose(request: ProposeRequest, context: ProposeContext): Pr
       failure: {
         errorClass: "capability-undeclared",
         message: `endpoint '${binding.name}' does not declare the propose capability`
-          + ` — declare [capabilities.propose] in the Service Manifest (.ukp/service.toml); 'ukp guide propose' walks through it`,
+          + ` - declare [capabilities.propose] in the Service Manifest (.ukp/service.toml); 'ukp guide propose' walks through it`,
       },
     };
   }

package/src/capabilities/read.ts

@@ -870,7 +870,7 @@ function executeResolvedRead(
         return readFailure(
           "resource-missing",
           `resource-missing '${request.path}' in endpoint '${binding.name}'`
-            + ` (absolute paths address files exactly; the mapped route does not exist — the target may live one level deeper, e.g. under src/)\n`
+            + ` (absolute paths address files exactly; the mapped route does not exist - the target may live one level deeper, e.g. under src/)\n`
             + formatRecoveryCandidates(recovered.recovery.candidates).trimEnd(),
           recovered.recovery,
         );