bmad-opencode-converter 1.0.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,275 @@
+# BMAD to OpenCode Converter
+
+Convert [BMAD-METHOD](https://github.com/bmad-code-org/BMAD-METHOD) modules to [OpenCode](https://opencode.ai) plugins.
+
+## Installation
+
+```bash
+npx bmad-opencode-converter --source <bmad-dir> --output <output-dir>
+```
+
+Or install globally:
+
+```bash
+npm install -g bmad-opencode-converter
+bmad-convert --source <bmad-dir> --output <output-dir>
+```
+
+## Usage
+
+### Convert BMAD to OpenCode
+
+```bash
+# Convert from _bmad directory to current project
+npx bmad-opencode-converter --source ./_bmad --output ./ --verbose
+
+# Convert to a specific output directory
+npx bmad-opencode-converter -s ./_bmad -o ./my-opencode-project -v
+```
+
+### Options
+
+| Option | Short | Description |
+|--------|-------|-------------|
+| `--source` | `-s` | Path to BMAD `_bmad` directory |
+| `--output` | `-o` | Output directory for OpenCode files |
+| `--verbose` | `-v` | Show detailed conversion progress |
+| `--help` | `-h` | Show help message |
+
+## Conversion Mapping
+
+| BMAD Component | OpenCode Output |
+|----------------|-----------------|
+| Agent (persona, menu, rules) | `.opencode/agents/*.md` + `.opencode/skills/*/SKILL.md` |
+| Workflow (yaml + instructions) | `.opencode/skills/*/SKILL.md` |
+| Task (standalone instructions) | `.opencode/skills/*/SKILL.md` |
+
+## Output Structure
+
+After conversion, your project will have:
+
+```
+your-project/
+├── .opencode/
+│   ├── agents/           # OpenCode agent definitions
+│   │   ├── bmm-dev.md
+│   │   ├── bmm-pm.md
+│   │   ├── cis-storyteller.md
+│   │   └── ...
+│   └── skills/           # OpenCode skill definitions
+│       ├── bmad-bmm-dev-story/
+│       │   └── SKILL.md
+│       ├── bmad-bmm-create-prd/
+│       │   └── SKILL.md
+│       ├── bmad-cis-storytelling/
+│       │   └── SKILL.md
+│       └── ...
+└── ...
+```
+
+---
+
+## After Conversion: Using OpenCode Plugins
+
+### 1. Verify Generated Files
+
+Check that the conversion created the expected files:
+
+```bash
+ls .opencode/agents/     # Should list agent .md files
+ls .opencode/skills/     # Should list skill directories
+```
+
+### 2. Using Converted Agents
+
+Converted BMAD agents are available as OpenCode subagents. You can:
+
+**Switch to an agent** using Tab or your configured `switch_agent` keybind.
+
+**Invoke via @ mention** in your message:
+```
+@bmm-dev implement the user authentication feature
+@cis-storyteller help me craft a product narrative
+@bmm-architect review the system design
+```
+
+**Available agents include:**
+- `bmm-dev` - Developer Agent (Amelia)
+- `bmm-pm` - Product Manager (John)
+- `bmm-architect` - System Architect (Winston)
+- `bmm-analyst` - Business Analyst (Mary)
+- `bmm-qa` - QA Engineer (Quinn)
+- `cis-storyteller` - Master Storyteller (Sophia)
+- `tea-tea` - Test Architect (Murat)
+- And more...
+
+### 3. Using Converted Skills
+
+Skills are loaded on-demand. OpenCode agents can invoke them automatically, or you can request them explicitly:
+
+```
+Load the bmad-bmm-create-prd skill and help me create a PRD
+```
+
+**Workflow skills include:**
+- `bmad-bmm-create-prd` - Create Product Requirements Document
+- `bmad-bmm-create-architecture` - Design system architecture
+- `bmad-bmm-dev-story` - Implement user stories
+- `bmad-bmm-code-review` - Adversarial code review
+- `bmad-cis-storytelling` - Craft compelling narratives
+- `bmad-tea-testarch-automate` - Generate test automation
+
+### 4. Configuring Permissions
+
+Edit `opencode.json` to control agent/skill access:
+
+```json
+{
+  "$schema": "https://opencode.ai/config.json",
+  "permission": {
+    "skill": {
+      "*": "allow",
+      "bmad-*": "allow"
+    }
+  },
+  "agent": {
+    "bmm-dev": {
+      "permission": {
+        "bash": "allow",
+        "edit": "allow"
+      }
+    }
+  }
+}
+```
+
+### 5. Customizing Converted Agents
+
+Edit the generated agent files to customize behavior:
+
+```markdown
+---
+description: "Developer Agent"
+mode: subagent
+model: anthropic/claude-sonnet-4-20250514  # Add custom model
+temperature: 0.2                            # Adjust temperature
+tools:
+  write: true
+  edit: true
+  bash: true
+---
+
+Your customized prompt here...
+```
+
+### 6. Adding to npm Package (Optional)
+
+To distribute as an npm package, add to your `opencode.json`:
+
+```json
+{
+  "plugin": ["your-bmad-opencode-plugin"]
+}
+```
+
+---
+
+## Example: Full Workflow
+
+```bash
+# 1. Install BMAD to your project
+npx bmad-method install
+
+# 2. Convert to OpenCode format
+npx bmad-opencode-converter --source ./_bmad --output ./ --verbose
+
+# 3. Start OpenCode
+opencode
+
+# 4. Use converted agents
+# Type: @bmm-pm help me define the product requirements
+```
+
+---
+
+## Conversion Details
+
+### Agent Conversion
+
+Each BMAD agent produces:
+
+1. **OpenCode Agent** (`.opencode/agents/{module}-{name}.md`)
+   - Persona as system prompt
+   - Mode set to `subagent`
+   - Full tool access enabled
+
+2. **OpenCode Skill** (`.opencode/skills/bmad-{module}-{name}/SKILL.md`)
+   - Activation steps preserved
+   - Menu commands documented
+   - Workflow references included
+
+### Workflow Conversion
+
+Each BMAD workflow produces a skill with:
+- Step-by-step instructions
+- Questions to ask at each step
+- Output template (if defined)
+- Supporting data file references
+
+### Task Conversion
+
+Each BMAD task produces a skill with:
+- Task instructions (cleaned from XML)
+- Standalone execution guidance
+
+---
+
+## Troubleshooting
+
+### "No manifest files found"
+
+Ensure you're pointing to the correct `_bmad` directory:
+```bash
+# Check manifest exists
+ls ./_bmad/_config/agent-manifest.csv
+
+# Run with correct path
+npx bmad-opencode-converter --source ./_bmad --output ./
+```
+
+### Agent names look wrong
+
+Agent IDs are extracted from BMAD paths. Some duplication (e.g., `storyteller-storyteller`) comes from nested directory structures in BMAD.
+
+### Skills not loading
+
+1. Check skill name follows pattern: lowercase alphanumeric with single hyphens
+2. Verify `SKILL.md` exists in the skill folder
+3. Check permissions in `opencode.json`
+
+---
+
+## Development
+
+```bash
+# Clone and install
+git clone <repo-url>
+cd bmad-opencode-converter
+npm install
+
+# Run tests with sample data
+npm test
+
+# Build for distribution
+npm run build
+
+# Run locally without build
+npm run dev -- --source ./_bmad --output ./output --verbose
+
+# Clean output
+npm run clean
+```
+
+## License
+
+MIT

package/dist/cli.d.ts

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+export {};
+//# sourceMappingURL=cli.d.ts.map

package/dist/cli.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":""}

package/dist/cli.js

@@ -0,0 +1,73 @@
+#!/usr/bin/env node
+import { convert } from './converter.js';
+function parseArgs(args) {
+    let source = '';
+    let output = '';
+    let verbose = false;
+    for (let i = 0; i < args.length; i++) {
+        const arg = args[i];
+        if (arg === '--source' || arg === '-s') {
+            source = args[++i] || '';
+        }
+        else if (arg === '--output' || arg === '-o') {
+            output = args[++i] || '';
+        }
+        else if (arg === '--verbose' || arg === '-v') {
+            verbose = true;
+        }
+        else if (arg === '--help' || arg === '-h') {
+            printHelp();
+            process.exit(0);
+        }
+    }
+    return { source, output, verbose };
+}
+function printHelp() {
+    console.log(`
+BMAD to OpenCode Converter
+
+Usage: bmad-convert --source <dir> --output <dir> [options]
+
+Options:
+  -s, --source <dir>   Path to BMAD _bmad directory
+  -o, --output <dir>   Output directory for OpenCode files
+  -v, --verbose        Enable verbose output
+  -h, --help           Show this help message
+
+Examples:
+  bmad-convert --source ./_bmad --output ./
+  bmad-convert -s tests/sources/_bmad -o tests/output -v
+`);
+}
+async function main() {
+    const args = process.argv.slice(2);
+    const { source, output, verbose } = parseArgs(args);
+    if (!source || !output) {
+        console.error('Error: Both --source and --output are required');
+        printHelp();
+        process.exit(1);
+    }
+    try {
+        const result = await convert({
+            sourceDir: source,
+            outputDir: output,
+            verbose,
+        });
+        if (result.errors.length > 0) {
+            console.error('\nErrors:');
+            for (const error of result.errors) {
+                console.error(`  - ${error}`);
+            }
+            process.exit(1);
+        }
+        if (!verbose) {
+            console.log(`Converted ${result.agents.length} agents and ${result.skills.length} skills to ${output}`);
+        }
+    }
+    catch (err) {
+        console.error('Conversion failed:', err);
+        process.exit(1);
+    }
+}
+main();
+//# sourceMappingURL=cli.js.map

package/dist/cli.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.js","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":";AAEA,OAAO,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAC;AAEzC,SAAS,SAAS,CAAC,IAAc;IAC/B,IAAI,MAAM,GAAG,EAAE,CAAC;IAChB,IAAI,MAAM,GAAG,EAAE,CAAC;IAChB,IAAI,OAAO,GAAG,KAAK,CAAC;IAEpB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACrC,MAAM,GAAG,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;QACpB,IAAI,GAAG,KAAK,UAAU,IAAI,GAAG,KAAK,IAAI,EAAE,CAAC;YACvC,MAAM,GAAG,IAAI,CAAC,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;QAC3B,CAAC;aAAM,IAAI,GAAG,KAAK,UAAU,IAAI,GAAG,KAAK,IAAI,EAAE,CAAC;YAC9C,MAAM,GAAG,IAAI,CAAC,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;QAC3B,CAAC;aAAM,IAAI,GAAG,KAAK,WAAW,IAAI,GAAG,KAAK,IAAI,EAAE,CAAC;YAC/C,OAAO,GAAG,IAAI,CAAC;QACjB,CAAC;aAAM,IAAI,GAAG,KAAK,QAAQ,IAAI,GAAG,KAAK,IAAI,EAAE,CAAC;YAC5C,SAAS,EAAE,CAAC;YACZ,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAClB,CAAC;IACH,CAAC;IAED,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC;AACrC,CAAC;AAED,SAAS,SAAS;IAChB,OAAO,CAAC,GAAG,CAAC;;;;;;;;;;;;;;CAcb,CAAC,CAAC;AACH,CAAC;AAED,KAAK,UAAU,IAAI;IACjB,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IACnC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC;IAEpD,IAAI,CAAC,MAAM,IAAI,CAAC,MAAM,EAAE,CAAC;QACvB,OAAO,CAAC,KAAK,CAAC,gDAAgD,CAAC,CAAC;QAChE,SAAS,EAAE,CAAC;QACZ,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;IAED,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC;YAC3B,SAAS,EAAE,MAAM;YACjB,SAAS,EAAE,MAAM;YACjB,OAAO;SACR,CAAC,CAAC;QAEH,IAAI,MAAM,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC7B,OAAO,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;YAC3B,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC;gBAClC,OAAO,CAAC,KAAK,CAAC,OAAO,KAAK,EAAE,CAAC,CAAC;YAChC,CAAC;YACD,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAClB,CAAC;QAED,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,OAAO,CAAC,GAAG,CAAC,aAAa,MAAM,CAAC,MAAM,CAAC,MAAM,eAAe,MAAM,CAAC,MAAM,CAAC,MAAM,cAAc,MAAM,EAAE,CAAC,CAAC;QAC1G,CAAC;IACH,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,OAAO,CAAC,KAAK,CAAC,oBAAoB,EAAE,GAAG,CAAC,CAAC;QACzC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;AACH,CAAC;AAED,IAAI,EAAE,CAAC"}

package/dist/converter.d.ts

@@ -0,0 +1,8 @@
+import type { OpenCodeConversionResult } from './types/index.js';
+export interface ConversionOptions {
+    sourceDir: string;
+    outputDir: string;
+    verbose?: boolean;
+}
+export declare function convert(options: ConversionOptions): Promise<OpenCodeConversionResult>;
+//# sourceMappingURL=converter.d.ts.map

package/dist/converter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"converter.d.ts","sourceRoot":"","sources":["../src/converter.ts"],"names":[],"mappings":"AAUA,OAAO,KAAK,EAAE,wBAAwB,EAAgC,MAAM,kBAAkB,CAAC;AAQ/F,MAAM,WAAW,iBAAiB;IAChC,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAqKD,wBAAsB,OAAO,CAAC,OAAO,EAAE,iBAAiB,GAAG,OAAO,CAAC,wBAAwB,CAAC,CA+E3F"}