@taurgis/bonsai 1.0.4 → 1.0.5

package/dist/lib/text.js

@@ -0,0 +1,63 @@
+/**
+ * Pick the singular or plural noun for a count so human-readable output stays grammatical
+ * ("1 entry" / "2 entries"). English has irregular plurals, so the plural is passed explicitly
+ * rather than derived.
+ */
+export function pluralize(count, singular, plural) {
+    return count === 1 ? singular : plural;
+}
+/** Heading for a result listing; notes truncation inline when more matched than are shown. */
+export function resultListHeading(total, shown, labels) {
+    const noun = `${labels.noun} ${pluralize(total, 'entry', 'entries')}`;
+    return total > shown
+        ? `Found ${total} ${noun} (showing ${labels.order} ${shown}; raise --limit to see more):`
+        : `Found ${total} ${noun}:`;
+}
+/**
+ * One-line truncation notice for stderr, or null when nothing was cut. Used under --json, where the
+ * stdout heading is suppressed and an agent would otherwise get no signal that results were capped.
+ */
+export function truncationNotice(total, shown, labels) {
+    if (total <= shown)
+        return null;
+    return `${total} entries matched; returning the ${labels.order} ${shown}. Raise --limit (max ${labels.maxLimit}) to see more.`;
+}
+/**
+ * Levenshtein edit distance: the minimum number of single-character insertions, deletions, or
+ * substitutions to turn `s1` into `s2`. Shared by fuzzy search ranking and command-typo suggestion.
+ */
+export function levenshtein(s1, s2) {
+    if (s1.length < s2.length)
+        return levenshtein(s2, s1);
+    if (s2.length === 0)
+        return s1.length;
+    let prevRow = Array.from({ length: s2.length + 1 }, (_, i) => i);
+    for (let i = 0; i < s1.length; i++) {
+        const currRow = [i + 1];
+        for (let j = 0; j < s2.length; j++) {
+            const deletions = prevRow[j + 1] + 1;
+            const insertions = currRow[j] + 1;
+            const substitutions = prevRow[j] + (s1[i] === s2[j] ? 0 : 1);
+            currRow.push(Math.min(deletions, insertions, substitutions));
+        }
+        prevRow = currRow;
+    }
+    return prevRow[s2.length];
+}
+/**
+ * The candidate nearest to `input` by edit distance, or null when even the closest is farther than
+ * `maxDistance`. The threshold keeps suggestions to plausible typos — input that resembles nothing
+ * gets no correction rather than an absurd one.
+ */
+export function closestMatch(input, candidates, maxDistance) {
+    let best = null;
+    let bestDistance = Infinity;
+    for (const candidate of candidates) {
+        const distance = levenshtein(input, candidate);
+        if (distance < bestDistance) {
+            bestDistance = distance;
+            best = candidate;
+        }
+    }
+    return bestDistance <= maxDistance ? best : null;
+}

package/oclif.manifest.json

@@ -9,7 +9,7 @@
           "required": true
         }
       },
-      "description": "Scrapes the specified URL, strips HTML boilerplate, converts the semantic payload into clean Markdown format, and caches the result locally using dynamic TTL rules.",
+      "description": "Scrapes the specified URL, strips HTML boilerplate, converts the semantic payload into clean Markdown format, and caches the result locally using dynamic TTL rules.\n\nUsually invoked via the shorthand `bonsai <url>` rather than `bonsai fetch <url>`.",
       "examples": [
         {
           "description": "Research a URL with detailed output, tagged with topic and tags",
@@ -72,7 +72,7 @@
         },
         "ttl": {
           "char": "l",
-          "description": "Predicted lifespan of the data (e.g., \"2h\", \"7d\", \"3m\").",
+          "description": "Predicted lifespan: number + h/d/w/m/y (m = months), e.g. \"2h\", \"7d\", \"6m\".",
           "name": "ttl",
           "hasDynamicHelp": false,
           "multiple": false,
@@ -525,7 +525,7 @@
           "type": "option"
         },
         "remote": {
-          "description": "Discover uncached docs via a site’s public search (Algolia DocSearch, MkDocs/Sphinx/Just-the-Docs index). Pass a docs page URL; falls back to local cache search if no connector applies.",
+          "description": "Discover uncached docs via a site’s public search or index (Algolia DocSearch, MkDocs/Sphinx/Just-the-Docs, llms.txt, sitemap.xml). Pass a docs page URL; falls back to local cache search if no connector applies.",
           "name": "remote",
           "hasDynamicHelp": false,
           "multiple": false,
@@ -610,7 +610,7 @@
           "required": true
         }
       },
