karajan-code 2.20.0 → 2.21.0

package/README.md

@@ -345,6 +345,22 @@ Opt out: set `telemetry: false` in `~/.karajan/kj.config.yml`
 
 ## Recent releases
 
+> **v2.21.0 released** — Minor. **Brownfield Onboarder role**. Karajan now ships a dedicated path to analyze any existing codebase and produce a Markdown Architecture Brief that the planner can consume as automatic context. Closes KJC-TSK-0384 (3 PRs).
+>
+> KJC-TSK-0384 (PRs #804 + #805 + #806): **`kj onboard`** runs five deterministic collectors over a project root — directory walk (ignoring `node_modules` / `.git` / `dist` / `build`), git log (commits, branches, hot files via `--name-only` over the last 200 commits), 18 well-known config patterns + `package.json` scripts, ADR-style filenames under `docs/adr/`, `docs/adrs/`, `docs/architecture/`, plus a one-shot bundle. Then optionally synthesises a Markdown Architecture Brief via the new OnboarderRole. Output lands at `~/.karajan/onboarding/<slug>.md`. Flags: `--no-synth` (skip the LLM call, dump the raw collectors — useful for CI), `--output <path>` (override default target). Greenfield projects produce `# Project is greenfield` instead of erroring.
+>
+> **New `--use-onboarding` flag on `kj plan generate`**: reads the cached Architecture Brief and prepends it to the planner context under a `## Architecture Brief (from kj onboard)` heading. Silent on cache miss without the flag; loud `warn` when the flag is set but no cache exists, so a missed `kj onboard` invocation surfaces immediately.
+>
+> Workflow:
+>
+> ```bash
+> kj onboard                            # produces ~/.karajan/onboarding/<slug>.md once
+> kj plan generate task.md \
+>     --use-onboarding                  # next plan uses it as context
+> ```
+>
+> **What's next** — The **Project RAG** epic (KJC-PCS-0049) starts in v2.22.0: vector store + Ollama embedder + indexer + retriever + CLI / MCP / HU Board consumers. Onboarder is its prerequisite (the brief feeds the indexer's first pass).
+>
 > **v2.20.0 released** — Minor. **HU Board polish + UX papercuts** cluster: 5 cards closed across two net-new features, two PG housekeeping syncs for work that had already landed, and one docs refresh.
 >
 > KJC-TSK-0397 (PR #801): **`kj plan generate` now prepends a `[PREFLIGHT-000]` HU to every plan** and gates every functional HU on it. The HU's acceptance tests are stack-aware shell commands — Node gets `node --version` + `npm install` + conditional `npm test` / `npm run lint`; Python gets `python --version` + `pip install -r requirements.txt` (or `poetry install`) + `pytest --collect-only`; Firebase projects get `firebase projects:list`; GCP projects get `gcloud auth list`; everyone gets `git status --porcelain`. Idempotent: a plan that already has a HU titled `PREFLIGHT-000` / "verificar entorno" is left untouched. Opt out per-invocation with `--no-preflight-hu`. The point: Karajan owns the plumbing, the user no longer has to remember to add a 'verify env' step to every task file.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "karajan-code",
-  "version": "2.20.0",
+  "version": "2.21.0",
   "description": "Local multi-agent coding orchestrator with TDD, SonarQube, and code review pipeline",
   "type": "module",
   "license": "AGPL-3.0",

package/src/cli/register-meta.js

@@ -2,6 +2,7 @@ import { discoverCommand } from "../commands/discover.js";
 import { triageCommand } from "../commands/triage.js";
 import { researcherCommand } from "../commands/researcher.js";
 import { architectCommand } from "../commands/architect.js";
+import { onboardCommand } from "../commands/onboard.js";
 import { auditCommand } from "../commands/audit.js";
 import { resumeCommand } from "../commands/resume.js";
 import { boardCommand } from "../commands/board.js";
@@ -86,6 +87,17 @@ export function registerMeta(program, { pkgVersion }) {
       });
     });
 
