@kaddo/cli 3.23.2 → 3.24.0

package/README.md

@@ -513,6 +513,7 @@ create --from roadmap → owners → guard → explain`.
 | v3.23 | Knowledge Impact Report: `kaddo report impact` (Markdown/JSON, `--output`); evidence-first health/coverage/traceability/readiness/signals; MCP resource + tool |
 | v3.23.1 | Impact report Actionable Gaps: per-Work-Item missing source/initiative/ownership/level/acceptance/DoD/validation, broad globs, overlaps; Work-Item-specific Suggested Actions + Score Breakdown |
 | v3.23.2 | Impact report defaults to `all` scope (accumulated impact), graph built in memory; `--scope active`; `scope_source`/`default_scope` in JSON |
+| v3.24 | Estimated Savings Model: `kaddo savings` (+ `savings init`, `.kaddo/savings.yml`); evidence-based time/value estimates, confidence; MCP resource + tool |
 
 **Optional modules (installed with `kaddo add`):**
 

package/dist/index.js

@@ -688,6 +688,10 @@ var COMMAND_HELP = {
   "report impact": {
     question: "What impact is Kaddo having on this project?",
     next: "Act on the Suggested Actions section"
+  },
+  savings: {
+    question: "How much time/value might Kaddo be saving (estimate)?",
+    next: "Run `kaddo savings init` to calibrate assumptions"
   }
 };
 function commandFooterLines(name) {
@@ -11352,6 +11356,256 @@ function runReportImpact(opts = {}) {
   console.log(content);
 }
 
+// src/core/savings.ts
+import { parse as parseYaml15 } from "yaml";
+var DEFAULT_ASSUMPTIONS = {
+  currency: "USD",
+  hourly_cost: 40,
+  context_preparation_minutes_saved_per_work_item: 30,
+  rework_hours_avoided_per_resolved_drift: 2,
+  onboarding_hours_saved_per_new_contributor: 4,
+  review_minutes_saved_per_work_item_with_ownership: 20,
+  clarification_minutes_saved_per_ready_work_item: 25,
+  architecture_discovery_hours_saved_when_graph_good: 3,
+  expected_new_contributors_per_month: 1,
+  expected_work_items_per_month: 8
+};
+var SAVINGS_PATH = ".kaddo/savings.yml";
+function loadAssumptions(dir) {
+  const p2 = join(dir, SAVINGS_PATH);
+  if (!exists(p2)) return { assumptions: { ...DEFAULT_ASSUMPTIONS }, source: "default" };
+  try {
+    const raw = parseYaml15(readFile(p2));
+    const a = raw?.assumptions ?? {};
+    const t = raw?.team ?? {};
+    const num = (v, d) => typeof v === "number" && Number.isFinite(v) ? v : d;
+    return {
+      source: "file",
+      assumptions: {
+        currency: raw?.currency ?? DEFAULT_ASSUMPTIONS.currency,
+        hourly_cost: num(raw?.hourly_cost, DEFAULT_ASSUMPTIONS.hourly_cost),
+        context_preparation_minutes_saved_per_work_item: num(a.context_preparation_minutes_saved_per_work_item, DEFAULT_ASSUMPTIONS.context_preparation_minutes_saved_per_work_item),
+        rework_hours_avoided_per_resolved_drift: num(a.rework_hours_avoided_per_resolved_drift, DEFAULT_ASSUMPTIONS.rework_hours_avoided_per_resolved_drift),
+        onboarding_hours_saved_per_new_contributor: num(a.onboarding_hours_saved_per_new_contributor, DEFAULT_ASSUMPTIONS.onboarding_hours_saved_per_new_contributor),
+        review_minutes_saved_per_work_item_with_ownership: num(a.review_minutes_saved_per_work_item_with_ownership, DEFAULT_ASSUMPTIONS.review_minutes_saved_per_work_item_with_ownership),
+        clarification_minutes_saved_per_ready_work_item: num(a.clarification_minutes_saved_per_ready_work_item, DEFAULT_ASSUMPTIONS.clarification_minutes_saved_per_ready_work_item),
+        architecture_discovery_hours_saved_when_graph_good: num(a.architecture_discovery_hours_saved_when_graph_good, DEFAULT_ASSUMPTIONS.architecture_discovery_hours_saved_when_graph_good),
+        expected_new_contributors_per_month: num(t.expected_new_contributors_per_month, DEFAULT_ASSUMPTIONS.expected_new_contributors_per_month),
+        expected_work_items_per_month: num(t.expected_work_items_per_month, DEFAULT_ASSUMPTIONS.expected_work_items_per_month)
+      }
+    };
+  } catch {
+    return { assumptions: { ...DEFAULT_ASSUMPTIONS }, source: "default" };
+  }
+}
+function savingsTemplate() {
+  return [
+    "# Kaddo savings assumptions (VS-062). Estimates are evidence-based, not exact ROI.",
+    "# Edit these to match your team, then run `kaddo savings`.",
+    "currency: USD",
+    "",
+    "hourly_cost: 40",
+    "",
+    "assumptions:",
+    "  context_preparation_minutes_saved_per_work_item: 30",
+    "  rework_hours_avoided_per_resolved_drift: 2",
+    "  onboarding_hours_saved_per_new_contributor: 4",
+    "  review_minutes_saved_per_work_item_with_ownership: 20",
+    "  clarification_minutes_saved_per_ready_work_item: 25",
+    "  architecture_discovery_hours_saved_when_graph_good: 3",
+    "",
+    "team:",
+    "  expected_new_contributors_per_month: 1",
+    "  expected_work_items_per_month: 8",
+    ""
+  ].join("\n");
+}
+var READINESS_MULT = { Low: 0.25, Medium: 0.5, High: 0.75, "Very High": 1 };
+var GRAPH_MULT = { empty: 0, sparse: 0.25, partial: 0.6, good: 1, unknown: 0 };
+var round2 = (n) => Math.round(n * 100) / 100;
+function parseRatioNumerator(s) {
+  const m = s.match(/^(\d+)/);
+  return m ? Number(m[1]) : 0;
+}
+var SAVINGS_DISCLAIMER = "These are evidence-based estimates, not exact ROI. Adjust assumptions with real team data.";
+function buildSavingsReport(dir, opts = {}, now = /* @__PURE__ */ new Date()) {
+  const { assumptions: a, source } = loadAssumptions(dir);
+  const impact = buildImpactReport(dir, { scope: opts.scope, scopeSource: opts.scopeSource }, now);
+  const completed = impact.traceability.completed_work_items;
+  const wiWithOwnership = parseRatioNumerator(impact.traceability.work_items_connected_to_code);
+  const acceptanceCov = impact.knowledge_coverage.find((c) => c.label.toLowerCase().includes("acceptance"));
+  const wiWithAcceptance = acceptanceCov?.have ?? 0;
+  const graphQuality = impact.graph_quality.available ? impact.graph_quality.quality : "unknown";
+  const readiness = impact.context_readiness.level;
+  const ctxPrepH = round2(completed * a.context_preparation_minutes_saved_per_work_item / 60);
+  const reviewH = round2(wiWithOwnership * a.review_minutes_saved_per_work_item_with_ownership / 60);
+  const clarH = round2(wiWithAcceptance * a.clarification_minutes_saved_per_ready_work_item / 60);
+  const readinessMult = READINESS_MULT[readiness] ?? 0.5;
+  const onboardH = round2(a.expected_new_contributors_per_month * a.onboarding_hours_saved_per_new_contributor * readinessMult);
+  const graphMult = GRAPH_MULT[graphQuality] ?? 0;
+  const archH = round2(a.architecture_discovery_hours_saved_when_graph_good * graphMult);
+  const totalHours = round2(ctxPrepH + reviewH + clarH + onboardH + archH);
+  const totalValue = Math.round(totalHours * a.hourly_cost);
+  const reasons = [];
+  let level;
+  if (impact.score === null || impact.score < 60 || graphQuality === "empty") {
+    level = "Low";
+    reasons.push("Impact score is low or the knowledge graph is empty.");
+  } else {
+    level = "Medium";
+    reasons.push("Strong knowledge and graph evidence.");
+  }
+  reasons.push("Guard history is not persisted yet \u2014 avoided rework is not estimated.");
+  reasons.push(source === "file" ? "Assumptions come from `.kaddo/savings.yml`." : "Savings assumptions are defaults and should be calibrated.");
+  const actions = [];
+  if (source === "default") actions.push("Run `kaddo savings init` to customize assumptions.");
+  actions.push("Calibrate hourly cost and team assumptions with real team data.");
+  actions.push("Run `kaddo impact` to verify the underlying evidence quality.");
+  actions.push("Use this report as directional evidence, not accounting data.");
+  actions.push("Future: persist Guard history to estimate avoided rework.");
+  return {
+    generated_at: now.toISOString(),
+    project: impact.project,
+    scope: impact.scope,
+    currency: a.currency,
+    disclaimer: SAVINGS_DISCLAIMER,
+    assumptions_source: source,
+    assumptions: {
+      hourly_cost: a.hourly_cost,
+      context_preparation_minutes_saved_per_work_item: a.context_preparation_minutes_saved_per_work_item,
+      review_minutes_saved_per_work_item_with_ownership: a.review_minutes_saved_per_work_item_with_ownership,
+      clarification_minutes_saved_per_ready_work_item: a.clarification_minutes_saved_per_ready_work_item,
+      onboarding_hours_saved_per_new_contributor: a.onboarding_hours_saved_per_new_contributor,
+      expected_new_contributors_per_month: a.expected_new_contributors_per_month,
+      architecture_discovery_hours_saved_when_graph_good: a.architecture_discovery_hours_saved_when_graph_good
+    },
+    evidence: {
+      knowledge_impact_score: impact.score,
+      completed_work_items: completed,
+      ownership_coverage_percent: impact.ownership_coverage.coverage_percent,
+      work_items_with_acceptance_criteria: acceptanceCov ? `${acceptanceCov.have}/${acceptanceCov.total}` : "0/0",
+      graph_quality: graphQuality,
+      graph_nodes: impact.graph_quality.available ? impact.graph_quality.nodes : null,
+      graph_edges: impact.graph_quality.available ? impact.graph_quality.edges : null,
+      context_readiness: readiness,
+      guard_history_available: false
+    },
+    estimated_savings: {
+      context_preparation: { hours: ctxPrepH, formula: `${completed} Work Items \xD7 ${a.context_preparation_minutes_saved_per_work_item} min` },
+      review_effort: { hours: reviewH, formula: `${wiWithOwnership} Work Items with ownership \xD7 ${a.review_minutes_saved_per_work_item_with_ownership} min` },
+      clarification_reduction: { hours: clarH, formula: `${wiWithAcceptance} Work Items with Acceptance Criteria \xD7 ${a.clarification_minutes_saved_per_ready_work_item} min` },
+      onboarding: { hours: onboardH, formula: `${a.expected_new_contributors_per_month} contributor \xD7 ${a.onboarding_hours_saved_per_new_contributor} h \xD7 ${readinessMult.toFixed(2)} readiness multiplier` },
+      architecture_discovery: { hours: archH, formula: `${a.architecture_discovery_hours_saved_when_graph_good} h \xD7 ${graphMult.toFixed(2)} graph multiplier` },
+      drift_prevention: { available: false, hours: 0, reason: "Guard history is not persisted yet." }
+    },
+    total: { estimated_hours_saved: totalHours, estimated_value: totalValue, currency: a.currency },
+    confidence: { level, reasons },
+    suggested_actions: actions
+  };
+}
+function renderSavingsMarkdown(r) {
+  const L = [];
+  L.push("# Kaddo Estimated Savings Report", "");
+  L.push(`Generated at: ${r.generated_at}`);
+  L.push(`Project: ${r.project}`);
+  L.push(`Scope: ${r.scope}`);
+  L.push(`Currency: ${r.currency}`);
+  L.push("");
+  L.push("## Disclaimer", "");
+  L.push(r.disclaimer, "");
+  L.push("## Executive Summary", "");
+  L.push(`- Estimated time saved: ${r.total.estimated_hours_saved} hours`);
+  L.push(`- Estimated value: ${r.total.estimated_value} ${r.currency}`);
+  L.push(`- Confidence: ${r.confidence.level}`);
+  if (r.assumptions_source === "default") L.push("- Using default assumptions. Run `kaddo savings init` to customize them.");
+  L.push("");
+  L.push("## Assumptions", "");
+  L.push(`- Hourly cost: ${r.assumptions.hourly_cost} ${r.currency}`);
+  L.push(`- Context preparation saved per Work Item: ${r.assumptions.context_preparation_minutes_saved_per_work_item} min`);
+  L.push(`- Review saved per Work Item with ownership: ${r.assumptions.review_minutes_saved_per_work_item_with_ownership} min`);
+  L.push(`- Clarification saved per Work Item with acceptance criteria: ${r.assumptions.clarification_minutes_saved_per_ready_work_item} min`);
+  L.push(`- Onboarding saved per new contributor: ${r.assumptions.onboarding_hours_saved_per_new_contributor} h`);
+  L.push(`- Expected new contributors per month: ${r.assumptions.expected_new_contributors_per_month}`);
+  L.push(`- Architecture discovery saved when graph is good: ${r.assumptions.architecture_discovery_hours_saved_when_graph_good} h`);
+  L.push("");
+  L.push("## Evidence Used", "");
+  const e = r.evidence;
+  L.push(`- Knowledge Impact Score: ${e.knowledge_impact_score ?? "not available"}${e.knowledge_impact_score !== null ? "/100" : ""}`);
+  L.push(`- Completed Work Items: ${e.completed_work_items}`);
+  L.push(`- Ownership coverage: ${e.ownership_coverage_percent}%`);
+  L.push(`- Work Items with Acceptance Criteria: ${e.work_items_with_acceptance_criteria}`);
+  L.push(`- Graph quality: ${e.graph_quality}`);
+  if (e.graph_nodes !== null) L.push(`- Graph nodes: ${e.graph_nodes}`);
+  if (e.graph_edges !== null) L.push(`- Graph edges: ${e.graph_edges}`);
+  L.push(`- Context readiness: ${e.context_readiness}`);
+  L.push("- Guard history: not available");
+  L.push("");
+  L.push("## Estimated Savings", "");
+  const s = r.estimated_savings;
+  const line = (title, l) => {
+    L.push(`### ${title}`, "");
+    L.push(`- Formula: ${l.formula}`);
+    L.push(`- Estimated: ${l.hours} h`, "");
+  };
+  line("Context Preparation", s.context_preparation);
+  line("Review Effort", s.review_effort);
+  line("Clarification Reduction", s.clarification_reduction);
+  line("Onboarding", s.onboarding);
+  line("Architecture Discovery", s.architecture_discovery);
+  L.push("### Drift Prevention", "");
+  L.push("- Not available yet.");
+  L.push(`- Reason: ${s.drift_prevention.reason}`, "");
+  L.push("## Total", "");
+  L.push(`- Estimated time saved: ${r.total.estimated_hours_saved} h`);
+  L.push(`- Estimated value: ${r.total.estimated_value} ${r.currency}`);
+  L.push("");
+  L.push("## Confidence", "");
+  L.push(`Confidence: ${r.confidence.level}`, "", "Reason:");
+  for (const reason of r.confidence.reasons) L.push(`- ${reason}`);
+  L.push("");
+  L.push("## Suggested Actions", "");
+  r.suggested_actions.forEach((act, i) => L.push(`${i + 1}. ${act}`));
+  L.push("");
+  return L.join("\n");
+}
+function serializeSavingsJson(r) {
+  return JSON.stringify(r, null, 2) + "\n";
+}
+
+// src/commands/savings.ts
+function runSavings(opts = {}) {
+  const dir = cwd();
+  requireConfig(dir);
+  const scope = opts.scope === "active" ? "active" : opts.scope === "all" ? "all" : void 0;
+  const report = buildSavingsReport(dir, { scope });
+  const content = opts.json ? serializeSavingsJson(report) : renderSavingsMarkdown(report);
+  if (opts.output) {
+    intro2("kaddo savings");
+    writeFile(join(dir, opts.output), content);
+    log2.success(`Wrote ${opts.output.replace(/\\/g, "/")}`);
+    printCommandFooter("savings");
+    outro2("Savings report written.");
+    return;
+  }
+  console.log(content);
+}
+function runSavingsInit(opts = {}) {
+  const dir = cwd();
+  requireConfig(dir);
+  intro2("kaddo savings init");
+  const rel = ".kaddo/savings.yml";
+  const full = join(dir, rel);
+  if (exists(full) && !opts.force) {
+    log2.warn(`${rel} already exists. Use --force to overwrite.`);
+    outro2("Nothing changed.");
+    return;
+  }
+  writeFile(full, savingsTemplate());
+  log2.success(`Wrote ${rel}`);
+  log2.info("Edit the assumptions, then run `kaddo savings`.");
+  outro2("Savings assumptions ready.");
+}
+
 // src/index.ts
 var require2 = createRequire(import.meta.url);
 var { version } = require2("../package.json");
