@hivehub/rulebook 4.2.1 → 4.3.0

package/templates/commands/rulebook-task-create.md

@@ -1,93 +1,93 @@
----
-name: /rulebook-task-create
-id: rulebook-task-create
-category: Rulebook
-description: Create a new Rulebook task following OpenSpec-compatible format with Context7 MCP validation.
----
-<!-- RULEBOOK:START -->
-**Guardrails**
-- Favor straightforward, minimal implementations first and add complexity only when it is requested or clearly required.
-- Keep changes tightly scoped to the requested outcome.
-- Refer to `/.rulebook/specs/RULEBOOK.md` for complete task management guidelines and format requirements.
-- **CRITICAL**: Context7 MCP is REQUIRED for task creation to ensure correct OpenSpec-compatible format.
-- Identify any vague or ambiguous details and ask the necessary follow-up questions before editing files.
-
-**Steps**
-1. **Check Context7 MCP (MANDATORY)**: Query Context7 for OpenSpec documentation to get the official format:
-   ```
-   @Context7 /fission-ai/openspec task creation format spec structure
-   ```
-   Review official format requirements: spec delta format, requirement structure, scenario formatting, delta headers (ADDED/MODIFIED/REMOVED/RENAMED).
-
-2. **Explore Current State**: 
-   - Run `rulebook task list` to see existing tasks
-   - Review related code or docs (e.g., via `rg`/`ls`) to understand current behavior
-   - Note any gaps that require clarification
-
-3. **Choose Task ID**: Use verb-led kebab-case (e.g., `add-feature`, `update-api`, `refactor-module`). Must be unique.
-
-4. **Create Task Structure**:
-   ```bash
-   rulebook task create <task-id>
-   ```
-   This creates `/.rulebook/tasks/<task-id>/` with:
-   - `proposal.md` - Why and what changes
-   - `tasks.md` - Implementation checklist
-   - `specs/` - Directory for spec deltas
-
-5. **Write Proposal** (`proposal.md`):
-   - **Why**: Minimum 20 characters explaining why this change is needed
-   - **What Changes**: Detailed description of what will change
-   - **Impact**: Affected specs, code, breaking changes, user benefits
-
-6. **Write Tasks Checklist** (`tasks.md`):
-   - Organize by phases (Implementation, Testing, Documentation)
-   - Use checkbox format: `- [ ] Task description`
-   - Include validation steps (tests, coverage checks)
-
-7. **Write Spec Delta** (`specs/<module>/spec.md`):
-   - Use `## ADDED|MODIFIED|REMOVED|RENAMED Requirements` headers
-   - Requirements MUST use `### Requirement: [Name]` with SHALL/MUST keywords
-   - Scenarios MUST use `#### Scenario:` (4 hashtags, NOT 3)
-   - Scenarios MUST use Given/When/Then structure
-   - Example:
-     ```markdown
-     ## ADDED Requirements
-     
-     ### Requirement: Feature Name
-     The system SHALL do something specific and testable.
-     
-     #### Scenario: Scenario Name
-     Given some precondition
-     When an action occurs
-     Then an expected outcome happens
-     ```
-
-8. **Validate Task**:
-   ```bash
-   rulebook task validate <task-id>
-   ```
-   Fix any validation errors before proceeding.
-
-9. **Verify Format**:
-   - Purpose section: ≥20 characters ✅
-   - Requirements: Contain SHALL or MUST ✅
-   - Scenarios: Use `#### Scenario:` (4 hashtags) ✅
-   - Scenarios: Use Given/When/Then structure ✅
-   - Delta headers: Use ADDED/MODIFIED/REMOVED/RENAMED ✅
-
-**Reference**
-- See `/.rulebook/specs/RULEBOOK.md` for complete task management guidelines
-- Use `rulebook task show <task-id>` to view task details
-- Use `rulebook task list` to see all tasks
-- Search existing requirements with `rg -n "Requirement:|Scenario:" .rulebook/tasks` before writing new ones
-- Explore the codebase with `rg <keyword>`, `ls`, or direct file reads so proposals align with current implementation realities
-
-**Common Pitfalls to Avoid**
-- ❌ Using 3 hashtags for scenarios (`### Scenario:`) - MUST use 4 (`#### Scenario:`)
-- ❌ Missing SHALL/MUST keywords in requirements
-- ❌ Using bullet points for scenarios instead of Given/When/Then
-- ❌ Purpose section too short (<20 characters)
-- ❌ Wrong delta headers (use ADDED/MODIFIED/REMOVED/RENAMED, not "New Requirements" or "Changes")
-<!-- RULEBOOK:END -->
-
+---
+name: /rulebook-task-create
+id: rulebook-task-create
+category: Rulebook
+description: Create a new Rulebook task following OpenSpec-compatible format with Context7 MCP validation.
+---
+<!-- RULEBOOK:START -->
+**Guardrails**
+- Favor straightforward, minimal implementations first and add complexity only when it is requested or clearly required.
+- Keep changes tightly scoped to the requested outcome.
+- Refer to `/.rulebook/specs/RULEBOOK.md` for complete task management guidelines and format requirements.
+- **CRITICAL**: Context7 MCP is REQUIRED for task creation to ensure correct OpenSpec-compatible format.
+- Identify any vague or ambiguous details and ask the necessary follow-up questions before editing files.
+
+**Steps**
+1. **Check Context7 MCP (MANDATORY)**: Query Context7 for OpenSpec documentation to get the official format:
+   ```
+   @Context7 /fission-ai/openspec task creation format spec structure
+   ```
+   Review official format requirements: spec delta format, requirement structure, scenario formatting, delta headers (ADDED/MODIFIED/REMOVED/RENAMED).
+
+2. **Explore Current State**: 
+   - Run `rulebook task list` to see existing tasks
+   - Review related code or docs (e.g., via `rg`/`ls`) to understand current behavior
+   - Note any gaps that require clarification
+
+3. **Choose Task ID**: Use verb-led kebab-case (e.g., `add-feature`, `update-api`, `refactor-module`). Must be unique.
+
+4. **Create Task Structure**:
+   ```bash
+   rulebook task create <task-id>
+   ```
+   This creates `/.rulebook/tasks/<task-id>/` with:
+   - `proposal.md` - Why and what changes
+   - `tasks.md` - Implementation checklist
+   - `specs/` - Directory for spec deltas
+
+5. **Write Proposal** (`proposal.md`):
+   - **Why**: Minimum 20 characters explaining why this change is needed
+   - **What Changes**: Detailed description of what will change
+   - **Impact**: Affected specs, code, breaking changes, user benefits
+
+6. **Write Tasks Checklist** (`tasks.md`):
+   - Organize by phases (Implementation, Testing, Documentation)
+   - Use checkbox format: `- [ ] Task description`
+   - Include validation steps (tests, coverage checks)
+
+7. **Write Spec Delta** (`specs/<module>/spec.md`):
+   - Use `## ADDED|MODIFIED|REMOVED|RENAMED Requirements` headers
+   - Requirements MUST use `### Requirement: [Name]` with SHALL/MUST keywords
+   - Scenarios MUST use `#### Scenario:` (4 hashtags, NOT 3)
+   - Scenarios MUST use Given/When/Then structure
+   - Example:
+     ```markdown
+     ## ADDED Requirements
+     
+     ### Requirement: Feature Name
+     The system SHALL do something specific and testable.
+     
+     #### Scenario: Scenario Name
+     Given some precondition
+     When an action occurs
+     Then an expected outcome happens
+     ```
+
+8. **Validate Task**:
+   ```bash
+   rulebook task validate <task-id>
+   ```
+   Fix any validation errors before proceeding.
+
+9. **Verify Format**:
+   - Purpose section: ≥20 characters ✅
+   - Requirements: Contain SHALL or MUST ✅
+   - Scenarios: Use `#### Scenario:` (4 hashtags) ✅
+   - Scenarios: Use Given/When/Then structure ✅
+   - Delta headers: Use ADDED/MODIFIED/REMOVED/RENAMED ✅
+
+**Reference**
+- See `/.rulebook/specs/RULEBOOK.md` for complete task management guidelines
+- Use `rulebook task show <task-id>` to view task details
+- Use `rulebook task list` to see all tasks
+- Search existing requirements with `rg -n "Requirement:|Scenario:" .rulebook/tasks` before writing new ones
+- Explore the codebase with `rg <keyword>`, `ls`, or direct file reads so proposals align with current implementation realities
+
+**Common Pitfalls to Avoid**
+- ❌ Using 3 hashtags for scenarios (`### Scenario:`) - MUST use 4 (`#### Scenario:`)
+- ❌ Missing SHALL/MUST keywords in requirements
+- ❌ Using bullet points for scenarios instead of Given/When/Then
+- ❌ Purpose section too short (<20 characters)
+- ❌ Wrong delta headers (use ADDED/MODIFIED/REMOVED/RENAMED, not "New Requirements" or "Changes")
+<!-- RULEBOOK:END -->
+

