npm - @pennyfarthing/core - Versions diffs - 9.2.0 → 9.3.0 - Mend

@pennyfarthing/core 9.2.0 → 9.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (1039) hide show

package/pennyfarthing-dist/workflows/project-setup/steps/step-09-cyclist.md DELETED Viewed

@@ -1,245 +0,0 @@
-# Step 9: Install Cyclist (Optional)
-<purpose>
-Optionally install Cyclist, the visual terminal interface for Claude Code. Cyclist provides a graphical interface with panels for sprint tracking, workflow visualization, and enhanced tool display.
-</purpose>
-<instructions>
-1. Explain what Cyclist provides
-2. Check if Cyclist is already installed
-3. Offer installation options
-4. Guide through setup if desired
-5. Verify installation works
-</instructions>
-<output>
-- User informed about Cyclist features
-- Cyclist installed if user requested
-- Basic verification completed
-- User knows how to launch Cyclist
-</output>
-## WHAT IS CYCLIST?
-```
-🚴 Cyclist - Visual Terminal for Claude Code
-═════════════════════════════════════════════
-Cyclist provides a graphical interface that enhances Claude Code with:
-┌─────────────────────────────────────────────────────────────────────┐
-│  ┌──────────────┐ ┌──────────────┐ ┌──────────────┐                │
-│  │ Sprint Panel │ │ Workflow     │ │ Changed      │                │
-│  │              │ │ Panel        │ │ Files        │                │
-│  │ • Status     │ │              │ │              │                │
-│  │ • Stories    │ │ • Phase      │ │ • Diffs      │                │
-│  │ • Progress   │ │ • Handoffs   │ │ • Staging    │                │
-│  └──────────────┘ └──────────────┘ └──────────────┘                │
-│  ┌───────────────────────────────────────────────────────────────┐ │
-│  │                     Message Panel                              │ │
-│  │                                                                │ │
-│  │  Claude: I'll help you implement that feature...               │ │
-│  │                                                                │ │
-│  │  [Tool Call] Reading src/components/App.tsx                    │ │
-│  │  [Tool Call] Writing src/components/Feature.tsx                │ │
-│  │                                                                │ │
-│  └───────────────────────────────────────────────────────────────┘ │
-└─────────────────────────────────────────────────────────────────────┘
-Features:
-  • 📊 Sprint panel - Live sprint status and story tracking
-  • 🔄 Workflow panel - BikeLane phase visualization
-  • 📁 Changed files panel - Git diff integration
-  • 🎨 Themed personas - Character portraits and styles
-  • 🛠️ Tool visualization - Enhanced tool call display
-  • ⌨️ Quick actions - One-click workflow commands
-```
-## INSTALLATION CHECK
-```bash
-# Check if Cyclist is installed
-npm list @pennyfarthing/cyclist 2>/dev/null || echo "Not installed"
-# Check for global installation
-which cyclist 2>/dev/null || echo "No global cyclist"
-# Check for local installation
-ls -la node_modules/@pennyfarthing/cyclist 2>/dev/null || echo "Not in node_modules"
-```
-## INSTALLATION OPTIONS
-```
-🚴 Cyclist Installation
-═══════════════════════
-Cyclist is the visual terminal for Pennyfarthing. Would you like to install it?
-[1] Install Cyclist (recommended)
-    npm install @pennyfarthing/cyclist
-    Adds ~160MB to node_modules
-[2] Install globally
-    npm install -g @pennyfarthing/cyclist
-    Available system-wide
-[3] Use standalone app (macOS)
-    Download Cyclist.app from releases
-    No npm installation needed
-[4] Skip - I'll use terminal only
-    Cyclist is optional, CLI works fine without it
-[5] Learn more about Cyclist
-    Show detailed feature breakdown
-```
-### Installation Flow
-If user selects [1] or [2]:
-```bash
-# Local installation
-npm install @pennyfarthing/cyclist
-# Or global installation
-npm install -g @pennyfarthing/cyclist
-```
-### Post-Installation Setup
-```
-✓ Cyclist installed successfully
-Quick setup:
-  1. Add to justfile (if created):
-     cyclist:
-         npx cyclist
-  2. Or run directly:
-     npx cyclist
-  3. Or add to package.json scripts:
-     "cyclist": "cyclist"
-```
-## VERIFICATION
-After installation:
-```bash
-# Verify installation
-npx cyclist --version
-# Quick test (opens Cyclist)
-npx cyclist --help
-```
-```
-✓ Cyclist v9.1.1 installed
-Launching Cyclist for verification...
-{Cyclist window opens or web preview starts}
-Did Cyclist launch correctly?
-[Y] Yes, it works
-[N] No, troubleshoot
-[S] Skip verification
-```
-### Troubleshooting
-If issues:
-```
-🔧 Cyclist Troubleshooting
-═══════════════════════════
-Common issues:
-1. "Cannot find module" error
-   → Run: npm install @pennyfarthing/cyclist
-2. Port already in use
-   → Kill existing process: lsof -i :3457 | kill
-3. Electron not found
-   → Cyclist needs Electron: npm install electron
-4. Blank window
-   → Check browser console for errors
-   → Try: npx cyclist --no-sandbox
-[R] Retry installation
-[M] More troubleshooting options
-[S] Skip Cyclist for now
-```
-## JUSTFILE INTEGRATION
-If justfile was created in step 6, offer to add Cyclist recipe:
-```
-Add Cyclist recipe to justfile?
-[Y] Yes, add recipe:
-    cyclist:
-        npx cyclist
-[N] No, I'll launch it manually
-```
-## CYCLIST FEATURES DEEP DIVE
-If user selects "Learn more":
-```
-🚴 Cyclist Features
-════════════════════
-PANELS (draggable, resizable):
-┌────────────────┬─────────────────────────────────────────────┐
-│ Panel          │ Features                                    │
-├────────────────┼─────────────────────────────────────────────┤
-│ Message        │ Conversation display, streaming, markdown   │
-│ Sprint         │ Current sprint, stories, progress bars      │
-│ Workflow       │ BikeLane phases, handoff detection          │
-│ Changed Files  │ Git status, staged/unstaged, diffs          │
-│ Acceptance     │ Story AC checkboxes                         │
-│ Todos          │ Task list tracking                          │
-│ Background     │ Background task monitoring                  │
-│ Debug          │ OTEL spans, performance data                │
-│ Git            │ Branch info, commit history                 │
-│ Settings       │ Theme, fonts, colors                        │
-└────────────────┴─────────────────────────────────────────────┘
-TOOL VISUALIZATION:
-  • Collapsible tool calls with intent summaries
-  • Stacked consecutive tool calls
-  • Color-coded by tool type
-  • Execution time display
-PERSONA INTEGRATION:
-  • Character portraits for each agent
-  • Theme-specific colors and styles
-  • Agent popup with role info
-QUICK ACTIONS:
-  • Detected from CYCLIST markers
-  • One-click workflow commands
-  • Handoff buttons
-```
-## SUCCESS CRITERIA
-✅ User informed about Cyclist features
-✅ Installation completed (if requested)
-✅ Verification passed (if installed)
-✅ Justfile updated (if applicable)
-✅ User knows how to launch Cyclist
-## NEXT STEP
-After Cyclist setup, proceed to `step-10-complete.md` to finalize project setup and run validation.

