@hivehub/rulebook 5.7.0 → 5.8.1

package/templates/commands/rulebook-memory-save.md

@@ -1,48 +1,48 @@
----
-name: /rulebook-memory-save
-id: rulebook-memory-save
-category: Rulebook
-description: Save a new persistent memory for context across AI sessions.
----
-<!-- RULEBOOK:START -->
-**Guardrails**
-- Use the MCP memory tools when available (preferred over CLI commands).
-- Choose the correct memory type for accurate classification and search.
-- Keep titles concise and content descriptive.
-- Use tags for better discoverability.
-
-**Steps**
-1. **Save a memory** using the MCP tool or CLI:
-   ```
-   # Via MCP (preferred)
-   rulebook_memory_save({
-     type: "feature",
-     title: "Short descriptive title",
-     content: "Detailed description of what happened, why, and context",
-     tags: ["relevant", "tags"]
-   })
-
-   # Via CLI
-   rulebook memory save "content text" --type feature --title "Title" --tags tag1,tag2
-   ```
-
-2. **Choose the right type**:
-   - `bugfix` - Fixed a bug or resolved an error
-   - `feature` - Added new functionality
-   - `refactor` - Restructured code without changing behavior
-   - `decision` - Made an architecture or design choice (protected from eviction)
-   - `discovery` - Found something important about the codebase
-   - `change` - General code modification
-   - `observation` - Noted something worth remembering
-
-3. **Verify** the memory was saved:
-   ```
-   rulebook_memory_search({ query: "your title keywords" })
-   ```
-
-**Best Practices**
-- Save decisions early - they are protected from cache eviction
-- Include "why" in content, not just "what"
-- Use consistent tags across related memories
-- Content within `<private>...</private>` tags will be automatically redacted
-<!-- RULEBOOK:END -->
+---
+name: /rulebook-memory-save
+id: rulebook-memory-save
+category: Rulebook
+description: Save a new persistent memory for context across AI sessions.
+---
+<!-- RULEBOOK:START -->
+**Guardrails**
+- Use the MCP memory tools when available (preferred over CLI commands).
+- Choose the correct memory type for accurate classification and search.
+- Keep titles concise and content descriptive.
+- Use tags for better discoverability.
+
+**Steps**
+1. **Save a memory** using the MCP tool or CLI:
+   ```
+   # Via MCP (preferred)
+   rulebook_memory_save({
+     type: "feature",
+     title: "Short descriptive title",
+     content: "Detailed description of what happened, why, and context",
+     tags: ["relevant", "tags"]
+   })
+
+   # Via CLI
+   rulebook memory save "content text" --type feature --title "Title" --tags tag1,tag2
+   ```
+
+2. **Choose the right type**:
+   - `bugfix` - Fixed a bug or resolved an error
+   - `feature` - Added new functionality
+   - `refactor` - Restructured code without changing behavior
+   - `decision` - Made an architecture or design choice (protected from eviction)
+   - `discovery` - Found something important about the codebase
+   - `change` - General code modification
+   - `observation` - Noted something worth remembering
+
+3. **Verify** the memory was saved:
+   ```
+   rulebook_memory_search({ query: "your title keywords" })
+   ```
+
+**Best Practices**
+- Save decisions early - they are protected from cache eviction
+- Include "why" in content, not just "what"
+- Use consistent tags across related memories
+- Content within `<private>...</private>` tags will be automatically redacted
+<!-- RULEBOOK:END -->

package/templates/commands/rulebook-memory-search.md