+  program
+    .command("onboard")
+    .description("Analyze an existing codebase (brownfield) and produce an Architecture Brief")
+    .option("--no-synth", "Skip the LLM synthesis step, dump raw collectors only")
+    .option("--output <path>", "Override the default ~/.karajan/onboarding/<slug>.md target")
+    .action(async (flags) => {
+      await withConfig(pkgVersion, "onboard", flags, async ({ config, logger }) => {
+        await onboardCommand({ config, logger, flags });
+      });
+    });
+
   program
     .command("audit")
     .description("Analyze codebase health (read-only)")

package/src/cli/register-plan.js

@@ -43,6 +43,7 @@ export function registerPlan(program, { pkgVersion }) {
     .option("--skip-spec-review", "Bypass the spec-reviewer pre-pipeline audit")
     .option("--quick", "Sketch mode — skip every quality pass after the initial planner call")
     .option("--no-preflight-hu", "Skip auto-injection of [PREFLIGHT-000] HU at the top of the generated plan")
+    .option("--use-onboarding", "Inject the cached Architecture Brief (~/.karajan/onboarding/<slug>.md) into the planner context")
     .option("-y, --yes", "Skip the project-name prompt (use the auto-derived default).")
     .option("--no-interactive", "Force non-interactive mode (no prompts, use defaults).")
     .action(async (task, flags) => {
@@ -102,6 +103,7 @@ export function registerPlan(program, { pkgVersion }) {
             yes: Boolean(flags.yes),
             interactive: flags.interactive,
             preflightHu: flags.preflightHu !== false, // KJC-TSK-0397
+            useOnboarding: Boolean(flags.useOnboarding), // KJC-TSK-0384 PR 3
           },
         });
       });

package/src/commands/onboard.js

@@ -0,0 +1,35 @@
+// KJC-TSK-0384 PR 2 — `kj onboard` runs collectors + optional LLM synth.
+import { writeFile, mkdir, readFile } from "node:fs/promises";
+import { existsSync } from "node:fs";
+import path from "node:path";
+import { collectAll } from "../onboarder/collectors/index.js";
+import { OnboarderRole } from "../roles/onboarder-role.js";
+import { resolveRole } from "../config.js";
+import { getKarajanHome } from "../utils/paths.js";
+
+export function briefPath(projectDir) {
+  const slug = path.basename(projectDir).replace(/[^a-zA-Z0-9._-]/g, "-").toLowerCase() || "project";
+  return path.join(getKarajanHome(), "onboarding", `${slug}.md`);
+}
+
+export async function onboardCommand({ config, logger, flags = {} }) {
+  const projectDir = config?.projectDir || process.cwd();
+  const out = flags.output || briefPath(projectDir);
+  logger.info(`[onboard] collecting from ${projectDir}`);
+  const bundle = await collectAll(projectDir);
+  await mkdir(path.dirname(out), { recursive: true });
+  if (flags.noSynth) {
+    await writeFile(out, `# Onboarding bundle — ${projectDir}\n\n\`\`\`json\n${JSON.stringify(bundle, null, 2)}\n\`\`\`\n`, "utf8");
+    logger.info(`[onboard] wrote raw bundle to ${out} (--no-synth)`);
+    return { path: out, bundle, brief: null };
+  }
+  const roleCfg = resolveRole(config, "onboarder") || resolveRole(config, "architect");
+  const templatePath = new URL("../../templates/roles/onboarder.md", import.meta.url).pathname;
+  const instructions = existsSync(templatePath) ? await readFile(templatePath, "utf8") : "";
+  const role = new OnboarderRole({ instructions, config, ...roleCfg });
+  const result = await role.run({ bundle });
+  const brief = result?.result?.brief || "# Project is greenfield\n\nNo synth output.\n";
+  await writeFile(out, brief, "utf8");
+  logger.info(`[onboard] wrote Architecture Brief to ${out}`);
+  return { path: out, bundle, brief };
+}

package/src/commands/plan/generate.js

