@hivehub/rulebook 4.0.0 → 4.2.0

package/templates/ides/CONTINUE_RULES.md

@@ -1,16 +1,16 @@
-<!-- RULEBOOK:START -->
-# Continue.dev — Code Assistant Rules
-
-## Context Loading
-- Always read AGENTS.md before making changes
-- Check `.rulebook/specs/` for relevant spec files
-
-## Code Standards
-- Match existing code style and conventions
-- Prefer editing existing files over creating new ones
-- Add types for all new parameters and return values
-
-## Testing
-- Write tests for every new function
-- Run existing tests after changes to verify no regressions
-<!-- RULEBOOK:END -->
+<!-- RULEBOOK:START -->
+# Continue.dev — Code Assistant Rules
+
+## Context Loading
+- Always read AGENTS.md before making changes
+- Check `.rulebook/specs/` for relevant spec files
+
+## Code Standards
+- Match existing code style and conventions
+- Prefer editing existing files over creating new ones
+- Add types for all new parameters and return values
+
+## Testing
+- Write tests for every new function
+- Run existing tests after changes to verify no regressions
+<!-- RULEBOOK:END -->

package/templates/ides/COPILOT.md

@@ -1,37 +1,37 @@
-<!-- COPILOT:START -->
-# GitHub Copilot Rules
-
-**Tool**: GitHub's AI pair programmer (inline + chat)
-
-## Quick Start
-
-Copilot reads:
-- `.github/copilot-instructions.md` (generated by `rulebook init`)
-- Workspace context (open files)
-
-## Usage
-
-```bash
-# In Copilot Chat:
-"Follow @AGENTS.md. Implement [feature] with tests (95%+ coverage)."
-
-# Inline suggestions:
-Accept/reject based on AGENTS.md standards
-```
-
-## Modes
-
-**Inline Completions**: Context-aware suggestions while typing
-**Copilot Chat**: Ask questions, request implementations
-**Workspace Agent** (Labs): Multi-file autonomous mode
-
-## Workflow
-
-1. Rulebook generates `.github/copilot-instructions.md` → references AGENTS.md
-2. Keep AGENTS.md open for context
-3. Use `@workspace` to include project context
-4. Reference `@AGENTS.md` explicitly in chat
-
-**Critical**: Generated `copilot-instructions.md` points Copilot to AGENTS.md standards.
-
-<!-- COPILOT:END -->
+<!-- COPILOT:START -->
+# GitHub Copilot Rules
+
+**Tool**: GitHub's AI pair programmer (inline + chat)
+
+## Quick Start
+
+Copilot reads:
+- `.github/copilot-instructions.md` (generated by `rulebook init`)
+- Workspace context (open files)
+
+## Usage
+
+```bash
+# In Copilot Chat:
+"Follow @AGENTS.md. Implement [feature] with tests (95%+ coverage)."
+
+# Inline suggestions:
+Accept/reject based on AGENTS.md standards
+```
+
+## Modes
+
+**Inline Completions**: Context-aware suggestions while typing
+**Copilot Chat**: Ask questions, request implementations
+**Workspace Agent** (Labs): Multi-file autonomous mode
+
+## Workflow
+
+1. Rulebook generates `.github/copilot-instructions.md` → references AGENTS.md
+2. Keep AGENTS.md open for context
+3. Use `@workspace` to include project context
+4. Reference `@AGENTS.md` explicitly in chat
+
+**Critical**: Generated `copilot-instructions.md` points Copilot to AGENTS.md standards.
+
+<!-- COPILOT:END -->

package/templates/ides/COPILOT_INSTRUCTIONS.md