package/templates/commands/rulebook-task-list.md

@@ -1,42 +1,42 @@
----
-name: /rulebook-task-list
-id: rulebook-task-list
-category: Rulebook
-description: List all Rulebook tasks (active and optionally archived).
----
-<!-- RULEBOOK:START -->
-**Guardrails**
-- Favor straightforward, minimal implementations first and add complexity only when it is requested or clearly required.
-- Keep changes tightly scoped to the requested outcome.
-- Refer to `/.rulebook/specs/RULEBOOK.md` for complete task management guidelines.
-
-**Steps**
-1. **List Active Tasks**:
-   ```bash
-   rulebook task list
-   ```
-   Shows all active tasks with their status (pending, in-progress, completed, blocked).
-
-2. **List Including Archived**:
-   ```bash
-   rulebook task list --archived
-   ```
-   Shows both active and archived tasks.
-
-3. **Review Task Status**:
-   - **pending**: Task not started
-   - **in-progress**: Task being worked on
-   - **completed**: Task finished (ready for archive)
-   - **blocked**: Task blocked by dependency
-
-4. **Select Task to Work On**:
-   - Choose task with highest priority
-   - Check task status before starting
-   - Verify task is not blocked
-
-**Reference**
-- Use `rulebook task show <task-id>` to view task details
-- Use `rulebook task validate <task-id>` to check task format
-- See `/.rulebook/specs/RULEBOOK.md` for complete task management guidelines
-<!-- RULEBOOK:END -->
-
+---
+name: /rulebook-task-list
+id: rulebook-task-list
+category: Rulebook
+description: List all Rulebook tasks (active and optionally archived).
+---
+<!-- RULEBOOK:START -->
+**Guardrails**
+- Favor straightforward, minimal implementations first and add complexity only when it is requested or clearly required.
+- Keep changes tightly scoped to the requested outcome.
+- Refer to `/.rulebook/specs/RULEBOOK.md` for complete task management guidelines.
+
+**Steps**
+1. **List Active Tasks**:
+   ```bash
+   rulebook task list
+   ```
+   Shows all active tasks with their status (pending, in-progress, completed, blocked).
+
+2. **List Including Archived**:
+   ```bash
+   rulebook task list --archived
+   ```
+   Shows both active and archived tasks.
+
+3. **Review Task Status**:
+   - **pending**: Task not started
+   - **in-progress**: Task being worked on
+   - **completed**: Task finished (ready for archive)
+   - **blocked**: Task blocked by dependency
+
+4. **Select Task to Work On**:
+   - Choose task with highest priority
+   - Check task status before starting
+   - Verify task is not blocked
+
+**Reference**
+- Use `rulebook task show <task-id>` to view task details
+- Use `rulebook task validate <task-id>` to check task format
+- See `/.rulebook/specs/RULEBOOK.md` for complete task management guidelines
+<!-- RULEBOOK:END -->
+