@@ -1,47 +1,47 @@
----
-name: /rulebook-memory-search
-id: rulebook-memory-search
-category: Rulebook
-description: Search persistent memories using hybrid BM25+vector search for context across sessions.
----
-<!-- RULEBOOK:START -->
-**Guardrails**
-- Use the MCP memory tools when available (preferred over CLI commands).
-- The memory system uses 3-layer search: Layer 1 (compact search), Layer 2 (timeline), Layer 3 (full details).
-- Always start with a broad search, then narrow down with timeline and full details.
-
-**Steps**
-1. **Search memories** using the MCP tool or CLI:
-   ```
-   # Via MCP (preferred)
-   rulebook_memory_search({ query: "search terms", mode: "hybrid", limit: 20 })
-
-   # Via CLI
-   rulebook memory search "search terms" --mode hybrid --limit 20
-   ```
-   Modes: `hybrid` (default, best results), `bm25` (keyword only), `vector` (semantic only).
-
-2. **Get timeline context** around a relevant result:
-   ```
-   rulebook_memory_timeline({ memoryId: "<id>", window: 5 })
-   ```
-
-3. **Get full details** for specific memories:
-   ```
-   rulebook_memory_get({ ids: ["<id1>", "<id2>"] })
-   ```
-
-**Memory Types**
-- `bugfix` - Bug fixes and error resolutions
-- `feature` - New features and capabilities
-- `refactor` - Code restructuring
-- `decision` - Architecture/design decisions (protected from eviction)
-- `discovery` - Findings about codebase or tools
-- `change` - General code changes
-- `observation` - General observations
-
-**Reference**
-- Use `rulebook memory stats` to check database health
-- Decisions are never evicted during cleanup
-- Privacy: content within `<private>...</private>` tags is automatically redacted
-<!-- RULEBOOK:END -->
+---
+name: /rulebook-memory-search
+id: rulebook-memory-search
+category: Rulebook
+description: Search persistent memories using hybrid BM25+vector search for context across sessions.
+---
+<!-- RULEBOOK:START -->
+**Guardrails**
+- Use the MCP memory tools when available (preferred over CLI commands).
+- The memory system uses 3-layer search: Layer 1 (compact search), Layer 2 (timeline), Layer 3 (full details).
+- Always start with a broad search, then narrow down with timeline and full details.
+
+**Steps**
+1. **Search memories** using the MCP tool or CLI:
+   ```
+   # Via MCP (preferred)
+   rulebook_memory_search({ query: "search terms", mode: "hybrid", limit: 20 })
+
+   # Via CLI
+   rulebook memory search "search terms" --mode hybrid --limit 20
+   ```
+   Modes: `hybrid` (default, best results), `bm25` (keyword only), `vector` (semantic only).
+
+2. **Get timeline context** around a relevant result:
+   ```
+   rulebook_memory_timeline({ memoryId: "<id>", window: 5 })
+   ```
+
+3. **Get full details** for specific memories:
+   ```
+   rulebook_memory_get({ ids: ["<id1>", "<id2>"] })
+   ```
+
+**Memory Types**
+- `bugfix` - Bug fixes and error resolutions
+- `feature` - New features and capabilities
+- `refactor` - Code restructuring
+- `decision` - Architecture/design decisions (protected from eviction)
+- `discovery` - Findings about codebase or tools
+- `change` - General code changes
+- `observation` - General observations
+
+**Reference**
+- Use `rulebook memory stats` to check database health
+- Decisions are never evicted during cleanup
+- Privacy: content within `<private>...</private>` tags is automatically redacted
+<!-- RULEBOOK:END -->

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