package/pennyfarthing-dist/workflows/project-setup/steps/step-10-complete.md DELETED Viewed

@@ -1,204 +0,0 @@
-# Step 10: Complete Setup & Validation
-<purpose>
-Finalize the project setup, run validation checks, and provide the user with a summary of everything configured. Ensure the project is ready for development.
-</purpose>
-<instructions>
-1. Run pennyfarthing doctor to validate installation
-2. Summarize all configurations created
-3. Provide quick-start guide
-4. Offer next steps and resources
-</instructions>
-<output>
-- All validation checks pass
-- Configuration summary presented
-- Quick-start guide provided
-- User ready to begin development
-</output>
-## VALIDATION
-### Run Doctor
-```bash
-pennyfarthing doctor
-```
-Expected output:
-```
-🔧 Pennyfarthing Health Check
-════════════════════════════
-✓ .pennyfarthing/ directory exists
-✓ Manifest found (v9.1.1)
-✓ Symlinks valid
-✓ Sprint directory exists
-✓ Session directory exists
-✓ Git hooks installed
-✓ Settings configured
-All checks passed!
-```
-### Manual Validation Checklist
-```
-📋 Setup Validation
-════════════════════
-Configuration files:
-  {✓|✗} repos.yaml          - Repository configuration
-  {✓|✗} CLAUDE.md           - Project instructions
-  {✓|✗} shared-context.md   - Agent shared context
-  {✓|✗} justfile            - Task runner
-  {✓|✗} persona-config.yaml - Theme configuration
-Directories:
-  {✓|✗} .pennyfarthing/     - Framework installation
-  {✓|✗} .claude/            - Claude Code config
-  {✓|✗} sprint/             - Sprint tracking
-  {✓|✗} .session/           - Work sessions
-Optional:
-  {✓|✗} Cyclist installed
-  {✓|✗} Subrepos cloned
-```
-## CONFIGURATION SUMMARY
-```
-📊 Project Setup Summary
-═════════════════════════
-Project: {project_name}
-Type: {orchestrator|monorepo|single}
-Theme: {selected_theme}
-Repositories Configured:
-┌────────────────┬──────────┬────────────────────────┐
-│ Name           │ Type     │ Path                   │
-├────────────────┼──────────┼────────────────────────┤
-│ orchestrator   │ orch     │ .                      │
-│ api            │ api      │ {project}-api/         │
-│ ui             │ ui       │ {project}-ui/          │
-└────────────────┴──────────┴────────────────────────┘
-Files Created:
-  • repos.yaml           - Repository configuration
-  • CLAUDE.md            - Project instructions for Claude
-  • shared-context.md    - Shared agent context (updated)
-  • justfile             - Task runner with recipes
-  • persona-config.yaml  - Theme: {theme}
-Commands Available:
-  just test-all          - Run all tests
-  just build-all         - Build all repos
-  just dev               - Start development
-  just cyclist           - Launch Cyclist (if installed)
-```
-## QUICK-START GUIDE
-```
-🚀 Quick Start Guide
-════════════════════
-1. START DEVELOPMENT
-   just dev              # Start dev servers
-   # OR
-   just dev-api          # Start just API
-   just dev-ui           # Start just UI
-2. RUN TESTS
-   just test-all         # Test everything
-   just test-api         # Test API only
-3. USE PENNYFARTHING AGENTS
-   /sm                   # Scrum Master - manage stories
-   /sprint status        # View sprint
-   /sprint work          # Start a story
-4. WORKFLOW
-   Story flow: SM → TEA → Dev → Reviewer → SM
-5. LAUNCH CYCLIST (if installed)
-   just cyclist          # Visual terminal
-   # OR
-   npx cyclist
-6. GET HELP
-   /help                 # Context-aware help
-   pennyfarthing doctor  # Check installation
-```
-## NEXT STEPS
-```
-📌 Recommended Next Steps
-═════════════════════════
-IMMEDIATE:
-  □ Review CLAUDE.md and customize for your project
-  □ Add project-specific notes to shared-context.md
-  □ Create your first sprint in sprint/current-sprint.yaml
-WHEN READY:
-  □ Run /sm to start managing work
-  □ Create stories with /story create
-  □ Begin TDD workflow with /tea
-CUSTOMIZATION:
-  □ Add custom skills in .claude/project/skills/
-  □ Add custom commands in .claude/project/commands/
-  □ Configure agent sidecars in .pennyfarthing/sidecars/
-RESOURCES:
-  □ Docs: https://github.com/1898andCo/pennyfarthing
-  □ Issues: https://github.com/1898andCo/pennyfarthing/issues
-  □ Skill help: /help {skill_name}
-```
-## FINAL MESSAGE
-```
-✨ Setup Complete!
-══════════════════
-Your Pennyfarthing project is ready for development.
-{if theme_selected}
-Your agents now use the '{theme}' theme.
-{agent_character} says: "{theme_greeting}"
-{/if}
-Quick commands:
-  /sm              - Start managing work
-  /sprint status   - View sprint
-  /help            - Get help
-{if cyclist_installed}
-Launch Cyclist for the visual experience:
-  just cyclist
-{/if}
-Happy coding! 🚴
-```
-## WORKFLOW COMPLETE
-This workflow is now complete. The user has:
-✅ Discovered and configured repositories
-✅ Cloned any needed subrepos
-✅ Generated repos.yaml
-✅ Created CLAUDE.md
-✅ Populated shared-context.md
-✅ Created justfile with recipes
-✅ Selected a persona theme
-✅ Optionally installed additional theme packs
-✅ Optionally installed Cyclist
-✅ Validated the setup
-The project is ready for development with Pennyfarthing.

