ma-agents 3.5.0 → 3.5.2

package/lib/bmad-cache/bmb/samples/sample-module-setup/scripts/merge-help-csv.py

@@ -0,0 +1,218 @@
+#!/usr/bin/env python3
+# /// script
+# requires-python = ">=3.9"
+# dependencies = []
+# ///
+"""Merge module help entries into shared _bmad/module-help.csv.
+
+Reads a source CSV with module help entries and merges them into a target CSV.
+Uses an anti-zombie pattern: all existing rows matching the source module code
+are removed before appending fresh rows.
+
+Legacy cleanup: when --legacy-dir and --module-code are provided, deletes old
+per-module module-help.csv files from {legacy-dir}/{module-code}/ and
+{legacy-dir}/core/. Only the current module and core are touched.
+
+Exit codes: 0=success, 1=validation error, 2=runtime error
+"""
+
+import argparse
+import csv
+import json
+import sys
+from io import StringIO
+from pathlib import Path
+
+# CSV header for module-help.csv
+HEADER = [
+    "module",
+    "skill",
+    "display-name",
+    "menu-code",
+    "description",
+    "action",
+    "args",
+    "phase",
+    "after",
+    "before",
+    "required",
+    "output-location",
+    "outputs",
+]
+
+
+def parse_args():
+    parser = argparse.ArgumentParser(
+        description="Merge module help entries into shared _bmad/module-help.csv with anti-zombie pattern."
+    )
+    parser.add_argument(
+        "--target",
+        required=True,
+        help="Path to the target _bmad/module-help.csv file",
+    )
+    parser.add_argument(
+        "--source",
+        required=True,
+        help="Path to the source module-help.csv with entries to merge",
+    )
+    parser.add_argument(
+        "--legacy-dir",
+        help="Path to _bmad/ directory to check for legacy per-module CSV files.",
+    )
+    parser.add_argument(
+        "--module-code",
+        help="Module code (required with --legacy-dir for scoping cleanup).",
+    )
+    parser.add_argument(
+        "--verbose",
+        action="store_true",
+        help="Print detailed progress to stderr",
+    )
+    return parser.parse_args()
+
+
+def read_csv_rows(path: str) -> tuple[list[str], list[list[str]]]:
+    """Read CSV file returning (header, data_rows).
+
+    Returns empty header and rows if file doesn't exist.
+    """
+    file_path = Path(path)
+    if not file_path.exists():
+        return [], []
+
+    with open(file_path, "r", encoding="utf-8", newline="") as f:
+        content = f.read()
+
+    reader = csv.reader(StringIO(content))
+    rows = list(reader)
+
+    if not rows:
+        return [], []
+
+    return rows[0], rows[1:]
+
+
+def extract_module_codes(rows: list[list[str]]) -> set[str]:
+    """Extract unique module codes from data rows."""
+    codes = set()
+    for row in rows:
+        if row and row[0].strip():
+            codes.add(row[0].strip())
+    return codes
+
+
+def filter_rows(rows: list[list[str]], module_code: str) -> list[list[str]]:
+    """Remove all rows matching the given module code."""
+    return [row for row in rows if not row or row[0].strip() != module_code]
+
+
+def write_csv(path: str, header: list[str], rows: list[list[str]], verbose: bool = False) -> None:
+    """Write header + rows to CSV file, creating parent dirs as needed."""
+    file_path = Path(path)
+    file_path.parent.mkdir(parents=True, exist_ok=True)
+
+    if verbose:
+        print(f"Writing {len(rows)} data rows to {path}", file=sys.stderr)
+
+    with open(file_path, "w", encoding="utf-8", newline="") as f:
+        writer = csv.writer(f)
+        writer.writerow(header)
+        for row in rows:
+            writer.writerow(row)
+
+
+def cleanup_legacy_csvs(
+    legacy_dir: str, module_code: str, verbose: bool = False
+) -> list:
+    """Delete legacy per-module module-help.csv files for this module and core only.
+
+    Returns list of deleted file paths.
+    """
+    deleted = []
+    for subdir in (module_code, "core"):
+        legacy_path = Path(legacy_dir) / subdir / "module-help.csv"
+        if legacy_path.exists():
+            if verbose:
+                print(f"Deleting legacy CSV: {legacy_path}", file=sys.stderr)
+            legacy_path.unlink()
+            deleted.append(str(legacy_path))
+    return deleted
+
+
+def main():
+    args = parse_args()
+
+    # Read source entries
+    source_header, source_rows = read_csv_rows(args.source)
+    if not source_rows:
+        print(f"Error: No data rows found in source {args.source}", file=sys.stderr)
+        sys.exit(1)
+
+    # Determine module codes being merged
+    source_codes = extract_module_codes(source_rows)
+    if not source_codes:
+        print("Error: Could not determine module code from source rows", file=sys.stderr)
+        sys.exit(1)
+
+    if args.verbose:
+        print(f"Source module codes: {source_codes}", file=sys.stderr)
+        print(f"Source rows: {len(source_rows)}", file=sys.stderr)
+
+    # Read existing target (may not exist)
+    target_header, target_rows = read_csv_rows(args.target)
+    target_existed = Path(args.target).exists()
+
+    if args.verbose:
+        print(f"Target exists: {target_existed}", file=sys.stderr)
+        if target_existed:
+            print(f"Existing target rows: {len(target_rows)}", file=sys.stderr)
+
+    # Use source header if target doesn't exist or has no header
+    header = target_header if target_header else (source_header if source_header else HEADER)
+
+    # Anti-zombie: remove all rows for each source module code
+    filtered_rows = target_rows
+    removed_count = 0
+    for code in source_codes:
+        before_count = len(filtered_rows)
+        filtered_rows = filter_rows(filtered_rows, code)
+        removed_count += before_count - len(filtered_rows)
+
+    if args.verbose and removed_count > 0:
+        print(f"Removed {removed_count} existing rows (anti-zombie)", file=sys.stderr)
+
+    # Append source rows
+    merged_rows = filtered_rows + source_rows
+
+    # Write result
+    write_csv(args.target, header, merged_rows, args.verbose)
+
+    # Legacy cleanup: delete old per-module CSV files
+    legacy_deleted = []
+    if args.legacy_dir:
+        if not args.module_code:
+            print(
+                "Error: --module-code is required when --legacy-dir is provided",
+                file=sys.stderr,
+            )
+            sys.exit(1)
+        legacy_deleted = cleanup_legacy_csvs(
+            args.legacy_dir, args.module_code, args.verbose
+        )
+
+    # Output result summary as JSON
+    result = {
+        "status": "success",
+        "target_path": str(Path(args.target).resolve()),
+        "target_existed": target_existed,
+        "module_codes": sorted(source_codes),
+        "rows_removed": removed_count,
+        "rows_added": len(source_rows),
+        "total_rows": len(merged_rows),
+        "legacy_csvs_deleted": legacy_deleted,
+    }
+    print(json.dumps(result, indent=2))
+
+
+if __name__ == "__main__":
+    main()