package/templates/commands/rulebook-task-show.md

@@ -1,52 +1,52 @@
----
-name: /rulebook-task-show
-id: rulebook-task-show
-category: Rulebook
-description: Show detailed information about a specific Rulebook task.
----
-<!-- RULEBOOK:START -->
-**Guardrails**
-- Favor straightforward, minimal implementations first and add complexity only when it is requested or clearly required.
-- Keep changes tightly scoped to the requested outcome.
-- Refer to `/.rulebook/specs/RULEBOOK.md` for complete task management guidelines.
-
-**Steps**
-1. **Show Task Details**:
-   ```bash
-   rulebook task show <task-id>
-   ```
-   Displays:
-   - Task ID and title
-   - Status (pending, in-progress, completed, blocked)
-   - Created and updated dates
-   - Archive date (if archived)
-   - Proposal summary
-   - Spec files list
-
-2. **Review Proposal**:
-   - Read `proposal.md` to understand why and what changes
-   - Check impact assessment
-   - Verify breaking changes are documented
-
-3. **Review Tasks Checklist**:
-   - Check `tasks.md` for implementation checklist
-   - Identify completed items (`[x]`)
-   - Identify pending items (`[ ]`)
-   - Follow priority order (most critical first)
-
-4. **Review Spec Deltas**:
-   - Check `specs/*/spec.md` files
-   - Verify format compliance (SHALL/MUST, 4 hashtags for scenarios)
-   - Understand requirements and scenarios
-
-5. **Check Task Status**:
-   - Verify task is not blocked
-   - Check if task is ready for implementation
-   - Confirm all prerequisites are met
-
-**Reference**
-- Use `rulebook task list` to see all tasks
-- Use `rulebook task validate <task-id>` to check task format
-- See `/.rulebook/specs/RULEBOOK.md` for complete task management guidelines
-<!-- RULEBOOK:END -->
-
+---
+name: /rulebook-task-show
+id: rulebook-task-show
+category: Rulebook
+description: Show detailed information about a specific Rulebook task.
+---
+<!-- RULEBOOK:START -->
+**Guardrails**
+- Favor straightforward, minimal implementations first and add complexity only when it is requested or clearly required.
+- Keep changes tightly scoped to the requested outcome.
+- Refer to `/.rulebook/specs/RULEBOOK.md` for complete task management guidelines.
+
+**Steps**
+1. **Show Task Details**:
+   ```bash
+   rulebook task show <task-id>
+   ```
+   Displays:
+   - Task ID and title
+   - Status (pending, in-progress, completed, blocked)
+   - Created and updated dates
+   - Archive date (if archived)
+   - Proposal summary
+   - Spec files list
+
+2. **Review Proposal**:
+   - Read `proposal.md` to understand why and what changes
+   - Check impact assessment
+   - Verify breaking changes are documented
+
+3. **Review Tasks Checklist**:
+   - Check `tasks.md` for implementation checklist
+   - Identify completed items (`[x]`)
+   - Identify pending items (`[ ]`)
+   - Follow priority order (most critical first)
+
+4. **Review Spec Deltas**:
+   - Check `specs/*/spec.md` files
+   - Verify format compliance (SHALL/MUST, 4 hashtags for scenarios)
+   - Understand requirements and scenarios
+
+5. **Check Task Status**:
+   - Verify task is not blocked
+   - Check if task is ready for implementation
+   - Confirm all prerequisites are met
+
+**Reference**
+- Use `rulebook task list` to see all tasks
+- Use `rulebook task validate <task-id>` to check task format
+- See `/.rulebook/specs/RULEBOOK.md` for complete task management guidelines
+<!-- RULEBOOK:END -->
+

