@michaelborck/honeyguide-cli 0.0.0-stage → 0.6.0

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/dist/index.js

@@ -0,0 +1,94 @@
+#!/usr/bin/env node
+import path from 'node:path';
+import { readFile } from 'node:fs/promises';
+import { Command } from 'commander';
+import { suggestResources, suggestBatch, toBatchMarkdown, recheckResources, toRecheckMarkdown, configFromEnv, toMarkdown, toCitations, toLmsHtml, extract, } from '@michaelborck/honeyguide-core';
+const program = new Command();
+program
+    .name('honeyguide')
+    .description('Finds and verifies supporting resources for your teaching.')
+    .version('0.1.1');
+program
+    .command('suggest')
+    .description('List mode: verified, annotated resources for a topic or document')
+    .argument('[topic...]', 'topic to find supporting resources for')
+    .option('-f, --file <path>', 'read the topic from a document (PDF, DOCX, TXT, MD)')
+    .option('-n, --max-results <n>', 'maximum number of resources', '10')
+    .option('-o, --format <format>', 'output format: markdown, json, html (LMS-ready), apa, harvard', 'markdown')
+    .option('--json', 'shorthand for --format json')
+    .option('-c, --counterpoint', 'also surface material disagreeing with the framing')
+    .action(async (topicWords, options) => {
+    let input = topicWords.join(' ');
+    let label = input;
+    if (options.file) {
+        const doc = await extract(options.file);
+        input = doc.text;
+        label = label || path.basename(options.file);
+    }
+    if (!input.trim()) {
+        program.error('Provide a topic or --file <path>.');
+    }
+    const result = await suggestResources({
+        input,
+        maxResults: Number(options.maxResults),
+        counterpoint: Boolean(options.counterpoint),
+    }, configFromEnv());
+    const format = options.json ? 'json' : options.format;
+    let out;
+    switch (format) {
+        case 'json':
+            out = JSON.stringify(result, null, 2);
+            break;
+        case 'html':
+            out = toLmsHtml(label, result);
+            break;
+        case 'apa':
+        case 'harvard':
+            out = toCitations(result, format);
+            break;
+        default:
+            out = toMarkdown(label, result);
+    }
+    process.stdout.write(out + '\n');
+});
+program
+    .command('batch')
+    .description('Batch mode: verified resources for many topics at once (one per line)')
+    .argument('<file>', 'text file with one topic per line')
+    .option('-n, --max-results <n>', 'maximum resources per topic', '8')
+    .option('-c, --counterpoint', 'also surface disagreeing material per topic')
+    .option('--json', 'output JSON instead of markdown')
+    .action(async (file, options) => {
+    const topics = (await readFile(file, 'utf8'))
+        .split('\n')
+        .map((l) => l.trim())
+        .filter((l) => l && !l.startsWith('#'));
+    if (!topics.length)
+        program.error('No topics found in file.');
+    const entries = await suggestBatch(topics, configFromEnv(), {
+        maxResults: Number(options.maxResults),
+        counterpoint: Boolean(options.counterpoint),
+    });
+    process.stdout.write((options.json ? JSON.stringify({ entries }, null, 2) : toBatchMarkdown(entries)) +
+        '\n');
+});
+program
+    .command('recheck')
+    .description('Link-rot re-run: re-verify a previously saved JSON result list')
+    .argument('<file>', 'JSON file from a previous `suggest --json` run')
+    .option('--json', 'output JSON instead of markdown')
+    .action(async (file, options) => {
+    const saved = JSON.parse(await readFile(file, 'utf8'));
+    const resources = saved.resources ?? saved.entries?.flatMap((e) => e.result.resources);
+    if (!Array.isArray(resources) || !resources.length) {
+        program.error('No resources found in file — expected suggest/batch JSON output.');
+    }
+    const entries = await recheckResources(resources);
+    process.stdout.write((options.json ? JSON.stringify({ entries }, null, 2) : toRecheckMarkdown(entries)) +
+        '\n');
+});
+program.parseAsync().catch((error) => {
+    console.error(error instanceof Error ? error.message : error);
+    process.exitCode = 1;
+});
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AACA,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAC5C,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EACL,gBAAgB,EAChB,YAAY,EACZ,eAAe,EACf,gBAAgB,EAChB,iBAAiB,EACjB,aAAa,EACb,UAAU,EACV,WAAW,EACX,SAAS,EACT,OAAO,GACR,MAAM,+BAA+B,CAAC;AAEvC,MAAM,OAAO,GAAG,IAAI,OAAO,EAAE,CAAC;AAE9B,OAAO;KACJ,IAAI,CAAC,YAAY,CAAC;KAClB,WAAW,CAAC,4DAA4D,CAAC;KACzE,OAAO,CAAC,OAAO,CAAC,CAAC;AAEpB,OAAO;KACJ,OAAO,CAAC,SAAS,CAAC;KAClB,WAAW,CAAC,kEAAkE,CAAC;KAC/E,QAAQ,CAAC,YAAY,EAAE,wCAAwC,CAAC;KAChE,MAAM,CAAC,mBAAmB,EAAE,qDAAqD,CAAC;KAClF,MAAM,CAAC,uBAAuB,EAAE,6BAA6B,EAAE,IAAI,CAAC;KACpE,MAAM,CACL,uBAAuB,EACvB,+DAA+D,EAC/D,UAAU,CACX;KACA,MAAM,CAAC,QAAQ,EAAE,6BAA6B,CAAC;KAC/C,MAAM,CAAC,oBAAoB,EAAE,oDAAoD,CAAC;KAClF,MAAM,CACL,KAAK,EACH,UAAoB,EACpB,OAMC,EACD,EAAE;IACF,IAAI,KAAK,GAAG,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACjC,IAAI,KAAK,GAAG,KAAK,CAAC;IAClB,IAAI,OAAO,CAAC,IAAI,EAAE,CAAC;QACjB,MAAM,GAAG,GAAG,MAAM,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QACxC,KAAK,GAAG,GAAG,CAAC,IAAI,CAAC;QACjB,KAAK,GAAG,KAAK,IAAI,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAC/C,CAAC;IACD,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,EAAE,CAAC;QAClB,OAAO,CAAC,KAAK,CAAC,mCAAmC,CAAC,CAAC;IACrD,CAAC;IACD,MAAM,MAAM,GAAG,MAAM,gBAAgB,CACnC;QACE,KAAK;QACL,UAAU,EAAE,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC;QACtC,YAAY,EAAE,OAAO,CAAC,OAAO,CAAC,YAAY,CAAC;KAC5C,EACD,aAAa,EAAE,CAChB,CAAC;IACF,MAAM,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC;IACtD,IAAI,GAAW,CAAC;IAChB,QAAQ,MAAM,EAAE,CAAC;QACf,KAAK,MAAM;YACT,GAAG,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;YACtC,MAAM;QACR,KAAK,MAAM;YACT,GAAG,GAAG,SAAS,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;YAC/B,MAAM;QACR,KAAK,KAAK,CAAC;QACX,KAAK,SAAS;YACZ,GAAG,GAAG,WAAW,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;YAClC,MAAM;QACR;YACE,GAAG,GAAG,UAAU,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;IACpC,CAAC;IACD,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,GAAG,IAAI,CAAC,CAAC;AACnC,CAAC,CACF,CAAC;AAEJ,OAAO;KACJ,OAAO,CAAC,OAAO,CAAC;KAChB,WAAW,CAAC,uEAAuE,CAAC;KACpF,QAAQ,CAAC,QAAQ,EAAE,mCAAmC,CAAC;KACvD,MAAM,CAAC,uBAAuB,EAAE,6BAA6B,EAAE,GAAG,CAAC;KACnE,MAAM,CAAC,oBAAoB,EAAE,6CAA6C,CAAC;KAC3E,MAAM,CAAC,QAAQ,EAAE,iCAAiC,CAAC;KACnD,MAAM,CACL,KAAK,EACH,IAAY,EACZ,OAAuE,EACvE,EAAE;IACF,MAAM,MAAM,GAAG,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;SAC1C,KAAK,CAAC,IAAI,CAAC;SACX,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;SACpB,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC;IAC1C,IAAI,CAAC,MAAM,CAAC,MAAM;QAAE,OAAO,CAAC,KAAK,CAAC,0BAA0B,CAAC,CAAC;IAC9D,MAAM,OAAO,GAAG,MAAM,YAAY,CAAC,MAAM,EAAE,aAAa,EAAE,EAAE;QAC1D,UAAU,EAAE,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC;QACtC,YAAY,EAAE,OAAO,CAAC,OAAO,CAAC,YAAY,CAAC;KAC5C,CAAC,CAAC;IACH,OAAO,CAAC,MAAM,CAAC,KAAK,CAClB,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC;QAC9E,IAAI,CACP,CAAC;AACJ,CAAC,CACF,CAAC;AAEJ,OAAO;KACJ,OAAO,CAAC,SAAS,CAAC;KAClB,WAAW,CAAC,gEAAgE,CAAC;KAC7E,QAAQ,CAAC,QAAQ,EAAE,gDAAgD,CAAC;KACpE,MAAM,CAAC,QAAQ,EAAE,iCAAiC,CAAC;KACnD,MAAM,CAAC,KAAK,EAAE,IAAY,EAAE,OAA2B,EAAE,EAAE;IAC1D,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC;IACvD,MAAM,SAAS,GAAG,KAAK,CAAC,SAAS,IAAI,KAAK,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAuC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;IAC7H,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC;QACnD,OAAO,CAAC,KAAK,CAAC,kEAAkE,CAAC,CAAC;IACpF,CAAC;IACD,MAAM,OAAO,GAAG,MAAM,gBAAgB,CAAC,SAAS,CAAC,CAAC;IAClD,OAAO,CAAC,MAAM,CAAC,KAAK,CAClB,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC;QAChF,IAAI,CACP,CAAC;AACJ,CAAC,CAAC,CAAC;AAEL,OAAO,CAAC,UAAU,EAAE,CAAC,KAAK,CAAC,CAAC,KAAc,EAAE,EAAE;IAC5C,OAAO,CAAC,KAAK,CAAC,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;IAC9D,OAAO,CAAC,QAAQ,GAAG,CAAC,CAAC;AACvB,CAAC,CAAC,CAAC"}

package/package.json

@@ -1,6 +1,29 @@
 {
   "name": "@michaelborck/honeyguide-cli",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.6.0",
+  "description": "Honeyguide CLI: verified teaching resources from your terminal.",
+  "license": "MIT",
+  "author": "Michael Borck",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/michael-borck/honeyguide.git",
+    "directory": "packages/cli"
+  },
+  "type": "module",
+  "bin": {
+    "honeyguide": "dist/index.js"
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsc -p tsconfig.json"
+  },
+  "dependencies": {
+    "@michaelborck/honeyguide-core": "*",
+    "commander": "^12.1.0"
+  },
+  "devDependencies": {
+    "typescript": "^5.5.0"
+  }
+}

package/README.md

@@ -1,3 +0,0 @@
-# Temporary Holding Version
-
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.