package/lib/bmad-cache/bmb/skills/bmad-agent-builder/assets/init-sanctum-template.py

@@ -0,0 +1,277 @@
+#!/usr/bin/env python3
+"""
+First Breath — Deterministic sanctum scaffolding.
+
+This script runs BEFORE the conversational awakening. It creates the sanctum
+folder structure, copies template files with config values substituted,
+copies all capability files and their supporting references into the sanctum,
+and auto-generates CAPABILITIES.md from capability prompt frontmatter.
+
+After this script runs, the sanctum is fully self-contained — the agent does
+not depend on the skill bundle location for normal operation.
+
+Usage:
+    python3 init-sanctum.py <project-root> <skill-path>
+
+    project-root: The root of the project (where _bmad/ lives)
+    skill-path:   Path to the skill directory (where SKILL.md, references/, assets/ live)
+"""
+
+import sys
+import re
+import shutil
+from datetime import date
+from pathlib import Path
+
+# --- Agent-specific configuration (set by builder) ---
+
+SKILL_NAME = "{skillName}"
+SANCTUM_DIR = SKILL_NAME
+
+# Files that stay in the skill bundle (only used during First Breath)
+SKILL_ONLY_FILES = {"{skill-only-files}"}
+
+TEMPLATE_FILES = [
+    {template-files-list}
+]
+
+# Whether the owner can teach this agent new capabilities
+EVOLVABLE = {evolvable}
+
+# --- End agent-specific configuration ---
+
+
+def parse_yaml_config(config_path: Path) -> dict:
+    """Simple YAML key-value parser. Handles top-level scalar values only."""
+    config = {}
+    if not config_path.exists():
+        return config
+    with open(config_path) as f:
+        for line in f:
+            line = line.strip()
+            if not line or line.startswith("#"):
+                continue
+            if ":" in line:
+                key, _, value = line.partition(":")
+                value = value.strip().strip("'\"")
+                if value:
+                    config[key.strip()] = value
+    return config
+
+
+def parse_frontmatter(file_path: Path) -> dict:
+    """Extract YAML frontmatter from a markdown file."""
+    meta = {}
+    with open(file_path) as f:
+        content = f.read()
+
+    match = re.match(r"^---\s*\n(.*?)\n---", content, re.DOTALL)
+    if not match:
+        return meta
+
+    for line in match.group(1).strip().split("\n"):
+        if ":" in line:
+            key, _, value = line.partition(":")
+            meta[key.strip()] = value.strip().strip("'\"")
+    return meta
+
+
+def copy_references(source_dir: Path, dest_dir: Path) -> list[str]:
+    """Copy all reference files (except skill-only files) into the sanctum."""
+    dest_dir.mkdir(parents=True, exist_ok=True)
+    copied = []
+
+    for source_file in sorted(source_dir.iterdir()):
+        if source_file.name in SKILL_ONLY_FILES:
+            continue
+        if source_file.is_file():
+            shutil.copy2(source_file, dest_dir / source_file.name)
+            copied.append(source_file.name)
+
+    return copied
+
+
+def copy_scripts(source_dir: Path, dest_dir: Path) -> list[str]:
+    """Copy any scripts the capabilities might use into the sanctum."""
+    if not source_dir.exists():
+        return []
+    dest_dir.mkdir(parents=True, exist_ok=True)
+    copied = []
+
+    for source_file in sorted(source_dir.iterdir()):
+        if source_file.is_file() and source_file.name != "init-sanctum.py":
+            shutil.copy2(source_file, dest_dir / source_file.name)
+            copied.append(source_file.name)
+
+    return copied
+
+
+def discover_capabilities(references_dir: Path, sanctum_refs_path: str) -> list[dict]:
+    """Scan references/ for capability prompt files with frontmatter."""
+    capabilities = []
+
+    for md_file in sorted(references_dir.glob("*.md")):
+        if md_file.name in SKILL_ONLY_FILES:
+            continue
+        meta = parse_frontmatter(md_file)
+        if meta.get("name") and meta.get("code"):
+            capabilities.append({
+                "name": meta["name"],
+                "description": meta.get("description", ""),
+                "code": meta["code"],
+                "source": f"{sanctum_refs_path}/{md_file.name}",
+            })
+    return capabilities
+
+
+def generate_capabilities_md(capabilities: list[dict], evolvable: bool) -> str:
+    """Generate CAPABILITIES.md content from discovered capabilities."""
+    lines = [
+        "# Capabilities",
+        "",
+        "## Built-in",
+        "",
+        "| Code | Name | Description | Source |",
+        "|------|------|-------------|--------|",
+    ]
+    for cap in capabilities:
+        lines.append(
+            f"| [{cap['code']}] | {cap['name']} | {cap['description']} | `{cap['source']}` |"
+        )
+
+    if evolvable:
+        lines.extend([
+            "",
+            "## Learned",
+            "",
+            "_Capabilities added by the owner over time. Prompts live in `capabilities/`._",
+            "",
+            "| Code | Name | Description | Source | Added |",
+            "|------|------|-------------|--------|-------|",
+            "",
+            "## How to Add a Capability",
+            "",
+            'Tell me "I want you to be able to do X" and we\'ll create it together.',
+            "I'll write the prompt, save it to `capabilities/`, and register it here.",
+            "Next session, I'll know how.",
+            "Load `./references/capability-authoring.md` for the full creation framework.",
+        ])
+
+    lines.extend([
+        "",
+        "## Tools",
+        "",
+        "Prefer crafting your own tools over depending on external ones. A script you wrote "
+        "and saved is more reliable than an external API. Use the file system creatively.",
+        "",
+        "### User-Provided Tools",
+        "",
+        "_MCP servers, APIs, or services the owner has made available. Document them here._",
+    ])
+
+    return "\n".join(lines) + "\n"
+
+
+def substitute_vars(content: str, variables: dict) -> str:
+    """Replace {var_name} placeholders with values from the variables dict."""
+    for key, value in variables.items():
+        content = content.replace(f"{{{key}}}", value)
+    return content
+
+
+def main():
+    if len(sys.argv) < 3:
+        print("Usage: python3 init-sanctum.py <project-root> <skill-path>")
+        sys.exit(1)
+
+    project_root = Path(sys.argv[1]).resolve()
+    skill_path = Path(sys.argv[2]).resolve()
+
+    # Paths
+    bmad_dir = project_root / "_bmad"
+    memory_dir = bmad_dir / "memory"
+    sanctum_path = memory_dir / SANCTUM_DIR
+    assets_dir = skill_path / "assets"
+    references_dir = skill_path / "references"
+    scripts_dir = skill_path / "scripts"
+
+    # Sanctum subdirectories
+    sanctum_refs = sanctum_path / "references"
+    sanctum_scripts = sanctum_path / "scripts"
+
+    # Fully qualified path for CAPABILITIES.md references
+    sanctum_refs_path = "./references"
+
+    # Check if sanctum already exists
+    if sanctum_path.exists():
+        print(f"Sanctum already exists at {sanctum_path}")
+        print("This agent has already been born. Skipping First Breath scaffolding.")
+        sys.exit(0)
+
+    # Load config
+    config = {}
+    for config_file in ["config.yaml", "config.user.yaml"]:
+        config.update(parse_yaml_config(bmad_dir / config_file))
+
+    # Build variable substitution map
+    today = date.today().isoformat()
+    variables = {
+        "user_name": config.get("user_name", "friend"),
+        "communication_language": config.get("communication_language", "English"),
+        "birth_date": today,
+        "project_root": str(project_root),
+        "sanctum_path": str(sanctum_path),
+    }
+
+    # Create sanctum structure
+    sanctum_path.mkdir(parents=True, exist_ok=True)
+    (sanctum_path / "capabilities").mkdir(exist_ok=True)
+    (sanctum_path / "sessions").mkdir(exist_ok=True)
+    print(f"Created sanctum at {sanctum_path}")
+
+    # Copy reference files (capabilities + techniques + guidance) into sanctum
+    copied_refs = copy_references(references_dir, sanctum_refs)
+    print(f"  Copied {len(copied_refs)} reference files to sanctum/references/")
+    for name in copied_refs:
+        print(f"    - {name}")
+
+    # Copy any supporting scripts into sanctum
+    copied_scripts = copy_scripts(scripts_dir, sanctum_scripts)
+    if copied_scripts:
+        print(f"  Copied {len(copied_scripts)} scripts to sanctum/scripts/")
+        for name in copied_scripts:
+            print(f"    - {name}")
+
+    # Copy and substitute template files
+    for template_name in TEMPLATE_FILES:
+        template_path = assets_dir / template_name
+        if not template_path.exists():
+            print(f"  Warning: template {template_name} not found, skipping")
+            continue
+
+        # Remove "-template" from the output filename and uppercase it
+        output_name = template_name.replace("-template", "").upper()
+        # Fix extension casing: .MD -> .md
+        output_name = output_name[:-3] + ".md"
+
+        content = template_path.read_text()
+        content = substitute_vars(content, variables)
+
+        output_path = sanctum_path / output_name
+        output_path.write_text(content)
+        print(f"  Created {output_name}")
+
+    # Auto-generate CAPABILITIES.md from references/ frontmatter
+    capabilities = discover_capabilities(references_dir, sanctum_refs_path)
+    capabilities_content = generate_capabilities_md(capabilities, evolvable=EVOLVABLE)
+    (sanctum_path / "CAPABILITIES.md").write_text(capabilities_content)
+    print(f"  Created CAPABILITIES.md ({len(capabilities)} built-in capabilities discovered)")
+
+    print()
+    print("First Breath scaffolding complete.")
+    print("The conversational awakening can now begin.")
+    print(f"Sanctum: {sanctum_path}")
+
+
+if __name__ == "__main__":
+    main()