@@ -15,6 +15,7 @@ import { buildStandbyState } from "../../brain/standby-store.js";
 import { printResumeHint } from "../../utils/display/resume-hint.js";
 import { runSpecReview } from "../../spec-review/run-spec-review.js";
 import { prependPreflightHu } from "../../plan/preflight-hu.js";
+import { readCachedBrief } from "../../onboarder/cache.js";
 import { formatPlan, formatHuTable } from "./_shared.js";
 
 /**
@@ -56,12 +57,29 @@ async function planGenerateImpl({ task, config, logger, json, context, runLog, f
     task = reviewResult.finalSpec; // downstream runs the refined spec
   }
 
+  // KJC-TSK-0384 PR 3: --use-onboarding folds the cached Architecture Brief
+  // from `kj onboard` into the planner's context. Silent when no brief is
+  // cached so users without one don't see noise; loud warn when they passed
+  // the flag explicitly but the cache is empty so the missed wiring surfaces.
+  let resolvedContext = context;
+  if (flags?.useOnboarding) {
+    const brief = await readCachedBrief(config?.projectDir || process.cwd());
+    if (brief.found) {
+      resolvedContext = [
+        resolvedContext, brief.content ? `## Architecture Brief (from kj onboard)\n\n${brief.content}` : null,
+      ].filter(Boolean).join("\n\n");
+      runLog.logText(`[planner] onboarding brief injected from ${brief.path}`);
+    } else {
+      logger?.warn?.(`--use-onboarding passed but no brief at ${brief.path}. Run 'kj onboard' first.`);
+    }
+  }
+
   const plannerRole = resolveRole(config, "planner");
   await assertAgentsAvailable([plannerRole.provider]);
   runLog.logText(`[planner] provider=${plannerRole.provider}`);
 
   const planner = createAgent(plannerRole.provider, config, logger);
-  const prompt = buildPlannerPrompt({ task, context });
+  const prompt = buildPlannerPrompt({ task, context: resolvedContext });
   const silenceTimeoutMs = Number(config?.session?.max_agent_silence_minutes) > 0
     ? Math.round(Number(config.session.max_agent_silence_minutes) * 60 * 1000)
     : undefined;

package/src/onboarder/cache.js

@@ -0,0 +1,24 @@
+// KJC-TSK-0384 PR 3 — read the cached Architecture Brief deterministically.
+// briefPath() is exported by src/commands/onboard.js so the writer and
+// reader share the same slug rule.
+import { existsSync } from "node:fs";
+import { readFile } from "node:fs/promises";
+
+import { briefPath } from "../commands/onboard.js";
+
+/**
+ * Read the cached Architecture Brief for `projectDir`. Returns:
+ *   { found: true,  path, content }  — when the file exists
+ *   { found: false, path }           — when it does not
+ * Never throws.
+ */
+export async function readCachedBrief(projectDir) {
+  const p = briefPath(projectDir);
+  if (!existsSync(p)) return { found: false, path: p };
+  try {
+    const content = await readFile(p, "utf8");
+    return { found: true, path: p, content };
+  } catch {
+    return { found: false, path: p };
+  }
+}

package/src/onboarder/collectors/index.js