-      "description": "Print a config value. Without --global/--local, shows the merged effective value (flag > env > project > user > default).\n\nValid keys: storage.",
+      "description": "Print a config value. Without --global/--local, shows the merged effective value (flag > env > project > user > default).\n\nValid keys: storage, summary.",
       "examples": [
         {
           "description": "Get the effective storage mode",
@@ -662,7 +662,7 @@
     "config:list": {
       "aliases": [],
       "args": {},
-      "description": "Show every configuration key with its current value. Use --global/--local to show a single scope.\n\nValid keys: storage.",
+      "description": "Show every configuration key with its current value. Use --global/--local to show a single scope.\n\nValid keys: storage, summary.",
       "examples": [
         {
           "description": "Show all effective config values",
@@ -725,7 +725,7 @@
           "required": false
         }
       },
-      "description": "Persist a configuration value. Writes user-level config by default; pass --local to write the project-level config (.bonsai.json in cwd).\n\nValid keys: storage. The inline form `<key>=<value>` is also accepted.",
+      "description": "Persist a configuration value. Writes user-level config by default; pass --local to write the project-level config (.bonsai.json in cwd).\n\nValid keys: storage, summary. The inline form `<key>=<value>` is also accepted.",
       "examples": [
         {
           "description": "Store research cache inside the current project",
@@ -789,7 +789,7 @@
           "required": true
         }
       },
-      "description": "Delete a key from user-level config (default) or project-level config (--local), restoring the built-in default.\n\nValid keys: storage.",
+      "description": "Delete a key from user-level config (default) or project-level config (--local), restoring the built-in default.\n\nValid keys: storage, summary.",
       "examples": [
         {
           "description": "Remove the user-level storage setting",
@@ -845,5 +845,5 @@
       "stdoutIsPrimaryData": true
     }
   },
-  "version": "1.0.4"
+  "version": "1.0.5"
 }

package/package.json

@@ -1,7 +1,12 @@
 {
   "name": "@taurgis/bonsai",
-  "version": "1.0.4",
+  "version": "1.0.5",
   "description": "Bonsai is a standalone local research cache CLI for AI agents",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/taurgis/bonsai.git"
+  },
+  "homepage": "https://bonsai.rhino-inquisitor.com/",
   "type": "module",
   "main": "./dist/index.js",
   "bin": {
@@ -29,7 +34,10 @@
     "nexus:sync": "npx forward-nexus update && npx forward-nexus sync",
     "test": "vitest",
     "test:coverage": "vitest run --coverage",
-    "type-check": "tsc --noEmit"
+    "type-check": "tsc --noEmit",
+    "docs:dev": "vitepress dev docs",
+    "docs:build": "vitepress build docs",
+    "docs:preview": "vitepress preview docs"
   },
   "lint-staged": {
     "src/**/*.ts": "prettier --write",
@@ -55,7 +63,9 @@
     "oclif": "^4.23.21",
     "prettier": "^3.8.1",
     "typescript": "^5.9.3",
-    "vitest": "^4.0.17"
+    "vitepress": "^1.6.4",
+    "vitest": "^4.0.17",
+    "vue": "^3.5.39"
   },
   "engines": {
     "node": ">=22"
@@ -64,12 +74,16 @@
   "oclif": {
     "bin": "bonsai",
     "dirname": "bonsai",
+    "description": "Bonsai is a standalone local research cache CLI for AI agents.\nResearch and cache a web page by passing its URL directly:\n\n  $ bonsai https://nodejs.org/api/url.html\n\nThe URL form is shorthand for fetching and caching the page. The commands listed below search, inspect, list, import, and prune the local research cache.",
     "commands": {
       "strategy": "explicit",
       "target": "./dist/commands.js",
       "identifier": "commands"
     },
     "topicSeparator": " ",
+    "hooks": {
+      "command_not_found": "./dist/hooks/command-not-found/suggest.js"
+    },
     "topics": {
       "config": {
         "description": "Manage research cache storage configuration (global vs project)"