@@ -11387,6 +11641,15 @@ reportCmd.command("impact").description("Knowledge Impact Report: knowledge heal
 program.command("impact").description("Alias for `kaddo report impact`").option("--json", "Output JSON instead of Markdown").option("--scope <scope>", "Scope: all (default \u2014 accumulated impact) or active").option("--output <path>", "Write the report to a file").action((opts) => {
   runReportImpact(opts);
 });
+reportCmd.command("savings").description("Estimated Savings Report: evidence-based time/effort/value estimates (deterministic, no LLM)").option("--json", "Output JSON instead of Markdown").option("--scope <scope>", "Scope: all (default) or active").option("--output <path>", "Write the report to a file (e.g. .kaddo/reports/savings-report.md)").action((opts) => {
+  runSavings(opts);
+});
+var savingsCmd = program.command("savings").description("Estimated Savings Report from impact evidence + configurable assumptions").option("--json", "Output JSON instead of Markdown").option("--scope <scope>", "Scope: all (default) or active").option("--output <path>", "Write the report to a file").action((opts) => {
+  runSavings(opts);
+});
+savingsCmd.command("init").description("Create an editable `.kaddo/savings.yml` with savings assumptions").option("--force", "Overwrite an existing .kaddo/savings.yml").action((opts) => {
+  runSavingsInit(opts);
+});
 program.command("guard").description("Check if modified code has related artifacts that were not updated").option("--staged", "Check only staged files").option("--no-interactive", "Disable interactive ignore prompts").option("--ci", "CI mode: output JSON, no prompts, non-blocking").option("--json", "Output JSON (alias for --ci)").option("--workspace", "Also check local mapped module repos from .kaddo/modules.yml (opt-in)").option("--include-archived", "Include archived Work Items in ownership matching (excluded by default)").action(async (opts) => {
   await runGuard(opts);
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kaddo/cli",
-  "version": "3.23.2",
+  "version": "3.24.0",
   "description": "Knowledge Driven Development toolkit",
   "license": "MIT",
   "repository": {