@hivehub/rulebook 5.5.2 → 5.8.0

package/templates/cli/CONTINUE.md

@@ -1,34 +1,34 @@
-<!-- CONTINUE:START -->
-# Continue CLI/Extension Rules
-
-**Tool**: Open-source Copilot alternative (VS Code extension + CLI)
-
-## Quick Start
-
-```bash
-# In VS Code: Install Continue extension
-# Or CLI: npm install -g continue-cli
-```
-
-## Usage
-
-```bash
-# Always reference AGENTS.md in prompts:
-"Follow @AGENTS.md standards. Implement [feature] with tests (95%+ coverage)."
-
-# Slash commands:
-/edit    # Edit files
-/chat    # Ask questions
-/cmd     # Run terminal commands
-```
-
-## Workflow
-
-1. Open AGENTS.md in editor for Continue to read
-2. Use `/edit` to modify code following standards
-3. Reference AGENTS.md in every request
-4. Run quality checks after changes
-
-**Critical**: Keep AGENTS.md open or reference it explicitly in prompts.
-
-<!-- CONTINUE:END -->
+<!-- CONTINUE:START -->
+# Continue CLI/Extension Rules
+
+**Tool**: Open-source Copilot alternative (VS Code extension + CLI)
+
+## Quick Start
+
+```bash
+# In VS Code: Install Continue extension
+# Or CLI: npm install -g continue-cli
+```
+
+## Usage
+
+```bash
+# Always reference AGENTS.md in prompts:
+"Follow @AGENTS.md standards. Implement [feature] with tests (95%+ coverage)."
+
+# Slash commands:
+/edit    # Edit files
+/chat    # Ask questions
+/cmd     # Run terminal commands
+```
+
+## Workflow
+
+1. Open AGENTS.md in editor for Continue to read
+2. Use `/edit` to modify code following standards
+3. Reference AGENTS.md in every request
+4. Run quality checks after changes
+
+**Critical**: Keep AGENTS.md open or reference it explicitly in prompts.
+
+<!-- CONTINUE:END -->

package/templates/cli/CURSOR_CLI.md

@@ -1,62 +1,62 @@
-<!-- CURSOR_CLI:START -->
-# Cursor CLI Rules
-
-**Tool**: Cursor IDE automation and scripting
-
-## Quick Start
-
-```bash
-# Cursor reads .cursorrules automatically
-# This file is generated by rulebook init
-```
-
-## Usage
-
-Cursor automatically references:
-- `.cursorrules` (generated by rulebook)
-- `AGENTS.md` (via @AGENTS.md references)
-
-## Workflow
-
-1. Use `@AGENTS.md` in chat to reference standards
-2. Check past implementations in memory before starting
-3. Request: "Follow @AGENTS.md. Implement [feature] with tests."
-4. Cursor respects .cursorrules and AGENTS.md automatically
-5. Save implementation learnings to memory
-6. Review and accept changes
-
-**Critical**: Generated `.cursorrules` points to AGENTS.md. Use @ mentions for explicit references.
-
-## Persistent Memory Integration
-
-### Using Memory in Cursor
-When requesting features, include memory context:
-
-```
-@AGENTS.md
-@.rulebook/memory.md (if available)
-
-Search memory for similar implementations and include in your reasoning before implementing.
-Implement [feature]...
-```
-
-### Capturing Implementation Learnings
-After Cursor completes work:
-
-```bash
-# Review auto-captured memories
-rulebook memory search "feature name"
-
-# Augment with additional insights
-rulebook memory save "Implementation approach, patterns discovered, edge cases handled..." --type feature --title "Feature name" --tags relevant,tags
-```
-
-### Memory-Enhanced Development
-Cursor + Memory workflow:
-1. **Search**: Find past implementations with similar patterns
-2. **Reference**: Include relevant memories in prompts for context
-3. **Implement**: Cursor generates code informed by past solutions
-4. **Capture**: Save learnings for future sessions
-5. **Search Again**: Next session finds and leverages the work
-
-<!-- CURSOR_CLI:END -->
+<!-- CURSOR_CLI:START -->
+# Cursor CLI Rules
+
+**Tool**: Cursor IDE automation and scripting
+
+## Quick Start
+
+```bash
+# Cursor reads .cursorrules automatically
+# This file is generated by rulebook init
+```
+
+## Usage
+
+Cursor automatically references:
+- `.cursorrules` (generated by rulebook)
+- `AGENTS.md` (via @AGENTS.md references)
+
+## Workflow
+
+1. Use `@AGENTS.md` in chat to reference standards
+2. Check past implementations in memory before starting
+3. Request: "Follow @AGENTS.md. Implement [feature] with tests."
+4. Cursor respects .cursorrules and AGENTS.md automatically
+5. Save implementation learnings to memory
+6. Review and accept changes
+
+**Critical**: Generated `.cursorrules` points to AGENTS.md. Use @ mentions for explicit references.
+
+## Persistent Memory Integration
+
+### Using Memory in Cursor
+When requesting features, include memory context:
+
+```
+@AGENTS.md
+@.rulebook/memory.md (if available)
+
+Search memory for similar implementations and include in your reasoning before implementing.
+Implement [feature]...
+```
+
+### Capturing Implementation Learnings
+After Cursor completes work:
+
+```bash
+# Review auto-captured memories
+rulebook memory search "feature name"
+
+# Augment with additional insights
+rulebook memory save "Implementation approach, patterns discovered, edge cases handled..." --type feature --title "Feature name" --tags relevant,tags
+```
+
+### Memory-Enhanced Development
+Cursor + Memory workflow:
+1. **Search**: Find past implementations with similar patterns
+2. **Reference**: Include relevant memories in prompts for context
+3. **Implement**: Cursor generates code informed by past solutions
+4. **Capture**: Save learnings for future sessions
+5. **Search Again**: Next session finds and leverages the work
+
+<!-- CURSOR_CLI:END -->

