bmad-elsabro 1.0.0

package/docs/user-guide/workflows.md

@@ -0,0 +1,546 @@
+---
+title: "Working with Workflows"
+description: Master visual workflow editing, execution, and Party Mode in BMAD Studio
+---
+
+Use BMAD Studio's Visual Workflow Editor to create, modify, and execute AI-powered workflows with drag-and-drop simplicity and real-time visualization.
+
+## What You'll Learn
+
+- Navigate the Visual Workflow Editor interface
+- Create workflows using drag-and-drop step composition
+- Execute workflows with real-time progress tracking
+- Use Party Mode for multi-agent coordination
+- Debug workflows with integrated tools
+- Import and export workflow definitions
+
+:::note[Prerequisites]
+- BMAD Studio installed and configured
+- At least one project initialized
+- Basic understanding of BMAD workflows and agents
+:::
+
+:::tip[Quick Path]
+**Open Workflows** → Select or create workflow
+**Drag Steps** → Add steps from palette to canvas
+**Connect** → Link steps to define execution order
+**Configure** → Set step parameters and conditions
+**Execute** → Run workflow with real-time tracking
+:::
+
+## Understanding Workflows in BMAD Studio
+
+Workflows in BMAD Studio combine the power of the CLI tool with visual editing capabilities:
+
+| Component | What It Does |
+| --------- | ------------ |
+| **Workflow Canvas** | Visual graph showing step sequence and dependencies |
+| **Step Palette** | Library of 102+ available steps organized by category |
+| **Properties Panel** | Configure selected step parameters and conditions |
+| **Execution Panel** | Real-time progress, logs, and token usage during runs |
+| **Validation Engine** | Real-time checking for errors and missing configurations |
+
+### Workflow Types
+
+| Type | Purpose | Key Features |
+| ---- | ------- | ------------ |
+| **Analysis** | Brainstorming, research, product briefs | Analyst agent, ideation steps, research tools |
+| **Planning** | PRD, architecture, epics, stories | PM and Architect agents, document generation |
+| **Implementation** | Story execution, code review, testing | DEV agent, code generation, validation |
+| **Testing** | Test design, automation, NFR assessment | Test agents, fixture generation, coverage analysis |
+
+## The Visual Workflow Editor
+
+### Opening the Editor
+
+1. Navigate to **Workflows** in the sidebar
+2. Choose an action:
+   - **Create Workflow** — Start from scratch
+   - **Open Existing** — Edit predefined workflows (28+ included)
+   - **Import** — Load workflow from YAML/JSON file
+   - **Clone** — Duplicate and modify existing workflow
+
+### Editor Layout
+
+| Area | Location | Purpose |
+| ---- | -------- | ------- |
+| **Toolbar** | Top | Save, run, validate, export, settings |
+| **Step Palette** | Left panel | Drag steps to canvas, organized by phase |
+| **Canvas** | Center | Visual workflow graph with steps and connections |
+| **Properties Panel** | Right panel | Configure selected step or workflow settings |
+| **Execution Panel** | Bottom (when running) | Progress, logs, token usage, errors |
+
+### Keyboard Shortcuts
+
+| Shortcut | Action |
+| -------- | ------ |
+| `Ctrl+S` / `Cmd+S` | Save workflow |
+| `Ctrl+R` / `Cmd+R` | Run workflow |
+| `Ctrl+V` / `Cmd+V` | Validate workflow |
+| `Del` / `Backspace` | Delete selected step |
+| `Ctrl+Z` / `Cmd+Z` | Undo last action |
+| `Ctrl+Y` / `Cmd+Y` | Redo action |
+| `Ctrl+F` / `Cmd+F` | Search steps in palette |
+
+## Creating Workflows
+
+### Step 1: Initialize New Workflow
+
+1. Click **Create Workflow** in the Workflows view
+2. Enter workflow details:
+   - **Name** — Descriptive workflow name (e.g., "custom-feature-development")
+   - **Description** — What the workflow accomplishes
+   - **Phase** — Analysis, Planning, Implementation, or Testing
+   - **Default Agent** — Primary agent for this workflow (can be changed)
+
+### Step 2: Add Steps to Canvas
+
+**From the Step Palette:**
+
+1. Browse or search the step library (102+ steps)
+2. Drag a step to the canvas
+3. Drop it in the desired position
+4. The step appears as a node on the graph
+
+**Step Categories:**
+
+- **Analysis** — Brainstorming, research, discovery steps
+- **Planning** — Requirements, architecture, design steps
+- **Implementation** — Coding, review, integration steps
+- **Testing** — Test design, automation, validation steps
+- **Utilities** — File operations, formatting, validation steps
+
+:::tip[Search Steps]
+Press `Ctrl+F` (or `Cmd+F`) in the workflow editor to quickly search for steps by name or keyword.
+:::
+
+### Step 3: Connect Steps
+
+**Define Execution Order:**
+
+1. Click the **output port** (right side) of the first step
+2. Drag to the **input port** (left side) of the next step
+3. Release to create a connection
+4. Arrows show execution flow
+
+**Connection Types:**
+
+- **Sequential** — Solid line: Always execute next step
+- **Conditional** — Dashed line: Execute if condition met
+- **Parallel** — Multiple outputs: Execute steps simultaneously
+
+### Step 4: Configure Step Properties
+
+**Select a step to view properties panel:**
+
+| Property | Description |
+| -------- | ----------- |
+| **Name** | Step identifier (must be unique in workflow) |
+| **Description** | What this step does |
+| **Agent** | Which agent executes this step (default or custom) |
+| **Inputs** | Required input parameters and files |
+| **Outputs** | Files and data produced by this step |
+| **Conditions** | When to execute (always, on success, on failure, custom) |
+| **Timeout** | Maximum execution time before cancellation |
+
+**Parameter Types:**
+
+- **Text** — Free-form string input
+- **File Path** — Select file from project
+- **Options** — Select from predefined choices
+- **Boolean** — True/false toggle
+- **JSON** — Structured data input with validation
+
+### Step 5: Validate Workflow
+
+Click **Validate** button (or press `Ctrl+V` / `Cmd+V`):
+
+**Validation Checks:**
+
+- All required parameters provided
+- Step names are unique
+- No circular dependencies
+- All steps have valid connections
+- Agent configurations exist
+- Input files referenced are available
+
+**Validation Results:**
+
+- ✓ **Valid** — Green checkmark, ready to execute
+- ⚠️ **Warnings** — Yellow triangle, can execute but check issues
+- ✗ **Errors** — Red X, must fix before execution
+
+:::caution[Fix Errors Before Running]
+Workflows with validation errors cannot be executed. Address all red X errors shown in the validation panel.
+:::
+
+### Step 6: Save Workflow
+
+1. Click **Save** button (or press `Ctrl+S` / `Cmd+S`)
+2. Workflow saved to `.bmad/workflows/` in YAML format
+3. Workflow now appears in your workflows list
+4. Can be executed from editor or workflows list
+
+## Executing Workflows
+
+### Starting Execution
+
+**From the Editor:**
+
+1. Open workflow in Visual Workflow Editor
+2. Click **Run** button (or press `Ctrl+R` / `Cmd+R`)
+3. Execution Panel appears at bottom
+4. Steps execute in defined order
+
+**From the Workflows List:**
+
+1. Navigate to Workflows in sidebar
+2. Find workflow in list
+3. Click **Run** icon (▶️) next to workflow name
+4. Execution begins in background
+
+### Execution Panel
+
+**During execution, the panel shows:**
+
+| Section | Information |
+| ------- | ----------- |
+| **Progress Bar** | Overall workflow completion percentage |
+| **Current Step** | Which step is currently executing |
+| **Step Status** | Pending, running, completed, or failed for each step |
+| **Logs** | Real-time output from executing steps |
+| **Token Usage** | Running total of tokens consumed |
+| **Elapsed Time** | How long the workflow has been running |
+
+**Step Status Indicators:**
+
+- ⏳ **Pending** — Gray: Waiting to execute
+- ▶️ **Running** — Blue: Currently executing
+- ✓ **Completed** — Green: Finished successfully
+- ✗ **Failed** — Red: Error occurred
+- ⏸️ **Paused** — Yellow: Waiting for user input or approval
+
+### Monitoring Execution
+
+**Real-Time Updates:**
+
+- Canvas highlights current step in blue
+- Completed steps turn green
+- Failed steps turn red
+- Logs stream to Execution Panel
+- Token counter updates in real-time
+
+**Interaction During Execution:**
+
+- **Pause** — Stop execution, resume later
+- **Cancel** — Terminate workflow immediately
+- **View Logs** — Expand log viewer for detailed output
+- **Respond to Prompts** — Some steps require user input
+
+:::note[User Input Steps]
+When a workflow step requires input (e.g., confirmation, selection), execution pauses. Respond to the prompt in the Execution Panel to continue.
+:::
+
+### Execution Completion
+
+**On Success:**
+
+- All steps show green checkmarks
+- Summary shows total time and tokens used
+- Output files saved to `.bmad-output/`
+- Notification appears: "Workflow completed successfully"
+
+**On Failure:**
+
+- Failed step highlighted in red
+- Error message displayed in logs
+- Workflow stops at failure point
+- Option to restart from failed step or beginning
+
+## Party Mode: Multi-Agent Coordination
+
+Party Mode allows multiple agents to work on different parts of a workflow simultaneously.
+
+### When to Use Party Mode
+
+- **Large Projects** — Multiple epics that can be developed in parallel
+- **Independent Features** — Non-overlapping code changes
+- **Accelerated Development** — When speed is critical
+- **Resource Utilization** — Maximize AI agent efficiency
+
+### Enabling Party Mode
+
+1. Open workflow in Visual Workflow Editor
+2. Click **Party Mode** button in toolbar
+3. Select steps that can run in parallel
+4. Assign different agents to parallel branches
+5. Configure coordination settings
+
+### Party Mode Configuration
+
+| Setting | Purpose |
+| ------- | ------- |
+| **Max Concurrent Agents** | How many agents run simultaneously (2-5 recommended) |
+| **Resource Locking** | Prevent agents from editing same files |
+| **Coordination Strategy** | How agents communicate (shared memory, message queue) |
+| **Conflict Resolution** | What happens when agents modify same code |
+
+### Coordination Dashboard
+
+When Party Mode is active:
+
+- Each agent has a separate panel showing its progress
+- Shared resources panel shows file locks
+- Conflict detection alerts appear in real-time
+- Merge strategy selector for resolving conflicts
+- Combined token usage across all agents
+
+:::caution[Preventing Conflicts]
+Use resource locking to prevent multiple agents from modifying the same files. Review the [Preventing Agent Conflicts](/docs/explanation/preventing-agent-conflicts.md) guide for best practices.
+:::
+
+## Debugging Workflows
+
+### Common Issues
+
+**Step Won't Execute:**
+
+- Check that all required parameters are provided
+- Verify input files exist at specified paths
+- Ensure agent configuration is valid
+- Check timeout settings aren't too short
+
+**Wrong Output Generated:**
+
+- Review step configuration parameters
+- Check agent prompt templates in `.bmad/agents/`
+- Verify input files contain expected data
+- Examine step logs for AI reasoning
+
+**Workflow Hangs:**
+
+- Check for circular dependencies in step connections
+- Verify steps aren't waiting for unavailable resources
+- Look for steps with infinite retry loops
+- Review timeout settings in step properties
+
+### Debug Tools
+
+| Tool | Purpose |
+| ---- | ------- |
+| **Step Logs** | Detailed output from each step execution |
+| **Validation Report** | Pre-execution checks and warnings |
+| **Dry Run Mode** | Simulate execution without making changes |
+| **Breakpoints** | Pause execution at specific steps |
+| **Variable Inspector** | View workflow variables and state |
+
+### Using Breakpoints
+
+1. Right-click on a step in the canvas
+2. Select **Add Breakpoint**
+3. Red dot appears on step
+4. Workflow pauses when reaching this step
+5. Inspect variables and logs before continuing
+
+## Importing and Exporting
+
+### Export Workflow
+
+**To share or backup workflows:**
+
+1. Open workflow in editor
+2. Click **Export** in toolbar
+3. Choose export format:
+   - **YAML** — Human-readable, editable
+   - **JSON** — Machine-readable, programmatic use
+   - **Visual Archive** — Includes canvas layout metadata
+4. Save to desired location
+
+### Import Workflow
+
+**To use workflows from others:**
+
+1. Click **Import** in Workflows view
+2. Select file (YAML, JSON, or archive)
+3. Review imported workflow details
+4. Click **Import** to add to your workflows
+5. Workflow appears in workflows list
+
+### Migrating CLI Workflows
+
+**Convert existing CLI workflows to visual format:**
+
+1. Navigate to Workflows → **Import Legacy**
+2. Select `.bmad/workflows/` folder from CLI project
+3. Migration wizard analyzes YAML files
+4. Each workflow converted to visual format
+5. Review and adjust connections in editor
+
+:::tip[Batch Import]
+The Legacy Migration Wizard can import multiple workflows at once. Select a folder containing multiple YAML workflow files.
+:::
+
+## Workflow Templates
+
+### Using Domain Templates
+
+BMAD Studio includes pre-configured workflow templates:
+
+| Domain | Templates Included |
+| ------ | ------------------ |
+| **Healthcare** | HIPAA compliance, patient data workflows, medical device docs |
+| **FinTech** | PCI compliance, transaction processing, audit trail generation |
+| **E-Commerce** | Product catalog, cart, checkout, order fulfillment workflows |
+| **SaaS** | User onboarding, subscription management, multi-tenant setup |
+| **Enterprise** | SSO integration, role-based access, compliance reporting |
+
+**To use a template:**
+
+1. Click **Create Workflow** → **From Template**
+2. Browse domain categories
+3. Select template
+4. Customize for your project
+5. Save as new workflow
+
+### Creating Custom Templates
+
+**Save your workflows as templates:**
+
+1. Open workflow in editor
+2. Click **Save as Template**
+3. Enter template details:
+   - Name and description
+   - Domain category
+   - Tags for searchability
+4. Template saved to templates library
+5. Reusable across all projects
+
+## Advanced Features
+
+### Dynamic Routing
+
+Configure workflows to automatically select execution paths:
+
+**Based on Project Type:**
+
+- React projects skip backend steps
+- API projects skip frontend steps
+- Full-stack projects execute all steps
+
+**Based on Complexity:**
+
+- Simple features use Quick Flow steps
+- Complex features use full planning cycle
+- Enterprise features include compliance steps
+
+**Configure in workflow properties:**
+
+- Add conditional branches
+- Set conditions based on project metadata
+- Test routing with different project types
+
+### Workflow Variables
+
+**Store and reuse data across steps:**
+
+- Set variables in step outputs
+- Reference in later step inputs using `${variable_name}`
+- Variables shown in Variable Inspector during execution
+- Persist variables across workflow sessions
+
+### Hooks and Triggers
+
+**Automate workflow execution:**
+
+| Trigger | When It Fires |
+| ------- | ------------- |
+| **On Commit** | After git commit in project |
+| **On File Change** | When specific files modified |
+| **On Schedule** | Cron-style scheduled execution |
+| **On API Call** | External webhook trigger |
+
+**Configure in Workflow Settings → Triggers**
+
+## What You've Accomplished
+
+You've mastered workflow creation and execution in BMAD Studio:
+
+- Created custom workflows using drag-and-drop editor
+- Configured steps with parameters and connections
+- Executed workflows with real-time monitoring
+- Used Party Mode for multi-agent coordination
+- Debugged workflow issues with built-in tools
+- Imported/exported workflows for sharing
+- Applied domain-specific templates
+
+Your workflow capabilities now include:
+
+```
+.bmad/workflows/
+├── custom-feature-workflow.yaml    # Your custom workflows
+├── analysis/
+├── planning/
+├── implementation/
+└── testing/
+    └── (28+ built-in workflows plus your customs)
+```
+
+## Quick Reference
+
+| Action | Method | Purpose |
+| ------ | ------ | ------- |
+| **Create Workflow** | Workflows → Create | Start new workflow from scratch |
+| **Edit Workflow** | Double-click workflow | Open in Visual Workflow Editor |
+| **Run Workflow** | Click ▶️ or `Ctrl+R` | Execute workflow |
+| **Validate** | Toolbar → Validate | Check for errors before running |
+| **Add Step** | Drag from palette | Add step to workflow |
+| **Connect Steps** | Drag from output to input | Define execution order |
+| **Configure Step** | Select step, edit properties | Set step parameters |
+| **Party Mode** | Toolbar → Party Mode | Multi-agent coordination |
+| **Export** | Toolbar → Export | Save workflow to file |
+| **Import** | Workflows → Import | Load workflow from file |
+
+## Common Questions
+
+### Can I edit workflows while they're running?
+
+No. Workflows must be stopped before editing. Save your changes and restart the workflow.
+
+### What happens if a step fails?
+
+The workflow stops at the failed step. Review logs, fix the issue, then restart from the failed step or from the beginning.
+
+### Can I run multiple workflows simultaneously?
+
+Yes. Each workflow execution is independent. However, watch for file conflicts if workflows modify the same files.
+
+### How do I share workflows with my team?
+
+Export workflows to YAML or JSON files and share via git, email, or cloud storage. Team members import them into their BMAD Studio.
+
+### Do visual workflows work with the CLI?
+
+Yes. Visual workflows are saved as YAML files compatible with the CLI tool. You can execute them with `bmad run workflow-name`.
+
+### Can I convert CLI workflows to visual format?
+
+Yes. Use Workflows → Import Legacy to convert YAML workflows to visual format with automatic layout.
+
+## Getting Help
+
+- **Step Documentation** — Right-click any step → View Documentation
+- **Workflow Templates** — Examples in Help → Workflow Examples
+- **Community** — [Discord](https://discord.gg/gk8jAdXWmj) (#workflow-help)
+- **Video Tutorials** — Help → Video Guides
+
+## Key Takeaways
+
+:::tip[Remember These]
+- **Validate before running** — Catch errors early with the validation engine
+- **Use Party Mode wisely** — Great for parallel work but watch for conflicts
+- **Templates save time** — Start with domain templates for common scenarios
+- **Workflows are portable** — Export to YAML for sharing and version control
+- **Debug with breakpoints** — Pause execution to inspect state at any step
+:::
+
+Ready to optimize your AI usage? Check out the [Token Economy Guide](/docs/user-guide/token-economy.md) to master budgets, efficiency modes, and cost tracking.

package/electron-builder.yml

@@ -0,0 +1,75 @@
+appId: com.bmad.studio
+productName: BMAD Studio
+copyright: Copyright © 2024 Brian (BMad) Madison
+
+# Directories
+directories:
+  output: dist
+  buildResources: build
+
+# Files to include/exclude in the packaged app
+files:
+  - dist/electron/**/*
+  - dist/renderer/**/*
+  - node_modules/**/*
+  - package.json
+  - "!**/*.ts"
+  - "!**/*.map"
+  - "!electron/**/*"
+  - "!renderer/**/*"
+  - "!test/**/*"
+  - "!.auto-claude/**/*"
+  - "!.github/**/*"
+  - "!.husky/**/*"
+  - "!docs/**/*"
+  - "!website/**/*"
+  - "!tools/**/*"
+  - "!*.md"
+  - "!.eslintrc*"
+  - "!.prettierrc*"
+  - "!tsconfig*.json"
+  - "!vite.config.ts"
+  - "!tailwind.config.js"
+  - "!postcss.config.js"
+
+# macOS configuration
+mac:
+  category: public.app-category.developer-tools
+  target:
+    - dmg
+    - zip
+  icon: build/icon.icns
+  hardenedRuntime: true
+  gatekeeperAssess: false
+  entitlements: build/entitlements.mac.plist
+  entitlementsInherit: build/entitlements.mac.plist
+
+dmg:
+  title: ${productName} ${version}
+  icon: build/icon.icns
+
+# Windows configuration
+win:
+  target:
+    - nsis
+    - portable
+  icon: build/icon.ico
+  artifactName: BMAD-Studio-Setup.${ext}
+
+nsis:
+  oneClick: false
+  allowToChangeInstallationDirectory: true
+  createDesktopShortcut: always
+  createStartMenuShortcut: true
+  shortcutName: ${productName}
+
+# Linux configuration
+linux:
+  target:
+    - AppImage
+  category: Development
+  icon: build/icons
+  artifactName: BMAD-Studio.${ext}
+
+# Publish configuration (disabled for now)
+publish: null