@rainbow-robotics/muscat-plugin-kit 0.1.2-dev.22 → 0.1.2-dev.24

package/cli/README.md

@@ -1,6 +1,6 @@
 # @rainbow-robotics/muscat-plugin-kit (`muscat-pk`)
 
-CLI to scaffold, build, preview and pack Muscat plugins.
+CLI to scaffold, build, and preview Muscat plugins.
 
 Install/use it the same way an external plugin author will:
 
@@ -11,8 +11,7 @@ muscat-pk new my-plugin
 
 ```bash
 muscat-pk new my-plugin [--type sdk|ros2|ui] [--pm npm|yarn|pnpm|bun] [--yes]
-muscat-pk build       # src/content.tsx -> dist/content.js (+ manifest, sandbox, assets)
-muscat-pk pack        # build (minified) + distributable ZIP with a size report
+muscat-pk build       # ui/content.tsx -> dist/ (minified) + distributable ZIP (--no-zip to skip)
 muscat-pk dev:ui      # preview the plugin in a mini-Muscat (preview-host)
 muscat-pk dev:back    # run the back end (.venv + python main.py)
 muscat-pk dev         # dev:ui + dev:back

package/cli/bin/muscat-pk.mjs

@@ -1,9 +1,9 @@
 #!/usr/bin/env node
 // muscat-pk — Muscat plugin developer CLI.
-// Subcommands: new, build, pack, dev, dev:ui, dev:back, update, sdk.
+// Subcommands: new, build, dev, dev:ui, dev:back, update, sdk.
+import { log } from "../src/util.mjs";
 import { runNew } from "../src/new.mjs";
 import { runBuild } from "../src/build.mjs";
-import { runPack } from "../src/pack.mjs";
 import { runDevUi } from "../src/devUi.mjs";
 import { runDevBack } from "../src/devBack.mjs";
 import { runDev } from "../src/dev.mjs";
@@ -21,8 +21,7 @@ Usage: muscat-pk <command> [options]
 Commands:
   new [dir]        Scaffold a new plugin project
   type change      Switch backend type (python <-> ros2)
-  build            Build src/content.tsx -> dist/content.js (+ manifest, assets)
-  pack             Build then create a distributable ZIP (with size report)
+  build            Build ui/content.tsx -> dist/ and zip into a distributable ZIP (--no-zip to skip)
   dev              Run Socket.IO bridge, dev:ui, and dev:back together
   dev:ui           Preview the plugin in a mini-Muscat (preview-host)
   dev:back         Run the plugin back end (python: watchfiles reload / ros2: Docker)
@@ -41,8 +40,6 @@ async function main() {
         return await runType(args);
       case "build":
         return await runBuild(args);
-      case "pack":
-        return await runPack(args);
       case "dev":
         return await runDev(args);
       case "dev:ui":
@@ -67,7 +64,8 @@ async function main() {
         process.exitCode = 1;
     }
   } catch (err) {
-    console.error(`\n✖ ${err?.message || err}`);
+    console.error();
+    log.error(err?.message || String(err));
     process.exitCode = 1;
   }
 }

package/cli/src/build.mjs

@@ -1,5 +1,6 @@
-// muscat-pk build — bundle src/content.tsx into dist/content.js and stage
-// manifest.json and assets/ for distribution.
+// muscat-pk build — bundle ui/content.tsx into dist/content.js, stage
+// manifest.json and assets/ for distribution, and zip dist/ into a
+// distributable ZIP (skip with --no-zip).
 //
 // sandbox.html is generated by the CLI — plugin authors never manage it.
 // The import map always reflects the current plugin-ui entry set, so users
@@ -8,11 +9,12 @@
 // The plugin author's `@rainbow-robotics/plugin-ui` and React imports are left external.
 // Muscat/robot and preview-host provide those modules through a sandbox import
 // map, so plugin ZIPs do not carry the UI runtime.
-import { cpSync, copyFileSync, existsSync, mkdirSync, readFileSync, rmSync, writeFileSync } from "node:fs";
+import { cpSync, copyFileSync, existsSync, mkdirSync, readdirSync, readFileSync, rmSync, statSync, writeFileSync } from "node:fs";
 import { createRequire } from "node:module";
-import { dirname, resolve } from "node:path";
-import { spawnSync } from "node:child_process";
-import { findPluginRoot, hasBin, log } from "./util.mjs";
+import { basename, dirname, resolve } from "node:path";
+import { execSync, spawnSync } from "node:child_process";
+import { findPluginRoot, hasBin, humanSize, log } from "./util.mjs";
+import { assertManifest } from "./manifest.mjs";
 
 // Find a usable node binary (for running vite as subprocess).
 function findNodeBin() {
@@ -116,7 +118,7 @@ async function latestPypiVersion(pkg, { stableOnly = false } = {}) {
 }
 
 // Pin unpinned (no version specifier) entries in requirements.txt to the
-// latest PyPI release. Runs on explicit `build`/`pack` only — keeps the shipped
+// latest PyPI release. Runs on explicit `build` only — keeps the shipped
 // plugin reproducible without churning the source file on every dev rebuild.
 // stableOnly=true is used on main-branch builds to avoid shipping dev versions.
 export async function pinRequirements(root, { stableOnly = false } = {}) {
@@ -174,6 +176,7 @@ export const SANDBOX_HTML = `<!doctype html>
 
 export async function buildPlugin({ root, minify = false } = {}) {
   const pluginRoot = root ?? findPluginRoot();
+  assertManifest(pluginRoot);
   const distDir = resolve(pluginRoot, "dist");
   rmSync(distDir, { recursive: true, force: true });
   mkdirSync(distDir, { recursive: true });
@@ -196,6 +199,13 @@ export async function buildPlugin({ root, minify = false } = {}) {
     cpSync(assetsSrc, resolve(distDir, "assets"), { recursive: true });
   }
 
+  // README.md and README.[lang].md → dist/
+  for (const f of readdirSync(pluginRoot)) {
+    if (/^README(\.[a-z]{2}(-[A-Z]{2})?)?\.md$/i.test(f)) {
+      copyFileSync(resolve(pluginRoot, f), resolve(distDir, f));
+    }
+  }
+
   // Backend runtime files — copy entire py/ into dist/, then requirements.txt from root.
   const pySrc = resolve(pluginRoot, "py");
   if (existsSync(pySrc)) {
@@ -210,14 +220,55 @@ export async function buildPlugin({ root, minify = false } = {}) {
   return { pluginRoot, distDir };
 }
 
+function dirSize(dir) {
+  let total = 0;
+  for (const entry of readdirSync(dir)) {
+    const full = resolve(dir, entry);
+    const st = statSync(full);
+    total += st.isDirectory() ? dirSize(full) : st.size;
+  }
+  return total;
+}
+
+// Zip dist/ (+ ros2_ws/install) into a distributable ZIP with a size report.
+function packZip(pluginRoot) {
+  const manifest = JSON.parse(readFileSync(resolve(pluginRoot, "manifest.json"), "utf8"));
+  const zipName = `${basename(pluginRoot)}-${manifest.version || "0.0.0"}.zip`;
+  const zipPath = resolve(pluginRoot, zipName);
+  rmSync(zipPath, { force: true });
+
+  const entries = ["dist"];
+  if (existsSync(resolve(pluginRoot, "ros2_ws/install"))) entries.push("ros2_ws/install");
+
+  log.step(`packing ${entries.join(", ")} → ${zipName}`);
+  try {
+    execSync(`zip -r -q "${zipPath}" ${entries.map((e) => `"${e}"`).join(" ")}`, {
+      cwd: pluginRoot,
+      stdio: "inherit",
+    });
+  } catch {
+    throw new Error("`zip` not found. Install zip or pack manually.");
+  }
+
+  const zipBytes = statSync(zipPath).size;
+  log.ok(`${zipName}   ${humanSize(zipBytes)}`);
+  for (const e of entries) {
+    const full = resolve(pluginRoot, e);
+    const size = statSync(full).isDirectory() ? dirSize(full) : statSync(full).size;
+    log.info(`  ├─ ${e}   ${humanSize(size)}`);
+  }
+  log.warn("robot install checks free space via GET /plugin/capacity (507 if low).");
+}
+
 export async function runBuild(args) {
-  const minify = args.includes("--minify");
+  const noZip = args.includes("--no-zip");
   const root = findPluginRoot();
   if (!args.includes("--no-pin")) {
     const stableOnly = isMainBranch();
     log.step(`pinning requirements.txt to latest ${stableOnly ? "stable " : ""}PyPI versions`);
     await pinRequirements(root, { stableOnly });
   }
-  await buildPlugin({ root, minify });
+  const { pluginRoot } = await buildPlugin({ root, minify: true });
   await exportRos2Build(root);
+  if (!noZip) packZip(pluginRoot);
 }

package/cli/src/devBack.mjs

@@ -8,6 +8,7 @@ import { spawn, spawnSync } from "node:child_process";
 import { existsSync, readFileSync, watch } from "node:fs";
 import { resolve } from "node:path";
 import { detectPythonCmd, hasBin, findPluginRoot, log, venvPython } from "./util.mjs";
+import { readManifest as readManifestSchema, validateManifest } from "./manifest.mjs";
 import {
   ROS2_DEV_IMAGE,
   assertDockerReady,
@@ -146,8 +147,16 @@ function runRos2(root) {
   process.on("SIGTERM", cleanup);
 }
 
+function warnManifest(root) {
+  const manifest = readManifestSchema(root);
+  if (!manifest || Object.keys(manifest).length === 0) return;
+  const errors = validateManifest(manifest);
+  for (const e of errors) log.warn(`manifest.json: ${e}`);
+}
+
 export async function runDevBack() {
   const root = findPluginRoot();
+  warnManifest(root);
   const type = manifestRuntime(root);
   if (type === "ros2") return runRos2(root);
   return runPython(root);

package/cli/src/devUi.mjs

@@ -13,6 +13,10 @@ const PREVIEW_PKG = "@rainbow-robotics/preview-host";
 const CACHE_DIR = resolve(homedir(), ".muscat-pk");
 const CACHE_ROOT = resolve(CACHE_DIR, "node_modules", "@rainbow-robotics", "preview-host");
 
+// Dev builds go to a throwaway dir, not dist/ — dist/ is reserved for
+// build/pack output (the shippable artifact).
+const DEV_OUT = ".muscat-dev";
+
 function findNodeBin() {
   if (typeof Bun === "undefined") return process.execPath;
   for (const c of ["node", "node20", "node18"]) {
@@ -52,14 +56,14 @@ function findPreviewHostRoot() {
   return CACHE_ROOT;
 }
 
-// Write sandbox.html + copy manifest into dist/ (vite doesn't generate these).
+// Write sandbox.html + copy manifest into the dev out dir (vite doesn't generate these).
 function stageDevAssets(pluginRoot) {
-  const distDir = resolve(pluginRoot, "dist");
-  mkdirSync(distDir, { recursive: true });
-  writeFileSync(resolve(distDir, "sandbox.html"), SANDBOX_HTML, "utf8");
+  const outDir = resolve(pluginRoot, DEV_OUT);
+  mkdirSync(outDir, { recursive: true });
+  writeFileSync(resolve(outDir, "sandbox.html"), SANDBOX_HTML, "utf8");
   const manifestSrc = resolve(pluginRoot, "manifest.json");
-  if (existsSync(manifestSrc)) copyFileSync(manifestSrc, resolve(distDir, "manifest.json"));
-  return distDir;
+  if (existsSync(manifestSrc)) copyFileSync(manifestSrc, resolve(outDir, "manifest.json"));
+  return outDir;
 }
 
 // Resolve vite bin path from the plugin root, hoisting-aware.
@@ -79,8 +83,8 @@ function spawnViteWatch(pluginRoot, node) {
   const viteBin = findViteBin(pluginRoot);
   if (!node || !viteBin || !existsSync(viteBin)) return null;
 
-  log.step("vite build --watch (ui/content.tsx → dist/content.js)");
-  return spawn(node, [viteBin, "build", "--watch", "--mode", "development"], {
+  log.step(`vite build --watch (ui/content.tsx → ${DEV_OUT}/content.js)`);
+  return spawn(node, [viteBin, "build", "--watch", "--mode", "development", "--outDir", DEV_OUT], {
     cwd: pluginRoot,
     stdio: "inherit",
   });
@@ -106,14 +110,14 @@ export async function runDevUi(args = []) {
 
   await checkKitUpdate();
   const pluginRoot = findPluginRoot();
-  const distDir = stageDevAssets(pluginRoot);
+  const outDir = stageDevAssets(pluginRoot);
 
   const node = findNodeBin();
   const viteProc = spawnViteWatch(pluginRoot, node);
 
   if (viteProc) {
     log.step("waiting for initial vite build…");
-    await waitForInitialBuild(distDir);
+    await waitForInitialBuild(outDir);
   } else {
     log.warn("vite not found — UI will not be bundled. Run `npm install` in the plugin project.");
   }
@@ -133,7 +137,7 @@ export async function runDevUi(args = []) {
   log.step(`starting preview-host on :${port}`);
   const child = spawn(
     node ?? process.execPath,
-    [serveEntry, "--plugin", distDir, "--port", String(port)],
+    [serveEntry, "--plugin", outDir, "--port", String(port)],
     { stdio: "inherit" },
   );
 

package/cli/src/manifest.mjs

@@ -0,0 +1,183 @@
+// manifest.mjs — manifest.json schema definition and validation
+import { existsSync, readFileSync } from "node:fs";
+import { resolve } from "node:path";
+
+export const CONTRIBUTION_POINTS = ["program.command", "toolbar", "move.rnb"];
+const ICON_SIZES = ["16", "48", "128"];
+const RUNTIME_TYPES = ["none", "python", "ros2"];
+const ROS_CLIENTS = ["rclpy", "rclcpp"];
+const I18N_LANGS = ["ko", "en", "ja", "zh", "vi", "th", "es"];
+const TARGET_CATEGORIES = ["manipulate", "amr", "rby1", "vision"];
+
+function validateI18nLabel(value, field, errors) {
+  if (value === undefined || value === null) {
+    errors.push(`${field} is required`);
+    return;
+  }
+  if (typeof value === "string") return;
+  if (typeof value === "object") {
+    if (typeof value.en !== "string")
+      errors.push(`${field}: "en" is required when using object form`);
+    const unknown = Object.keys(value).filter((k) => !I18N_LANGS.includes(k));
+    if (unknown.length > 0)
+      errors.push(`${field}: unsupported language key(s) — ${unknown.map((k) => `"${k}"`).join(", ")} (allowed: ${I18N_LANGS.join(", ")})`);
+    return;
+  }
+  errors.push(`${field}: must be a string or { en (required), ko, ja, zh, vi, th, es }`);
+}
+
+export function readManifest(root) {
+  const path = resolve(root, "manifest.json");
+  if (!existsSync(path)) return {};
+  try {
+    return JSON.parse(readFileSync(path, "utf8"));
+  } catch {
+    return null;
+  }
+}
+
+function validateIcons(icons, errors) {
+  if (icons === undefined || icons === null) {
+    errors.push("icons is required");
+    return;
+  }
+  if (typeof icons === "string") {
+    if (!icons.toLowerCase().endsWith(".svg"))
+      errors.push(`icons: non-SVG images (PNG, JPG, etc.) must use the { "16": "...", "48": "...", "128": "..." } object form`);
+  } else if (typeof icons === "object") {
+    const missing = ICON_SIZES.filter((s) => typeof icons[s] !== "string" || icons[s].length === 0);
+    if (missing.length > 0)
+      errors.push(`icons: missing size(s) ${missing.map((s) => `"${s}"`).join(", ")} — all three (16, 48, 128) are required for image files`);
+  } else {
+    errors.push(`icons: must be a string (SVG path) or { "16", "48", "128" } object (PNG/JPG)`);
+  }
+}
+
+function validateRuntime(runtime, errors) {
+  if (runtime === undefined || runtime === null) {
+    errors.push("runtime is required");
+    return;
+  }
+  if (typeof runtime !== "object") {
+    errors.push("runtime must be an object");
+    return;
+  }
+  if (!RUNTIME_TYPES.includes(runtime.type))
+    errors.push(`runtime.type must be one of ${RUNTIME_TYPES.map((t) => `"${t}"`).join(" | ")}`);
+  if (runtime.type === "python" && !runtime.entry)
+    errors.push("runtime.entry is required for python runtime");
+  if (runtime.type === "ros2") {
+    if (!runtime.package) errors.push("runtime.package is required for ros2 runtime");
+    if (!runtime.launch) errors.push("runtime.launch is required for ros2 runtime");
+    if (!ROS_CLIENTS.includes(runtime.rosClient))
+      errors.push(`runtime.rosClient must be one of ${ROS_CLIENTS.map((c) => `"${c}"`).join(" | ")}`);
+  }
+}
+
+function validateCommandInfo(info, prefix, errors) {
+  if (typeof info.name !== "string" || info.name.length === 0)
+    errors.push(`${prefix}.commandInfo.name is required`);
+  if (typeof info.icon !== "string" || info.icon.length === 0)
+    errors.push(`${prefix}.commandInfo.icon is required`);
+  if (info.iconClassName !== undefined && typeof info.iconClassName !== "string")
+    errors.push(`${prefix}.commandInfo.iconClassName must be a string`);
+  if (info.funcName !== undefined && typeof info.funcName !== "string")
+    errors.push(`${prefix}.commandInfo.funcName must be a string`);
+  if (info.args !== undefined && (typeof info.args !== "object" || Array.isArray(info.args)))
+    errors.push(`${prefix}.commandInfo.args must be an object`);
+  for (const key of ["disabled", "syncGroupId", "disableCopy", "disableDelete", "requireChildren", "requireParent"]) {
+    if (info[key] !== undefined && typeof info[key] !== "boolean")
+      errors.push(`${prefix}.commandInfo.${key} must be a boolean`);
+  }
+  for (const key of ["allowChildren", "allowParents", "notAllowChildren"]) {
+    if (info[key] !== undefined && (!Array.isArray(info[key]) || info[key].some((v) => typeof v !== "string")))
+      errors.push(`${prefix}.commandInfo.${key} must be a string[]`);
+  }
+  if (info.childrenCommand !== undefined && typeof info.childrenCommand !== "string")
+    errors.push(`${prefix}.commandInfo.childrenCommand must be a string`);
+}
+
+function validateContributes(contributes, errors) {
+  if (!Array.isArray(contributes) || contributes.length === 0) {
+    errors.push("contributes is required and must be a non-empty array");
+    return;
+  }
+  if (!contributes.some((c) => c.point === "toolbar"))
+    errors.push(`contributes: at least one "toolbar" entry is required`);
+
+  const uiValues = contributes.map((c) => c.ui).filter(Boolean);
+  const duplicateUi = uiValues.filter((v, i) => uiValues.indexOf(v) !== i);
+  if (duplicateUi.length > 0)
+    errors.push(`contributes: "ui" values must be unique across all entries (duplicates: ${[...new Set(duplicateUi)].map((v) => `"${v}"`).join(", ")})`);
+
+  contributes.forEach((c, i) => {
+    validateI18nLabel(c.label, `contributes[${i}].label`, errors);
+    if (c.point === "program.command") {
+      if (!c.commandInfo)
+        errors.push(`contributes[${i}]: "commandInfo" is required when point is "program.command"`);
+      else
+        validateCommandInfo(c.commandInfo, `contributes[${i}]`, errors);
+    }
+  });
+}
+
+/**
+ * Validate manifest.json. Returns an array of error messages (empty = valid).
+ */
+export function validateManifest(manifest) {
+  const errors = [];
+
+  if (typeof manifest !== "object" || manifest === null)
+    return ["manifest.json is not a valid JSON object"];
+
+  for (const key of ["id", "name", "version", "minMuscatVersion"]) {
+    if (typeof manifest[key] !== "string" || manifest[key].length === 0)
+      errors.push(`"${key}" is required`);
+  }
+  if (typeof manifest.author !== "string" || manifest.author.length === 0)
+    errors.push(`"author" is required`);
+
+  const hasModels = manifest.targetModels !== undefined && manifest.targetModels !== null;
+  const hasCategorys = manifest.targetCategorys !== undefined && manifest.targetCategorys !== null;
+  if (!hasModels && !hasCategorys) {
+    errors.push(`"targetModels" or "targetCategorys" is required`);
+  } else {
+    if (hasModels) {
+      if (manifest.targetModels !== "all" && (!Array.isArray(manifest.targetModels) || manifest.targetModels.length === 0))
+        errors.push(`"targetModels" must be "all" or a non-empty array of model strings`);
+      else if (Array.isArray(manifest.targetModels) && manifest.targetModels.some((m) => typeof m !== "string"))
+        errors.push(`"targetModels": all entries must be strings`);
+    }
+    if (hasCategorys) {
+      if (manifest.targetCategorys !== "all" && (!Array.isArray(manifest.targetCategorys) || manifest.targetCategorys.length === 0))
+        errors.push(`"targetCategorys" must be "all" or a non-empty array`);
+      else if (Array.isArray(manifest.targetCategorys)) {
+        const invalid = manifest.targetCategorys.filter((c) => !TARGET_CATEGORIES.includes(c));
+        if (invalid.length > 0)
+          errors.push(`"targetCategorys": invalid value(s) ${invalid.map((c) => `"${c}"`).join(", ")} — allowed: ${TARGET_CATEGORIES.join(", ")}`);
+      }
+    }
+  }
+  validateI18nLabel(manifest.description, "description", errors);
+
+  validateIcons(manifest.icons, errors);
+  validateRuntime(manifest.runtime, errors);
+  validateContributes(manifest.contributes, errors);
+
+  return errors;
+}
+
+/**
+ * Read and validate manifest.json. Throws if any errors are found.
+ */
+export function assertManifest(root) {
+  const manifest = readManifest(root);
+  if (manifest === null)
+    throw new Error("manifest.json parse failed — check JSON syntax");
+  if (Object.keys(manifest).length === 0)
+    return manifest;
+  const errors = validateManifest(manifest);
+  if (errors.length > 0)
+    throw new Error(`manifest.json errors:\n${errors.map((e) => `  • ${e}`).join("\n")}`);
+  return manifest;
+}

package/cli/src/new.mjs

@@ -149,7 +149,7 @@ export async function runNew(args) {
   // gitignore (templates can't ship a literal .gitignore via npm reliably)
   writeFileSync(
     resolve(target, ".gitignore"),
-    ["node_modules", "dist", ".venv", "*.zip", "ros2_ws/install", ""].join("\n"),
+    ["node_modules", "dist", ".muscat-dev", ".venv", "*.zip", "ros2_ws/install", ""].join("\n"),
   );
 
   if (!opts["no-install"]) {
@@ -197,7 +197,7 @@ export async function runNew(args) {
   log.ok(`created ${targetName} (type: ${type}, pm: ${pm})`);
   log.info(`\n  cd ${targetName}`);
   log.info(`  muscat-pk dev      # preview in mini-Muscat + back end`);
-  log.info(`  muscat-pk pack     # build a distributable ZIP\n`);
+  log.info(`  muscat-pk build    # build + distributable ZIP\n`);
 
   // ── post-scaffold environment warnings ───────────────────────────────────
   const noNode = !hasBin("node");

package/cli/src/util.mjs

@@ -79,14 +79,16 @@ export function findPluginRoot(start = process.cwd()) {
   );
 }
 
+const RED    = "\x1b[31m";
 const ORANGE = "\x1b[33m";
 const RESET  = "\x1b[0m";
 
 export const log = {
-  info: (...m) => console.log(...m),
-  step: (...m) => console.log("›", ...m),
-  ok:   (...m) => console.log("✓", ...m),
-  warn: (...m) => console.warn(`${ORANGE}⚠${RESET}`, ...m.map(s => `${ORANGE}${s}${RESET}`)),
+  info:  (...m) => console.log(...m),
+  step:  (...m) => console.log("›", ...m),
+  ok:    (...m) => console.log("✓", ...m),
+  warn:  (...m) => console.warn(`${ORANGE}⚠${RESET}`, ...m.map(s => `${ORANGE}${s}${RESET}`)),
+  error: (...m) => console.error(`${RED}✖${RESET}`, ...m.map(s => `${RED}${s}${RESET}`)),
 };
 
 export function humanSize(bytes) {

package/cli/templates/common/README.md

@@ -8,7 +8,7 @@ A Muscat plugin project. Build, develop, and ship with `muscat-pk` CLI.
 muscat-pk dev        # UI preview + backend together
 muscat-pk dev:ui     # UI preview only
 muscat-pk dev:back   # backend only (Python watchfiles / ROS2 Docker)
-muscat-pk pack       # build a distributable ZIP
+muscat-pk build      # build + distributable ZIP
 ```
 
 ---
@@ -17,20 +17,22 @@ muscat-pk pack       # build a distributable ZIP
 
 ```
 __PLUGIN_DIR__/
-├─ src/
+├─ ui/
 │   └─ content.tsx      # plugin UI entry point
+├─ py/
+│   └─ main.py          # Python backend entry point
 ├─ assets/
 │   └─ icon.svg         # icon referenced from manifest
 ├─ manifest.json        # metadata, contribution points, runtime config
-├─ main.py              # backend (Python or ROS2)
-└─ requirements.txt     # Python deps (auto-pinned to latest on pack)
+├─ README.md            # this file (copied to dist/ on build)
+└─ requirements.txt     # Python deps (auto-pinned to latest on build)
 ```
 
 > ROS2 plugins additionally include a `ros2_ws/` directory.
 
 ---
 
-## Frontend (`src/content.tsx`)
+## Frontend (`ui/content.tsx`)
 
 ### useRb() hook
 
@@ -97,12 +99,11 @@ connect(App);
 
 ---
 
-## Backend (`main.py`)
+## Backend (`py/main.py`)
 
 The backend communicates with the frontend using `rainbow.rb_sdk.RBPluginCall`.
-Relative topics and plugin context are handled by the SDK.
-`muscat-pk dev` starts the local Socket.IO bridge separately; `main.py`
-should contain plugin logic only and should not start its own server.
+`muscat-pk dev` starts the local Socket.IO bridge; `py/main.py` should contain plugin
+logic only and must not start its own server.
 
 ### Python plugin
 
@@ -148,7 +149,6 @@ if __name__ == "__main__":
 ### ROS2 plugin
 
 The node is launched with `--ros-args -r __ns:=/{slug}` automatically by `dev:back`.
-ROS2 topics are bridged to the plugin communication layer — no extra code needed.
 
 ```python
 # ros2_ws/src/__PLUGIN_SLUG__/__PLUGIN_SLUG__/node.py
@@ -173,30 +173,125 @@ class __PLUGIN_CLASS__Node(Node):
 
 ```jsonc
 {
-  "id": "com.example.my-plugin",   // unique plugin ID (reverse-domain recommended)
+  // unique plugin ID — reverse-domain format recommended
+  "id": "com.example.my-plugin",
   "name": "My Plugin",
   "version": "1.0.0",
-  "minAppVersion": "2.0.0",
-  "icon": "assets/icon.svg",
+
+  // minimum Muscat version required to load this plugin
+  "minMuscatVersion": "1.0.0",
+
+  // plugin author (empty string is fine)
+  "author": "Your Name",
+
+  // displayed in the Muscat plugin store / info panel
+  // string or { en (required), ko, ja, zh, vi, th, es }
+  "description": { "en": "Plugin description", "ko": "플러그인 설명" },
+
+  // SVG string (single file) or PNG/JPG size map (all three sizes required)
+  "icons": "assets/icon.svg",
+  // "icons": { "16": "assets/icon-16.png", "48": "assets/icon-48.png", "128": "assets/icon-128.png" },
+
+  // targetModels and/or targetCategorys — at least one is required
+  // "all" = every target, or list specific values
+  "targetModels": "all",
+  // "targetModels": ["C500920", "C500930"],
+  "targetCategorys": "all",
+  // "targetCategorys": ["manipulate", "amr", "rby1", "vision"],
 
   "contributes": [
-    { "point": "program.panel", "label": "My Plugin", "icon": "assets/icon.svg" },
-    { "point": "lnb",           "label": "My Plugin", "icon": "assets/icon.svg" },
-    { "point": "header.toolbar","label": "My Plugin", "icon": "assets/icon.svg", "opens": "popover" }
+    // program.command — adds a step node to the program tree
+    {
+      "point": "program.command",
+      "icon": "assets/icon.svg",
+      "label": { "ko": "내 플러그인", "en": "My Plugin" },
+      "ui": "program/content",   // must be unique across all contributions
+      "commandInfo": {
+        "name": "My Plugin",
+        "icon": "assets/icon.svg",
+        "funcName": "plugin.run",
+        "args": {}
+      }
+    },
+    // toolbar — adds a button to the top toolbar (required)
+    {
+      "point": "toolbar",
+      "icon": "assets/icon.svg",
+      "label": { "ko": "내 플러그인", "en": "My Plugin" },
+      "ui": "content",           // must be unique across all contributions
+      "opens": "popover"
+    },
+    // move.rnb — adds a panel to the Move screen right-side area
+    {
+      "point": "move.rnb",
+      "icon": "assets/icon.svg",
+      "label": { "ko": "내 플러그인", "en": "My Plugin" },
+      "ui": "move/content"       // must be unique across all contributions
+    }
   ],
 
-  // "python" | "ros2"
+  // "none" | "python" | "ros2"
   "runtime": { "type": "python", "entry": "main.py" }
 }
 ```
 
 **Contribution points:**
 
-| point | Where it appears |
-|---|---|
-| `program.panel` | Program panel tab |
-| `lnb` | Left navigation bar |
-| `header.toolbar` | Header toolbar button |
+| point | Where it appears | `commandInfo` required |
+|---|---|:---:|
+| `toolbar` | Top toolbar button (must have at least one) | — |
+| `program.command` | Program tree step node | ✓ |
+| `move.rnb` | Move screen right-side panel | — |
+
+**`commandInfo` fields** (for `program.command`):
+
+| field | type | description |
+|---|---|---|
+| `name` | `string` | Display name of the step node |
+| `icon` | `string` | Icon path |
+| `iconClassName` | `string?` | Optional CSS class for the icon |
+| `funcName` | `string?` | Backend function name to call |
+| `args` | `Record<string, any>?` | Default arguments |
+| `disabled` | `boolean?` | Whether the node is disabled |
+| `allowChildren` | `string[]?` | Allowed child commands |
+| `allowParents` | `string[]?` | Allowed parent commands |
+| `notAllowChildren` | `string[]?` | Disallowed child commands |
+| `syncGroupId` | `boolean?` | Sync group ID across children |
+| `disableCopy` | `boolean?` | Prevent copy |
+| `disableDelete` | `boolean?` | Prevent delete |
+| `requireChildren` | `boolean?` | Whether a child command is required |
+| `requireParent` | `boolean?` | Whether a parent command is required |
+| `childrenCommand` | `string?` | Default command type for children |
+
+**Validation rules:**
+- `id`, `name`, `version`, `minMuscatVersion` — required non-empty strings
+- `author` — required non-empty string
+- `description` — required (`string` or `{ en (required), ko?, ja?, zh?, vi?, th?, es? }`)
+- `icons` — SVG: single string path ending in `.svg`; PNG/JPG: object with `"16"`, `"48"`, `"128"` all present
+- `targetModels` — `"all"` or a non-empty array of robot model ID strings (at least one of `targetModels` / `targetCategorys` required)
+- `targetCategorys` — `"all"` or a non-empty array of `"manipulate" | "amr" | "rby1" | "vision"` (at least one of `targetModels` / `targetCategorys` required)
+- `contributes` — required array; must contain at least one `toolbar` entry
+- `ui` — each contribution must have a unique value
+- `commandInfo` — required when `point` is `"program.command"`
+
+`muscat-pk build` throws on any validation error. `muscat-pk dev` prints warnings.
+
+---
+
+## Localized documentation
+
+You can ship per-language README files alongside the main `README.md`. Place them in the project root:
+
+```
+README.md        # default / English fallback
+README.ko.md     # Korean
+README.en.md     # explicit English (optional)
+README.ja.md     # Japanese
+```
+
+All `README*.md` files found at the project root are automatically copied to `dist/` on
+`muscat-pk build`. Muscat displays the file matching the user's locale,
+falling back to `README.md` if none matches.
 
 ---
 
@@ -211,14 +306,12 @@ numpy==1.26.4
 opencv-python
 ```
 
-Then just run `muscat-pk dev` or `muscat-pk dev:back` — dependencies are installed automatically on every startup:
+Run `muscat-pk dev` or `muscat-pk dev:back` — dependencies are installed automatically on every startup.
 
 - **Python plugin**: installed into `.venv` via `pip install -r requirements.txt`
 - **ROS2 plugin**: installed inside the Docker container via `pip install -r requirements.txt`
 
-No extra steps needed.
-
-> `muscat-pk build` / `muscat-pk pack` only **pins** versions in `requirements.txt` — it does not run `pip install`.
+> `muscat-pk build` only **pins** versions in `requirements.txt` — it does not run `pip install`.
 
 ---
 
@@ -237,11 +330,13 @@ muscat-pk type change --to python # ros2 → python
 ## Shipping
 
 ```bash
-muscat-pk pack
+muscat-pk build            # build + ZIP
+muscat-pk build --no-zip   # build only, no ZIP
 ```
 
-- Builds `src/content.tsx` → `dist/content.js`
+- Builds `ui/content.tsx` → `dist/content.js` (minified)
 - Pins `requirements.txt` to latest versions (stable-only on `main` branch)
+- Copies `assets/`, `manifest.json`, `README*.md`, `py/`, and `requirements.txt` into `dist/`
 - ROS2: runs `colcon build` inside the Jazzy container; includes `ros2_ws/install/`
 - Output: `__PLUGIN_DIR__-{version}.zip`
 
@@ -249,10 +344,15 @@ ZIP layout:
 
 ```
 __PLUGIN_DIR__-1.0.0.zip
-├─ dist/             # built UI
-├─ main.py
-├─ requirements.txt  # pinned
-└─ ros2_ws/install/  # ROS2 only
+├─ dist/
+│   ├─ content.js        # built UI
+│   ├─ manifest.json
+│   ├─ assets/
+│   ├─ README.md
+│   ├─ README.ko.md      # if present
+│   ├─ main.py           # from py/
+│   └─ requirements.txt  # pinned
+└─ ros2_ws/install/      # ROS2 only
 ```
 
 ---
@@ -263,8 +363,7 @@ __PLUGIN_DIR__-1.0.0.zip
 muscat-pk dev        # UI + backend
 muscat-pk dev:ui     # UI preview only (preview-host)
 muscat-pk dev:back   # backend only (Python: watchfiles / ROS2: Docker)
-muscat-pk build      # UI build only → dist/
-muscat-pk pack       # build + ZIP
+muscat-pk build      # build → dist/ + distributable ZIP (--no-zip to skip)
 ```
 
 ```bash

package/cli/templates/common/manifest.json

@@ -2,16 +2,40 @@
   "id": "__PLUGIN_ID__",
   "name": "__PLUGIN_NAME__",
   "version": "1.0.0",
-  "minAppVersion": "2.0.0",
-  "icon": "assets/icon.svg",
+  "minMuscatVersion": "1.0.0",
+  "author": "",
+  "description": {
+    "ko": "",
+    "en": ""
+  },
+  "icons": "assets/icon.svg",
+  "targetModels": "all",
+  "targetCategorys": "all",
   "contributes": [
-    { "point": "program.panel", "label": "__PLUGIN_NAME__", "icon": "assets/icon.svg" },
-    { "point": "lnb", "label": "__PLUGIN_NAME__", "icon": "assets/icon.svg" },
     {
-      "point": "header.toolbar",
-      "label": "__PLUGIN_NAME__",
+      "point": "program.command",
       "icon": "assets/icon.svg",
+      "label": { "ko": "__PLUGIN_NAME__", "en": "__PLUGIN_NAME__" },
+      "ui": "program/content",
+      "commandInfo": {
+        "name": "__PLUGIN_NAME__",
+        "icon": "assets/icon.svg",
+        "funcName": "plugin.run",
+        "args": {}
+      }
+    },
+    {
+      "point": "toolbar",
+      "icon": "assets/icon.svg",
+      "label": { "ko": "__PLUGIN_NAME__", "en": "__PLUGIN_NAME__" },
+      "ui": "content",
       "opens": "popover"
+    },
+    {
+      "point": "move.rnb",
+      "icon": "assets/icon.svg",
+      "label": { "ko": "__PLUGIN_NAME__", "en": "__PLUGIN_NAME__" },
+      "ui": "move/content"
     }
   ],
   "runtime": { "type": "__RUNTIME_TYPE__", "entry": "main.py" }

package/cli/templates/common/requirements.txt

@@ -1,4 +1,4 @@
-rainbow-rb-sdk==0.0.9.dev42
-rainbow-rb-flat-buffers==0.0.9.dev42
-rainbow-rb-zenoh==0.0.9.dev42
+rainbow-rb-sdk==0.0.9.dev43
+rainbow-rb-flat-buffers==0.0.9.dev43
+rainbow-rb-zenoh==0.0.9.dev43
 requests==2.34.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rainbow-robotics/muscat-plugin-kit",
-  "version": "0.1.2-dev.22",
+  "version": "0.1.2-dev.24",
   "type": "module",
   "engines": {
     "node": ">=20"
@@ -31,7 +31,7 @@
     "@types/react-dom": "^19.0.4"
   },
   "dependencies": {
-    "@rainbow-robotics/preview-host": "0.1.2-dev.22",
+    "@rainbow-robotics/preview-host": "0.1.2-dev.24",
     "socket.io": "^4.8.1"
   },
   "optionalDependencies": {

package/cli/src/pack.mjs

@@ -1,58 +0,0 @@
-// muscat-pk pack — build, then create a distributable ZIP with a size report.
-import { execSync } from "node:child_process";
-import { existsSync, readFileSync, readdirSync, rmSync, statSync } from "node:fs";
-import { basename, resolve } from "node:path";
-import { buildPlugin, exportRos2Build, pinRequirements } from "./build.mjs";
-import { findPluginRoot, humanSize, log } from "./util.mjs";
-
-function dirSize(dir) {
-  let total = 0;
-  for (const entry of readdirSync(dir)) {
-    const full = resolve(dir, entry);
-    const st = statSync(full);
-    total += st.isDirectory() ? dirSize(full) : st.size;
-  }
-  return total;
-}
-
-export async function runPack() {
-  const pluginRoot = findPluginRoot();
-  log.step("pinning requirements.txt to latest PyPI versions");
-  await pinRequirements(pluginRoot);
-  await buildPlugin({ root: pluginRoot, minify: true });
-  await exportRos2Build(pluginRoot);
-
-  const manifest = JSON.parse(
-    readFileSync(resolve(pluginRoot, "manifest.json"), "utf8"),
-  );
-  const zipName = `${basename(pluginRoot)}-${manifest.version || "0.0.0"}.zip`;
-  const zipPath = resolve(pluginRoot, zipName);
-  rmSync(zipPath, { force: true });
-
-  // dist/ already contains main.py, requirements.txt, manifest.json, assets/.
-  const entries = ["dist"];
-  if (existsSync(resolve(pluginRoot, "ros2_ws/install"))) {
-    entries.push("ros2_ws/install");
-  }
-
-  log.step(`packing ${entries.join(", ")} → ${zipName}`);
-  try {
-    execSync(`zip -r -q "${zipPath}" ${entries.map((e) => `"${e}"`).join(" ")}`, {
-      cwd: pluginRoot,
-      stdio: "inherit",
-    });
-  } catch {
-    throw new Error("`zip` not found. Install zip or pack manually.");
-  }
-
-  const zipBytes = statSync(zipPath).size;
-  log.ok(`${zipName}   ${humanSize(zipBytes)}`);
-  for (const e of entries) {
-    const full = resolve(pluginRoot, e);
-    const size = statSync(full).isDirectory() ? dirSize(full) : statSync(full).size;
-    log.info(`  ├─ ${e}   ${humanSize(size)}`);
-  }
-  log.warn(
-    "robot install checks free space via GET /plugin/capacity (507 if low).",
-  );
-}