@@ -0,0 +1,119 @@
+// Onboarder collectors — deterministic, zero-LLM extractors. Each pure,
+// JSON-serialisable, fail-soft (returns null on the slot, never throws).
+// Output bundle is consumed by PR 2 synthesis or dumped via `--no-synth`.
+import { execFileSync } from "node:child_process";
+import { existsSync, readFileSync, statSync } from "node:fs";
+import { readdir } from "node:fs/promises";
+import { join, relative } from "node:path";
+
+import { detectProjectStack } from "../../utils/stack-detect.js";
+
+const IGNORED_DIRS = new Set(["node_modules", ".git", "dist", "build", "coverage", ".karajan", ".next", "__pycache__"]);
+
+function safeRun(cmd, args, opts = {}) {
+  try { return execFileSync(cmd, args, { encoding: "utf8", stdio: ["pipe", "pipe", "pipe"], ...opts }).trim(); }
+  catch { return null; }
+}
+
+// Tree summary: immediate dirs with rough byte count. Ignores noise dirs.
+export async function collectTree(projectDir, { maxDepth = 2 } = {}) {
+  async function walk(dir, depth) {
+    if (depth > maxDepth) return [];
+    let entries;
+    try { entries = await readdir(dir, { withFileTypes: true }); } catch { return []; }
+    const out = [];
+    for (const ent of entries) {
+      if (ent.name.startsWith(".") && ent.name !== ".github") continue;
+      if (IGNORED_DIRS.has(ent.name)) continue;
+      const sub = join(dir, ent.name);
+      if (ent.isDirectory()) {
+        const children = await walk(sub, depth + 1);
+        let bytes = 0;
+        for (const c of children) bytes += c.bytes || 0;
+        out.push({ path: relative(projectDir, sub), kind: "dir", bytes, children });
+      } else if (ent.isFile()) {
+        try { out.push({ path: relative(projectDir, sub), kind: "file", bytes: statSync(sub).size }); } catch { /* race */ }
+      }
+    }
+    return out;
+  }
+  return walk(projectDir, 0);
+}
+
+// Git log + branches + hot files. Returns null on non-git (greenfield).
+export function collectGitHistory(projectDir, { maxHotFiles = 10 } = {}) {
+  const inside = safeRun("git", ["rev-parse", "--is-inside-work-tree"], { cwd: projectDir });
+  if (inside !== "true") return null;
+  const commitsRaw = safeRun("git", ["log", "--oneline", "-n", "100"], { cwd: projectDir }) || "";
+  const branchesRaw = safeRun("git", ["branch", "--list", "--all", "--format=%(refname:short)"], { cwd: projectDir }) || "";
+  const hotRaw = safeRun("git", ["log", "--name-only", "--pretty=format:", "-n", "200"], { cwd: projectDir }) || "";
+  const counts = {};
+  for (const line of hotRaw.split("\n").map((s) => s.trim()).filter(Boolean)) {
+    counts[line] = (counts[line] || 0) + 1;
+  }
+  const hotFiles = Object.entries(counts)
+    .sort((a, b) => b[1] - a[1]).slice(0, maxHotFiles)
+    .map(([file, touches]) => ({ file, touches }));
+  return {
+    commitCount: commitsRaw ? commitsRaw.split("\n").length : 0,
+    branches: branchesRaw.split("\n").filter(Boolean),
+    hotFiles,
+    headSha: safeRun("git", ["rev-parse", "HEAD"], { cwd: projectDir }) || null,
+  };
+}
+
+// Presence-check of known config files + package.json scripts.
+export function collectConfigs(projectDir) {
+  const configFiles = [
+    "package.json", "pyproject.toml", "Cargo.toml", "go.mod",
+    "tsconfig.json", "jsconfig.json",
+    ".eslintrc.js", ".eslintrc.json", "eslint.config.js",
+    "vitest.config.js", "vitest.config.ts", "jest.config.js", "jest.config.ts",
+    "firebase.json", ".gcloudignore", "Dockerfile", "docker-compose.yml",
+    ".github/workflows", ".gitlab-ci.yml", "Makefile",
+  ];
+  const present = configFiles.filter((f) => existsSync(join(projectDir, f)));
+  let scripts = null;
+  try {
+    const pkg = JSON.parse(readFileSync(join(projectDir, "package.json"), "utf8"));
+    scripts = pkg.scripts || null;
+  } catch { /* not a node project */ }
+  return { present, scripts };
+}
+
+// Discover ADR files under docs/adr/, docs/adrs/, docs/architecture/, root.
+export async function collectAdrs(projectDir) {
+  const dirs = ["docs/adr", "docs/adrs", "docs/architecture", "."];
+  const found = [];
+  for (const d of dirs) {
+    const abs = join(projectDir, d);
+    if (!existsSync(abs)) continue;
+    try {
+      const entries = await readdir(abs);
+      for (const f of entries) {
+        if (/^adr-?\d|^\d{4}-.+\.md$/i.test(f) || /architecture.*\.md$/i.test(f)) {
+          found.push(relative(projectDir, join(abs, f)));
+        }
+      }
+    } catch { /* unreadable */ }
+  }
+  return found;
+}
+
+// One-shot bundle: every slot is independent; missing slots → null/[].
+export async function collectAll(projectDir) {
+  const [stack, tree, adrs] = await Promise.all([
+    detectProjectStack(projectDir).catch(() => null),
+    collectTree(projectDir).catch(() => []),
+    collectAdrs(projectDir).catch(() => []),
+  ]);
+  return {
+    projectDir,
+    stack,
+    tree,
+    git: collectGitHistory(projectDir),
+    configs: collectConfigs(projectDir),
+    adrs,
+    collectedAt: new Date().toISOString(),
+  };
+}

