burhan-mop 0.1.1 → 0.1.2

package/.MOP/PROTOCOL.md

@@ -287,9 +287,12 @@ apply.
 The package installer command is:
 
 ```bash
-npx burhan-mop install
+npx burhan-mop install [--target <project-folder>] [--force] [--json]
 ```
 
+The default output is a clean terminal UI. Use `--json` for CI, scripts, and
+other automation that needs machine-readable output.
+
 The short package command works after the package is published to npm. Before
 an npm publish, install directly from GitHub:
 

package/.MOP/scripts/burhan-mop.mjs

@@ -5,6 +5,39 @@ import { fileURLToPath } from 'node:url';
 
 const here = dirname(fileURLToPath(import.meta.url));
 const packageRoot = resolve(here, '..', '..');
+const colorEnabled = process.stdout.isTTY && !process.env.NO_COLOR;
+const colors = {
+  reset: '\x1b[0m',
+  bold: '\x1b[1m',
+  dim: '\x1b[2m',
+  green: '\x1b[32m',
+  yellow: '\x1b[33m',
+  red: '\x1b[31m',
+  cyan: '\x1b[36m',
+  gray: '\x1b[90m'
+};
+const installEntries = [
+  'AGENTS.md',
+  'CLAUDE.md',
+  'GEMINI.md',
+  '.MOP',
+  '.agents',
+  '.claude',
+  '.claude-flow',
+  '.codex',
+  '.gemini',
+  '.mcp.json'
+];
+const doctorEntries = [
+  'AGENTS.md',
+  'CLAUDE.md',
+  'GEMINI.md',
+  '.MOP/STATE.json',
+  '.MOP/PROTOCOL.md',
+  '.MOP/scripts/mop-core.mjs',
+  '.MOP/scripts/mop-workflow.mjs',
+  '.agents/skills/mop-help/SKILL.md'
+];
 
 function parseArgs(argv) {
   const out = { _: [] };
@@ -14,7 +47,11 @@ function parseArgs(argv) {
       out._.push(item);
       continue;
     }
-    const key = item.slice(2);
+    const [key, inlineValue] = item.slice(2).split('=', 2);
+    if (inlineValue !== undefined) {
+      out[key] = inlineValue;
+      continue;
+    }
     const next = argv[i + 1];
     if (!next || next.startsWith('--')) {
       out[key] = true;
@@ -26,82 +63,178 @@ function parseArgs(argv) {
   return out;
 }
 
-function copyPath(source, target, force = false) {
-  if (!existsSync(source)) return { source, target, status: 'missing-source' };
-  if (existsSync(target) && !force) return { source, target, status: 'skipped-existing' };
+function paint(name, value) {
+  if (!colorEnabled) return value;
+  return `${colors[name]}${value}${colors.reset}`;
+}
+
+function rule() {
+  console.log(paint('gray', '-'.repeat(66)));
+}
+
+function header(title, subtitle) {
+  console.log('');
+  rule();
+  console.log(paint('bold', title));
+  console.log(paint('cyan', subtitle));
+  rule();
+}
+
+function asJson(args) {
+  return args.json === true || args.format === 'json';
+}
+
+function statusBadge(status) {
+  if (status === 'installed') return paint('green', '[OK]');
+  if (status === 'skipped-existing') return paint('yellow', '[SKIP]');
+  if (status === 'missing-source') return paint('red', '[MISS]');
+  return paint('gray', '[INFO]');
+}
+
+function statusLabel(status) {
+  if (status === 'installed') return 'installed';
+  if (status === 'skipped-existing') return 'already exists';
+  if (status === 'missing-source') return 'template missing';
+  return status;
+}
+
+function summarize(results) {
+  return results.reduce((summary, item) => {
+    if (item.status === 'installed') summary.installed += 1;
+    else if (item.status === 'skipped-existing') summary.skipped += 1;
+    else if (item.status === 'missing-source') summary.missing += 1;
+    else summary.other += 1;
+    return summary;
+  }, { installed: 0, skipped: 0, missing: 0, other: 0 });
+}
+
+function copyPath(entry, source, target, force = false) {
+  if (!existsSync(source)) return { entry, source, target, status: 'missing-source' };
+  if (existsSync(target) && !force) return { entry, source, target, status: 'skipped-existing' };
   mkdirSync(dirname(target), { recursive: true });
   cpSync(source, target, { recursive: true, force: true });
-  return { source, target, status: 'installed' };
+  return { entry, source, target, status: 'installed' };
 }
 
-function install(args) {
+function buildInstallReport(args) {
   const targetRoot = resolve(String(args.target || process.cwd()));
   const force = args.force === true;
-  const entries = [
-    'AGENTS.md',
-    'CLAUDE.md',
-    'GEMINI.md',
-    '.MOP',
-    '.agents',
-    '.claude',
-    '.claude-flow',
-    '.codex',
-    '.gemini',
-    '.mcp.json'
-  ];
-  const results = entries.map((entry) => copyPath(
+  const results = installEntries.map((entry) => copyPath(
+    entry,
     join(packageRoot, entry),
     join(targetRoot, entry),
     force
   ));
-  console.log(JSON.stringify({
-    ok: true,
+  const summary = summarize(results);
+  return {
+    ok: summary.missing === 0,
     command: 'npx burhan-mop install',
     target: targetRoot,
     force,
     results,
+    summary,
     next: [
       'Run /mop-setup in the target project.',
       'For team mode, initialize autosycn after setup.',
       'Use: node .MOP/scripts/mop-workflow.mjs help --actor <codename> --task "lepas ni buat apa?"'
     ]
-  }, null, 2));
-}
-
-function doctor() {
-  const required = [
-    'AGENTS.md',
-    'CLAUDE.md',
-    'GEMINI.md',
-    '.MOP/STATE.json',
-    '.MOP/PROTOCOL.md',
-    '.MOP/scripts/mop-core.mjs',
-    '.MOP/scripts/mop-workflow.mjs',
-    '.agents/skills/mop-help/SKILL.md'
-  ];
-  const results = required.map((entry) => {
+  };
+}
+
+function renderInstall(report) {
+  header('BURHAN-MOP installer', 'Portable AI MemoryCore for Claude, Codex / ChatGPT, Gemini, and Antigravity');
+  console.log(`${paint('bold', 'Target')} : ${report.target}`);
+  console.log(`${paint('bold', 'Mode')}   : ${report.force ? 'force overwrite' : 'safe install'}`);
+  rule();
+  for (const item of report.results) {
+    console.log(`${statusBadge(item.status)} ${item.entry.padEnd(28)} ${statusLabel(item.status)}`);
+  }
+  rule();
+  console.log(`${paint('bold', 'Summary')}: ${report.summary.installed} installed, ${report.summary.skipped} skipped, ${report.summary.missing} missing`);
+  if (report.summary.skipped > 0) {
+    console.log(paint('yellow', 'Tip: existing files were kept. Use --force only when you want to overwrite them.'));
+  }
+  if (report.summary.missing > 0) {
+    console.log(paint('red', 'Some package templates are missing. Reinstall or report this package build.'));
+  }
+  console.log('');
+  console.log(paint('bold', 'Next'));
+  report.next.forEach((item, index) => {
+    console.log(`  ${index + 1}. ${item}`);
+  });
+  console.log('');
+  console.log(paint('dim', 'Automation JSON: npx burhan-mop install --json'));
+}
+
+function install(args) {
+  const report = buildInstallReport(args);
+  if (asJson(args)) {
+    console.log(JSON.stringify(report, null, 2));
+    return;
+  }
+  renderInstall(report);
+}
+
+function buildDoctorReport() {
+  const results = doctorEntries.map((entry) => {
     const path = join(process.cwd(), entry);
+    const exists = existsSync(path);
     return {
       entry,
-      exists: existsSync(path),
-      type: existsSync(path) ? (statSync(path).isDirectory() ? 'dir' : 'file') : 'missing'
+      exists,
+      type: exists ? (statSync(path).isDirectory() ? 'dir' : 'file') : 'missing'
     };
   });
-  console.log(JSON.stringify({
+  return {
     ok: results.every((item) => item.exists),
     cwd: process.cwd(),
     results
-  }, null, 2));
+  };
 }
 
-function listPackage() {
-  console.log(JSON.stringify({
+function renderDoctor(report) {
+  header('BURHAN-MOP doctor', 'Workspace health check');
+  console.log(`${paint('bold', 'Project')}: ${report.cwd}`);
+  rule();
+  for (const item of report.results) {
+    const badge = item.exists ? paint('green', '[OK]') : paint('red', '[MISS]');
+    console.log(`${badge} ${item.entry.padEnd(38)} ${item.type}`);
+  }
+  rule();
+  console.log(`${paint('bold', 'Status')}: ${report.ok ? paint('green', 'ready') : paint('red', 'missing files')}`);
+  console.log('');
+  console.log(paint('dim', 'Automation JSON: npx burhan-mop doctor --json'));
+}
+
+function doctor(args) {
+  const report = buildDoctorReport();
+  if (asJson(args)) {
+    console.log(JSON.stringify(report, null, 2));
+    return;
+  }
+  renderDoctor(report);
+}
+
+function listPackage(args) {
+  const report = {
     packageRoot,
     entries: readdirSync(packageRoot, { withFileTypes: true }).map((item) => ({
       name: item.name,
       type: item.isDirectory() ? 'dir' : 'file'
     }))
-  }, null, 2));
+  };
+  if (asJson(args)) {
+    console.log(JSON.stringify(report, null, 2));
+    return;
+  }
+  header('BURHAN-MOP package', 'Published package contents');
+  console.log(`${paint('bold', 'Root')}: ${report.packageRoot}`);
+  rule();
+  for (const item of report.entries) {
+    console.log(`${item.type.padEnd(4)} ${item.name}`);
+  }
+  console.log('');
+  console.log(paint('dim', 'Automation JSON: npx burhan-mop package --json'));
 }
 
 function main() {
@@ -109,11 +242,11 @@ function main() {
   const args = parseArgs(rest);
   if (command === 'install') return install(args);
   if (command === 'doctor') return doctor(args);
-  if (command === 'package') return listPackage();
+  if (command === 'package') return listPackage(args);
   console.log(`Usage:
-  npx burhan-mop install [--target PATH] [--force]
-  npx burhan-mop doctor
-  npx burhan-mop package`);
+  npx burhan-mop install [--target PATH] [--force] [--json]
+  npx burhan-mop doctor [--json]
+  npx burhan-mop package [--json]`);
 }
 
 try {

package/README.bm.md

@@ -0,0 +1,152 @@
+<h1 align="center">BURHAN-MOP</h1>
+
+<p align="center">
+  <strong>MOP portable AI MemoryCore untuk Claude, Codex / ChatGPT, Gemini, dan Antigravity.</strong>
+</p>
+
+<p align="center">
+  <a href="https://www.npmjs.com/package/burhan-mop">
+    <img src="https://img.shields.io/npm/v/burhan-mop?style=for-the-badge&label=NPM" alt="npm version">
+  </a>
+  <a href="https://github.com/BURHANDEV-ENTERPRISE/BURHAN-MOP">
+    <img src="https://img.shields.io/badge/GitHub-BURHAN--MOP-181717?style=for-the-badge&logo=github" alt="GitHub repository">
+  </a>
+  <img src="https://img.shields.io/badge/Node-%3E%3D20-1FAE4B?style=for-the-badge&logo=node.js&logoColor=white" alt="Node 20+">
+  <img src="https://img.shields.io/badge/License-UNLICENSED-9CA3AF?style=for-the-badge" alt="License">
+</p>
+
+<p align="center">
+  <img src="https://img.shields.io/badge/Claude-ready-5A45FF?style=flat-square" alt="Claude ready">
+  <img src="https://img.shields.io/badge/Codex-ready-111111?style=flat-square" alt="Codex ready">
+  <img src="https://img.shields.io/badge/Gemini-ready-4285F4?style=flat-square" alt="Gemini ready">
+  <img src="https://img.shields.io/badge/Antigravity-ready-00A67E?style=flat-square" alt="Antigravity ready">
+  <img src="https://img.shields.io/badge/MOP_Workflow-BMAD_inspired-FFB000?style=flat-square" alt="MOP workflow">
+</p>
+
+<p align="center">
+  <a href="./README.md">English</a>
+  |
+  <strong>Bahasa Melayu</strong>
+</p>
+
+---
+
+## Apa Itu BURHAN-MOP?
+
+BURHAN-MOP ialah **MOP (Memory of Planet) core** yang portable untuk workspace
+coding AI. Ia bagi semua AI provider sumber kebenaran yang sama: memory project,
+peraturan agent, workflow gate, folder artifact, autosycn, dan setup deploy.
+
+Maksudnya mudah: pasang sekali, kemudian Claude, Codex / ChatGPT, Gemini, dan
+Antigravity boleh masuk project yang sama dengan context yang sama.
+
+## Install
+
+Jalankan dalam root project:
+
+```bash
+npx burhan-mop install
+npx burhan-mop doctor
+```
+
+Install ke folder lain:
+
+```bash
+npx burhan-mop install --target "C:\path\to\project"
+```
+
+Paksa overwrite install sedia ada:
+
+```bash
+npx burhan-mop install --force
+```
+
+Installer akan tunjuk terminal UI yang kemas secara default. Untuk automation,
+guna JSON:
+
+```bash
+npx burhan-mop install --json
+npx burhan-mop doctor --json
+```
+
+Selepas install, buka AI coding chat dalam project itu dan jalankan:
+
+```text
+/mop-setup
+```
+
+## Apa Yang Dipasang
+
+| Path | Fungsi |
+| --- | --- |
+| `.MOP/` | State, protocol, script, workflow config, dan template artifact MOP. |
+| `AGENTS.md` | Arahan neutral untuk Codex / ChatGPT coding agents. |
+| `CLAUDE.md` | Entry point dan rules untuk Claude Code. |
+| `GEMINI.md` | Entry point untuk Gemini CLI. |
+| `.agents/` | Agent dan skill yang sesuai untuk Antigravity. |
+| `.codex/`, `.gemini/`, `.claude/` | Config dan skill surface ikut provider. |
+
+## Fungsi Utama
+
+| Fungsi | Apa dia buat |
+| --- | --- |
+| Auth Gate | First action mesti setup/login. AI tidak terus bekerja sebelum gate lulus. |
+| Agent Router | Pilih satu primary agent dan tambah support agent bila perlu. |
+| Party Mode | Tunjuk perbincangan agent-to-agent untuk keputusan multi-role. |
+| MOP Workflow | Flow inspirasi BMAD dari idea sampai release dengan readiness gate. |
+| Artifacts | Simpan plan, spec, review, dan release notes dalam `.MOP/artifacts/`. |
+| Autosycn | Commit dan push guna identiti user sebenar, bukan identiti AI tool. |
+| Auto Deploy | Setup optional untuk GitHub, Docker, dan Vercel. |
+
+## Flow Sesi Pertama
+
+```text
+1. AI baca .MOP/STATE.json
+2. Jika belum setup, AI suruh jalankan /mop-setup
+3. Setup tanya nama project, owner, codename, password, mode, bahasa, dan GitHub
+4. Selepas login, setiap task lalu Agent Router
+5. Task kompleks guna MOP Workflow dan readiness gate sebelum coding
+```
+
+## Command Berguna
+
+```bash
+npx burhan-mop install
+npx burhan-mop doctor
+npx burhan-mop package
+```
+
+Helper dalam project:
+
+```bash
+node .MOP/scripts/mop-core.mjs status
+node .MOP/scripts/mop-core.mjs validate
+node .MOP/scripts/mop-workflow.mjs help --actor <codename> --task "<task>"
+node .MOP/scripts/mop-autosycn.mjs run --actor <codename> --reason "<apa berubah>"
+```
+
+## Workflow Team
+
+Dalam team mode, kerja akan push ke branch user dulu:
+
+```text
+dev/<codename> -> BURHAN-MOP review -> main
+```
+
+BURHAN-MOP bertindak sebagai merge guardian. Ia semak branch, validate state,
+dan merge hanya bila workflow selamat.
+
+## Release
+
+| Item | Nilai |
+| --- | --- |
+| npm package | [`burhan-mop`](https://www.npmjs.com/package/burhan-mop) |
+| command latest | `npx burhan-mop install` |
+| GitHub release | [`v0.1.2`](https://github.com/BURHANDEV-ENTERPRISE/BURHAN-MOP/releases/tag/v0.1.2) |
+| Node | `>=20` |
+
+## Links
+
+- npm: https://www.npmjs.com/package/burhan-mop
+- GitHub: https://github.com/BURHANDEV-ENTERPRISE/BURHAN-MOP
+- English README: [README.md](./README.md)