@@ -1,23 +1,23 @@
-<!-- RULEBOOK:START -->
-# GitHub Copilot — Project Instructions
-
-## Code Style
-- Use TypeScript with strict mode
-- Follow existing naming conventions (camelCase functions, PascalCase classes)
-- Prefer `async/await` over callbacks or raw Promises
-
-## Architecture
-- Follow the module structure described in AGENTS.md
-- Keep functions small and focused (single responsibility)
-- Use dependency injection over direct imports where possible
-
-## Testing
-- Write Vitest tests for all new functions
-- Place tests in `tests/` directory, not alongside source files
-- Mock external dependencies in unit tests
-
-## Security
-- Never commit credentials or API keys
-- Validate all external input at system boundaries
-- Follow OWASP top 10 guidelines
-<!-- RULEBOOK:END -->
+<!-- RULEBOOK:START -->
+# GitHub Copilot — Project Instructions
+
+## Code Style
+- Use TypeScript with strict mode
+- Follow existing naming conventions (camelCase functions, PascalCase classes)
+- Prefer `async/await` over callbacks or raw Promises
+
+## Architecture
+- Follow the module structure described in AGENTS.md
+- Keep functions small and focused (single responsibility)
+- Use dependency injection over direct imports where possible
+
+## Testing
+- Write Vitest tests for all new functions
+- Place tests in `tests/` directory, not alongside source files
+- Mock external dependencies in unit tests
+
+## Security
+- Never commit credentials or API keys
+- Validate all external input at system boundaries
+- Follow OWASP top 10 guidelines
+<!-- RULEBOOK:END -->

package/templates/ides/CURSOR.md

@@ -1,43 +1,43 @@
-<!-- CURSOR:START -->
-# Cursor IDE Rules
-
-**IDE**: AI-first code editor with Agent mode and Composer
-
-## Quick Start
-
-Cursor automatically reads:
-- `.cursorrules` (generated by `rulebook init`)
-- `AGENTS.md` (via `@AGENTS.md` references)
-
-## Usage
-
-```bash
-# In Cursor chat/composer:
-"Follow @AGENTS.md. Implement [feature] with tests (95%+ coverage)."
-
-# Agent mode (Ctrl+Shift+K):
-Use for complex multi-file changes
-Reference @AGENTS.md for standards
-
-# Composer (Cmd+I):
-Use for quick edits
-Reference @AGENTS.md when needed
-```
-
-## Features
-
-- **Auto-context**: Reads .cursorrules automatically
-- **@ Mentions**: Use `@AGENTS.md` to include standards
-- **Agent Mode**: Autonomous multi-step implementations
-- **Composer**: Quick inline edits
-
-## Workflow
-
-1. Rulebook generates `.cursorrules` pointing to AGENTS.md
-2. Use `@AGENTS.md` in prompts for explicit reference
-3. Agent/Composer follows standards automatically
-4. Review changes and run quality checks
-
-**Critical**: `.cursorrules` ensures Cursor follows AGENTS.md by default.
-
-<!-- CURSOR:END -->
+<!-- CURSOR:START -->
+# Cursor IDE Rules
+
+**IDE**: AI-first code editor with Agent mode and Composer
+
+## Quick Start
+
+Cursor automatically reads:
+- `.cursorrules` (generated by `rulebook init`)
+- `AGENTS.md` (via `@AGENTS.md` references)
+
+## Usage
+
+```bash
+# In Cursor chat/composer:
+"Follow @AGENTS.md. Implement [feature] with tests (95%+ coverage)."
+
+# Agent mode (Ctrl+Shift+K):
+Use for complex multi-file changes
+Reference @AGENTS.md for standards
+
+# Composer (Cmd+I):
+Use for quick edits
+Reference @AGENTS.md when needed
+```
+
+## Features
+
+- **Auto-context**: Reads .cursorrules automatically
+- **@ Mentions**: Use `@AGENTS.md` to include standards
+- **Agent Mode**: Autonomous multi-step implementations
+- **Composer**: Quick inline edits
+
+## Workflow
+
+1. Rulebook generates `.cursorrules` pointing to AGENTS.md
+2. Use `@AGENTS.md` in prompts for explicit reference
+3. Agent/Composer follows standards automatically
+4. Review changes and run quality checks
+
+**Critical**: `.cursorrules` ensures Cursor follows AGENTS.md by default.
+
+<!-- CURSOR:END -->

package/templates/ides/GEMINI_RULES.md

