@mediamonks/canopy-cli 0.7.15 → 0.7.16

package/dist/docs/cli-docs.md

@@ -10,12 +10,14 @@ description: Read the Canopy docs from the terminal — live from the platform,
 ```bash
 canopy docs                 # list all topics
 canopy docs <topic>         # print one topic
+canopy docs search <terms…> # keyword search across all docs
 canopy docs <topic> --refresh
 ```
 
 ## Arguments & flags
 
 - `[topic]` — positional: the topic slug to print. Omit it to list every topic with a one-line summary, grouped by section. Guides keep bare slugs (`deploy`, `staging`); other sections prefix theirs (`sdk-database`, `cli-deploy`, `platform-schedules`).
+- `search <terms…>` — search every doc for the given terms instead of printing one. Case-insensitive; a doc matches only when every term appears somewhere in its title, summary, or body. Results come back best-first (title and summary hits outrank body mentions), each with the matching lines, capped at ten.
 - `--refresh` — re-fetch from the platform, bypassing the local cache. Default `false`.
 
 ## How it works
@@ -30,6 +32,8 @@ That last step is why `canopy docs` works with no network and no login: a fresh
 
 Asking for an unknown topic errors with the list of available slugs. Everything prints as plain Markdown to stdout, so it pipes cleanly into a pager or an agent's context.
 
+Search runs entirely on the local corpus — the cache plus the bundled snapshot — so it's instant and works offline. It's a locator, not a reader: find the topic, then print it with `canopy docs <topic>` (which fetches fresh content when it can).
+
 ## Examples
 
 ```bash
@@ -38,6 +42,12 @@ canopy docs
 
 Lists every topic with its summary — the starting point when you're not sure which guide covers what you're doing.
 
+```bash
+canopy docs search egress allowlist
+```
+
+Finds the docs that mention both terms — useful when the summaries don't tell you which doc covers a detail, like a specific error code or environment variable.
+
 ```bash
 canopy docs deploy --refresh
 ```

package/dist/{docs-BlzdYmou.mjs → docs-D7Ey1ZMQ.mjs}

@@ -1,4 +1,4 @@
-import { t as version } from "./package-CF0dX7UA.mjs";
+import { t as version } from "./package-BGDIsRxe.mjs";
 import { n as siteConfig } from "./site-BUlQR117.mjs";
 import { i as latestKnownVersion, r as compareSemver } from "./version-check-CcsA1QjI.mjs";
 import { n as reportErrors } from "./ui-B1Px5y7q.mjs";
@@ -14,6 +14,10 @@ import { fileURLToPath } from "node:url";
 * never goes stale, with a local cache and a bundled snapshot as offline
 * fallbacks. The listing is grouped per docs-site section.
 *
+* `canopy docs search <terms…>` greps the locally available corpus (cache +
+* bundled snapshot) — the corpus is small enough (~60 docs) that keyword
+* matching beats any index, and it works fully offline.
+*
 * The platform requires a login for docs (internal platform), so fetches carry
 * the CLI token when there is one; without it we simply fall back to the
 * bundled snapshot, so `canopy docs` still works before sign-in.
@@ -140,6 +144,75 @@ function bodyFromFallback(slug) {
 		}
 	}
 }
+const SEARCH_LIMIT = 10;
+const LINE_LIMIT = 2;
+const LINE_WIDTH = 120;
+/** A matching body line, trimmed and windowed around the first term hit. */
+function excerpt(line, matchIndex) {
+	const clean = line.replace(/\s+/g, " ").trim();
+	if (clean.length <= LINE_WIDTH) return clean;
+	const start = Math.max(0, Math.min(matchIndex - Math.floor(LINE_WIDTH / 3), clean.length - LINE_WIDTH));
+	const slice = clean.slice(start, start + LINE_WIDTH);
+	return `${start > 0 ? "…" : ""}${slice}${start + LINE_WIDTH < clean.length ? "…" : ""}`;
+}
+/**
+* Keyword search over the docs corpus: case-insensitive, every term must match
+* somewhere in a doc (title, summary, or body). Title and summary hits weigh
+* more than body occurrences; results come back best-first.
+*/
+function searchDocs(entries, query) {
+	const terms = query.toLowerCase().split(/\s+/).filter(Boolean);
+	if (terms.length === 0) return [];
+	const hits = [];
+	for (const entry of entries) {
+		const title = entry.title.toLowerCase();
+		const summary = entry.summary.toLowerCase();
+		const body = entry.body.toLowerCase();
+		let score = 0;
+		let matchesAll = true;
+		for (const term of terms) {
+			let termScore = 0;
+			if (title.includes(term)) termScore += 10;
+			if (summary.includes(term)) termScore += 5;
+			let count = 0;
+			for (let i = body.indexOf(term); i !== -1 && count < 20; i = body.indexOf(term, i + term.length)) count++;
+			termScore += count;
+			if (termScore === 0) {
+				matchesAll = false;
+				break;
+			}
+			score += termScore;
+		}
+		if (!matchesAll) continue;
+		const lines = [];
+		for (const line of entry.body.split("\n")) {
+			const lower = line.toLowerCase();
+			const at = terms.map((t) => lower.indexOf(t)).find((i) => i !== -1);
+			if (at !== void 0 && line.trim()) {
+				lines.push(excerpt(line, at));
+				if (lines.length >= LINE_LIMIT) break;
+			}
+		}
+		hits.push({
+			slug: entry.slug,
+			title: entry.title,
+			score,
+			lines
+		});
+	}
+	return hits.sort((a, b) => b.score - a.score || a.slug.localeCompare(b.slug));
+}
+/**
+* Every topic paired with its locally available body (cache first, bundled
+* snapshot second). A topic with no local body still gets searched by title
+* and summary — search never hits the network per doc.
+*/
+function searchEntries(index) {
+	return index.topics.map((t) => ({
+		...t,
+		body: bodyFromFallback(t.slug) ?? ""
+	}));
+}
 async function listIndex(refresh) {
 	const { apiUrl } = siteConfig();
 	if (refresh || !cacheFresh()) {
@@ -174,7 +247,7 @@ const docsCommand = defineCommand({
 		topic: {
 			type: "positional",
 			required: false,
-			description: "Topic to print (omit to list)"
+			description: "Topic to print (omit to list), or `search <terms…>`"
 		},
 		refresh: {
 			type: "boolean",
@@ -187,6 +260,23 @@ const docsCommand = defineCommand({
 		const topic = args.topic;
 		const latest = latestKnownVersion();
 		if (latest && compareSemver(version, latest) < 0) console.error(`Note: these docs describe CLI ${latest}; you have ${version} — commands or flags they mention may not exist here. Run \`canopy upgrade\`.\n`);
