openplanr 0.1.0

package/dist/templates/rules/claude/CLAUDE.md.hbs

@@ -0,0 +1,63 @@
+# {{projectName}} — Agile Planning Guide
+
+> Generated by OpenPlanr on {{date}}
+
+## Project Structure
+
+This project uses OpenPlanr for agile planning. All artifacts are in `{{agilePath}}/`.
+
+### Artifact Locations
+- **Epics:** `{{agilePath}}/epics/`
+- **Features:** `{{agilePath}}/features/`
+- **User Stories:** `{{agilePath}}/stories/`
+- **Tasks:** `{{agilePath}}/tasks/`
+- **ADRs:** `{{agilePath}}/adrs/`
+- **Checklist:** `{{agilePath}}/checklists/AGILE-DEVELOPMENT-GUIDE.md`
+
+## Agile Workflow
+
+Follow the 5-phase agile development workflow:
+
+### Phase 1: Requirements Analysis
+1. Read existing epics in `{{agilePath}}/epics/`
+2. Break epics into features in `{{agilePath}}/features/`
+3. Create user stories with Gherkin acceptance criteria in `{{agilePath}}/stories/`
+
+### Phase 2: Technical Design
+- Create UML sequence diagrams and C4 architecture diagrams
+- Store in `{{agilePath}}/diagrams/`
+
+### Phase 3: Architecture Decision Records
+- Document decisions in `{{agilePath}}/adrs/`
+- Cover: functional requirements, testing strategy, non-functional requirements
+
+### Phase 4: Solution Planning
+1. Generate task lists from stories in `{{agilePath}}/tasks/`
+2. Implement one subtask at a time
+3. Wait for user approval between subtasks
+4. Update task checkboxes on completion
+
+### Phase 5: Solution Review
+- Review implementation against acceptance criteria
+- Refactor as needed
+
+## Rules
+
+- Always check the checklist at `{{agilePath}}/checklists/AGILE-DEVELOPMENT-GUIDE.md` for current progress
+- When creating artifacts, follow the existing naming convention: `PREFIX-NNN-slug.md`
+- Cross-reference parent/child artifacts with relative links
+- One subtask at a time during implementation
+{{#if existingEpics}}
+
+## Current Epics
+{{#each existingEpics}}
+- [{{this.id}}]({{../agilePath}}/epics/{{this.filename}}): {{this.title}}
+{{/each}}
+{{/if}}
+{{#if existingFeatures}}
+
+## Current Features
+{{#each existingFeatures}}
+- [{{this.id}}]({{../agilePath}}/features/{{this.filename}}): {{this.title}}
+{{/each}}
+{{/if}}

package/dist/templates/rules/codex/AGENTS.md.hbs

@@ -0,0 +1,28 @@
+# {{projectName}} — Agent Instructions
+
+> Generated by OpenPlanr on {{date}}
+
+## Agile Planning
+
+This project follows a structured agile workflow. All planning artifacts are in `{{agilePath}}/`.
+
+### Artifact Structure
+- Epics: `{{agilePath}}/epics/` — High-level business initiatives
+- Features: `{{agilePath}}/features/` — Capabilities derived from epics
+- User Stories: `{{agilePath}}/stories/` — User-facing requirements with Gherkin acceptance criteria
+- Tasks: `{{agilePath}}/tasks/` — Implementation task lists with checkboxes
+- ADRs: `{{agilePath}}/adrs/` — Architecture Decision Records
+
+### Workflow
+1. Check the development checklist: `{{agilePath}}/checklists/AGILE-DEVELOPMENT-GUIDE.md`
+2. Identify the current phase and next incomplete activity
+3. When implementing tasks, work on ONE subtask at a time
+4. Update task checkboxes after completing each subtask
+5. Cross-reference artifacts using relative links
+
+### Naming Convention
+All artifacts follow `PREFIX-NNN-slug.md` format:
+- EPIC-001, EPIC-002, ...
+- FEAT-001, FEAT-002, ...
+- US-001, US-002, ...
+- TASK-001, TASK-002, ...

package/dist/templates/rules/cursor/2000-agile-checklist.mdc.hbs

@@ -0,0 +1,33 @@
+---
+description: "Agile Development Checklist — guides you through the 5-phase agile workflow for {{projectName}}"
+globs: ""
+alwaysApply: false
+---
+
+# Agile Development Checklist
+
+You are an agile planning assistant for **{{projectName}}**. Guide the user through the agile development workflow.
+
+## Workflow Phases
+
+1. **Requirements Analysis** — Create epics, features, and user stories
+2. **Technical Design** — UML sequence diagrams and C4 architecture diagrams
+3. **Architecture Decisions** — ADRs for functional requirements, testing, and NFRs
+4. **Solution Planning** — Task lists and implementation management
+5. **Solution Review** — Class diagrams, review, and refactoring
+
+## Artifact Locations
+
+- Epics: `{{agilePath}}/epics/`
+- Features: `{{agilePath}}/features/`
+- User Stories: `{{agilePath}}/stories/`
+- Tasks: `{{agilePath}}/tasks/`
+- ADRs: `{{agilePath}}/adrs/`
+- Checklist: `{{agilePath}}/checklists/AGILE-DEVELOPMENT-GUIDE.md`
+
+## Instructions
+
+1. Read the checklist at `{{agilePath}}/checklists/AGILE-DEVELOPMENT-GUIDE.md`
+2. Identify the current phase and next incomplete activity
+3. Guide the user through completing that activity
+4. After completing each activity, update the checklist status

package/dist/templates/rules/cursor/2001-agile-create-epic.mdc.hbs

@@ -0,0 +1,35 @@
+---
+description: "Create an Epic — conversational epic creation for {{projectName}}"
+globs: ""
+alwaysApply: false
+---
+
+# Create an Epic
+
+You are an agile planning assistant. Help the user create a well-structured epic.
+
+## Process
+
+### Phase 1: Information Gathering
+Ask these questions one at a time:
+1. What is the epic title?
+2. Who owns this epic?
+3. What is the business value?
+4. Who are the target users?
+5. What problem does this solve?
+6. What is the proposed solution?
+7. What are the success criteria?
+8. What are the key features (list)?
+9. What dependencies exist?
+10. What are the risks?
+
+### Phase 2: Document Generation
+Generate the epic document at `{{agilePath}}/epics/` using this structure:
+- YAML frontmatter with id, title, owner, dates, status
+- Sections: Business Value, Target Users, Problem Statement, Solution Overview, Success Criteria, Key Features, Dependencies, Risks
+
+### Phase 3: Next Steps
+Recommend creating features from this epic using `openplanr feature create --epic <ID>`.
+
+## Existing Epics
+Check `{{agilePath}}/epics/` for existing epics to avoid duplication.

package/dist/templates/rules/cursor/2002-agile-create-features.mdc.hbs

@@ -0,0 +1,35 @@
+---
+description: "Create Features from Epic — break down an epic into features for {{projectName}}"
+globs: ""
+alwaysApply: false
+---
+
+# Create Features from Epic
+
+You are an agile planning assistant. Help the user break an epic into well-defined features.
+
+## Process
+
+### Phase 1: Epic Analysis
+1. Read the specified epic from `{{agilePath}}/epics/`
+2. Analyze the key features and scope listed in the epic
+3. Propose a feature breakdown
+
+### Phase 2: Feature Definition
+For each feature, gather:
+1. Feature title
+2. Owner
+3. Overview/description
+4. Functional requirements (list)
+5. Dependencies
+6. Technical considerations
+7. Risks
+8. Success metrics
+
+### Phase 3: Document Generation
+Generate feature documents at `{{agilePath}}/features/` with:
+- YAML frontmatter linking back to the parent epic
+- Cross-references to the epic document
+
+### Phase 4: Next Steps
+Recommend creating user stories with `openplanr story create --feature <ID>`.

package/dist/templates/rules/cursor/2003-agile-create-user-story.mdc.hbs

@@ -0,0 +1,31 @@
+---
+description: "Create User Stories — generate user stories with Gherkin acceptance criteria for {{projectName}}"
+globs: ""
+alwaysApply: false
+---
+
+# Create User Stories
+
+You are an agile planning assistant. Help create user stories with Gherkin acceptance criteria.
+
+## Process
+
+### Phase 1: Feature Analysis
+1. Read the specified feature from `{{agilePath}}/features/`
+2. Analyze functional requirements
+3. Propose user story breakdown
+
+### Phase 2: Story Definition
+For each story, gather:
+1. Role (As a...)
+2. Goal (I want to...)
+3. Benefit (So that...)
+4. Acceptance criteria as Gherkin scenarios
+
+### Phase 3: Document Generation
+Generate two files per story:
+1. User story markdown at `{{agilePath}}/stories/US-XXX-title.md`
+2. Gherkin feature file at `{{agilePath}}/stories/US-XXX-gherkin.feature`
+
+### Phase 4: Next Steps
+Recommend creating tasks with `openplanr task create --story <ID>`.

package/dist/templates/rules/cursor/2100-create-task-list.mdc.hbs

@@ -0,0 +1,36 @@
+---
+description: "Create Task List — generate implementation tasks from user stories for {{projectName}}"
+globs: ""
+alwaysApply: false
+---
+
+# Create Task List
+
+You are a technical planning assistant. Generate implementation tasks from user stories.
+
+## Process
+
+### Phase 1: Artifact Analysis
+Read all relevant artifacts:
+- User stories at `{{agilePath}}/stories/`
+- Gherkin files for acceptance criteria
+- Any existing ADRs at `{{agilePath}}/adrs/`
+
+### Phase 2: High-Level Tasks
+Generate parent tasks that cover:
+- Setup and configuration
+- Core implementation
+- Testing
+- Documentation
+- Integration
+
+Wait for user confirmation before proceeding.
+
+### Phase 3: Subtask Breakdown
+For each parent task, generate subtasks with:
+- Clear acceptance criteria mapped to Gherkin scenarios
+- Estimated complexity
+- Dependencies on other tasks
+
+### Output
+Generate task list at `{{agilePath}}/tasks/` with checkbox format for tracking.

package/dist/templates/rules/cursor/2101-implement-task-list.mdc.hbs

@@ -0,0 +1,28 @@
+---
+description: "Implement Task List — manage task-by-task implementation for {{projectName}}"
+globs: ""
+alwaysApply: false
+---
+
+# Implement Task List
+
+You are an implementation assistant. Guide one-task-at-a-time implementation.
+
+## Rules
+
+1. Only work on ONE subtask at a time
+2. Wait for user approval before moving to the next subtask
+3. After completing a subtask, update the task list by checking the box
+4. Reference acceptance criteria from the linked user story's Gherkin file
+
+## Process
+
+1. Read the task list from `{{agilePath}}/tasks/`
+2. Find the first unchecked subtask
+3. Implement it
+4. Mark it complete in the task file
+5. Ask the user to review before proceeding
+
+## Task Locations
+- Task lists: `{{agilePath}}/tasks/`
+- User stories: `{{agilePath}}/stories/`

package/dist/templates/stories/gherkin.feature.hbs

@@ -0,0 +1,13 @@
+Feature: {{title}}
+  {{id}} - As a {{role}}, I want to {{goal}} so that {{benefit}}
+
+  Background:
+    Given the system is initialized
+
+{{#each scenarios}}
+  Scenario: {{this.name}}
+    Given {{this.given}}
+    When {{this.when}}
+    Then {{this.then}}
+
+{{/each}}

package/dist/templates/stories/user-story.md.hbs

@@ -0,0 +1,28 @@
+---
+id: "{{id}}"
+title: "{{title}}"
+featureId: "{{featureId}}"
+created: "{{date}}"
+updated: "{{date}}"
+status: "planning"
+---
+
+# {{id}}: {{title}}
+
+**Feature:** [{{featureId}}](../features/{{featureId}}.md)
+
+## User Story
+**As a** {{role}}
+**I want to** {{goal}}
+**So that** {{benefit}}
+
+## Acceptance Criteria
+See [{{id}}-gherkin.feature](./{{id}}-gherkin.feature) for detailed Gherkin scenarios.
+
+{{#if additionalNotes}}
+## Additional Notes
+{{additionalNotes}}
+{{/if}}
+
+## Tasks
+_Run `openplanr task create --story {{id}}` to generate tasks._

package/dist/templates/tasks/task-list.md.hbs

@@ -0,0 +1,24 @@
+---
+id: "{{id}}"
+title: "{{title}}"
+storyId: "{{storyId}}"
+created: "{{date}}"
+updated: "{{date}}"
+status: "pending"
+---
+
+# {{id}}: {{title}}
+
+**User Story:** [{{storyId}}](../stories/{{storyId}}.md)
+
+## Tasks
+
+{{#each tasks}}
+- [ ] **{{this.id}}** {{this.title}}
+{{#each this.subtasks}}
+  - [ ] {{this.id}} {{this.title}}
+{{/each}}
+{{/each}}
+
+## Notes
+_Mark tasks complete by checking the boxes above, or run `openplanr task implement {{id}}`._

package/dist/templates/templates/adrs/adr-general.md.hbs

@@ -0,0 +1,46 @@
+---
+id: "{{id}}"
+title: "{{title}}"
+created: "{{date}}"
+status: "proposed"
+---
+
+# {{id}}: {{title}}
+
+## Context
+{{context}}
+
+## Decision Drivers
+{{#each decisionDrivers}}
+- {{this}}
+{{/each}}
+
+## Considered Options
+{{#each options}}
+### Option {{@index}}: {{this.name}}
+{{this.description}}
+
+**Pros:**
+{{#each this.pros}}
+- {{this}}
+{{/each}}
+
+**Cons:**
+{{#each this.cons}}
+- {{this}}
+{{/each}}
+{{/each}}
+
+## Decision
+{{decision}}
+
+## Consequences
+### Positive
+{{#each positiveConsequences}}
+- {{this}}
+{{/each}}
+
+### Negative
+{{#each negativeConsequences}}
+- {{this}}
+{{/each}}

package/dist/templates/templates/checklists/agile-checklist.md.hbs

@@ -0,0 +1,49 @@
+# Agile Development Guide — {{projectName}}
+
+> Generated by Planr on {{date}}
+
+## Phase 1: Requirements Analysis
+
+| # | Activity | Command | Status |
+|---|----------|---------|--------|
+| 1 | Create Epic | `planr epic create` | [ ] |
+| 2 | Create Features from Epic | `planr feature create --epic <ID>` | [ ] |
+| 3 | Create User Stories from Features | `planr story create --feature <ID>` | [ ] |
+
+## Phase 2: Technical Design
+
+| # | Activity | Artifact | Status |
+|---|----------|----------|--------|
+| 4 | UML Sequence Diagrams | `docs/agile/diagrams/` | [ ] |
+| 5 | C4 Architecture Diagrams | `docs/agile/diagrams/` | [ ] |
+
+## Phase 3: Architecture Decision Records
+
+| # | Activity | Command | Status |
+|---|----------|---------|--------|
+| 6 | Functional Requirements ADR (CLI) | `docs/agile/adrs/` | [ ] |
+| 7 | Functional Requirements ADR (REST) | `docs/agile/adrs/` | [ ] |
+| 8 | Acceptance Testing Strategy ADR | `docs/agile/adrs/` | [ ] |
+| 9 | Non-Functional Requirements ADR | `docs/agile/adrs/` | [ ] |
+
+## Phase 4: Solution Planning
+
+| # | Activity | Command | Status |
+|---|----------|---------|--------|
+| 10 | Create Task Lists | `planr task create --story <ID>` | [ ] |
+| 11 | Implement Tasks | `planr task implement <ID>` | [ ] |
+| 12 | Create Definition of Done | `docs/agile/checklists/` | [ ] |
+
+## Phase 5: Solution Review
+
+| # | Activity | Artifact | Status |
+|---|----------|----------|--------|
+| 13 | UML Class Diagrams | `docs/agile/diagrams/` | [ ] |
+| 14 | Review & Refactoring | Code review | [ ] |
+
+## Best Practices
+
+- Complete each phase before moving to the next
+- All artifacts should be version controlled alongside your code
+- Use `planr status` to see overall progress
+- Use `planr rules generate` to keep AI agent rules in sync with your artifacts

package/dist/templates/templates/epics/epic.md.hbs

@@ -0,0 +1,46 @@
+---
+id: "{{id}}"
+title: "{{title}}"
+owner: "{{owner}}"
+created: "{{date}}"
+updated: "{{date}}"
+status: "planning"
+project: "{{projectName}}"
+---
+
+# {{id}}: {{title}}
+
+## Business Value
+{{businessValue}}
+
+## Target Users
+{{targetUsers}}
+
+## Problem Statement
+{{problemStatement}}
+
+## Solution Overview
+{{solutionOverview}}
+
+## Success Criteria
+{{successCriteria}}
+
+## Key Features
+{{#each keyFeatures}}
+- {{this}}
+{{/each}}
+
+## Dependencies
+{{dependencies}}
+
+## Risks
+{{risks}}
+
+## Features
+{{#if featureIds}}
+{{#each featureIds}}
+- [{{this}}](../features/{{this}}.md)
+{{/each}}
+{{else}}
+_No features created yet. Run `planr feature create --epic {{id}}` to break this epic into features._
+{{/if}}

package/dist/templates/templates/features/feature.md.hbs

@@ -0,0 +1,42 @@
+---
+id: "{{id}}"
+title: "{{title}}"
+epicId: "{{epicId}}"
+owner: "{{owner}}"
+created: "{{date}}"
+updated: "{{date}}"
+status: "planning"
+---
+
+# {{id}}: {{title}}
+
+**Epic:** [{{epicId}}](../epics/{{epicId}}.md)
+
+## Overview
+{{overview}}
+
+## Functional Requirements
+{{#each functionalRequirements}}
+- {{this}}
+{{/each}}
+
+## User Stories
+{{#if storyIds}}
+{{#each storyIds}}
+- [{{this}}](../stories/{{this}}.md)
+{{/each}}
+{{else}}
+_No user stories created yet. Run `planr story create --feature {{id}}` to create user stories._
+{{/if}}
+
+## Dependencies
+{{dependencies}}
+
+## Technical Considerations
+{{technicalConsiderations}}
+
+## Risks
+{{risks}}
+
+## Success Metrics
+{{successMetrics}}

package/dist/templates/templates/rules/claude/CLAUDE.md.hbs

@@ -0,0 +1,63 @@
+# {{projectName}} — Agile Planning Guide
+
+> Generated by OpenPlanr on {{date}}
+
+## Project Structure
+
+This project uses OpenPlanr for agile planning. All artifacts are in `{{agilePath}}/`.
+
+### Artifact Locations
+- **Epics:** `{{agilePath}}/epics/`
+- **Features:** `{{agilePath}}/features/`
+- **User Stories:** `{{agilePath}}/stories/`
+- **Tasks:** `{{agilePath}}/tasks/`
+- **ADRs:** `{{agilePath}}/adrs/`
+- **Checklist:** `{{agilePath}}/checklists/AGILE-DEVELOPMENT-GUIDE.md`
+
+## Agile Workflow
+
+Follow the 5-phase agile development workflow:
+
+### Phase 1: Requirements Analysis
+1. Read existing epics in `{{agilePath}}/epics/`
+2. Break epics into features in `{{agilePath}}/features/`
+3. Create user stories with Gherkin acceptance criteria in `{{agilePath}}/stories/`
+
+### Phase 2: Technical Design
+- Create UML sequence diagrams and C4 architecture diagrams
+- Store in `{{agilePath}}/diagrams/`
+
+### Phase 3: Architecture Decision Records
+- Document decisions in `{{agilePath}}/adrs/`
+- Cover: functional requirements, testing strategy, non-functional requirements
+
+### Phase 4: Solution Planning
+1. Generate task lists from stories in `{{agilePath}}/tasks/`
+2. Implement one subtask at a time
+3. Wait for user approval between subtasks
+4. Update task checkboxes on completion
+
+### Phase 5: Solution Review
+- Review implementation against acceptance criteria
+- Refactor as needed
+
+## Rules
+
+- Always check the checklist at `{{agilePath}}/checklists/AGILE-DEVELOPMENT-GUIDE.md` for current progress
+- When creating artifacts, follow the existing naming convention: `PREFIX-NNN-slug.md`
+- Cross-reference parent/child artifacts with relative links
+- One subtask at a time during implementation
+{{#if existingEpics}}
+
+## Current Epics
+{{#each existingEpics}}
+- [{{this.id}}]({{../agilePath}}/epics/{{this.filename}}): {{this.title}}
+{{/each}}
+{{/if}}
+{{#if existingFeatures}}
+
+## Current Features
+{{#each existingFeatures}}
+- [{{this.id}}]({{../agilePath}}/features/{{this.filename}}): {{this.title}}
+{{/each}}
+{{/if}}

package/dist/templates/templates/rules/codex/AGENTS.md.hbs

@@ -0,0 +1,28 @@
+# {{projectName}} — Agent Instructions
+
+> Generated by OpenPlanr on {{date}}
+
+## Agile Planning
+
+This project follows a structured agile workflow. All planning artifacts are in `{{agilePath}}/`.
+
+### Artifact Structure
+- Epics: `{{agilePath}}/epics/` — High-level business initiatives
+- Features: `{{agilePath}}/features/` — Capabilities derived from epics
+- User Stories: `{{agilePath}}/stories/` — User-facing requirements with Gherkin acceptance criteria
+- Tasks: `{{agilePath}}/tasks/` — Implementation task lists with checkboxes
+- ADRs: `{{agilePath}}/adrs/` — Architecture Decision Records
+
+### Workflow
+1. Check the development checklist: `{{agilePath}}/checklists/AGILE-DEVELOPMENT-GUIDE.md`
+2. Identify the current phase and next incomplete activity
+3. When implementing tasks, work on ONE subtask at a time
+4. Update task checkboxes after completing each subtask
+5. Cross-reference artifacts using relative links
+
+### Naming Convention
+All artifacts follow `PREFIX-NNN-slug.md` format:
+- EPIC-001, EPIC-002, ...
+- FEAT-001, FEAT-002, ...
+- US-001, US-002, ...
+- TASK-001, TASK-002, ...

package/dist/templates/templates/rules/cursor/2000-agile-checklist.mdc.hbs

@@ -0,0 +1,33 @@
+---
+description: "Agile Development Checklist — guides you through the 5-phase agile workflow for {{projectName}}"
+globs: ""
+alwaysApply: false
+---
+
+# Agile Development Checklist
+
+You are an agile planning assistant for **{{projectName}}**. Guide the user through the agile development workflow.
+
+## Workflow Phases
+
+1. **Requirements Analysis** — Create epics, features, and user stories
+2. **Technical Design** — UML sequence diagrams and C4 architecture diagrams
+3. **Architecture Decisions** — ADRs for functional requirements, testing, and NFRs
+4. **Solution Planning** — Task lists and implementation management
+5. **Solution Review** — Class diagrams, review, and refactoring
+
+## Artifact Locations
+
+- Epics: `{{agilePath}}/epics/`
+- Features: `{{agilePath}}/features/`
+- User Stories: `{{agilePath}}/stories/`
+- Tasks: `{{agilePath}}/tasks/`
+- ADRs: `{{agilePath}}/adrs/`
+- Checklist: `{{agilePath}}/checklists/AGILE-DEVELOPMENT-GUIDE.md`
+
+## Instructions
+
+1. Read the checklist at `{{agilePath}}/checklists/AGILE-DEVELOPMENT-GUIDE.md`
+2. Identify the current phase and next incomplete activity
+3. Guide the user through completing that activity
+4. After completing each activity, update the checklist status