@hivehub/rulebook 5.8.2 → 6.0.0

package/templates/cli/OPENCODE.md

@@ -1,85 +0,0 @@
-<!-- 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/gemini-extension.json

@@ -1,77 +0,0 @@
-{
-  "$schema": "https://ai.google.dev/schemas/gemini-extension.json",
-  "name": "rulebook",
-  "displayName": "Rulebook Project Standards",
-  "version": "2.0.0",
-  "description": "Standardize AI-generated projects with skills, templates, and quality gates",
-  "author": "HiveLLM",
-  "license": "Apache-2.0",
-  "capabilities": {
-    "codeGeneration": true,
-    "taskManagement": true,
-    "projectValidation": true,
-    "skillsSystem": true
-  },
-  "commands": {
-    "init": {
-      "description": "Initialize rulebook for current project",
-      "command": "rulebook init --yes"
-    },
-    "update": {
-      "description": "Update project rules to latest version",
-      "command": "rulebook update --yes"
-    },
-    "validate": {
-      "description": "Validate project structure",
-      "command": "rulebook validate"
-    },
-    "health": {
-      "description": "Check project health score",
-      "command": "rulebook health"
-    },
-    "fix": {
-      "description": "Auto-fix common issues",
-      "command": "rulebook fix"
-    },
-    "skill-list": {
-      "description": "List available skills",
-      "command": "rulebook skill list"
-    },
-    "skill-add": {
-      "description": "Add a skill",
-      "command": "rulebook skill add"
-    },
-    "task-create": {
-      "description": "Create a new task",
-      "command": "rulebook task create"
-    },
-    "task-list": {
-      "description": "List all tasks",
-      "command": "rulebook task list"
-    }
-  },
-  "files": {
-    "instructions": "GEMINI.md",
-    "agents": "AGENTS.md",
-    "config": ".rulebook",
-    "rules": "rulebook/"
-  },
-  "integration": {
-    "type": "cli",
-    "install": "npm install -g @hivehub/rulebook",
-    "mcp": {
-      "enabled": true,
-      "server": "rulebook-mcp"
-    }
-  },
-  "skills": {
-    "enabled": true,
-    "categories": [
-      "languages",
-      "frameworks",
-      "modules",
-      "services",
-      "core"
-    ]
-  }
-}

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

@@ -1,48 +0,0 @@
----
-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 +0,0 @@
----
-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/ides/CONTINUE_RULES.md

@@ -1,16 +0,0 @@
-<!-- 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_INSTRUCTIONS.md

@@ -1,23 +0,0 @@
-<!-- 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/GEMINI_RULES.md

@@ -1,17 +0,0 @@
-<!-- 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/OPENCODE.md