package/src/roles/onboarder-role.js

@@ -0,0 +1,61 @@
+// KJC-TSK-0384 PR 2 — Onboarder role. Wraps collectors bundle + LLM
+// synthesis into a Markdown Architecture Brief.
+import { AgentRole } from "./agent-role.js";
+
+const FENCE_RE = /^```(?:markdown|md)?\s*\n([\s\S]*?)\n```\s*$/;
+
+export class OnboarderRole extends AgentRole {
+  constructor(opts) {
+    super({ ...opts, name: "onboarder" });
+  }
+
+  extractInput(input) {
+    if (typeof input === "string") return { bundle: { projectDir: input } };
+    return { bundle: input?.bundle || input || { projectDir: "" } };
+  }
+
+  async buildPrompt({ bundle }) {
+    const instructions = this.instructions || "";
+    const prompt = [
+      instructions,
+      "",
+      "## Bundle (deterministic collectors output)",
+      "",
+      "```json",
+      JSON.stringify(bundle, null, 2),
+      "```",
+      "",
+      "Produce the Architecture Brief now.",
+    ].join("\n");
+    return { prompt };
+  }
+
+  parseOutput(raw) {
+    if (!raw || typeof raw !== "string") return { brief: "" };
+    const trimmed = raw.trim();
+    const fenced = trimmed.match(FENCE_RE);
+    return { brief: fenced ? fenced[1].trim() : trimmed };
+  }
+
+  buildSuccessResult(parsed, provider) {
+    return { brief: parsed.brief, provider };
+  }
+
+  buildSummary(parsed) {
+    const lines = (parsed.brief || "").split("\n").length;
+    return `Architecture brief composed (${lines} line${lines === 1 ? "" : "s"})`;
+  }
+
+  handleParseNull(agentResult, provider) {
+    return {
+      ok: true,
+      result: { brief: agentResult.output || "", provider },
+      summary: "Architecture brief composed (raw)",
+      usage: agentResult.usage,
+    };
+  }
+
+  handleParseError(_err, agentResult, provider) {
+    return this.handleParseNull(agentResult, provider);
+  }
+}

package/templates/roles/onboarder.md

@@ -0,0 +1,36 @@
+# Onboarder
+
+Onboarder role of Karajan. Take a deterministic collectors bundle from a
+brownfield project and emit a concise Markdown **Architecture Brief** for
+downstream roles (planner, architect, researcher, coder).
+
+## Mode
+
+Read-only. NO Bash/Write/Edit/MultiEdit/NotebookEdit. Output the Markdown
+brief as plain text in your response, NOT via tools.
+
+If the project is greenfield (no git, no configs, empty tree) emit
+`# Project is greenfield` plus whatever signal exists. NEVER error out.
+
+## Input
+
+JSON bundle with `projectDir`, `stack`, `tree`, `git` (or null), `configs`,
+`adrs`. Slots may be null/empty.
+
+## Output
+
+Markdown only — skip any section without data:
+
+```markdown
+# Architecture Brief — <projectDir>
+## Stack
+## Layout
+## Configs
+## Git history
+## ADRs
+## Conventions inferred
+## Recommendations for new work
+```
+
+Be conservative: only assert what the bundle shows. "Likely" / "appears to"
+are fine; invention is not. Aim for ~40–80 lines total.