package/templates/commands/rulebook-task-validate.md

@@ -1,53 +1,53 @@
----
-name: /rulebook-task-validate
-id: rulebook-task-validate
-category: Rulebook
-description: Validate Rulebook task format against OpenSpec-compatible requirements.
----
-<!-- RULEBOOK:START -->
-**Guardrails**
-- Favor straightforward, minimal implementations first and add complexity only when it is requested or clearly required.
-- Keep changes tightly scoped to the requested outcome.
-- Refer to `/.rulebook/specs/RULEBOOK.md` for complete task management guidelines and format requirements.
-
-**Steps**
-1. **Validate Task Format**:
-   ```bash
-   rulebook task validate <task-id>
-   ```
-   Checks:
-   - Purpose section length (≥20 characters)
-   - Requirement keywords (SHALL/MUST)
-   - Scenario format (4 hashtags, not 3)
-   - Given/When/Then structure
-   - Delta headers format (ADDED/MODIFIED/REMOVED/RENAMED)
-
-2. **Review Validation Results**:
-   - **Errors**: Must be fixed before proceeding
-   - **Warnings**: Should be addressed but not blocking
-
-3. **Fix Format Issues**:
-   - **Purpose too short**: Expand "Why" section to ≥20 characters
-   - **Missing SHALL/MUST**: Add SHALL or MUST keyword to requirements
-   - **Wrong scenario format**: Change `### Scenario:` to `#### Scenario:` (4 hashtags)
-   - **Missing Given/When/Then**: Replace bullet points with Given/When/Then structure
-   - **Wrong delta headers**: Use ADDED/MODIFIED/REMOVED/RENAMED, not "New Requirements"
-
-4. **Re-validate After Fixes**:
-   ```bash
-   rulebook task validate <task-id>
-   ```
-   Ensure all errors are resolved.
-
-5. **Common Format Errors**:
-   - ❌ `### Scenario:` (3 hashtags) → ✅ `#### Scenario:` (4 hashtags)
-   - ❌ "The system provides X" → ✅ "The system SHALL provide X"
-   - ❌ `- WHEN user does X THEN Y` → ✅ `Given X\nWhen Y\nThen Z`
-   - ❌ `## New Requirements` → ✅ `## ADDED Requirements`
-
-**Reference**
-- See `/.rulebook/specs/RULEBOOK.md` for complete format requirements
-- Use Context7 MCP to get official OpenSpec format documentation
-- Use `rulebook task show <task-id>` to view task details
-<!-- RULEBOOK:END -->
-
+---
+name: /rulebook-task-validate
+id: rulebook-task-validate
+category: Rulebook
+description: Validate Rulebook task format against OpenSpec-compatible requirements.
+---
+<!-- RULEBOOK:START -->
+**Guardrails**
+- Favor straightforward, minimal implementations first and add complexity only when it is requested or clearly required.
+- Keep changes tightly scoped to the requested outcome.
+- Refer to `/.rulebook/specs/RULEBOOK.md` for complete task management guidelines and format requirements.
+
+**Steps**
+1. **Validate Task Format**:
+   ```bash
+   rulebook task validate <task-id>
+   ```
+   Checks:
+   - Purpose section length (≥20 characters)
+   - Requirement keywords (SHALL/MUST)
+   - Scenario format (4 hashtags, not 3)
+   - Given/When/Then structure
+   - Delta headers format (ADDED/MODIFIED/REMOVED/RENAMED)
+
+2. **Review Validation Results**:
+   - **Errors**: Must be fixed before proceeding
+   - **Warnings**: Should be addressed but not blocking
+
+3. **Fix Format Issues**:
+   - **Purpose too short**: Expand "Why" section to ≥20 characters
+   - **Missing SHALL/MUST**: Add SHALL or MUST keyword to requirements
+   - **Wrong scenario format**: Change `### Scenario:` to `#### Scenario:` (4 hashtags)
+   - **Missing Given/When/Then**: Replace bullet points with Given/When/Then structure
+   - **Wrong delta headers**: Use ADDED/MODIFIED/REMOVED/RENAMED, not "New Requirements"
+
+4. **Re-validate After Fixes**:
+   ```bash
+   rulebook task validate <task-id>
+   ```
+   Ensure all errors are resolved.
+
+5. **Common Format Errors**:
+   - ❌ `### Scenario:` (3 hashtags) → ✅ `#### Scenario:` (4 hashtags)
+   - ❌ "The system provides X" → ✅ "The system SHALL provide X"
+   - ❌ `- WHEN user does X THEN Y` → ✅ `Given X\nWhen Y\nThen Z`
+   - ❌ `## New Requirements` → ✅ `## ADDED Requirements`
+
+**Reference**
+- See `/.rulebook/specs/RULEBOOK.md` for complete format requirements
+- Use Context7 MCP to get official OpenSpec format documentation
+- Use `rulebook task show <task-id>` to view task details
+<!-- RULEBOOK:END -->
+