+		if (topic === "search") {
+			const query = args._.slice(1).join(" ").trim();
+			if (!query) throw new Error("Usage: canopy docs search <terms…>");
+			const hits = searchDocs(searchEntries(await listIndex(refresh)), query);
+			if (hits.length === 0) {
+				console.log(`No docs match "${query}". Run \`canopy docs\` to list all topics.`);
+				return;
+			}
+			const shown = hits.slice(0, SEARCH_LIMIT);
+			console.log(`${hits.length} doc${hits.length === 1 ? "" : "s"} match "${query}" — run \`canopy docs <topic>\` to read one:\n`);
+			for (const hit of shown) {
+				console.log(`${hit.slug} — ${hit.title}`);
+				for (const line of hit.lines) console.log(`    ${line}`);
+			}
+			if (hits.length > shown.length) console.log(`\n…and ${hits.length - shown.length} more — add terms to narrow it down.`);
+			return;
+		}
 		if (!topic) {
 			const index = await listIndex(refresh);
 			if (index.topics.length === 0) throw new Error("No docs available — check your connection, or reinstall the CLI.");

package/dist/{feedback-h_j6DBBZ.mjs → feedback-B0iX3iZ1.mjs}

@@ -1,4 +1,4 @@
-import { t as version } from "./package-CF0dX7UA.mjs";
+import { t as version } from "./package-BGDIsRxe.mjs";
 import { a as projectDirArgs, c as resolveProject, n as siteConfig, u as tryReadCanopyJson } from "./site-BUlQR117.mjs";
 import { c as apiRequest, l as apiUpload, n as reportErrors, s as apiDownload } from "./ui-B1Px5y7q.mjs";
 import { defineCommand } from "citty";

package/dist/index.mjs

@@ -1,5 +1,5 @@
 #!/usr/bin/env node
-import { t as version } from "./package-CF0dX7UA.mjs";
+import { t as version } from "./package-BGDIsRxe.mjs";
 import { r as siteHeaderLine, t as setInvocationProfile } from "./site-BUlQR117.mjs";
 import { a as notifyOfUpdate, o as runRefresh } from "./version-check-CcsA1QjI.mjs";
 import { defineCommand, runMain } from "citty";
@@ -76,13 +76,13 @@ const main = defineCommand({
 		token: () => import("./token-BUxgRJVA.mjs").then((m) => m.tokenCommand),
 		egress: () => import("./egress-PJp0SZy2.mjs").then((m) => m.egressCommand),
 		schedule: () => import("./schedule-Cq9K0rnE.mjs").then((m) => m.scheduleCommand),
-		feedback: () => import("./feedback-h_j6DBBZ.mjs").then((m) => m.feedbackCommand),
+		feedback: () => import("./feedback-B0iX3iZ1.mjs").then((m) => m.feedbackCommand),
 		db: () => import("./db-DKnJQPm5.mjs").then((m) => m.dbCommand),
 		usage: () => import("./usage-DjNngyvy.mjs").then((m) => m.usageCommand),
 		open: () => import("./open-C5x3tX6I.mjs").then((m) => m.openCommand),
-		docs: () => import("./docs-BlzdYmou.mjs").then((m) => m.docsCommand),
-		skill: () => import("./skill-DaaxgqEk.mjs").then((m) => m.skillCommand),
-		upgrade: () => import("./upgrade-DG-7xwOs.mjs").then((m) => m.upgradeCommand),
+		docs: () => import("./docs-D7Ey1ZMQ.mjs").then((m) => m.docsCommand),
+		skill: () => import("./skill-Be_pqqdH.mjs").then((m) => m.skillCommand),
+		upgrade: () => import("./upgrade-ChwehW_q.mjs").then((m) => m.upgradeCommand),
 		logs: () => import("./logs-C53y2eAS.mjs").then((m) => m.logsCommand)
 	}
 });