package/templates/cli/FACTORY.md

@@ -1,18 +1,18 @@
-<!-- FACTORY:START -->
-# Factory Droid Rules
-
-**Tool**: Code generation and automation
-
-## Usage
-
-```
-"Follow @AGENTS.md standards. Generate [code] with tests."
-```
-
-## Workflow
-
-1. Reference AGENTS.md in prompts
-2. Review generated code
-3. Run quality checks
-
-<!-- FACTORY:END -->
+<!-- FACTORY:START -->
+# Factory Droid Rules
+
+**Tool**: Code generation and automation
+
+## Usage
+
+```
+"Follow @AGENTS.md standards. Generate [code] with tests."
+```
+
+## Workflow
+
+1. Reference AGENTS.md in prompts
+2. Review generated code
+3. Run quality checks
+
+<!-- FACTORY:END -->

package/templates/cli/GEMINI.md

@@ -1,35 +1,35 @@
-<!-- GEMINI:START -->
-# Gemini CLI Rules
-
-**Tool**: Google Gemini API with 2M token context
-
-## Quick Start
-
-```bash
-# Install gemini CLI
-npm install -g @google/generative-ai-cli
-
-# Set API key
-export GEMINI_API_KEY=your_key
-```
-
-## Usage
-
-```bash
-# Always reference AGENTS.md:
-gemini --prompt "Read @AGENTS.md. Implement [feature] with tests (95%+ coverage)."
-
-# Include files:
-gemini --files AGENTS.md,src/feature.ts
-```
-
-## Workflow
-
-1. Include AGENTS.md in context with `--files AGENTS.md`
-2. Request: "Follow @AGENTS.md. Implement [feature] with tests."
-3. Review output
-4. Run quality checks: `npm run lint && npm test`
-
-**Critical**: Reference @AGENTS.md for consistent code generation.
-
-<!-- GEMINI:END -->
+<!-- GEMINI:START -->
+# Gemini CLI Rules
+
+**Tool**: Google Gemini API with 2M token context
+
+## Quick Start
+
+```bash
+# Install gemini CLI
+npm install -g @google/generative-ai-cli
+
+# Set API key
+export GEMINI_API_KEY=your_key
+```
+
+## Usage
+
+```bash
+# Always reference AGENTS.md:
+gemini --prompt "Read @AGENTS.md. Implement [feature] with tests (95%+ coverage)."
+
+# Include files:
+gemini --files AGENTS.md,src/feature.ts
+```
+
+## Workflow
+
+1. Include AGENTS.md in context with `--files AGENTS.md`
+2. Request: "Follow @AGENTS.md. Implement [feature] with tests."
+3. Review output
+4. Run quality checks: `npm run lint && npm test`
+
+**Critical**: Reference @AGENTS.md for consistent code generation.
+
+<!-- GEMINI:END -->