@@ -1,17 +1,17 @@
-<!-- RULEBOOK:START -->
-# Gemini CLI — Project Directives
-
-## Code Generation Rules
-- Generate TypeScript with strict mode enabled
-- Follow existing file and function naming conventions
-- Always add error handling for async operations
-- Generate tests alongside implementation code
-
-## Quality Standards
-- All code must pass TypeScript type-check
-- All code must pass ESLint without warnings
-- Test coverage must meet project thresholds
-
-## Project Context
-See AGENTS.md for full project architecture and team conventions.
-<!-- RULEBOOK:END -->
+<!-- RULEBOOK:START -->
+# Gemini CLI — Project Directives
+
+## Code Generation Rules
+- Generate TypeScript with strict mode enabled
+- Follow existing file and function naming conventions
+- Always add error handling for async operations
+- Generate tests alongside implementation code
+
+## Quality Standards
+- All code must pass TypeScript type-check
+- All code must pass ESLint without warnings
+- Test coverage must meet project thresholds
+
+## Project Context
+See AGENTS.md for full project architecture and team conventions.
+<!-- RULEBOOK:END -->

package/templates/ides/JETBRAINS_AI.md

@@ -1,35 +1,35 @@
-<!-- JETBRAINS_AI:START -->
-# JetBrains AI Assistant Rules
-
-**IDEs**: IntelliJ, PyCharm, WebStorm, GoLand, RustRover, Rider, CLion, PhpStorm
-
-## Quick Start
-
-JetBrains AI reads workspace files automatically.
-
-## Usage
-
-```bash
-# In AI Assistant chat:
-"Follow @AGENTS.md. Implement [feature] with tests (95%+ coverage)."
-
-# Keep AGENTS.md open for AI to reference
-```
-
-## Features
-
-- **AI Chat**: Full conversation mode
-- **Inline Suggestions**: Context-aware completions
-- **Refactoring**: AI-powered code improvements
-- **Test Generation**: Automated test creation
-
-## Workflow
-
-1. Keep AGENTS.md open in editor
-2. Use AI Chat with "@AGENTS.md" references
-3. Review suggested changes
-4. Run IDE quality checks (built-in linters, tests)
-
-**Critical**: Keep AGENTS.md open for AI Assistant to include standards in context.
-
-<!-- JETBRAINS_AI:END -->
+<!-- JETBRAINS_AI:START -->
+# JetBrains AI Assistant Rules
+
+**IDEs**: IntelliJ, PyCharm, WebStorm, GoLand, RustRover, Rider, CLion, PhpStorm
+
+## Quick Start
+
+JetBrains AI reads workspace files automatically.
+
+## Usage
+
+```bash
+# In AI Assistant chat:
+"Follow @AGENTS.md. Implement [feature] with tests (95%+ coverage)."
+
+# Keep AGENTS.md open for AI to reference
+```
+
+## Features
+
+- **AI Chat**: Full conversation mode
+- **Inline Suggestions**: Context-aware completions
+- **Refactoring**: AI-powered code improvements
+- **Test Generation**: Automated test creation
+
+## Workflow
+
+1. Keep AGENTS.md open in editor
+2. Use AI Chat with "@AGENTS.md" references
+3. Review suggested changes
+4. Run IDE quality checks (built-in linters, tests)
+
+**Critical**: Keep AGENTS.md open for AI Assistant to include standards in context.
+
+<!-- JETBRAINS_AI:END -->

package/templates/ides/REPLIT.md

@@ -1,36 +1,36 @@
-<!-- REPLIT:START -->
-# Replit IDE Rules
-
-**Tool**: Cloud IDE with Ghostwriter AI
-
-## Quick Start
-
-Replit Ghostwriter reads workspace files automatically.
-
-## Usage
-
-```bash
-# In Ghostwriter chat:
-"Follow @AGENTS.md. Implement [feature] with tests."
-
-# Inline completions:
-Accept/reject based on AGENTS.md standards
-```
-
-## Features
-
-- **Ghostwriter Chat**: AI assistant
-- **Inline Completions**: Code suggestions
-- **Explain Code**: AI explanations
-- **Generate Code**: Full implementations
-
-## Workflow
-
-1. Keep AGENTS.md in workspace (Ghostwriter reads it)
-2. Reference `@AGENTS.md` in chat
-3. Review suggestions
-4. Run tests in Replit console
-
-**Critical**: Ghostwriter has workspace context - AGENTS.md is automatically available.
-
-<!-- REPLIT:END -->
+<!-- REPLIT:START -->
+# Replit IDE Rules
+
+**Tool**: Cloud IDE with Ghostwriter AI
+
+## Quick Start
+
+Replit Ghostwriter reads workspace files automatically.
+
+## Usage
+
+```bash
+# In Ghostwriter chat:
+"Follow @AGENTS.md. Implement [feature] with tests."
+
+# Inline completions:
+Accept/reject based on AGENTS.md standards
+```
+
+## Features
+
+- **Ghostwriter Chat**: AI assistant
+- **Inline Completions**: Code suggestions
+- **Explain Code**: AI explanations
+- **Generate Code**: Full implementations
+
+## Workflow
+
+1. Keep AGENTS.md in workspace (Ghostwriter reads it)
+2. Reference `@AGENTS.md` in chat
+3. Review suggestions
+4. Run tests in Replit console
+
+**Critical**: Ghostwriter has workspace context - AGENTS.md is automatically available.
+
+<!-- REPLIT:END -->