package/templates/core/AGENTS_LEAN.md

@@ -1,25 +1,25 @@
-<!-- RULEBOOK:START -->
-# Project Agent Directives
-
-Generated by @hivehub/rulebook (lean mode). Spec files are in `/.rulebook/specs/`.
-
-## Core Rules
-
-- **Task Management**: `/.rulebook/specs/RULEBOOK.md` ← ALWAYS READ FIRST
-- **Quality Gates**: `/.rulebook/specs/QUALITY_ENFORCEMENT.md`
-- **Git Workflow**: `/.rulebook/specs/GIT.md`
-- **Session Context**: `PLANS.md` ← read this at session start for current task context
-
-## Language & Framework Rules
-
-LANGUAGE_REFS
-
-## Module Rules
-
-MODULE_REFS
-
-## How to Use
-
-Reference the appropriate spec file before working on a specific area.
-Run `rulebook task create` to create tasks. Run `rulebook continue` for session context.
-<!-- RULEBOOK:END -->
+<!-- RULEBOOK:START -->
+# Project Agent Directives
+
+Generated by @hivehub/rulebook (lean mode). Spec files are in `/.rulebook/specs/`.
+
+## Core Rules
+
+- **Task Management**: `/.rulebook/specs/RULEBOOK.md` ← ALWAYS READ FIRST
+- **Quality Gates**: `/.rulebook/specs/QUALITY_ENFORCEMENT.md`
+- **Git Workflow**: `/.rulebook/specs/GIT.md`
+- **Session Context**: `PLANS.md` ← read this at session start for current task context
+
+## Language & Framework Rules
+
+LANGUAGE_REFS
+
+## Module Rules
+
+MODULE_REFS
+
+## How to Use
+
+Reference the appropriate spec file before working on a specific area.
+Run `rulebook task create` to create tasks. Run `rulebook continue` for session context.
+<!-- RULEBOOK:END -->