package/pennyfarthing-dist/workflows/project-setup/workflow.yaml DELETED Viewed

@@ -1,41 +0,0 @@
-# project-setup Workflow - Interactive Project Configuration
-# A BikeLane stepped workflow for configuring Pennyfarthing projects
-workflow:
-  name: project-setup
-  description: Interactive workflow for configuring a new Pennyfarthing project. Discovers repos, generates CLAUDE.md, populates shared-context.md, and configures themes.
-  version: "1.0.0"
-  type: stepped
-  # Step configuration
-  steps:
-    path: ./steps/
-    pattern: step-*.md
-  # Variables available in step files
-  variables:
-    project_root: .
-    claude_dir: .claude
-    pennyfarthing_dir: .pennyfarthing
-    output_repos: repos.yaml
-    output_claude_md: CLAUDE.md
-    output_shared_context: .claude/project/docs/shared-context.md
-  # Agent assignment - DevOps handles infrastructure setup
-  agent: devops
-  # Triggers - when to suggest this workflow
-  triggers:
-    types: [project-setup, init, setup]
-    tags: [setup, initialization, repos, claude-md]
-    conditions:
-      - no_repos_yaml: true
-      - no_claude_md: true
-  # Post-init hook suggestion
-  post_init_message: |
-    Run `/setup` to complete project configuration:
-    - Detect and configure repos
-    - Generate CLAUDE.md
-    - Populate shared-context.md
-    - Select persona theme