@@ -1,63 +0,0 @@
-<!-- OPENCODE:START -->
-# OpenCode Integration
-
-This project is managed by [@hivellm/rulebook](https://github.com/hivellm/rulebook).
-The OpenCode integration mirrors the Claude Code experience inside the
-[OpenCode](https://opencode.ai) terminal coding agent.
-
-## What Rulebook generates for OpenCode
-
-| File / Path | Purpose |
-|---|---|
-| `opencode.json` | Adds `$schema`, `mcp.rulebook`, and `instructions` (lazy-loads `AGENTS.md`, `AGENTS.override.md`, `.rulebook/specs/*.md`). Preserves all user-defined keys. |
-| `.opencode/commands/<name>.md` | One file per user-invocable Rulebook slash command. |
-| `.opencode/agents/<role>.md` | One file per Rulebook role agent, frontmatter translated. |
-| `.opencode/skills/<name>/SKILL.md` | One directory per Rulebook dev skill, name-normalized to OpenCode's regex. |
-| `.opencode/.rulebook-managed.json` | Sidecar so `rulebook update` knows which keys to refresh. |
-
-## Critical rules
-
-These mirror the rules every other Rulebook-supported tool follows:
-
-1. **Read `AGENTS.md` and `AGENTS.override.md`** before making changes.
-2. **Never revert or discard uncommitted work** — fix forward.
-3. **Edit files sequentially**, not in parallel. For 3+ files, decompose
-   into 1–2 file sub-tasks.
-4. **Run type-check / lint before tests** — diagnostic-first.
-5. **If a fix fails twice, escalate** — research, ask, or open a team.
-6. **Prefer MCP tools** (`mcp__rulebook__*`) over shell commands.
-7. **Capture learnings** at the end of significant work.
-8. **Never archive a task** without docs updated, tests written, and
-   tests passing.
-
-## Model tier mapping
-
-| Rulebook tier | OpenCode model |
-|---|---|
-| `haiku` | `anthropic/claude-haiku-4-5` |
-| `sonnet` | `anthropic/claude-sonnet-4-6` |
-| `opus` | `anthropic/claude-opus-4-7` |
-
-## Permission synthesis
-
-| Role type | `permission.edit` | `permission.bash` |
-|---|---|---|
-| Read-only (researcher, code-reviewer, security-reviewer, accessibility-reviewer, ux-reviewer, performance-engineer) | `deny` | `ask` |
-| All other roles | `allow` | `allow` |
-
-## Isolation
-
-Set `OPENCODE_DISABLE_CLAUDE_CODE=*` if you want OpenCode to ignore a
-`CLAUDE.md` shared with Claude Code, so only `AGENTS.md` is consulted.
-
-## 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/ides/WINDSURF_RULES.md

@@ -1,14 +0,0 @@
-<!-- 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 -->

package/templates/modules/ATLASSIAN.md

@@ -1,255 +0,0 @@
-<!-- ATLASSIAN:START -->
-# Atlassian MCP Instructions
-
-**CRITICAL**: Use MCP Atlassian for Jira issues, Confluence documentation, and Bitbucket repositories.
-
-## Jira Operations
-
-### Issue Management
-```typescript
-// Create issue
-jira.issues.createIssue({
-  fields: {
-    project: { key: 'PROJ' },
-    summary: 'Bug in authentication',
-    description: 'Users cannot login with valid credentials',
-    issuetype: { name: 'Bug' },
-    priority: { name: 'High' }
-  }
-})
-
-// Update issue
-jira.issues.updateIssue({
-  issueIdOrKey: 'PROJ-123',
-  fields: {
-    status: { name: 'In Progress' },
-    assignee: { accountId: 'user-id' }
-  }
-})
-
-// Get issue
-jira.issues.getIssue({ issueIdOrKey: 'PROJ-123' })
-
-// Search issues
-jira.issueSearch.searchForIssuesUsingJql({
-  jql: 'project = PROJ AND status = "To Do" ORDER BY priority DESC'
-})
-
-// Add comment
-jira.issueComments.addComment({
-  issueIdOrKey: 'PROJ-123',
-  body: 'Working on this issue'
-})
-```
-
-### Transitions
-```typescript
-// Get transitions
-const transitions = await jira.issues.getTransitions({ issueIdOrKey: 'PROJ-123' })
-
-// Transition issue
-jira.issues.doTransition({
-  issueIdOrKey: 'PROJ-123',
-  transition: { id: transitionId }
-})
-```
-
-## Confluence Operations
-
-### Page Management
-```typescript
-// Create page
-confluence.content.createContent({
-  type: 'page',
-  title: 'API Documentation',
-  space: { key: 'DOCS' },
-  body: {
-    storage: {
-      value: '<h1>Introduction</h1><p>Content here</p>',
-      representation: 'storage'
-    }
-  }
-})
-
-// Update page
-confluence.content.updateContent({
-  id: 'page-id',
-  type: 'page',
-  title: 'Updated Title',
-  version: { number: currentVersion + 1 },
-  body: {
-    storage: {
-      value: '<p>Updated content</p>',
-      representation: 'storage'
-    }
-  }
-})
-
-// Get page
-confluence.content.getContentById({ id: 'page-id' })
-
-// Search
-confluence.search.search({
-  cql: 'type=page AND space=DOCS AND title~"API"'
-})
-```
-
-### Attachments
-```typescript
-// Add attachment
-confluence.content.createAttachment({
-  id: 'page-id',
-  file: fileBuffer,
-  filename: 'document.pdf'
-})
-
-// Get attachments
-confluence.content.getAttachments({ id: 'page-id' })
-```
-
-## Bitbucket Operations
-
-### Repository Management
-```typescript
-// Get repositories
-bitbucket.repositories.list({ workspace: 'my-workspace' })
-
-// Get repository
-bitbucket.repositories.get({
-  workspace: 'my-workspace',
-  repo_slug: 'my-repo'
-})
-
-// Get branches
-bitbucket.refs.listBranches({
-  workspace: 'my-workspace',
-  repo_slug: 'my-repo'
-})
-```
-
-### Pull Requests
-```typescript
-// Create PR
-bitbucket.pullrequests.create({
-  workspace: 'my-workspace',
-  repo_slug: 'my-repo',
-  title: 'Add new feature',
-  source: { branch: { name: 'feature/new-feature' } },
-  destination: { branch: { name: 'main' } },
-  description: 'Implements feature X'
-})
-
-// List PRs
-bitbucket.pullrequests.list({
-  workspace: 'my-workspace',
-  repo_slug: 'my-repo',
-  state: 'OPEN'
-})
-
-// Approve PR
-bitbucket.pullrequests.approve({
-  workspace: 'my-workspace',
-  repo_slug: 'my-repo',
-  pull_request_id: 123
-})
-```
-
-## Common Patterns
-
-### CI/CD Integration
-```typescript
-// Create issue on test failure
-if (testsFailed) {
-  await jira.issues.createIssue({
-    fields: {
-      project: { key: 'PROJ' },
-      summary: `Test failure in ${testSuite}`,
-      description: `Tests failed with errors:\n${errors.join('\n')}`,
-      issuetype: { name: 'Bug' },
-      labels: ['ci-failure', 'automated']
-    }
-  })
-}
-```
-
-### Documentation Sync
-```typescript
-// Sync CHANGELOG to Confluence
-const changelog = fs.readFileSync('CHANGELOG.md', 'utf-8')
-const html = markdownToConfluenceHtml(changelog)
-
-await confluence.content.updateContent({
-  id: changelogPageId,
-  type: 'page',
-  title: 'Changelog',
-  version: { number: version + 1 },
-  body: { storage: { value: html, representation: 'storage' } }
-})
-```
-
-### Sprint Planning
-```typescript
-// Get sprint tasks
-const issues = await jira.issueSearch.searchForIssuesUsingJql({
-  jql: 'sprint = ACTIVE AND project = PROJ',
-  fields: ['summary', 'status', 'assignee', 'priority']
-})
-
-// Generate sprint report
-const report = issues.issues.map(issue => ({
-  key: issue.key,
-  summary: issue.fields.summary,
-  status: issue.fields.status.name,
-  assignee: issue.fields.assignee?.displayName
-}))
-```
-
-## Best Practices
-
-✅ **DO:**
-- Use JQL for complex Jira queries
-- Cache project/user data
-- Handle rate limits
-- Use issue transitions properly
-- Version Confluence pages correctly
-- Link issues to commits/PRs
-
-❌ **DON'T:**
-- Create duplicate issues
-- Skip issue validation
-- Ignore rate limiting
-- Hardcode issue keys
-- Update without version check
-- Store credentials in code
-
-## Configuration
-
-```json
-{
-  "mcpServers": {
-    "atlassian": {
-      "command": "npx",
-      "args": ["-y", "@modelcontextprotocol/server-atlassian"],
-      "env": {
-        "JIRA_HOST": "your-domain.atlassian.net",
-        "JIRA_EMAIL": "your-email@example.com",
-        "JIRA_API_TOKEN": "your-api-token",
-        "CONFLUENCE_HOST": "your-domain.atlassian.net",
-        "CONFLUENCE_EMAIL": "your-email@example.com",
-        "CONFLUENCE_API_TOKEN": "your-api-token",
-        "BITBUCKET_WORKSPACE": "your-workspace",
-        "BITBUCKET_USERNAME": "your-username",
-        "BITBUCKET_APP_PASSWORD": "your-app-password"
-      }
-    }
-  }
-}
-```
-
-**Setup:**
-1. Generate API token at https://id.atlassian.com/manage-profile/security/api-tokens
-2. For Bitbucket, create app password in account settings
-3. Never commit credentials
-
-<!-- ATLASSIAN:END -->
-