@aksp/opencrew 1.2.2 → 1.3.0

package/package.json

@@ -1,63 +1,63 @@
-{
-  "name": "@aksp/opencrew",
-  "version": "1.2.2",
-  "publishConfig": {
-    "access": "public"
-  },
-  "description": "A reworked build of OpenSquad (by Renato Asse) — create AI agent crews that work together, right from your IDE. Multi-agent orchestration with an npm installer.",
-  "type": "module",
-  "bin": {
-    "opencrew": "bin/opencrew.js"
-  },
-  "files": [
-    "bin/",
-    "src/",
-    "templates/",
-    "README.md",
-    "LICENSE",
-    "CHANGELOG.md"
-  ],
-  "scripts": {
-    "start": "node bin/opencrew.js",
-    "test": "node --test tests/cli.test.js tests/docs.test.js tests/fsx.test.js tests/ides.test.js tests/init.test.js tests/paths.test.js tests/ui.test.js tests/update.test.js",
-    "lint": "eslint src/ tests/ scripts/",
-    "version": "node scripts/stamp-version.js && git add templates/_opencrew/.opencrew-version"
-  },
-  "keywords": [
-    "ai-agents",
-    "multi-agent",
-    "orchestration",
-    "crews",
-    "claude-code",
-    "cursor",
-    "codex",
-    "gemini",
-    "opencode",
-    "cli"
-  ],
-  "author": {
-    "name": "aksp",
-    "url": "https://www.npmjs.com/~aksp"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/alberthpalhares/opencrew.git"
-  },
-  "homepage": "https://github.com/alberthpalhares/opencrew#readme",
-  "bugs": {
-    "url": "https://github.com/alberthpalhares/opencrew/issues"
-  },
-  "license": "MIT",
-  "engines": {
-    "node": ">=20.0.0"
-  },
-  "dependencies": {
-    "@inquirer/checkbox": "^5.1.0",
-    "@inquirer/confirm": "^5.1.0"
-  },
-  "devDependencies": {
-    "@eslint/js": "^9.0.0",
-    "eslint": "^9.0.0",
-    "globals": "^17.9.0"
-  }
-}
+{
+  "name": "@aksp/opencrew",
+  "version": "1.3.0",
+  "publishConfig": {
+    "access": "public"
+  },
+  "description": "A reworked build of OpenSquad (by Renato Asse) — create AI agent crews that work together, right from your IDE. Multi-agent orchestration with an npm installer.",
+  "type": "module",
+  "bin": {
+    "opencrew": "bin/opencrew.js"
+  },
+  "files": [
+    "bin/",
+    "src/",
+    "templates/",
+    "README.md",
+    "LICENSE",
+    "CHANGELOG.md"
+  ],
+  "scripts": {
+    "start": "node bin/opencrew.js",
+    "test": "node --test tests/cli.test.js tests/docs.test.js tests/fsx.test.js tests/ides.test.js tests/init.test.js tests/paths.test.js tests/ui.test.js tests/update.test.js",
+    "lint": "eslint src/ tests/ scripts/",
+    "version": "node scripts/stamp-version.js && git add templates/_opencrew/.opencrew-version"
+  },
+  "keywords": [
+    "ai-agents",
+    "multi-agent",
+    "orchestration",
+    "crews",
+    "claude-code",
+    "cursor",
+    "codex",
+    "gemini",
+    "opencode",
+    "cli"
+  ],
+  "author": {
+    "name": "aksp",
+    "url": "https://www.npmjs.com/~aksp"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/alberthpalhares/opencrew.git"
+  },
+  "homepage": "https://github.com/alberthpalhares/opencrew#readme",
+  "bugs": {
+    "url": "https://github.com/alberthpalhares/opencrew/issues"
+  },
+  "license": "MIT",
+  "engines": {
+    "node": ">=20.0.0"
+  },
+  "dependencies": {
+    "@inquirer/checkbox": "^5.1.0",
+    "@inquirer/confirm": "^5.1.0"
+  },
+  "devDependencies": {
+    "@eslint/js": "^9.0.0",
+    "eslint": "^9.0.0",
+    "globals": "^17.9.0"
+  }
+}