package/templates/ides/TABNINE.md

@@ -1,29 +1,29 @@
-<!-- TABNINE:START -->
-# Tabnine AI Rules
-
-**Tool**: Multi-IDE AI completion with team learning
-
-## Quick Start
-
-Works in: VS Code, JetBrains, Vim, Sublime, Atom, Emacs
-
-## Usage
-
-Tabnine learns from your codebase automatically. Keep AGENTS.md in workspace for team learning.
-
-## Features
-
-- **Inline Completions**: AI-powered code suggestions
-- **Team Learning**: Learns from team patterns
-- **Multi-IDE**: Consistent across all editors
-
-## Workflow
-
-1. Keep AGENTS.md in project root
-2. Tabnine learns standards from codebase
-3. Accept/reject suggestions based on AGENTS.md patterns
-4. Team model improves over time
-
-**Critical**: Tabnine learns from existing code - maintain AGENTS.md standards in all files.
-
-<!-- TABNINE:END -->
+<!-- TABNINE:START -->
+# Tabnine AI Rules
+
+**Tool**: Multi-IDE AI completion with team learning
+
+## Quick Start
+
+Works in: VS Code, JetBrains, Vim, Sublime, Atom, Emacs
+
+## Usage
+
+Tabnine learns from your codebase automatically. Keep AGENTS.md in workspace for team learning.
+
+## Features
+
+- **Inline Completions**: AI-powered code suggestions
+- **Team Learning**: Learns from team patterns
+- **Multi-IDE**: Consistent across all editors
+
+## Workflow
+
+1. Keep AGENTS.md in project root
+2. Tabnine learns standards from codebase
+3. Accept/reject suggestions based on AGENTS.md patterns
+4. Team model improves over time
+
+**Critical**: Tabnine learns from existing code - maintain AGENTS.md standards in all files.
+
+<!-- TABNINE:END -->

package/templates/ides/VSCODE.md

@@ -1,40 +1,40 @@
-<!-- VSCODE:START -->
-# VS Code AI Extensions Rules
-
-**IDE**: VS Code with Copilot, Cody, Continue, or other AI extensions
-
-## Quick Start
-
-VS Code reads:
-- `.vscode/settings.json` (generated by `rulebook init`)
-- `.vscode/copilot-instructions.md` (if Copilot enabled)
-
-## Usage
-
-```bash
-# In any AI chat/extension:
-"Follow @AGENTS.md. Implement [feature] with tests (95%+ coverage)."
-
-# Keep AGENTS.md open for context
-# Extensions will reference it automatically
-```
-
-## Supported Extensions
-
-- GitHub Copilot
-- Cody
-- Continue
-- Codeium
-- Tabnine
-- Amazon Q
-
-## Workflow
-
-1. Rulebook generates `.vscode/settings.json` and `copilot-instructions.md`
-2. Keep AGENTS.md open in workspace
-3. Reference `@AGENTS.md` in extension prompts
-4. Extensions read workspace context automatically
-
-**Critical**: Generated settings point extensions to AGENTS.md standards.
-
-<!-- VSCODE:END -->
+<!-- VSCODE:START -->
+# VS Code AI Extensions Rules
+
+**IDE**: VS Code with Copilot, Cody, Continue, or other AI extensions
+
+## Quick Start
+
+VS Code reads:
+- `.vscode/settings.json` (generated by `rulebook init`)
+- `.vscode/copilot-instructions.md` (if Copilot enabled)
+
+## Usage
+
+```bash
+# In any AI chat/extension:
+"Follow @AGENTS.md. Implement [feature] with tests (95%+ coverage)."
+
+# Keep AGENTS.md open for context
+# Extensions will reference it automatically
+```
+
+## Supported Extensions
+
+- GitHub Copilot
+- Cody
+- Continue
+- Codeium
+- Tabnine
+- Amazon Q
+
+## Workflow
+
+1. Rulebook generates `.vscode/settings.json` and `copilot-instructions.md`
+2. Keep AGENTS.md open in workspace
+3. Reference `@AGENTS.md` in extension prompts
+4. Extensions read workspace context automatically
+
+**Critical**: Generated settings point extensions to AGENTS.md standards.
+
+<!-- VSCODE:END -->