@@ -1,67 +1,67 @@
----
-name: /rulebook-task-apply
-id: rulebook-task-apply
-category: Rulebook
-description: Implement an approved Rulebook task and keep tasks checklist in sync.
----
-<!-- 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.
-- **CRITICAL**: Update `tasks.md` IMMEDIATELY after completing and testing each implementation step.
-
-**Steps**
-Track these steps as TODOs and complete them one by one.
-
-1. **Read Task Details**:
-   ```bash
-   rulebook task show <task-id>
-   ```
-   Read `proposal.md`, `design.md` (if present), and `tasks.md` to confirm scope and acceptance criteria.
-
-2. **Follow Priority Order (MANDATORY)**:
-   - **Tests** (HIGHEST PRIORITY) - Write tests first
-   - **Coverage Verification** (CRITICAL) - Verify coverage ≥95%
-   - **Update Task Status** (MANDATORY) - Mark completed items as `[x]` in `tasks.md`
-   - **Next Task** (Only after above steps)
-
-3. **Work Through Tasks Sequentially**:
-   - Work through `tasks.md` checklist item by item
-   - Keep edits minimal and focused on the requested change
-   - Follow priority order (most critical first)
-
-4. **After Each Implementation Step**:
-   - ✅ Implement the feature
-   - ✅ Test the implementation
-   - ✅ Verify test coverage (run `npm test -- --coverage`)
-   - ✅ Update `tasks.md` IMMEDIATELY (mark as `[x]`)
-   - ✅ Commit locally (backup)
-   - ✅ Only then proceed to next task
-
-5. **Update Tasks Checklist**:
-   After completing and testing each item:
-   ```markdown
-   ## 1. Implementation Phase
-   - [x] 1.1 Create task manager module <!-- tested, coverage: 95% -->
-   - [x] 1.2 Add validation logic <!-- tested, coverage: 92%, status: complete -->
-   - [ ] 1.3 Add archive functionality <!-- next: will start after status update -->
-   ```
-
-6. **Confirm Completion**:
-   - Make sure every item in `tasks.md` is finished
-   - All tests pass
-   - Coverage meets thresholds
-   - Documentation updated
-
-7. **Update Checklist After All Work**:
-   - Mark each completed task as `[x]`
-   - Add comments with test status and coverage
-   - Reflect reality in the checklist
-
-**Reference**
-- Use `rulebook task show <task-id>` when additional context is required
-- Use `rulebook task validate <task-id>` to check format before archiving
-- See `/.rulebook/specs/RULEBOOK.md` for complete task management guidelines and priority order
-<!-- RULEBOOK:END -->
-
+---
+name: /rulebook-task-apply
+id: rulebook-task-apply
+category: Rulebook
+description: Implement an approved Rulebook task and keep tasks checklist in sync.
+---
+<!-- 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.
+- **CRITICAL**: Update `tasks.md` IMMEDIATELY after completing and testing each implementation step.
+
+**Steps**
+Track these steps as TODOs and complete them one by one.
+
+1. **Read Task Details**:
+   ```bash
+   rulebook task show <task-id>
+   ```
+   Read `proposal.md`, `design.md` (if present), and `tasks.md` to confirm scope and acceptance criteria.
+
+2. **Follow Priority Order (MANDATORY)**:
+   - **Tests** (HIGHEST PRIORITY) - Write tests first
+   - **Coverage Verification** (CRITICAL) - Verify coverage ≥95%
+   - **Update Task Status** (MANDATORY) - Mark completed items as `[x]` in `tasks.md`
+   - **Next Task** (Only after above steps)
+
+3. **Work Through Tasks Sequentially**:
+   - Work through `tasks.md` checklist item by item
+   - Keep edits minimal and focused on the requested change
+   - Follow priority order (most critical first)
+
+4. **After Each Implementation Step**:
+   - ✅ Implement the feature
+   - ✅ Test the implementation
+   - ✅ Verify test coverage (run `npm test -- --coverage`)
+   - ✅ Update `tasks.md` IMMEDIATELY (mark as `[x]`)
+   - ✅ Commit locally (backup)
+   - ✅ Only then proceed to next task
+
+5. **Update Tasks Checklist**:
+   After completing and testing each item:
+   ```markdown
+   ## 1. Implementation Phase
+   - [x] 1.1 Create task manager module <!-- tested, coverage: 95% -->
+   - [x] 1.2 Add validation logic <!-- tested, coverage: 92%, status: complete -->
+   - [ ] 1.3 Add archive functionality <!-- next: will start after status update -->
+   ```
+
+6. **Confirm Completion**:
+   - Make sure every item in `tasks.md` is finished
+   - All tests pass
+   - Coverage meets thresholds
+   - Documentation updated
+
+7. **Update Checklist After All Work**:
+   - Mark each completed task as `[x]`
+   - Add comments with test status and coverage
+   - Reflect reality in the checklist
+
+**Reference**
+- Use `rulebook task show <task-id>` when additional context is required
+- Use `rulebook task validate <task-id>` to check format before archiving
+- See `/.rulebook/specs/RULEBOOK.md` for complete task management guidelines and priority order
+<!-- RULEBOOK:END -->
+

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

