@wonsukchoi/crondex 0.10.0 → 0.12.0

package/README.md

@@ -36,6 +36,10 @@ npx @wonsukchoi/crondex add ssl-cert-expiry-check --dest ./cron/ssl-cert-expiry-
 - `add <id> [--dest path]` — copy it into your project to edit
 - `init <id> [--category x]` — scaffold a brand-new job from the template
 
+Add `--json` to `list`/`categories`/`show`/`recommend` for machine-readable
+output — useful when an agent is parsing the result programmatically
+instead of a human reading it.
+
 No install needed — `npx` always runs against the latest catalog. Prefer
 installing once? `npm install -g @wonsukchoi/crondex`, then drop the `npx`
 prefix (run `npm update -g` later to pick up new jobs). Prefer no npm at
@@ -87,47 +91,54 @@ tags, variables) use `crondex list`, `crondex recommend`, or browse
 `jobs/<category>/` directly.
 
 <!-- BEGIN JOB SUMMARY -->
-187 jobs across 37 categories:
+257 jobs across 44 categories:
 
 | category | jobs |
 |---|---|
-| `agriculture` | 3 |
-| `construction` | 3 |
+| `agriculture` | 5 |
+| `automotive` | 3 |
+| `childcare` | 3 |
+| `construction` | 5 |
 | `content` | 13 |
-| `creator` | 4 |
-| `crypto` | 3 |
+| `creator` | 5 |
+| `crypto` | 5 |
 | `devops` | 26 |
-| `ecommerce` | 3 |
-| `education` | 3 |
-| `events` | 3 |
+| `ecommerce` | 5 |
+| `education` | 5 |
+| `events` | 5 |
 | `finance` | 10 |
-| `fleet` | 3 |
-| `gaming` | 3 |
+| `fitness` | 3 |
+| `fleet` | 5 |
+| `gaming` | 5 |
+| `government` | 3 |
 | `growth` | 5 |
-| `healthcare` | 3 |
-| `hiring` | 3 |
+| `healthcare` | 5 |
+| `hiring` | 5 |
 | `home` | 5 |
-| `hospitality` | 3 |
-| `hr` | 3 |
-| `insurance` | 3 |
-| `inventory` | 3 |
-| `investing` | 3 |
+| `hospitality` | 5 |
+| `hr` | 5 |
+| `insurance` | 5 |
+| `inventory` | 5 |
+| `investing` | 5 |
 | `learning` | 5 |
-| `legal` | 3 |
-| `logistics` | 3 |
-| `manufacturing` | 3 |
-| `marketing` | 4 |
-| `nonprofit` | 3 |
+| `legal` | 5 |
+| `logistics` | 5 |
+| `manufacturing` | 5 |
+| `marketing` | 5 |
+| `nonprofit` | 5 |
 | `personal` | 9 |
-| `podcast` | 3 |
+| `podcast` | 5 |
 | `productivity` | 9 |
-| `realestate` | 3 |
-| `restaurant` | 3 |
+| `realestate` | 5 |
+| `restaurant` | 5 |
+| `retail` | 3 |
 | `sales` | 5 |
 | `security` | 14 |
-| `support` | 3 |
-| `team` | 4 |
+| `support` | 5 |
+| `team` | 5 |
 | `travel` | 5 |
+| `veterinary` | 3 |
+| `warehousing` | 3 |
 <!-- END JOB SUMMARY -->
 
 ---