package/dist/{package-CF0dX7UA.mjs → package-BGDIsRxe.mjs}

@@ -1,4 +1,4 @@
 //#region package.json
-var version = "0.7.15";
+var version = "0.7.16";
 //#endregion
 export { version as t };

package/dist/skill/canopy/SKILL.md

@@ -71,8 +71,9 @@ The CLI ships the full documentation and keeps it fresh from the platform. List
 the topics and read the relevant one _before_ running unfamiliar commands:
 
 ```bash
-canopy docs            # list all topics
-canopy docs deploy     # print one topic
+canopy docs                          # list all topics
+canopy docs deploy                   # print one topic
+canopy docs search egress allowlist  # find the topics that mention all terms
 ```
 
 The listing is grouped by section: guides (`getting-started`, `deploy`, `dev`,

package/dist/{skill-DaaxgqEk.mjs → skill-Be_pqqdH.mjs}

@@ -1,4 +1,4 @@
-import { t as version } from "./package-CF0dX7UA.mjs";
+import { t as version } from "./package-BGDIsRxe.mjs";
 import { n as reportErrors } from "./ui-B1Px5y7q.mjs";
 import { defineCommand } from "citty";
 import { cpSync, existsSync, mkdirSync, rmSync, symlinkSync, writeFileSync } from "node:fs";

package/dist/{upgrade-DG-7xwOs.mjs → upgrade-ChwehW_q.mjs}

@@ -112,7 +112,7 @@ const upgradeCommand = defineCommand({
 		const spec = `${PACKAGE_NAME}@${args.version ?? "latest"}`;
 		const command = pmCommand(pm);
 		const cmd = installArgs(pm, spec);
-		const { skillInstalled } = await import("./skill-DaaxgqEk.mjs");
+		const { skillInstalled } = await import("./skill-Be_pqqdH.mjs");
 		const refreshSkill = skillInstalled(process.cwd());
 		console.log(`Upgrading via ${command}: ${command} ${cmd.join(" ")}`);
 		await run(command, cmd);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mediamonks/canopy-cli",
-  "version": "0.7.15",
+  "version": "0.7.16",
   "description": "Canopy CLI — create, develop and deploy Canopy projects.",
   "bin": {
     "canopy": "./dist/index.mjs"