compound-workflow 1.6.4 → 1.6.6

package/.claude-plugin/plugin.json

@@ -1,6 +1,6 @@
 {
   "name": "compound-workflow",
-  "version": "1.6.4",
+  "version": "1.6.6",
   "description": "Clarify -> plan -> execute -> verify -> capture workflow: commands, skills, and agents for Claude Code",
   "author": {
     "name": "Compound Workflow"

package/.cursor-plugin/plugin.json

@@ -1,6 +1,6 @@
 {
   "name": "compound-workflow",
-  "version": "1.6.4",
+  "version": "1.6.6",
   "description": "Clarify -> plan -> execute -> verify -> capture workflow for Cursor",
   "author": {
     "name": "Compound Workflow"

package/.cursor-plugin/registration.json

@@ -0,0 +1,5 @@
+{
+  "pluginId": "compound-workflow@local",
+  "scope": "user",
+  "installPath": "/Users/cjerochim/Documents/DEVELOPMENT/compound-workflow"
+}

package/README.md

@@ -42,6 +42,8 @@ If your package manager didn’t run postinstall, run once:
 npx compound-workflow install
 ```
 
+Restart Cursor after install; enable third-party plugins in Settings if skills/commands don't appear.
+
 **4. After updating the package**
 
 To get the latest commands and wiring (e.g. after `npm update compound-workflow` or a new release), run install again so your project’s `opencode.json` is refreshed:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "compound-workflow",
-  "version": "1.6.4",
+  "version": "1.6.6",
   "description": "Clarify → plan → execute → verify → capture. One Install action for Cursor, Claude, and OpenCode.",
   "license": "MIT",
   "repository": {
@@ -18,6 +18,7 @@
   ],
   "scripts": {
     "postinstall": "node scripts/postinstall.mjs",
+    "prepublishOnly": "npm run generate:artifacts",
     "generate:artifacts": "node scripts/generate-platform-artifacts.mjs",
     "check:artifacts": "node scripts/generate-platform-artifacts.mjs --check",
     "check:version-parity": "node scripts/check-version-parity.mjs",

package/scripts/generate-platform-artifacts.mjs

@@ -7,6 +7,14 @@ const __dirname = path.dirname(fileURLToPath(import.meta.url));
 const repoRoot = path.resolve(__dirname, "..");
 const agentsRoot = path.join(repoRoot, "src", ".agents");
 
+function loadRegistry() {
+  const registryPath = path.join(agentsRoot, "registry.json");
+  if (!fs.existsSync(registryPath)) {
+    throw new Error(`Registry not found at ${registryPath}`);
+  }
+  return JSON.parse(fs.readFileSync(registryPath, "utf8"));
+}
+
 function walkFiles(dirAbs, predicate) {
   const out = [];
   const stack = [dirAbs];
@@ -42,44 +50,64 @@ function parseFrontmatter(md) {
   return out;
 }
 
-function discoverCommands() {
-  const commandsDir = path.join(agentsRoot, "commands");
-  const files = walkFiles(commandsDir, (p) => p.endsWith(".md"));
-  const commands = [];
-
-  for (const fileAbs of files) {
-    const relWithin = path.relative(commandsDir, fileAbs).replaceAll(path.sep, "/");
-    const frontmatter = parseFrontmatter(fs.readFileSync(fileAbs, "utf8"));
-    const id = (frontmatter.invocation || frontmatter.name || path.basename(fileAbs, ".md")).trim();
-    if (!id) continue;
-    commands.push({
-      id,
-      description: (frontmatter.description || id).trim(),
-      rel: relWithin,
-    });
+/**
+ * Resolve id from frontmatter and config. idFrom = list of frontmatter keys; idFallback = "basename" | "dirname".
+ */
+function resolveId(frontmatter, fileAbs, dirAbs, config) {
+  for (const key of config.idFrom || []) {
+    if (key === "dirname") {
+      const relDir = path.relative(dirAbs, path.dirname(fileAbs));
+      return (relDir ? relDir.replaceAll(path.sep, "/") : path.basename(path.dirname(fileAbs))).trim();
+    }
+    const v = frontmatter[key];
+    if (typeof v === "string" && v.trim()) return v.trim();
   }
+  if (config.idFallback === "basename") return path.basename(fileAbs, ".md").trim();
+  if (config.idFallback === "dirname") return path.basename(path.dirname(fileAbs)).trim();
+  return path.basename(fileAbs, ".md").trim();
+}
 
-  return commands.sort((a, b) => a.id.localeCompare(b.id));
+function resolveDescription(frontmatter, config, id) {
+  const key = config.descriptionFrom;
+  if (key && frontmatter[key] != null) return String(frontmatter[key]).trim();
+  if (config.descriptionFallback === "id") return id || "";
+  return id || "";
 }
 
-function discoverAgents() {
-  const agentDir = path.join(agentsRoot, "agents");
-  const files = walkFiles(agentDir, (p) => p.endsWith(".md"));
-  const agents = [];
+/**
+ * Discover assets of one type from registry config. Returns array of { id, description, rel }.
+ */
+function discoverByType(agentsRootAbs, typeKey, config) {
+  const dirAbs = path.join(agentsRootAbs, config.dir);
+  if (!fs.existsSync(dirAbs)) return [];
+
+  let files = [];
+  if (config.glob === "**/*.md") {
+    files = walkFiles(dirAbs, (p) => p.endsWith(".md"));
+  } else if (config.glob === "*/SKILL.md") {
+    const entries = fs.readdirSync(dirAbs, { withFileTypes: true });
+    for (const e of entries) {
+      if (e.isDirectory()) {
+        const skillMd = path.join(dirAbs, e.name, "SKILL.md");
+        if (fs.existsSync(skillMd)) files.push(skillMd);
+      }
+    }
+    files.sort();
+  } else {
+    files = walkFiles(dirAbs, (p) => p.endsWith(".md"));
+  }
 
+  const out = [];
   for (const fileAbs of files) {
-    const relWithin = path.relative(agentDir, fileAbs).replaceAll(path.sep, "/");
-    const frontmatter = parseFrontmatter(fs.readFileSync(fileAbs, "utf8"));
-    const id = (frontmatter.name || path.basename(fileAbs, ".md")).trim();
+    const rel = path.relative(dirAbs, fileAbs).replaceAll(path.sep, "/");
+    const raw = fs.readFileSync(fileAbs, "utf8");
+    const frontmatter = parseFrontmatter(raw);
+    const id = resolveId(frontmatter, fileAbs, dirAbs, config);
     if (!id) continue;
-    agents.push({
-      id,
-      description: (frontmatter.description || id).trim(),
-      rel: relWithin,
-    });
+    const description = resolveDescription(frontmatter, config, id);
+    out.push({ id, description, rel });
   }
-
-  return agents.sort((a, b) => a.id.localeCompare(b.id));
+  return out.sort((a, b) => a.id.localeCompare(b.id));
 }
 
 function normalizeRepoUrl(repoValue) {
@@ -105,13 +133,25 @@ function writeJson(absPath, value, checkOnly, changed) {
 
 function main() {
   const checkOnly = process.argv.includes("--check");
+  const registry = loadRegistry();
+  const roots = registry.roots?.consumer || {};
+  const assetTypes = registry.assetTypes || {};
+
+  const commands =
+    assetTypes.command != null
+      ? discoverByType(agentsRoot, "command", assetTypes.command)
+      : [];
+  const agents =
+    assetTypes.agent != null ? discoverByType(agentsRoot, "agent", assetTypes.agent) : [];
 
   const pkg = JSON.parse(fs.readFileSync(path.join(repoRoot, "package.json"), "utf8"));
   const repositoryUrl = normalizeRepoUrl(pkg.repository);
-  const commands = discoverCommands();
-  const agents = discoverAgents();
   const changed = [];
 
+  const commandRoot = roots.commands || "node_modules/compound-workflow/src/.agents/commands";
+  const agentRoot = roots.agents || "node_modules/compound-workflow/src/.agents/agents";
+  const skillsPath = roots.skills || "node_modules/compound-workflow/src/.agents/skills";
+
   const claudePlugin = {
     name: pkg.name,
     version: pkg.version,
@@ -140,9 +180,9 @@ function main() {
 
   const openCodeManaged = {
     $schema: "https://opencode.ai/config.json",
-    skillsPath: "node_modules/compound-workflow/src/.agents/skills",
-    commandRoot: "node_modules/compound-workflow/src/.agents/commands",
-    agentRoot: "node_modules/compound-workflow/src/.agents/agents",
+    skillsPath,
+    commandRoot,
+    agentRoot,
     commands,
     agents,
   };

package/scripts/install-cli.mjs

@@ -6,6 +6,7 @@
  */
 import fs from "node:fs";
 import path from "node:path";
+import os from "node:os";
 import { fileURLToPath } from "node:url";
 import { spawnSync } from "node:child_process";
 
@@ -15,25 +16,30 @@ function usage(exitCode = 0) {
   const msg = `
 Usage:
   (automatic) npm install compound-workflow   # runs install via postinstall; no npx needed
-  (manual)    npx compound-workflow install [--root <projectDir>] [--dry-run] [--no-config]
+  (manual)    npx compound-workflow install [--root <projectDir>] [--dry-run] [--no-config] [--no-register-cursor] [--register-cursor]
 
 Install writes opencode.json (from package), merges AGENTS.md, creates standard
 docs/todos directories, and prompts for Repo Config Block (unless --no-config).
+When Cursor is detected (~/.cursor), registers the plugin so skills/commands appear.
 
-  --root <dir>  Project directory (default: cwd)
-  --dry-run     Print planned changes only
-  --no-config   Skip Repo Config Block reminder
+  --root <dir>            Project directory (default: cwd)
+  --dry-run               Print planned changes only
+  --no-config             Skip Repo Config Block reminder
+  --no-register-cursor    Do not register plugin with Cursor (skip apply to ~/.claude/)
+  --register-cursor       Force registration with Cursor even if ~/.cursor not found
 `;
   (exitCode === 0 ? console.log : console.error)(msg.trimStart());
   process.exit(exitCode);
 }
 
 function parseArgs(argv) {
-  const out = { root: process.cwd(), dryRun: false, noConfig: false };
+  const out = { root: process.cwd(), dryRun: false, noConfig: false, noRegisterCursor: false, registerCursor: false };
   for (let i = 2; i < argv.length; i++) {
     const arg = argv[i];
     if (arg === "--dry-run") out.dryRun = true;
     else if (arg === "--no-config") out.noConfig = true;
+    else if (arg === "--no-register-cursor") out.noRegisterCursor = true;
+    else if (arg === "--register-cursor") out.registerCursor = true;
     else if (arg === "--root") {
       const value = argv[i + 1];
       if (!value) usage(1);
@@ -331,15 +337,80 @@ function writePluginManifests(targetRoot, dryRun, isSelfInstall) {
   const cursorDir = path.join(targetRoot, ".cursor-plugin");
   const claudeDir = path.join(targetRoot, ".claude-plugin");
 
+  const installPathAbs = realpathSafe(targetRoot);
+  const registrationDescriptor = {
+    pluginId: "compound-workflow@local",
+    scope: "user",
+    installPath: installPathAbs,
+  };
+
   if (dryRun) {
-    console.log("[dry-run] Would write .cursor-plugin/plugin.json and .claude-plugin/plugin.json");
+    console.log("[dry-run] Would write .cursor-plugin/plugin.json, .claude-plugin/plugin.json, .cursor-plugin/registration.json");
     return;
   }
   fs.mkdirSync(cursorDir, { recursive: true });
   fs.mkdirSync(claudeDir, { recursive: true });
   fs.writeFileSync(path.join(cursorDir, "plugin.json"), JSON.stringify(cursorOut, null, 2) + "\n", "utf8");
   fs.writeFileSync(path.join(claudeDir, "plugin.json"), JSON.stringify(claudeOut, null, 2) + "\n", "utf8");
-  console.log("Wrote: .cursor-plugin/plugin.json, .claude-plugin/plugin.json");
+  fs.writeFileSync(path.join(cursorDir, "registration.json"), JSON.stringify(registrationDescriptor, null, 2) + "\n", "utf8");
+  console.log("Wrote: .cursor-plugin/plugin.json, .claude-plugin/plugin.json, .cursor-plugin/registration.json");
+}
+
+function cursorDetected() {
+  return fs.existsSync(path.join(os.homedir(), ".cursor"));
+}
+
+function applyCursorRegistration(targetRoot, dryRun, noRegisterCursor, forceRegister) {
+  if (dryRun) return;
+  if (noRegisterCursor && !forceRegister) return;
+  const shouldApply = forceRegister || (cursorDetected() && !noRegisterCursor);
+  if (!shouldApply) {
+    console.log("[cursor] Cursor not detected; skipped plugin registration. Use --register-cursor to force.");
+    return;
+  }
+
+  const registrationPath = path.join(targetRoot, ".cursor-plugin", "registration.json");
+  if (!fs.existsSync(registrationPath)) return;
+  let descriptor;
+  try {
+    descriptor = readJsonMaybe(registrationPath);
+  } catch {
+    return;
+  }
+  if (!descriptor?.pluginId || !descriptor?.installPath) return;
+
+  const claudePluginsDir = path.join(os.homedir(), ".claude", "plugins");
+  const installedPath = path.join(claudePluginsDir, "installed_plugins.json");
+  const settingsPath = path.join(os.homedir(), ".claude", "settings.json");
+
+  let installed = {};
+  if (fs.existsSync(installedPath)) {
+    try {
+      installed = readJsonMaybe(installedPath) ?? {};
+    } catch {
+      installed = {};
+    }
+  }
+  const plugins = ensureObject(installed.plugins);
+  plugins[descriptor.pluginId] = [{ scope: descriptor.scope || "user", installPath: descriptor.installPath }];
+  installed.plugins = plugins;
+
+  let settings = {};
+  if (fs.existsSync(settingsPath)) {
+    try {
+      settings = readJsonMaybe(settingsPath) ?? {};
+    } catch {
+      settings = {};
+    }
+  }
+  settings.enabledPlugins = ensureObject(settings.enabledPlugins);
+  settings.enabledPlugins[descriptor.pluginId] = true;
+
+  fs.mkdirSync(claudePluginsDir, { recursive: true });
+  fs.mkdirSync(path.dirname(settingsPath), { recursive: true });
+  fs.writeFileSync(installedPath, JSON.stringify(installed, null, 2) + "\n", "utf8");
+  fs.writeFileSync(settingsPath, JSON.stringify(settings, null, 2) + "\n", "utf8");
+  console.log("Registered compound-workflow with Cursor. Restart Cursor; enable 'Include third-party Plugins, Skills, and other configs' in Settings if needed.");
 }
 
 function reportOpenCodeIntegration(targetRoot, dryRun) {
@@ -406,6 +477,7 @@ function main() {
 
   writeOpenCodeJson(targetRoot, args.dryRun, isSelfInstall);
   writePluginManifests(targetRoot, args.dryRun, isSelfInstall);
+  applyCursorRegistration(targetRoot, args.dryRun, args.noRegisterCursor, args.registerCursor);
   reportOpenCodeIntegration(targetRoot, args.dryRun);
   writeAgentsMd(targetRoot, args.dryRun);
   ensureDirs(targetRoot, args.dryRun);

package/src/.agents/commands/install.md

@@ -2,7 +2,7 @@
 name: install
 invocation: install
 description: Install compound-workflow in this project (native mode): writes opencode.json, merges AGENTS.md, and creates docs/todo dirs.
-argument-hint: "[--dry-run] [--root <path>] [--no-config]"
+argument-hint: "[--dry-run] [--root <path>] [--no-config] [--no-register-cursor] [--register-cursor]"
 ---
 
 # /install
@@ -32,9 +32,15 @@ npx compound-workflow install --no-config
 - `--dry-run`: Print planned changes only; no writes.
 - `--root <path>`: Target project directory (default: current directory).
 - `--no-config`: Skip Repo Config Block reminder; still writes opencode.json, AGENTS.md, and dirs.
+- `--no-register-cursor`: Do not register the plugin with Cursor (skip writing to ~/.claude/).
+- `--register-cursor`: Force registration with Cursor even if Cursor is not detected in the default location.
 
 After running, suggest `opencode debug config` in the project to verify OpenCode resolution.
 
+## Cursor
+
+One command installs and registers the plugin with Cursor when Cursor is detected (`~/.cursor` exists). Restart Cursor after install; if skills or commands do not appear, enable "Include third-party Plugins, Skills, and other configs" in Cursor Settings > Features. Use `--no-register-cursor` to skip registration (e.g. in CI).
+
 ## What Install does
 
 1. Ensures `compound-workflow` is installed in the project.

package/src/.agents/registry.json

@@ -0,0 +1,48 @@
+{
+  "$schema": "https://compound-workflow.dev/registry.schema.json",
+  "roots": {
+    "package": {
+      "commands": "src/.agents/commands",
+      "agents": "src/.agents/agents",
+      "skills": "src/.agents/skills",
+      "references": "src/.agents/references"
+    },
+    "consumer": {
+      "commands": "node_modules/compound-workflow/src/.agents/commands",
+      "agents": "node_modules/compound-workflow/src/.agents/agents",
+      "skills": "node_modules/compound-workflow/src/.agents/skills",
+      "references": "node_modules/compound-workflow/src/.agents/references"
+    }
+  },
+  "assetTypes": {
+    "command": {
+      "dir": "commands",
+      "glob": "**/*.md",
+      "idFrom": ["invocation", "name"],
+      "idFallback": "basename",
+      "descriptionFrom": "description",
+      "descriptionFallback": "id",
+      "output": ["opencode.command", "plugin.commands"]
+    },
+    "agent": {
+      "dir": "agents",
+      "glob": "**/*.md",
+      "idFrom": ["name"],
+      "idFallback": "basename",
+      "descriptionFrom": "description",
+      "descriptionFallback": "id",
+      "output": ["opencode.agent", "plugin.agents"]
+    },
+    "skill": {
+      "dir": "skills",
+      "glob": "*/SKILL.md",
+      "idFrom": ["dirname"],
+      "output": ["opencode.skillsPath", "plugin.skills"]
+    },
+    "reference": {
+      "dir": "references",
+      "glob": "**/*.md",
+      "output": ["path"]
+    }
+  }
+}