package/pennyfarthing-dist/workflows/quick-dev/steps/step-01-mode-detection.md DELETED Viewed

@@ -1,177 +0,0 @@
----
-name: 'step-01-mode-detection'
-description: 'Determine execution mode (tech-spec vs direct), handle escalation, set state variables'
-workflow_path: '{project_root}/_bmad/bmm/workflows/bmad-quick-flow/quick-dev'
-thisStepFile: './step-01-mode-detection.md'
-nextStepFile_modeA: './step-03-execute.md'
-nextStepFile_modeB: './step-02-context-gathering.md'
----
-<purpose>
-Determine whether the user has provided a tech-spec file (Mode A) or direct task instructions (Mode B). Capture baseline commit, load project context if available, and evaluate escalation threshold to decide whether the request fits in Quick Dev or needs broader planning workflows.
-</purpose>
-<instructions>
-1. Capture the baseline commit hash (or "NO_GIT" if not a git repo)
-2. Load project context if exists in the codebase
-3. Parse user input to determine Mode A (tech-spec path provided) or Mode B (direct task description)
-4. For Mode B, evaluate escalation signals and present appropriate choices
-5. Set state variables for all subsequent steps
-6. Provide explicit NEXT directive indicating which step to load or workflow to exit to
-</instructions>
-<output>
-- `{baseline_commit}` - Git HEAD at workflow start (or "NO_GIT")
-- `{execution_mode}` - Either "tech-spec" or "direct"
-- `{tech_spec_path}` - Path to tech-spec file (only if Mode A)
-- `{project_context}` - Loaded project context if available
-- Explicit NEXT directive showing the next step to load or workflow to exit to
-</output>
-# Step 1: Mode Detection
-**Goal:** Determine execution mode, capture baseline, handle escalation if needed.
----
-## STATE VARIABLES (capture now, persist throughout)
-These variables MUST be set in this step and available to all subsequent steps:
-- `{baseline_commit}` - Git HEAD at workflow start (or "NO_GIT" if not a git repo)
-- `{execution_mode}` - "tech-spec" or "direct"
-- `{tech_spec_path}` - Path to tech-spec file (if Mode A)
----
-## EXECUTION SEQUENCE
-### 1. Capture Baseline
-First, check if the project uses Git version control:
-**If Git repo exists** (`.git` directory present or `git rev-parse --is-inside-work-tree` succeeds):
-- Run `git rev-parse HEAD` and store result as `{baseline_commit}`
-**If NOT a Git repo:**
-- Set `{baseline_commit}` = "NO_GIT"
-### 2. Load Project Context
-Check if `{project_context}` exists (`**/project-context.md`). If found, load it as a foundational reference for ALL implementation decisions.
-### 3. Parse User Input
-Analyze the user's input to determine mode:
-**Mode A: Tech-Spec**
-- User provided a path to a tech-spec file (e.g., `quick-dev tech-spec-auth.md`)
-- Load the spec, extract tasks/context/AC
-- Set `{execution_mode}` = "tech-spec"
-- Set `{tech_spec_path}` = provided path
-- **NEXT:** Load `step-03-execute.md`
-**Mode B: Direct Instructions**
-- User provided task description directly (e.g., `refactor src/foo.ts...`)
-- Set `{execution_mode}` = "direct"
-- **NEXT:** Evaluate escalation threshold, then proceed
----
-## ESCALATION THRESHOLD (Mode B only)
-Evaluate user input with minimal token usage (no file loading):
-**Triggers escalation (if 2+ signals present):**
-- Multiple components mentioned (dashboard + api + database)
-- System-level language (platform, integration, architecture)
-- Uncertainty about approach ("how should I", "best way to")
-- Multi-layer scope (UI + backend + data together)
-- Extended timeframe ("this week", "over the next few days")
-**Reduces signal:**
-- Simplicity markers ("just", "quickly", "fix", "bug", "typo", "simple")
-- Single file/component focus
-- Confident, specific request
-Use holistic judgment, not mechanical keyword matching.
----
-## ESCALATION HANDLING
-### No Escalation (simple request)
-Present choice:
-```
-**[t] Plan first** - Create tech-spec then implement
-**[e] Execute directly** - Start now
-```
-- **[t]:** Direct user to `{quick_spec_workflow}`. **EXIT Quick Dev.**
-- **[e]:** Ask for any additional guidance, then **NEXT:** Load `step-02-context-gathering.md`
-### Escalation Triggered - Level 0-2
-```
-This looks like a focused feature with multiple components.
-**[t] Create tech-spec first** (recommended)
-**[w] Seems bigger than quick-dev** - see what BMad Method recommends
-**[e] Execute directly**
-```
-- **[t]:** Direct to `{quick_spec_workflow}`. **EXIT Quick Dev.**
-- **[w]:** Direct to `{workflow_init}`. **EXIT Quick Dev.**
-- **[e]:** Ask for guidance, then **NEXT:** Load `step-02-context-gathering.md`
-### Escalation Triggered - Level 3+
-```
-This sounds like platform/system work.
-**[w] Start BMad Method** (recommended)
-**[t] Create tech-spec** (lighter planning)
-**[e] Execute directly** - feeling lucky
-```
-- **[w]:** Direct to `{workflow_init}`. **EXIT Quick Dev.**
-- **[t]:** Direct to `{quick_spec_workflow}`. **EXIT Quick Dev.**
-- **[e]:** Ask for guidance, then **NEXT:** Load `step-02-context-gathering.md`
----
-## NEXT STEP DIRECTIVE
-**CRITICAL:** When this step completes, explicitly state which step to load:
-- Mode A (tech-spec): "**NEXT:** Loading `step-03-execute.md`"
-- Mode B (direct, [e] selected): "**NEXT:** Loading `step-02-context-gathering.md`"
-- Escalation ([t] or [w]): "**EXITING Quick Dev.** Follow the directed workflow."
----
-## SUCCESS METRICS
-- `{baseline_commit}` captured and stored
-- `{execution_mode}` determined ("tech-spec" or "direct")
-- `{tech_spec_path}` set if Mode A
-- Project context loaded if exists
-- Escalation evaluated appropriately (Mode B)
-- Explicit NEXT directive provided
-## FAILURE MODES
-- Proceeding without capturing baseline commit
-- Not setting execution_mode variable
-- Loading step-02 when Mode A (tech-spec provided)
-- Attempting to "return" after escalation instead of EXIT
-- No explicit NEXT directive at step completion