package/src/cli.js

@@ -1,136 +1,136 @@
-import { readJson } from './lib/fsx.js';
-import { packageJsonPath } from './lib/paths.js';
-import { allIdeIds } from './lib/ides.js';
-import { init } from './commands/init.js';
-import { update } from './commands/update.js';
-import { c, log, err, warn, info } from './lib/ui.js';
-
-// Extract the minimum required Node version from an engines.node range string.
-// Handles: ">=20.0.0", "^20.5", ">=18.0.0 || >=20.0.0", plain "20.0.0".
-function minNodeVersion(range) {
-  // Split on || and take the lowest version (user is expected to meet at least one).
-  const parts = range.split(/\s*\|\|\s*/);
-  let lowest = null;
-  for (const part of parts) {
-    const v = part.replace(/[^0-9.]/g, '');
-    if (!v) continue;
-    if (!lowest || lt(v, lowest)) lowest = v;
-  }
-  return lowest;
-}
-
-// Simple semver comparison (no prerelease tags). Returns true if a < b.
-function lt(a, b) {
-  const pa = a.split('.').map(Number);
-  const pb = b.split('.').map(Number);
-  for (let i = 0; i < 3; i++) {
-    const na = pa[i] || 0;
-    const nb = pb[i] || 0;
-    if (na !== nb) return na < nb;
-  }
-  return false; // equal
-}
-
-function parseArgs(argv) {
-  const opts = { _: [] };
-  for (const a of argv) {
-    if (a.startsWith('--')) {
-      const eq = a.indexOf('=');
-      const k = eq > -1 ? a.slice(2, eq) : a.slice(2);
-      const v = eq > -1 ? a.slice(eq + 1) : true;
-      opts[k] = v;
-    } else if (a.startsWith('-') && a.length === 2) {
-      // Short flags: -y → yes, -v → version, -h → help
-      const short = a[1];
-      opts[short] = true;
-    } else {
-      opts._.push(a);
-    }
-  }
-  // Normalize short flags to their long-form equivalents.
-  if (opts.y) opts.yes = true;
-  if (opts.v) opts.version = true;
-  if (opts.h) opts.help = true;
-  return opts;
-}
-
-function help(version) {
-  log(`
-${c.bold(c.cyan('opencrew'))} ${c.dim('v' + version)} — create AI agent crews that work together
-
-${c.bold('Usage')}
-  npx @aksp/opencrew <command> [options]
-
-${c.bold('Commands')}
-  init            Scaffold an opencrew workspace in the current folder
-  update          Refresh the framework (keeps your crews, memory and .env)
-  upgrade         Alias for update
-  help            Show this help
-  version         Print the version
-
-${c.bold('Options for init')}
-  --ide=a,b       Preselect IDEs (skip the prompt). Valid: ${allIdeIds().join(', ')}
-  --all           Configure every supported IDE
-  --yes, -y       Non-interactive; accept defaults
-
-${c.bold('Options for update')}
-  --check         Dry-run: report whether an update is available without making changes
-
-${c.bold('Examples')}
-  npx @aksp/opencrew init
-  npx @aksp/opencrew init --ide=claude-code,codex
-  npx @aksp/opencrew init --all
-  npx @aksp/opencrew init -y
-  npx @aksp/opencrew update
-  npx @aksp/opencrew update --check
-`);
-}
-
-export async function run(argv) {
-  const opts = parseArgs(argv);
-
-  let version = 'unknown';
-  let engines = {};
-  try {
-    const pkg = await readJson(packageJsonPath);
-    version = pkg.version;
-    engines = pkg.engines || {};
-  } catch {
-    err('Could not read package.json. The installation may be corrupted.');
-    info('Try reinstalling: npm install @aksp/opencrew');
-    process.exitCode = 1;
-    return;
-  }
-
-  // Validate Node version against engines.node requirement.
-  if (engines.node) {
-    const required = minNodeVersion(engines.node);
-    const current = process.versions.node;
-    if (required && lt(current, required)) {
-      warn(`opencrew requires Node.js ${engines.node}. You have v${current}.`);
-      info(`Upgrade Node or use a compatible version.`);
-      process.exitCode = 1;
-      return;
-    }
-  }
-
-  const cmd = opts._[0] || (opts.help ? 'help' : 'init');
-
-  switch (cmd) {
-    case 'init':
-      return init(opts);
-    case 'update':
-    case 'upgrade':
-      return update(opts);
-    case 'version':
-    case '--version':
-      return log(version);
-    case 'help':
-    case '--help':
-      return help(version);
-    default:
-      err(`Unknown command: ${cmd}`);
-      help(version);
-      process.exitCode = 1;
-  }
-}
+import { readJson } from './lib/fsx.js';
+import { packageJsonPath } from './lib/paths.js';
+import { allIdeIds } from './lib/ides.js';
+import { init } from './commands/init.js';
+import { update } from './commands/update.js';
+import { c, log, err, warn, info } from './lib/ui.js';
+
+// Extract the minimum required Node version from an engines.node range string.
+// Handles: ">=20.0.0", "^20.5", ">=18.0.0 || >=20.0.0", plain "20.0.0".
+function minNodeVersion(range) {
+  // Split on || and take the lowest version (user is expected to meet at least one).
+  const parts = range.split(/\s*\|\|\s*/);
+  let lowest = null;
+  for (const part of parts) {
+    const v = part.replace(/[^0-9.]/g, '');
+    if (!v) continue;
+    if (!lowest || lt(v, lowest)) lowest = v;
+  }
+  return lowest;
+}
+
+// Simple semver comparison (no prerelease tags). Returns true if a < b.
+function lt(a, b) {
+  const pa = a.split('.').map(Number);
+  const pb = b.split('.').map(Number);
+  for (let i = 0; i < 3; i++) {
+    const na = pa[i] || 0;
+    const nb = pb[i] || 0;
+    if (na !== nb) return na < nb;
+  }
+  return false; // equal
+}
+
+function parseArgs(argv) {
+  const opts = { _: [] };
+  for (const a of argv) {
+    if (a.startsWith('--')) {
+      const eq = a.indexOf('=');
+      const k = eq > -1 ? a.slice(2, eq) : a.slice(2);
+      const v = eq > -1 ? a.slice(eq + 1) : true;
+      opts[k] = v;
+    } else if (a.startsWith('-') && a.length === 2) {
+      // Short flags: -y → yes, -v → version, -h → help
+      const short = a[1];
+      opts[short] = true;
+    } else {
+      opts._.push(a);
+    }
+  }
+  // Normalize short flags to their long-form equivalents.
+  if (opts.y) opts.yes = true;
+  if (opts.v) opts.version = true;
+  if (opts.h) opts.help = true;
+  return opts;
+}
+
+function help(version) {
+  log(`
+${c.bold(c.cyan('opencrew'))} ${c.dim('v' + version)} — create AI agent crews that work together
+
+${c.bold('Usage')}
+  npx @aksp/opencrew <command> [options]
+
+${c.bold('Commands')}
+  init            Scaffold an opencrew workspace in the current folder
+  update          Refresh the framework (keeps your crews, memory and .env)
+  upgrade         Alias for update
+  help            Show this help
+  version         Print the version
+
+${c.bold('Options for init')}
+  --ide=a,b       Preselect IDEs (skip the prompt). Valid: ${allIdeIds().join(', ')}
+  --all           Configure every supported IDE
+  --yes, -y       Non-interactive; accept defaults
+
+${c.bold('Options for update')}
+  --check         Dry-run: report whether an update is available without making changes
+
+${c.bold('Examples')}
+  npx @aksp/opencrew init
+  npx @aksp/opencrew init --ide=claude-code,codex
+  npx @aksp/opencrew init --all
+  npx @aksp/opencrew init -y
+  npx @aksp/opencrew update
+  npx @aksp/opencrew update --check
+`);
+}
+
+export async function run(argv) {
+  const opts = parseArgs(argv);
+
+  let version = 'unknown';
+  let engines = {};
+  try {
+    const pkg = await readJson(packageJsonPath);
+    version = pkg.version;
+    engines = pkg.engines || {};
+  } catch {
+    err('Could not read package.json. The installation may be corrupted.');
+    info('Try reinstalling: npm install @aksp/opencrew');
+    process.exitCode = 1;
+    return;
+  }
+
+  // Validate Node version against engines.node requirement.
+  if (engines.node) {
+    const required = minNodeVersion(engines.node);
+    const current = process.versions.node;
+    if (required && lt(current, required)) {
+      warn(`opencrew requires Node.js ${engines.node}. You have v${current}.`);
+      info(`Upgrade Node or use a compatible version.`);
+      process.exitCode = 1;
+      return;
+    }
+  }
+
+  const cmd = opts._[0] || (opts.version ? 'version' : opts.help ? 'help' : 'init');
+
+  switch (cmd) {
+    case 'init':
+      return init(opts);
+    case 'update':
+    case 'upgrade':
+      return update(opts);
+    case 'version':
+    case '--version':
+      return log(version);
+    case 'help':
+    case '--help':
+      return help(version);
+    default:
+      err(`Unknown command: ${cmd}`);
+      help(version);
+      process.exitCode = 1;
+  }
+}