package/templates/ides/WINDSURF.md

@@ -1,36 +1,36 @@
-<!-- WINDSURF:START -->
-# Windsurf IDE Rules
-
-**IDE**: AI-powered editor with Cascade AI and Flow State
-
-## Quick Start
-
-Windsurf reads:
-- `.windsurfrules` (generated by `rulebook init`)
-- AGENTS.md (when open in workspace)
-
-## Usage
-
-```bash
-# In Windsurf chat:
-"Follow @AGENTS.md. Implement [feature] with tests."
-
-# Cascade AI:
-Multi-file autonomous mode
-Reference @AGENTS.md for standards
-
-# Flow State:
-Inline suggestions
-Context-aware completions
-```
-
-## Workflow
-
-1. Rulebook generates `.windsurfrules` → points to AGENTS.md
-2. Keep AGENTS.md open in workspace
-3. Use Cascade for complex tasks with `@AGENTS.md` references
-4. Flow State provides inline suggestions
-
-**Critical**: `.windsurfrules` ensures standards are followed automatically.
-
-<!-- WINDSURF:END -->
+<!-- WINDSURF:START -->
+# Windsurf IDE Rules
+
+**IDE**: AI-powered editor with Cascade AI and Flow State
+
+## Quick Start
+
+Windsurf reads:
+- `.windsurfrules` (generated by `rulebook init`)
+- AGENTS.md (when open in workspace)
+
+## Usage
+
+```bash
+# In Windsurf chat:
+"Follow @AGENTS.md. Implement [feature] with tests."
+
+# Cascade AI:
+Multi-file autonomous mode
+Reference @AGENTS.md for standards
+
+# Flow State:
+Inline suggestions
+Context-aware completions
+```
+
+## Workflow
+
+1. Rulebook generates `.windsurfrules` → points to AGENTS.md
+2. Keep AGENTS.md open in workspace
+3. Use Cascade for complex tasks with `@AGENTS.md` references
+4. Flow State provides inline suggestions
+
+**Critical**: `.windsurfrules` ensures standards are followed automatically.
+
+<!-- WINDSURF:END -->

package/templates/ides/WINDSURF_RULES.md

@@ -1,14 +1,14 @@
-<!-- RULEBOOK:START -->
-# Windsurf — Project Rules
-
-You are an AI assistant for this project. Follow these rules:
-
-1. Read AGENTS.md for full project context before starting any task
-2. Never create files in the root unless explicitly asked
-3. All TypeScript must be strict-mode compatible
-4. Write tests for new functionality
-5. Run quality checks before marking work complete
-
-## Project Structure
-Follow the existing directory structure. See AGENTS.md for details.
-<!-- RULEBOOK:END -->
+<!-- RULEBOOK:START -->
+# Windsurf — Project Rules
+
+You are an AI assistant for this project. Follow these rules:
+
+1. Read AGENTS.md for full project context before starting any task
+2. Never create files in the root unless explicitly asked
+3. All TypeScript must be strict-mode compatible
+4. Write tests for new functionality
+5. Run quality checks before marking work complete
+
+## Project Structure
+Follow the existing directory structure. See AGENTS.md for details.
+<!-- RULEBOOK:END -->