package/templates/core/AGENTS_OVERRIDE.md

@@ -1,16 +1,16 @@
-<!-- OVERRIDE:START -->
-# Project-Specific Overrides
-
-This file contains project-specific directives that take precedence over the generated AGENTS.md.
-
-Add your custom rules, team conventions, or project-specific context here.
-This file is NEVER overwritten by `rulebook init` or `rulebook update`.
-
-## Example Overrides
-
-- **Preferred patterns**: Always use X pattern for Y
-- **Team conventions**: Code reviews require 2 approvals
-- **Project context**: This project targets Node.js 20+ only
-- **Custom quality gates**: Run `npm run e2e` before merging
-
-<!-- OVERRIDE:END -->
+<!-- OVERRIDE:START -->
+# Project-Specific Overrides
+
+This file contains project-specific directives that take precedence over the generated AGENTS.md.
+
+Add your custom rules, team conventions, or project-specific context here.
+This file is NEVER overwritten by `rulebook init` or `rulebook update`.
+
+## Example Overrides
+
+- **Preferred patterns**: Always use X pattern for Y
+- **Team conventions**: Code reviews require 2 approvals
+- **Project context**: This project targets Node.js 20+ only
+- **Custom quality gates**: Run `npm run e2e` before merging
+
+<!-- OVERRIDE:END -->