@@ -136,6 +147,7 @@ tags, variables) use `crondex list`, `crondex recommend`, or browse
 
 ```
 crondex/
+├── llms.txt               agent-discovery manifest (llms.txt convention)
 ├── bin/crondex.js         CLI: list / categories / show / add / recommend / init
 ├── lib/recommend.js       recommend's scoring logic (unit tested in test/)
 ├── catalog.json           generated index of every job — read this first

package/bin/crondex.js

@@ -2,6 +2,7 @@
 // CLI over catalog.json — browse jobs, read one, or pull one into your project.
 import { readFileSync, writeFileSync, existsSync } from "node:fs";
 import { join } from "node:path";
+import yaml from "js-yaml";
 import { tokenize, rankJobs } from "../lib/recommend.js";
 
 const ROOT = new URL("..", import.meta.url).pathname;
@@ -15,6 +16,14 @@ function flag(name) {
   return i === -1 ? undefined : args[i + 1];
 }
 
+function hasFlag(name) {
+  return args.includes(`--${name}`);
+}
+
+function printJson(value) {
+  console.log(JSON.stringify(value, null, 2));
+}
+
 function findJob(id) {
   const meta = CATALOG.jobs.find((j) => j.id === id);
   if (!meta) {
@@ -28,11 +37,11 @@ function printHelp() {
   console.log(`crondex — browse and pull pre-made cron jobs
 
 Usage:
-  crondex list [--category <name>] [--tag <name>]
-  crondex categories
-  crondex show <id>
+  crondex list [--category <name>] [--tag <name>] [--json]
+  crondex categories [--json]
+  crondex show <id> [--json]
   crondex add <id> [--dest <path>]
-  crondex recommend "<what you want done>" [--limit <n>]
+  crondex recommend "<what you want done>" [--limit <n>] [--json]
   crondex init <id> [--category <name>] [--dest <path>]
 
 Examples:
@@ -42,20 +51,39 @@ Examples:
   crondex add backup-reminder --dest ./cron/backup-reminder.yaml
   crondex recommend "warn me before my SSL cert expires"
   crondex init ssl-cert-expiry-check --category security
+
+Add --json to list/categories/show/recommend for machine-readable output —
+useful when an agent is parsing crondex's output programmatically instead
+of a human reading it.
 `);
 }
 
 function recommend(queryText) {
   const limit = Number(flag("limit")) || 5;
+  const json = hasFlag("json");
   if (!tokenize(queryText).length) {
+    if (json) return printJson([]);
     console.log("query too vague to match on — describe what you want the job to check or remind you about.");
     return;
   }
   const ranked = rankJobs(CATALOG.jobs, queryText, limit);
   if (!ranked.length) {
+    if (json) return printJson([]);
     console.log(`no confident match for "${queryText}". Run "crondex list" to browse everything.`);
     return;
   }
+  if (json) {
+    return printJson(
+      ranked.map((r) => ({
+        id: r.job.id,
+        category: r.job.category,
+        score: r.score,
+        matched_terms: r.matchedTerms,
+        modes: r.job.modes,
+        description: r.job.description,
+      }))
+    );
+  }
   console.log(`top match${ranked.length > 1 ? "es" : ""} for "${queryText}":`);
   console.log();
   for (const r of ranked) {
@@ -77,9 +105,11 @@ function catalogInfoLine() {
 function list() {
   const category = flag("category");
   const tag = flag("tag");
+  const json = hasFlag("json");
   const jobs = CATALOG.jobs.filter(
     (j) => (!category || j.category === category) && (!tag || j.tags.includes(tag))
   );
+  if (json) return printJson(jobs);
   console.log(catalogInfoLine());
   console.log();
   if (!jobs.length) {
@@ -94,15 +124,20 @@ function list() {
 }
 
 function show(id) {
-  console.log(readFileSync(join(ROOT, findJob(id).path), "utf8"));
+  const meta = findJob(id);
+  const raw = readFileSync(join(ROOT, meta.path), "utf8");
+  if (hasFlag("json")) return printJson(yaml.load(raw));
+  console.log(raw);
 }
 
 function categories() {
   const counts = {};
   for (const j of CATALOG.jobs) counts[j.category] = (counts[j.category] ?? 0) + 1;
+  const sorted = Object.entries(counts).sort(([a], [b]) => a.localeCompare(b));
+  if (hasFlag("json")) return printJson(sorted.map(([category, count]) => ({ category, count })));
   console.log(catalogInfoLine());
   console.log();
-  for (const [cat, n] of Object.entries(counts).sort(([a], [b]) => a.localeCompare(b))) {
+  for (const [cat, n] of sorted) {
     console.log(`${cat}  (${n})`);
   }
 }