@@ -1,94 +1,94 @@
----
-name: /rulebook-task-archive
-id: rulebook-task-archive
-category: Rulebook
-description: Archive a completed Rulebook task and apply spec deltas to main specifications.
----
-<!-- 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. **Verify Task Completion**:
-   - All items in `tasks.md` must be marked as `[x]`
-   - All tests must pass
-   - Code review complete (if applicable)
-   - Documentation updated (README, CHANGELOG, specs)
-
-2. **Run Quality Checks**:
-   ```bash
-   npm test
-   npm run lint
-   npm run type-check
-   npm run build
-   ```
-   Ensure all checks pass before archiving.
-
-3. **Validate Task Format**:
-   ```bash
-   rulebook task validate <task-id>
-   ```
-   Must pass all format checks.
-
-4. **Archive Task**:
-   ```bash
-   rulebook task archive <task-id>
-   ```
-   Or without prompts:
-   ```bash
-   rulebook task archive <task-id> --skip-validation
-   ```
-   (Only use `--skip-validation` if you're certain the task is valid)
-
-5. **Archive Process**:
-   - Validates task format (unless skipped)
-   - Checks task completion status
-   - Applies spec deltas to main specifications
-   - Moves task to `/.rulebook/tasks/archive/YYYY-MM-DD-<task-id>/`
-   - Updates related specifications
-
-6. **Verify Archive**:
-   ```bash
-   rulebook task list --archived
-   ```
-   Task should appear in archived list.
-
-7. **Post-Archive Actions**:
-   - Ensure spec deltas are applied to main specifications
-   - Update CHANGELOG.md with the change
-   - Document any breaking changes
-   - Create migration guides (if needed)
-   - Unblock related tasks (if any)
-
-8. **🚨 MANDATORY: Deferred Items → Tasks Rule**:
-   **ABSOLUTE RULE — NO EXCEPTIONS**: Whenever a task is archived with items marked as "Deferred" or "Phase X+", you MUST immediately create Rulebook tasks for those deferred items **before archiving**.
-
-   ```
-   ❌ WRONG — defer without creating task:
-   1. Archive task with "- [ ] D1. feature X — deferred Phase 4"
-      → Feature X is now forgotten forever
-
-   ✅ CORRECT — defer with tracking:
-   1. Add "- [ ] D1. feature X — deferred Phase 4" to tasks.md
-   2. Call rulebook_task_create("phase4-feature-x")
-   3. Write tasks.md for the new task with full context
-   4. THEN call rulebook_task_archive
-   ```
-
-   **Archive Checklist (ALL must be done before archiving):**
-   ```
-   □ 1. tasks.md uses - [x] for implemented, - [ ] for deferred
-   □ 2. Each deferred item has a "Phase N" target
-   □ 3. A rulebook task exists for EVERY deferred item or group
-   □ 4. The new deferred tasks have tasks.md with full context
-   □ 5. THEN call rulebook_task_archive
-   ```
-
-**Reference**
-- Use `rulebook task list --archived` to see archived tasks
-- Use `rulebook task show <task-id>` to view task details
-- See `/.rulebook/specs/RULEBOOK.md` for complete task management guidelines
-<!-- RULEBOOK:END -->
-
+---
+name: /rulebook-task-archive
+id: rulebook-task-archive
+category: Rulebook
+description: Archive a completed Rulebook task and apply spec deltas to main specifications.
+---
+<!-- 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. **Verify Task Completion**:
+   - All items in `tasks.md` must be marked as `[x]`
+   - All tests must pass
+   - Code review complete (if applicable)
+   - Documentation updated (README, CHANGELOG, specs)
+
+2. **Run Quality Checks**:
+   ```bash
+   npm test
+   npm run lint
+   npm run type-check
+   npm run build
+   ```
+   Ensure all checks pass before archiving.
+
+3. **Validate Task Format**:
+   ```bash
+   rulebook task validate <task-id>
+   ```
+   Must pass all format checks.
+
+4. **Archive Task**:
+   ```bash
+   rulebook task archive <task-id>
+   ```
+   Or without prompts:
+   ```bash
+   rulebook task archive <task-id> --skip-validation
+   ```
+   (Only use `--skip-validation` if you're certain the task is valid)
+
+5. **Archive Process**:
+   - Validates task format (unless skipped)
+   - Checks task completion status
+   - Applies spec deltas to main specifications
+   - Moves task to `/.rulebook/tasks/archive/YYYY-MM-DD-<task-id>/`
+   - Updates related specifications
+
+6. **Verify Archive**:
+   ```bash
+   rulebook task list --archived
+   ```
+   Task should appear in archived list.
+
+7. **Post-Archive Actions**:
+   - Ensure spec deltas are applied to main specifications
+   - Update CHANGELOG.md with the change
+   - Document any breaking changes
+   - Create migration guides (if needed)
+   - Unblock related tasks (if any)
+
+8. **🚨 MANDATORY: Deferred Items → Tasks Rule**:
+   **ABSOLUTE RULE — NO EXCEPTIONS**: Whenever a task is archived with items marked as "Deferred" or "Phase X+", you MUST immediately create Rulebook tasks for those deferred items **before archiving**.
+
+   ```
+   ❌ WRONG — defer without creating task:
+   1. Archive task with "- [ ] D1. feature X — deferred Phase 4"
+      → Feature X is now forgotten forever
+
+   ✅ CORRECT — defer with tracking:
+   1. Add "- [ ] D1. feature X — deferred Phase 4" to tasks.md
+   2. Call rulebook_task_create("phase4-feature-x")
+   3. Write tasks.md for the new task with full context
+   4. THEN call rulebook_task_archive
+   ```
+
+   **Archive Checklist (ALL must be done before archiving):**
+   ```
+   □ 1. tasks.md uses - [x] for implemented, - [ ] for deferred
+   □ 2. Each deferred item has a "Phase N" target
+   □ 3. A rulebook task exists for EVERY deferred item or group
+   □ 4. The new deferred tasks have tasks.md with full context
+   □ 5. THEN call rulebook_task_archive
+   ```
+
+**Reference**
+- Use `rulebook task list --archived` to see archived tasks
+- Use `rulebook task show <task-id>` to view task details
+- See `/.rulebook/specs/RULEBOOK.md` for complete task management guidelines
+<!-- RULEBOOK:END -->
+