package/templates/cli/KILOCODE.md

@@ -1,18 +1,18 @@
-<!-- KILOCODE:START -->
-# Kilo Code Rules
-
-**Tool**: Lightweight coding companion
-
-## Usage
-
-```
-"Follow @AGENTS.md. Implement [feature] with tests."
-```
-
-## Workflow
-
-1. Reference AGENTS.md
-2. Review code
-3. Run quality checks
-
-<!-- KILOCODE:END -->
+<!-- KILOCODE:START -->
+# Kilo Code Rules
+
+**Tool**: Lightweight coding companion
+
+## Usage
+
+```
+"Follow @AGENTS.md. Implement [feature] with tests."
+```
+
+## Workflow
+
+1. Reference AGENTS.md
+2. Review code
+3. Run quality checks
+
+<!-- KILOCODE:END -->

package/templates/cli/OPENCODE.md

@@ -1,18 +1,85 @@
-<!-- OPENCODE:START -->
-# OpenCode Rules
-
-**Tool**: Open-source AI assistant
-
-## Usage
-
-```
-"Follow @AGENTS.md. Implement [feature] with tests."
-```
-
-## Workflow
-
-1. Reference AGENTS.md
-2. Review code
-3. Run quality checks
-
-<!-- OPENCODE:END -->
+<!-- OPENCODE:START -->
+# OpenCode Rules
+
+**Tool**: [OpenCode](https://opencode.ai) — open-source terminal coding agent (SST).
+
+OpenCode reads `AGENTS.md` natively (with `CLAUDE.md` as fallback). When
+Rulebook is initialized in this project, OpenCode also gets:
+
+- `opencode.json` — declares the rulebook MCP server and lazy-loads the
+  project rule files via the `instructions` array.
+- `.opencode/commands/` — mirrors Rulebook's user-invocable slash commands
+  (`/handoff`, `/rulebook-task-*`, `/rulebook-decision-*`,
+  `/rulebook-knowledge-*`, `/rulebook-memory-*`, `/rulebook-learn-*`).
+- `.opencode/agents/` — mirrors role agents (`researcher`, `implementer`,
+  `tester`, `code-reviewer`, `architect`, etc.) translated to OpenCode's
+  frontmatter schema (`mode`, `model`, `permission`).
+- `.opencode/skills/` — mirrors the dev skill library normalized to
+  OpenCode's strict skill-name regex.
+
+## Quick Start
+
+```bash
+# Install OpenCode
+curl -fsSL https://opencode.ai/install | bash
+
+# In a Rulebook-managed project, OpenCode picks up everything automatically:
+opencode
+```
+
+## Workflow
+
+1. **Reference rules** — `AGENTS.md`, `AGENTS.override.md`, and
+   `.rulebook/specs/*.md` are wired into `instructions` so the model
+   has them on demand without burning context.
+2. **Use slash commands** — type `/rulebook-task-create`,
+   `/rulebook-task-list`, `/handoff`, etc. They're real OpenCode
+   commands, not just prompt text.
+3. **Delegate to role agents** — `@researcher analyze X`,
+   `@implementer add Y`, `@tester cover Z`. Each role has its own
+   `model`, `permission`, and `description` matching the Rulebook
+   delegation table.
+4. **Quality checks** — type-check / lint / test before committing,
+   per `AGENTS.md` quality-gate rules.
+5. **Save learnings** — `rulebook memory save`, `rulebook knowledge add`,
+   `rulebook learn capture`, or invoke the corresponding slash commands.
+
+## Sequential editing
+
+OpenCode is held to the same Rulebook discipline as Claude Code:
+
+- Edit files **one at a time** (Read → Edit → Read → Edit), not in batch.
+- For 3+ files across subsystems, decompose into 1–2 file sub-tasks.
+- Run diagnostics (type-check / lint) **before** the test suite.
+
+## MCP & token usage
+
+The `mcp.rulebook` entry in `opencode.json` exposes the full Rulebook
+MCP toolset (`rulebook_task_*`, `rulebook_memory_*`, `rulebook_decision_*`,
+`rulebook_knowledge_*`, etc.). Prefer MCP tools over shell commands when
+both exist — they're faster, structured, and don't pollute context.
+
+Output discipline: prefer concise output. Don't generate "Quality Checks"
+status tables, "Next Steps" sections, or restate the question. Put
+implementation details in code comments, not markdown.
+
+## Isolation from Claude Code
+
+OpenCode falls back to `CLAUDE.md` if `AGENTS.md` is absent. To force
+OpenCode to ignore a `CLAUDE.md` shared with Claude Code, set:
+
+```bash
+export OPENCODE_DISABLE_CLAUDE_CODE=*
+```
+
+## Documentation
+
+- [opencode.ai/docs/rules](https://opencode.ai/docs/rules/)
+- [opencode.ai/docs/config](https://opencode.ai/docs/config/)
+- [opencode.ai/docs/mcp-servers](https://opencode.ai/docs/mcp-servers/)
+- [opencode.ai/docs/commands](https://opencode.ai/docs/commands/)
+- [opencode.ai/docs/agents](https://opencode.ai/docs/agents/)
+- [opencode.ai/docs/skills](https://opencode.ai/docs/skills/)
+- [opencode.ai/docs/permissions](https://opencode.ai/docs/permissions/)
+
+<!-- OPENCODE:END -->

package/templates/cli/_GENERIC_TEMPLATE.md

@@ -1,29 +1,29 @@
-<!-- {TOOL}:START -->
-# {Tool Name} CLI Rules
-
-**Tool**: {Brief description}
-
-## Quick Start
-
-```bash
-{installation command}
-```
-
-## Usage
-
-Always reference AGENTS.md in prompts:
-```
-"Follow @AGENTS.md standards. Implement [feature] with tests first (95%+ coverage)."
-```
-
-## Workflow
-
-1. Include AGENTS.md in context (tool-specific method)
-2. Request features with "@AGENTS.md" reference
-3. Review generated code
-4. Run quality checks: `npm run lint && npm test`
-
-**Critical**: Reference AGENTS.md for consistent standards.
-
-<!-- {TOOL}:END -->
-
+<!-- {TOOL}:START -->
+# {Tool Name} CLI Rules
+
+**Tool**: {Brief description}
+
+## Quick Start
+
+```bash
+{installation command}
+```
+
+## Usage
+
+Always reference AGENTS.md in prompts:
+```
+"Follow @AGENTS.md standards. Implement [feature] with tests first (95%+ coverage)."
+```
+
+## Workflow
+
+1. Include AGENTS.md in context (tool-specific method)
+2. Request features with "@AGENTS.md" reference
+3. Review generated code
+4. Run quality checks: `npm run lint && npm test`
+
+**Critical**: Reference AGENTS.md for consistent standards.
+
+<!-- {TOOL}:END -->
+

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

@@ -1,55 +1,55 @@
----
-name: /rulebook-decision-create
-id: rulebook-decision-create
-category: Rulebook
-description: Create a new Architecture Decision Record (ADR) with auto-numbering and memory integration.
----
-<!-- 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.
-- Decisions are stored in `.rulebook/decisions/` as numbered Markdown files with metadata sidecars.
-
-**Steps**
-1. **Understand the Decision**: Ask the user what architectural/technical decision needs to be recorded. Gather:
-   - **Title**: Short, descriptive name (e.g., "Use PostgreSQL for Primary Database")
-   - **Context**: Why this decision is needed — constraints, requirements, trade-offs
-   - **Decision**: What was decided
-   - **Alternatives**: What other options were considered and why they were rejected
-   - **Consequences**: What follows from this decision (positive and negative)
-   - **Related Tasks**: Any task IDs this decision relates to
-
-2. **Check Existing Decisions**:
-   ```bash
-   rulebook decision list
-   ```
-   Verify no duplicate or conflicting decision exists.
-
-3. **Create the Decision**:
-   ```bash
-   rulebook decision create "<title>" --context "<context>" --related-task <task-id>
-   ```
-   The system auto-numbers the decision (e.g., ADR-001, ADR-002).
-
-4. **Enrich the Decision File**: Open the generated `.rulebook/decisions/NNN-<slug>.md` and fill in:
-   - Context section with full background
-   - Decision section with the chosen approach
-   - Alternatives Considered with reasoning for each rejected option
-   - Consequences with both positive and negative outcomes
-
-5. **Update Status** (if immediately accepted):
-   ```bash
-   # Via MCP tool or direct metadata edit
-   ```
-
-6. **Verify**:
-   ```bash
-   rulebook decision show <id>
-   ```
-
-**Reference**
-- Decisions use 4 statuses: `proposed` → `accepted` → `superseded` | `deprecated`
-- Use `rulebook decision supersede <oldId> <newId>` to replace a decision
-- Decisions are auto-injected into AGENTS.md on `rulebook update`
-- See `/.rulebook/specs/DECISIONS.md` for format documentation
-<!-- RULEBOOK:END -->
+---
+name: /rulebook-decision-create
+id: rulebook-decision-create
+category: Rulebook
+description: Create a new Architecture Decision Record (ADR) with auto-numbering and memory integration.
+---
+<!-- 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.
+- Decisions are stored in `.rulebook/decisions/` as numbered Markdown files with metadata sidecars.
+
+**Steps**
+1. **Understand the Decision**: Ask the user what architectural/technical decision needs to be recorded. Gather:
+   - **Title**: Short, descriptive name (e.g., "Use PostgreSQL for Primary Database")
+   - **Context**: Why this decision is needed — constraints, requirements, trade-offs
+   - **Decision**: What was decided
+   - **Alternatives**: What other options were considered and why they were rejected
+   - **Consequences**: What follows from this decision (positive and negative)
+   - **Related Tasks**: Any task IDs this decision relates to
+
+2. **Check Existing Decisions**:
+   ```bash
+   rulebook decision list
+   ```
+   Verify no duplicate or conflicting decision exists.
+
+3. **Create the Decision**:
+   ```bash
+   rulebook decision create "<title>" --context "<context>" --related-task <task-id>
+   ```
+   The system auto-numbers the decision (e.g., ADR-001, ADR-002).
+
+4. **Enrich the Decision File**: Open the generated `.rulebook/decisions/NNN-<slug>.md` and fill in:
+   - Context section with full background
+   - Decision section with the chosen approach
+   - Alternatives Considered with reasoning for each rejected option
+   - Consequences with both positive and negative outcomes
+
+5. **Update Status** (if immediately accepted):
+   ```bash
+   # Via MCP tool or direct metadata edit
+   ```
+
+6. **Verify**:
+   ```bash
+   rulebook decision show <id>
+   ```
+
+**Reference**
+- Decisions use 4 statuses: `proposed` → `accepted` → `superseded` | `deprecated`
+- Use `rulebook decision supersede <oldId> <newId>` to replace a decision
+- Decisions are auto-injected into AGENTS.md on `rulebook update`
+- See `/.rulebook/specs/DECISIONS.md` for format documentation
+<!-- RULEBOOK:END -->

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

@@ -1,15 +1,15 @@
----
-name: /rulebook-decision-list
-id: rulebook-decision-list
-category: Rulebook
-description: List all Architecture Decision Records with optional status filter.
----
-<!-- RULEBOOK:START -->
-**Steps**
-1. Run `rulebook decision list` to see all decisions.
-2. Optionally filter: `rulebook decision list --status accepted`
-3. Present results to the user with ID, title, and status.
-4. If the user wants details on a specific decision, run `rulebook decision show <id>`.
-
-**Status Values**: proposed, accepted, superseded, deprecated
-<!-- RULEBOOK:END -->
+---
+name: /rulebook-decision-list
+id: rulebook-decision-list
+category: Rulebook
+description: List all Architecture Decision Records with optional status filter.
+---
+<!-- RULEBOOK:START -->
+**Steps**
+1. Run `rulebook decision list` to see all decisions.
+2. Optionally filter: `rulebook decision list --status accepted`
+3. Present results to the user with ID, title, and status.
+4. If the user wants details on a specific decision, run `rulebook decision show <id>`.
+
+**Status Values**: proposed, accepted, superseded, deprecated
+<!-- RULEBOOK:END -->