@open-product-primer/cli 1.0.0 → 1.1.0

package/dist/commands/init.js

@@ -59,20 +59,32 @@ function initCommand() {
             console.log(chalk_1.default.green('✓') + ' OpenSpec detected');
         if (graphify.detected)
             console.log(chalk_1.default.green('✓') + ' Graphify detected');
+        console.log('');
+        const okfEnabled = await (0, install_agent_1.promptOkfFrontmatter)();
         const primerDir = path.join(projectRoot, 'oprim');
         (0, scaffold_1.ensureDir)(path.join(primerDir, 'decisions'));
         (0, scaffold_1.ensureDir)(path.join(primerDir, 'bets'));
         (0, scaffold_1.ensureDir)(path.join(primerDir, 'reviews'));
         (0, scaffold_1.ensureDir)(path.join(primerDir, 'templates'));
         (0, scaffold_1.ensureDir)(path.join(primerDir, 'scripts'));
-        const configWritten = (0, scaffold_1.writeFileIfAbsent)(path.join(primerDir, 'config.yaml'), (0, templates_1.configTemplate)(projectName, openspec.detected, graphify.detected));
+        const configWritten = (0, scaffold_1.writeFileIfAbsent)(path.join(primerDir, 'config.yaml'), (0, templates_1.configTemplate)(projectName, openspec.detected, graphify.detected, okfEnabled));
         const sequenceWritten = (0, scaffold_1.writeFileIfAbsent)(path.join(primerDir, 'sequence.yaml'), templates_1.sequenceTemplate);
-        (0, scaffold_1.writeFile)(path.join(primerDir, 'templates', 'pdr.md'), templates_1.pdrTemplate);
-        (0, scaffold_1.writeFile)(path.join(primerDir, 'templates', 'bet-decision.md'), templates_1.betDecisionTemplate);
+        const pdrContent = okfEnabled ? (0, templates_1.okfFrontmatter)('pdr', '<Decision title>') + templates_1.pdrTemplate : templates_1.pdrTemplate;
+        const betContent = okfEnabled
+            ? (0, templates_1.okfFrontmatter)('bet-decision', '<Bet title>') + templates_1.betDecisionTemplate
+            : templates_1.betDecisionTemplate;
+        const kpiContent = okfEnabled
+            ? (0, templates_1.okfFrontmatter)('kpi-review', 'KPI Review: BET-XXX') + templates_1.kpiReviewTemplate
+            : templates_1.kpiReviewTemplate;
+        (0, scaffold_1.writeFile)(path.join(primerDir, 'templates', 'pdr.md'), pdrContent);
+        (0, scaffold_1.writeFile)(path.join(primerDir, 'templates', 'bet-decision.md'), betContent);
         (0, scaffold_1.writeFile)(path.join(primerDir, 'templates', 'criteria.yaml'), templates_1.criteriaTemplate);
-        (0, scaffold_1.writeFile)(path.join(primerDir, 'templates', 'kpi-review.md'), templates_1.kpiReviewTemplate);
+        (0, scaffold_1.writeFile)(path.join(primerDir, 'templates', 'kpi-review.md'), kpiContent);
         (0, scaffold_1.writeFile)(path.join(primerDir, 'templates', 'discovery.md'), templates_1.discoveryTemplate);
         (0, scaffold_1.writeFile)(path.join(primerDir, 'scripts', 'generate-sequence-view.js'), templates_1.sequenceViewScriptTemplate);
+        if (okfEnabled) {
+            (0, scaffold_1.writeFile)(path.join(primerDir, 'index.md'), (0, templates_1.indexTemplate)(projectName));
+        }
         (0, scaffold_1.writeFileIfAbsent)(path.join(primerDir, 'decisions', '.gitkeep'), '');
         (0, scaffold_1.writeFileIfAbsent)(path.join(primerDir, 'bets', '.gitkeep'), '');
         (0, scaffold_1.writeFileIfAbsent)(path.join(primerDir, 'reviews', '.gitkeep'), '');
@@ -83,6 +95,7 @@ function initCommand() {
         console.log('  ' + chalk_1.default.gray('oprim/sequence.yaml') + ' — ' + sequenceStatus);
         console.log('  ' + chalk_1.default.gray('oprim/templates/') + ' — refreshed');
         console.log('  ' + chalk_1.default.gray('oprim/scripts/') + ' — refreshed');
+        console.log('  ' + chalk_1.default.gray('OKF frontmatter') + ' — ' + (okfEnabled ? 'enabled' : 'disabled'));
         // ── Agent selection ───────────────────────────────────────────────────────
         let selectedAgents;
         const flaggedAgents = opts.agent;

package/dist/commands/update.js

@@ -51,6 +51,10 @@ function updateCommand() {
         .action(async () => {
         const projectRoot = process.cwd();
         const configAgents = (0, detect_1.readAgentsFromConfig)(projectRoot);
+        // okf.enabled is persisted at init time; update reads it (no re-prompt) since
+        // already-scaffolded oprim/templates/*.md files are never rewritten here.
+        const okfEnabled = (0, detect_1.readOkfEnabledFromConfig)(projectRoot);
+        console.log(chalk_1.default.dim(`OKF frontmatter: ${okfEnabled ? 'enabled' : 'disabled'} (persisted from init)`));
         const primerDir = path.join(projectRoot, 'oprim');
         (0, scaffold_1.ensureDir)(path.join(primerDir, 'scripts'));
         (0, scaffold_1.writeFile)(path.join(primerDir, 'scripts', 'generate-sequence-view.js'), templates_1.sequenceViewScriptTemplate);

package/dist/lib/detect.d.ts

@@ -7,5 +7,6 @@ export declare function detectGraphify(projectRoot: string): {
     graphDir: string | null;
 };
 export declare function readAgentsFromConfig(projectRoot: string): string[] | null;
+export declare function readOkfEnabledFromConfig(projectRoot: string): boolean;
 export declare function detectAvailableAgents(projectRoot: string): string[];
 export declare function writeAgentsToConfig(agents: string[], projectRoot: string): void;

package/dist/lib/detect.js

@@ -36,6 +36,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.detectOpenSpec = detectOpenSpec;
 exports.detectGraphify = detectGraphify;
 exports.readAgentsFromConfig = readAgentsFromConfig;
+exports.readOkfEnabledFromConfig = readOkfEnabledFromConfig;
 exports.detectAvailableAgents = detectAvailableAgents;
 exports.writeAgentsToConfig = writeAgentsToConfig;
 const fs = __importStar(require("fs"));
@@ -62,6 +63,15 @@ function readAgentsFromConfig(projectRoot) {
         return null;
     return agents;
 }
+function readOkfEnabledFromConfig(projectRoot) {
+    const configPath = path.join(projectRoot, 'oprim', 'config.yaml');
+    if (!fs.existsSync(configPath))
+        return false;
+    const content = fs.readFileSync(configPath, 'utf-8');
+    const config = yaml.load(content);
+    const okf = config?.['okf'];
+    return Boolean(okf?.['enabled']);
+}
 function detectAvailableAgents(projectRoot) {
     const detected = [];
     if (fs.existsSync(path.join(projectRoot, '.claude')))

package/dist/lib/install-agent.d.ts

@@ -3,6 +3,7 @@ export declare const SUPPORTED_AGENTS: readonly Agent[];
 export declare function promptFrameworkSelection(projectRoot: string): Promise<string>;
 export declare function promptAgentSelection(projectRoot: string): Promise<string[]>;
 export declare function promptPdrSurfacing(): Promise<boolean>;
+export declare function promptOkfFrontmatter(): Promise<boolean>;
 export declare function installAgentSkills(agent: Agent, projectRoot: string, framework?: string, pdrSurfacing?: boolean): void;
 export declare const OPRIM_CONTEXT_SKILL_STEP = "## Step 0: Check relevant product decisions\nInvoke the `oprim:context` skill using the Skill tool. If matching PDRs are surfaced, review them before proceeding. If no PDRs match or `oprim/decisions/` is empty, the skill exits silently \u2014 continue to Step 1 immediately.";
 export declare const CLAUDE_SKILLS: Record<string, string>;

package/dist/lib/install-agent.js

@@ -40,6 +40,7 @@ exports.CURSOR_COMMANDS = exports.CURSOR_SKILLS = exports.POOLSIDE_SKILLS = expo
 exports.promptFrameworkSelection = promptFrameworkSelection;
 exports.promptAgentSelection = promptAgentSelection;
 exports.promptPdrSurfacing = promptPdrSurfacing;
+exports.promptOkfFrontmatter = promptOkfFrontmatter;
 exports.installAgentSkills = installAgentSkills;
 exports.writeAgentInstructionFile = writeAgentInstructionFile;
 exports.codexInstructions = codexInstructions;
@@ -96,6 +97,13 @@ async function promptPdrSurfacing() {
     const { confirm } = await Promise.resolve().then(() => __importStar(require('@inquirer/prompts')));
     return confirm({ message: 'Enable proactive PDR surfacing in skills? (y/N)', default: false });
 }
+async function promptOkfFrontmatter() {
+    const { confirm } = await Promise.resolve().then(() => __importStar(require('@inquirer/prompts')));
+    return confirm({
+        message: 'Enable OKF (Open Knowledge Format) frontmatter on scaffolded artifacts? (y/N)',
+        default: false,
+    });
+}
 function installAgentSkills(agent, projectRoot, framework = 'openspec', pdrSurfacing = false) {
     if (agent === 'claude') {
         const claudeDir = path.join(projectRoot, '.claude');
@@ -372,7 +380,12 @@ Ask: Context (what forced this decision), Decision (clear statement), Alternativ
 ### 4. Check for supersession
 Ask: "Does this supersede an existing PDR? If so, which ID? (Enter to skip)"
 
+### 4b. Check for OKF frontmatter
+Read \`oprim/templates/pdr.md\`. If it begins with a YAML frontmatter block (\`---\` ... \`---\`), this workspace has OKF frontmatter enabled. Ask for a one-line description and comma-separated tags (subject-area keywords). Prepare a frontmatter block with \`type: pdr\`, \`title: <title>\`, \`description: <description>\`, \`tags: [<tags>]\`, \`timestamp: <today's date, ISO 8601>\`, to prepend in step 5.
+If no frontmatter block is found in the template, skip this step — write the file with no frontmatter, matching current behavior.
+
 ### 5. Write the PDR file
+Prepend the frontmatter block from step 4b, if one was prepared.
 \`\`\`
 # PDR-NNN: <title>
 
@@ -461,7 +474,12 @@ Then ask about each of the four risk dimensions (Low / Medium / High + short rat
 - "**Feasibility risk**: Can we build this with our current skills, time, and technology? (Low / Medium / High — and why?)"
 - "**Business viability risk**: Does this solution work for the business (revenue, legal, ops)? (Low / Medium / High — and why?)"
 
+### 4b. Check for OKF frontmatter
+Read \`oprim/templates/bet-decision.md\`. If it begins with a YAML frontmatter block (\`---\` ... \`---\`), this workspace has OKF frontmatter enabled. Ask for a one-line description and comma-separated tags (subject-area keywords). Prepare a frontmatter block with \`type: bet-decision\`, \`title: <title>\`, \`description: <description>\`, \`tags: [<tags>]\`, \`timestamp: <today's date, ISO 8601>\`, to prepend in step 5.
+If no frontmatter block is found in the template, skip this step — write the file with no frontmatter, matching current behavior.
+
 ### 5. Write oprim/bets/BET-NNN-<slug>/bet-decision.md
+Prepend the frontmatter block from step 4b, if one was prepared.
 \`\`\`
 # Decision: BET-NNN <title>
 <!-- Naming tip: verb + object [for context] — e.g. "Improve bet naming for scannability" not "Naming" -->
@@ -820,7 +838,12 @@ Ask: reviewer name, decision quality notes.
 ### 5. Output path
 \`oprim/reviews/YYYY-MM-DD-BET-NNN-kpi.md\` (today's date)
 
+### 5b. Check for OKF frontmatter
+Read \`oprim/templates/kpi-review.md\`. If it begins with a YAML frontmatter block (\`---\` ... \`---\`), this workspace has OKF frontmatter enabled. Ask for a one-line description and comma-separated tags (derived from the reviewed bet's subject area). Prepare a frontmatter block with \`type: kpi-review\`, \`title: <bet ID and title>\`, \`description: <description>\`, \`tags: [<tags>]\`, \`timestamp: <review date, ISO 8601>\`, to prepend in step 6.
+If no frontmatter block is found in the template, skip this step — write the file with no frontmatter, matching current behavior.
+
 ### 6. Write the review file
+Prepend the frontmatter block from step 5b, if one was prepared.
 \`\`\`markdown
 # KPI Review: BET-NNN
 

package/dist/lib/templates.d.ts

@@ -1,4 +1,6 @@
-export declare function configTemplate(projectName: string, openspecEnabled: boolean, graphifyEnabled: boolean): string;
+export declare function configTemplate(projectName: string, openspecEnabled: boolean, graphifyEnabled: boolean, okfEnabled: boolean): string;
+export declare function okfFrontmatter(type: string, titleHint: string): string;
+export declare function indexTemplate(projectName: string): string;
 export declare const sequenceTemplate = "wip_limits:\n  now: 2\n\nnow: []\nnext: []\nlater: []\nbacklog: []\n";
 export declare const pdrTemplate = "# PDR-XXX: <Decision title>\n\n## Status\nProposed | Accepted | Deprecated | Superseded by PDR-YYY\n\n## Context\n<What forced this decision?>\n\n## Decision\n<Clear statement of what is decided>\n\n## Alternatives considered\n- <Alternative A and why rejected>\n- <Alternative B and why rejected>\n\n## Consequences\n- Positive: <...>\n- Trade-offs: <...>\n- Follow-ups: <...>\n\n## Evidence\n- <Research link>\n- <Data link>\n\n## Related\n- Bets: <BET-IDs>\n- OpenSpec: <change paths>\n- Supersedes: <PDR-ID or none>\n";
 export declare const betDecisionTemplate = "# Decision: BET-XXX <Bet title>\n<!-- Naming tip: verb + object [for context] \u2014 e.g. \"Improve bet naming for scannability\" not \"Naming\" -->\n\n## Status\n- Decision: Build now | Defer | Kill\n- Date: YYYY-MM-DD\n- Owner: <name>\n- Review date: YYYY-MM-DD\n\n## Why now\n- <prioritization rationale>\n\n## Alternatives considered\n- <alternative + reason>\n\n## Expected outcomes\n- <metric: baseline -> target in timeframe>\n\n## Kill criteria / rollback trigger\n- <condition and action>\n\n## Links\n- PDRs: <PDR-IDs>\n- OpenSpec change: <path once promoted>\n";

package/dist/lib/templates.js

@@ -2,7 +2,9 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.kpiReviewTemplate = exports.sequenceViewScriptTemplate = exports.discoveryTemplate = exports.criteriaTemplate = exports.betDecisionTemplate = exports.pdrTemplate = exports.sequenceTemplate = void 0;
 exports.configTemplate = configTemplate;
-function configTemplate(projectName, openspecEnabled, graphifyEnabled) {
+exports.okfFrontmatter = okfFrontmatter;
+exports.indexTemplate = indexTemplate;
+function configTemplate(projectName, openspecEnabled, graphifyEnabled, okfEnabled) {
     return `version: 1
 project:
   name: "${projectName}"
@@ -14,6 +16,8 @@ integrations:
   graphify:
     enabled: ${graphifyEnabled}
     graph_dir: graphify-out
+okf:
+  enabled: ${okfEnabled}
 measurement:
   amplitude:
     enabled: false
@@ -25,6 +29,29 @@ sequencing:
     now: 2
 `;
 }
+// OKF (Open Knowledge Format) — https://github.com/GoogleCloudPlatform/okf
+function okfFrontmatter(type, titleHint) {
+    return `---
+type: ${type}
+title: "${titleHint}"
+description: "<one-line summary>"
+tags: []
+timestamp: YYYY-MM-DDTHH:MM:SSZ
+---
+
+`;
+}
+function indexTemplate(projectName) {
+    return `${okfFrontmatter('index', `${projectName} — oprim workspace`)}# ${projectName} — oprim workspace
+
+OKF (Open Knowledge Format) bundle entrypoint for this oprim workspace.
+
+## Contents
+- [Bets](./bets/) — product bet decisions
+- [Decisions](./decisions/) — Product Decision Records (PDRs)
+- [Reviews](./reviews/) — KPI reviews
+`;
+}
 exports.sequenceTemplate = `wip_limits:
   now: 2
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@open-product-primer/cli",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "Open Product Primer CLI — product decisions, sequencing, and KPI tracking for repositories",
   "keywords": [
     "product",