package/src/commands/init.js

@@ -1,103 +1,125 @@
-import path from 'node:path';
-import { promises as fs } from 'node:fs';
-import { templatesDir, packageJsonPath } from '../lib/paths.js';
-import { copyDir, exists, writeFileSafe, readJson } from '../lib/fsx.js';
-import { ideById, allIdeIds } from '../lib/ides.js';
-import { pickIdes } from '../lib/prompts.js';
-import { c, log, info, ok, warn, step } from '../lib/ui.js';
-
-export async function init(opts = {}) {
-  const target = process.cwd();
-  const pkg = await readJson(packageJsonPath);
-  const version = pkg.version;
-
-  log(`\n${c.bold(c.cyan('opencrew'))} ${c.dim('v' + version)} — scaffolding a crew workspace`);
-  log(c.dim(`Target: ${target}\n`));
-
-  const alreadyInstalled = await exists(path.join(target, '_opencrew', 'core'));
-  if (alreadyInstalled) {
-    warn('An opencrew workspace already exists here.');
-    info(`To update only the framework, use: ${c.cyan('npx @aksp/opencrew update')}`);
-    info(`To reinstall from scratch, delete _opencrew/ first, then run init again.`);
-    return;
-  }
-
-  // 1. Copy the framework payload (never clobber user work).
-  step('Installing framework files');
-  const copied = { count: 0 };
-  await copyDir(path.join(templatesDir, '_opencrew'), path.join(target, '_opencrew'), {
-    overwrite: false,
-    // Never ship stray logs or browser sessions; keep the empty dir via .gitkeep only.
-    skip: (rel) =>
-      (rel.startsWith('logs/') && rel !== 'logs/.gitkeep') ||
-      rel.startsWith('_browser_profile/'),
-    onCopy: () => (copied.count += 1),
-  });
-  await copyDir(path.join(templatesDir, 'skills'), path.join(target, 'skills'), {
-    overwrite: false,
-    onCopy: () => (copied.count += 1),
-  });
-  await copyDir(path.join(templatesDir, 'crews'), path.join(target, 'crews'), {
-    overwrite: false,
-  });
-  ok(`Framework files ready (${copied.count} written, existing files preserved)`);
-
-  // 2. Canonical system doc + root configs.
-  step('Writing configuration');
-  await writeFileSafe(path.join(target, 'AGENTS.md'), await tpl('AGENTS.md'));
-  ok('AGENTS.md (single source of truth)');
-
-  const mcpWritten = await writeFileSafe(path.join(target, '.mcp.json'), await tpl('.mcp.json'), {
-    overwrite: false,
-  });
-  info(mcpWritten ? '.mcp.json' : '.mcp.json (kept existing)');
-
-  await writeFileSafe(path.join(target, '.env.example'), await tpl('.env.example'));
-  const giWritten = await writeFileSafe(path.join(target, '.gitignore'), await tpl('gitignore'), {
-    overwrite: false,
-  });
-  info(giWritten ? '.gitignore' : '.gitignore (kept existing)');
-
-  // 3. IDE bridge files.
-  step('Configuring AI IDEs');
-  let ids = normalizeIdes(opts.ide);
-  if (opts.all) ids = allIdeIds();
-  if (!ids) ids = await pickIdes();
-
-  for (const id of ids) {
-    const ide = ideById(id);
-    if (!ide) {
-      warn(`Unknown IDE "${id}" — skipped. Valid: ${allIdeIds().join(', ')}`);
-      continue;
-    }
-    for (const f of ide.files) {
-      await writeFileSafe(path.join(target, f.path), f.content);
-    }
-    ok(`${ide.label} → ${ide.files.map((f) => f.path).join(', ')}`);
-  }
-
-  if (ids.includes('claude-code')) {
-    warn(`opencrew ships its own Playwright MCP server (.mcp.json) — disable Claude Code's`);
-    warn(`native Playwright plugin/extension to avoid the two conflicting.`);
-  }
-
-  // 4. Version stamp.
-  await fs.writeFile(path.join(target, '_opencrew', '.opencrew-version'), version + '\n');
-
-  // 5. Done.
-  log(`\n${c.green(c.bold('Done!'))} opencrew is installed.\n`);
-  log(`${c.bold('Next steps:')}`);
-  log(`  1. Open this folder in your AI IDE.`);
-  log(`  2. Type ${c.cyan('/opencrew')} to start (first run sets up your company profile).`);
-  log(`     No API keys needed up front — opencrew asks for them in chat only if a skill you use requires one.\n`);
-}
-
-async function tpl(name) {
-  return fs.readFile(path.join(templatesDir, name), 'utf8');
-}
-
-function normalizeIdes(val) {
-  if (!val) return null;
-  const list = Array.isArray(val) ? val : String(val).split(',');
-  return list.map((s) => s.trim()).filter(Boolean);
-}
+import path from 'node:path';
+import { promises as fs } from 'node:fs';
+import { templatesDir, packageJsonPath } from '../lib/paths.js';
+import { copyDir, exists, writeFileSafe, readJson, writeBridgeFile } from '../lib/fsx.js';
+import { ideById, allIdeIds } from '../lib/ides.js';
+import { pickIdes } from '../lib/prompts.js';
+import { c, log, info, ok, warn, step } from '../lib/ui.js';
+
+export async function init(opts = {}) {
+  const target = process.cwd();
+  const pkg = await readJson(packageJsonPath);
+  const version = pkg.version;
+
+  log(`\n${c.bold(c.cyan('opencrew'))} ${c.dim('v' + version)} — scaffolding a crew workspace`);
+  log(c.dim(`Target: ${target}\n`));
+
+  const alreadyInstalled = await exists(path.join(target, '_opencrew', 'core'));
+  if (alreadyInstalled) {
+    warn('An opencrew workspace already exists here.');
+    info(`To update only the framework, use: ${c.cyan('npx @aksp/opencrew update')}`);
+    info(`To reinstall from scratch, delete _opencrew/ first, then run init again.`);
+    return;
+  }
+
+  // 1. Copy the framework payload (never clobber user work).
+  step('Installing framework files');
+  const copied = { count: 0 };
+  await copyDir(path.join(templatesDir, '_opencrew'), path.join(target, '_opencrew'), {
+    overwrite: false,
+    // Never ship stray logs or browser sessions; keep the empty dir via .gitkeep only.
+    skip: (rel) =>
+      (rel.startsWith('logs/') && rel !== 'logs/.gitkeep') ||
+      rel.startsWith('_browser_profile/'),
+    onCopy: () => (copied.count += 1),
+  });
+  await copyDir(path.join(templatesDir, 'skills'), path.join(target, 'skills'), {
+    overwrite: false,
+    onCopy: () => (copied.count += 1),
+  });
+  await copyDir(path.join(templatesDir, 'crews'), path.join(target, 'crews'), {
+    overwrite: false,
+  });
+  ok(`Framework files ready (${copied.count} written, existing files preserved)`);
+
+  // 2. System doc + root configs.
+  step('Writing configuration');
+
+  // Full system definition lives in _opencrew/core/ — never at project root.
+  // The root AGENTS.md is just a thin bridge (like CLAUDE.md, GEMINI.md, etc.).
+  await writeFileSafe(path.join(target, '_opencrew', 'core', 'system.md'), await tpl('AGENTS.md'));
+  ok('_opencrew/core/system.md (full system definition)');
+
+  const agentsBridge = '# opencrew\n\n'
+    + 'The opencrew system definition lives at `_opencrew/core/system.md`.\n'
+    + 'Read that file and adopt the opencrew system role — follow all initialization,\n'
+    + 'command routing, and workflow instructions defined there.\n\n'
+    + 'Type `/opencrew` to open the main menu.\n';
+
+  const agentsResult = await writeBridgeFile(path.join(target, 'AGENTS.md'), agentsBridge);
+  if (agentsResult.merged) info('AGENTS.md (merged — existing content preserved)');
+  else ok('AGENTS.md (bridge to system.md)');
+
+  const mcpWritten = await writeFileSafe(path.join(target, '.mcp.json'), await tpl('.mcp.json'), {
+    overwrite: false,
+  });
+  info(mcpWritten ? '.mcp.json' : '.mcp.json (kept existing)');
+
+  await writeFileSafe(path.join(target, '.env.example'), await tpl('.env.example'));
+  const giWritten = await writeFileSafe(path.join(target, '.gitignore'), await tpl('gitignore'), {
+    overwrite: false,
+  });
+  info(giWritten ? '.gitignore' : '.gitignore (kept existing)');
+
+  // 3. IDE bridge files.
+  step('Configuring AI IDEs');
+  let ids = normalizeIdes(opts.ide);
+  if (opts.all) ids = allIdeIds();
+  if (opts.yes) ids = allIdeIds();
+  if (!ids) ids = await pickIdes();
+
+  for (const id of ids) {
+    const ide = ideById(id);
+    if (!ide) {
+      warn(`Unknown IDE "${id}" — skipped. Valid: ${allIdeIds().join(', ')}`);
+      continue;
+    }
+    for (const f of ide.files) {
+      const fp = path.join(target, f.path);
+      // Files that require frontmatter at byte 0 (YAML, .mdc) must NOT be wrapped in HTML markers.
+      const hasFrontmatter = f.content.startsWith('---');
+      if (hasFrontmatter) {
+        await writeFileSafe(fp, f.content, { overwrite: false });
+      } else {
+        const result = await writeBridgeFile(fp, f.content);
+        if (result.merged) info(`${f.path} (merged — existing content preserved)`);
+      }
+    }
+    ok(`${ide.label} → ${ide.files.map((f) => f.path).join(', ')}`);
+  }
+
+  if (ids.includes('claude-code')) {
+    warn(`opencrew ships its own Playwright MCP server (.mcp.json) — disable Claude Code's`);
+    warn(`native Playwright plugin/extension to avoid the two conflicting.`);
+  }
+
+  // 4. Version stamp.
+  await fs.writeFile(path.join(target, '_opencrew', '.opencrew-version'), version + '\n');
+
+  // 5. Done.
+  log(`\n${c.green(c.bold('Done!'))} opencrew is installed.\n`);
+  log(`${c.bold('Next steps:')}`);
+  log(`  1. Open this folder in your AI IDE.`);
+  log(`  2. Type ${c.cyan('/opencrew')} to start (first run sets up your company profile).`);
+  log(`     No API keys needed up front — opencrew asks for them in chat only if a skill you use requires one.\n`);
+}
+
+async function tpl(name) {
+  return fs.readFile(path.join(templatesDir, name), 'utf8');
+}
+
+function normalizeIdes(val) {
+  if (!val || val === true) return null;
+  const list = Array.isArray(val) ? val : String(val).split(',');
+  return list.map((s) => s.trim()).filter(Boolean);
+}