@hivehub/rulebook 4.3.1 → 5.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.claude/commands/rulebook-decision-create.md +55 -0
- package/.claude/commands/rulebook-decision-list.md +15 -0
- package/.claude/commands/rulebook-knowledge-add.md +41 -0
- package/.claude/commands/rulebook-knowledge-list.md +15 -0
- package/.claude/commands/rulebook-learn-capture.md +48 -0
- package/.claude/commands/rulebook-learn-list.md +13 -0
- package/.claude/commands/rulebook-task-archive.md +24 -0
- package/.claude-plugin/plugin.json +1 -1
- package/README.md +53 -10
- package/dist/cli/commands.d.ts +32 -0
- package/dist/cli/commands.d.ts.map +1 -1
- package/dist/cli/commands.js +257 -0
- package/dist/cli/commands.js.map +1 -1
- package/dist/core/agent-template-engine.d.ts +51 -0
- package/dist/core/agent-template-engine.d.ts.map +1 -0
- package/dist/core/agent-template-engine.js +273 -0
- package/dist/core/agent-template-engine.js.map +1 -0
- package/dist/core/complexity-detector.d.ts +36 -0
- package/dist/core/complexity-detector.d.ts.map +1 -0
- package/dist/core/complexity-detector.js +254 -0
- package/dist/core/complexity-detector.js.map +1 -0
- package/dist/core/decision-manager.d.ts +25 -0
- package/dist/core/decision-manager.d.ts.map +1 -0
- package/dist/core/decision-manager.js +188 -0
- package/dist/core/decision-manager.js.map +1 -0
- package/dist/core/generator.d.ts +1 -0
- package/dist/core/generator.d.ts.map +1 -1
- package/dist/core/generator.js +47 -3
- package/dist/core/generator.js.map +1 -1
- package/dist/core/indexer/background-indexer.d.ts +9 -2
- package/dist/core/indexer/background-indexer.d.ts.map +1 -1
- package/dist/core/indexer/background-indexer.js +99 -83
- package/dist/core/indexer/background-indexer.js.map +1 -1
- package/dist/core/knowledge-manager.d.ts +24 -0
- package/dist/core/knowledge-manager.d.ts.map +1 -0
- package/dist/core/knowledge-manager.js +173 -0
- package/dist/core/knowledge-manager.js.map +1 -0
- package/dist/core/learn-manager.d.ts +29 -0
- package/dist/core/learn-manager.d.ts.map +1 -0
- package/dist/core/learn-manager.js +159 -0
- package/dist/core/learn-manager.js.map +1 -0
- package/dist/core/rule-engine.d.ts +64 -0
- package/dist/core/rule-engine.d.ts.map +1 -0
- package/dist/core/rule-engine.js +333 -0
- package/dist/core/rule-engine.js.map +1 -0
- package/dist/core/task-manager.d.ts +4 -0
- package/dist/core/task-manager.d.ts.map +1 -1
- package/dist/core/task-manager.js +39 -24
- package/dist/core/task-manager.js.map +1 -1
- package/dist/core/workspace/project-worker.d.ts +9 -0
- package/dist/core/workspace/project-worker.d.ts.map +1 -1
- package/dist/core/workspace/project-worker.js +27 -0
- package/dist/core/workspace/project-worker.js.map +1 -1
- package/dist/index.js +250 -1
- package/dist/index.js.map +1 -1
- package/dist/mcp/rulebook-server.d.ts.map +1 -1
- package/dist/mcp/rulebook-server.js +758 -22
- package/dist/mcp/rulebook-server.js.map +1 -1
- package/dist/memory/hnsw-index.d.ts +3 -1
- package/dist/memory/hnsw-index.d.ts.map +1 -1
- package/dist/memory/hnsw-index.js +121 -18
- package/dist/memory/hnsw-index.js.map +1 -1
- package/dist/memory/memory-manager.d.ts +5 -0
- package/dist/memory/memory-manager.d.ts.map +1 -1
- package/dist/memory/memory-manager.js +34 -8
- package/dist/memory/memory-manager.js.map +1 -1
- package/dist/memory/memory-store.d.ts +15 -3
- package/dist/memory/memory-store.d.ts.map +1 -1
- package/dist/memory/memory-store.js +327 -272
- package/dist/memory/memory-store.js.map +1 -1
- package/dist/types.d.ts +60 -0
- package/dist/types.d.ts.map +1 -1
- package/package.json +8 -3
- package/templates/agents/compiler/codegen-debugger.md +34 -0
- package/templates/agents/compiler/stdlib-engineer.md +28 -0
- package/templates/agents/compiler/test-coverage-guardian.md +31 -0
- package/templates/agents/context-intelligence.md +52 -0
- package/templates/agents/game-engine/cpp-core-expert.md +35 -0
- package/templates/agents/game-engine/render-engineer.md +22 -0
- package/templates/agents/game-engine/shader-engineer.md +38 -0
- package/templates/agents/game-engine/systems-integration.md +43 -0
- package/templates/agents/generic/code-reviewer.md +39 -0
- package/templates/agents/generic/docs-writer.md +25 -0
- package/templates/agents/generic/project-manager.md +34 -0
- package/templates/agents/generic/researcher.md +34 -0
- package/templates/agents/generic/test-engineer.md +40 -0
- package/templates/agents/mobile/platform-specialist.md +22 -0
- package/templates/agents/mobile/ui-engineer.md +22 -0
- package/templates/agents/web-app/api-designer.md +22 -0
- package/templates/agents/web-app/backend-engineer.md +30 -0
- package/templates/agents/web-app/database-engineer.md +22 -0
- package/templates/agents/web-app/frontend-engineer.md +29 -0
- package/templates/agents/web-app/security-reviewer.md +32 -0
- package/templates/commands/rulebook-decision-create.md +55 -0
- package/templates/commands/rulebook-decision-list.md +15 -0
- package/templates/commands/rulebook-knowledge-add.md +41 -0
- package/templates/commands/rulebook-knowledge-list.md +15 -0
- package/templates/commands/rulebook-learn-capture.md +48 -0
- package/templates/commands/rulebook-learn-list.md +13 -0
- package/templates/core/AGENT_AUTOMATION.md +8 -0
- package/templates/core/DECISIONS.md +38 -0
- package/templates/core/KNOWLEDGE.md +49 -0
- package/templates/core/RULEBOOK.md +12 -0
- package/templates/core/TIER1_PROHIBITIONS.md +154 -0
- package/templates/core/TOKEN_OPTIMIZATION.md +49 -0
- package/templates/git/GIT_WORKFLOW.md +35 -0
- package/templates/rules/follow-task-sequence.md +36 -0
- package/templates/rules/git-safety.md +29 -0
- package/templates/rules/incremental-tests.md +29 -0
- package/templates/rules/no-deferred.md +31 -0
- package/templates/rules/no-shortcuts.md +30 -0
- package/templates/rules/research-first.md +30 -0
- package/templates/rules/sequential-editing.md +21 -0
- package/templates/rules/session-workflow.md +24 -0
- package/templates/rules/task-decomposition.md +32 -0
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: /rulebook-decision-create
|
|
3
|
+
id: rulebook-decision-create
|
|
4
|
+
category: Rulebook
|
|
5
|
+
description: Create a new Architecture Decision Record (ADR) with auto-numbering and memory integration.
|
|
6
|
+
---
|
|
7
|
+
<!-- RULEBOOK:START -->
|
|
8
|
+
**Guardrails**
|
|
9
|
+
- Favor straightforward, minimal implementations first and add complexity only when it is requested or clearly required.
|
|
10
|
+
- Keep changes tightly scoped to the requested outcome.
|
|
11
|
+
- Decisions are stored in `.rulebook/decisions/` as numbered Markdown files with metadata sidecars.
|
|
12
|
+
|
|
13
|
+
**Steps**
|
|
14
|
+
1. **Understand the Decision**: Ask the user what architectural/technical decision needs to be recorded. Gather:
|
|
15
|
+
- **Title**: Short, descriptive name (e.g., "Use PostgreSQL for Primary Database")
|
|
16
|
+
- **Context**: Why this decision is needed — constraints, requirements, trade-offs
|
|
17
|
+
- **Decision**: What was decided
|
|
18
|
+
- **Alternatives**: What other options were considered and why they were rejected
|
|
19
|
+
- **Consequences**: What follows from this decision (positive and negative)
|
|
20
|
+
- **Related Tasks**: Any task IDs this decision relates to
|
|
21
|
+
|
|
22
|
+
2. **Check Existing Decisions**:
|
|
23
|
+
```bash
|
|
24
|
+
rulebook decision list
|
|
25
|
+
```
|
|
26
|
+
Verify no duplicate or conflicting decision exists.
|
|
27
|
+
|
|
28
|
+
3. **Create the Decision**:
|
|
29
|
+
```bash
|
|
30
|
+
rulebook decision create "<title>" --context "<context>" --related-task <task-id>
|
|
31
|
+
```
|
|
32
|
+
The system auto-numbers the decision (e.g., ADR-001, ADR-002).
|
|
33
|
+
|
|
34
|
+
4. **Enrich the Decision File**: Open the generated `.rulebook/decisions/NNN-<slug>.md` and fill in:
|
|
35
|
+
- Context section with full background
|
|
36
|
+
- Decision section with the chosen approach
|
|
37
|
+
- Alternatives Considered with reasoning for each rejected option
|
|
38
|
+
- Consequences with both positive and negative outcomes
|
|
39
|
+
|
|
40
|
+
5. **Update Status** (if immediately accepted):
|
|
41
|
+
```bash
|
|
42
|
+
# Via MCP tool or direct metadata edit
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
6. **Verify**:
|
|
46
|
+
```bash
|
|
47
|
+
rulebook decision show <id>
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
**Reference**
|
|
51
|
+
- Decisions use 4 statuses: `proposed` → `accepted` → `superseded` | `deprecated`
|
|
52
|
+
- Use `rulebook decision supersede <oldId> <newId>` to replace a decision
|
|
53
|
+
- Decisions are auto-injected into AGENTS.md on `rulebook update`
|
|
54
|
+
- See `/.rulebook/specs/DECISIONS.md` for format documentation
|
|
55
|
+
<!-- RULEBOOK:END -->
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: /rulebook-decision-list
|
|
3
|
+
id: rulebook-decision-list
|
|
4
|
+
category: Rulebook
|
|
5
|
+
description: List all Architecture Decision Records with optional status filter.
|
|
6
|
+
---
|
|
7
|
+
<!-- RULEBOOK:START -->
|
|
8
|
+
**Steps**
|
|
9
|
+
1. Run `rulebook decision list` to see all decisions.
|
|
10
|
+
2. Optionally filter: `rulebook decision list --status accepted`
|
|
11
|
+
3. Present results to the user with ID, title, and status.
|
|
12
|
+
4. If the user wants details on a specific decision, run `rulebook decision show <id>`.
|
|
13
|
+
|
|
14
|
+
**Status Values**: proposed, accepted, superseded, deprecated
|
|
15
|
+
<!-- RULEBOOK:END -->
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: /rulebook-knowledge-add
|
|
3
|
+
id: rulebook-knowledge-add
|
|
4
|
+
category: Rulebook
|
|
5
|
+
description: Add a pattern or anti-pattern to the project knowledge base.
|
|
6
|
+
---
|
|
7
|
+
<!-- RULEBOOK:START -->
|
|
8
|
+
**Guardrails**
|
|
9
|
+
- Knowledge entries are auto-injected into AGENTS.md on `rulebook update`, making them visible to all AI assistants.
|
|
10
|
+
- Patterns go to `.rulebook/knowledge/patterns/`, anti-patterns to `.rulebook/knowledge/anti-patterns/`.
|
|
11
|
+
|
|
12
|
+
**Steps**
|
|
13
|
+
1. **Determine Type**: Ask if this is a `pattern` (good practice to follow) or `anti-pattern` (bad practice to avoid).
|
|
14
|
+
|
|
15
|
+
2. **Gather Details**:
|
|
16
|
+
- **Title**: Short, descriptive name (e.g., "Repository Pattern", "God Object")
|
|
17
|
+
- **Category**: `architecture` | `code` | `testing` | `security` | `performance` | `devops`
|
|
18
|
+
- **Description**: What the pattern/anti-pattern is
|
|
19
|
+
- **Example**: Code showing correct (or incorrect) usage
|
|
20
|
+
- **When to Use**: Situations where this applies
|
|
21
|
+
- **When NOT to Use**: Exceptions and edge cases
|
|
22
|
+
- **Tags**: For searchability
|
|
23
|
+
|
|
24
|
+
3. **Create Entry**:
|
|
25
|
+
```bash
|
|
26
|
+
rulebook knowledge add <type> "<title>" --category <category> --description "<desc>"
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
4. **Enrich the Entry**: Open `.rulebook/knowledge/<type>s/<slug>.md` and fill in Example, When to Use, and When NOT to Use sections with concrete code examples.
|
|
30
|
+
|
|
31
|
+
5. **Verify**:
|
|
32
|
+
```bash
|
|
33
|
+
rulebook knowledge show <slug>
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
**Reference**
|
|
37
|
+
- Use `rulebook knowledge list` to see all entries
|
|
38
|
+
- Use `rulebook knowledge list --type pattern --category architecture` to filter
|
|
39
|
+
- Use `rulebook knowledge remove <slug>` to delete an entry
|
|
40
|
+
- Entries appear in AGENTS.md "Project Knowledge" section after `rulebook update`
|
|
41
|
+
<!-- RULEBOOK:END -->
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: /rulebook-knowledge-list
|
|
3
|
+
id: rulebook-knowledge-list
|
|
4
|
+
category: Rulebook
|
|
5
|
+
description: List project knowledge entries (patterns and anti-patterns).
|
|
6
|
+
---
|
|
7
|
+
<!-- RULEBOOK:START -->
|
|
8
|
+
**Steps**
|
|
9
|
+
1. Run `rulebook knowledge list` to see all entries.
|
|
10
|
+
2. Optionally filter:
|
|
11
|
+
- By type: `rulebook knowledge list --type pattern`
|
|
12
|
+
- By category: `rulebook knowledge list --category architecture`
|
|
13
|
+
3. Present results with type badge, title, and category.
|
|
14
|
+
4. If the user wants details, run `rulebook knowledge show <slug>`.
|
|
15
|
+
<!-- RULEBOOK:END -->
|
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: /rulebook-learn-capture
|
|
3
|
+
id: rulebook-learn-capture
|
|
4
|
+
category: Rulebook
|
|
5
|
+
description: Capture a learning from implementation work for future reference.
|
|
6
|
+
---
|
|
7
|
+
<!-- RULEBOOK:START -->
|
|
8
|
+
**Guardrails**
|
|
9
|
+
- Learnings are saved to both the memory system and `.rulebook/learnings/` for offline backup.
|
|
10
|
+
- Learnings can be promoted to patterns/decisions later via `rulebook learn promote`.
|
|
11
|
+
|
|
12
|
+
**Steps**
|
|
13
|
+
1. **Gather the Learning**:
|
|
14
|
+
- **Title**: Short description of what was learned
|
|
15
|
+
- **Content**: Full explanation — what happened, what was discovered, why it matters
|
|
16
|
+
- **Tags**: Keywords for searchability
|
|
17
|
+
- **Related Task**: Task ID if this learning came from a specific task
|
|
18
|
+
- **Source**: `manual` (default), `ralph`, or `task-archive`
|
|
19
|
+
|
|
20
|
+
2. **Capture**:
|
|
21
|
+
```bash
|
|
22
|
+
rulebook learn capture --title "<title>" --content "<content>" --tags "tag1,tag2" --related-task <task-id>
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
3. **Verify**:
|
|
26
|
+
```bash
|
|
27
|
+
rulebook learn list --limit 5
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
**Promotion Flow**
|
|
31
|
+
If a learning is significant enough to become a team pattern or decision:
|
|
32
|
+
```bash
|
|
33
|
+
rulebook learn promote <id> knowledge # → creates a pattern
|
|
34
|
+
rulebook learn promote <id> decision # → creates an ADR
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
**Ralph Integration**
|
|
38
|
+
Extract learnings from Ralph autonomous loop history:
|
|
39
|
+
```bash
|
|
40
|
+
rulebook learn from-ralph
|
|
41
|
+
```
|
|
42
|
+
This reads `.rulebook/ralph/history/iteration-*.json` and captures entries with non-empty learnings.
|
|
43
|
+
|
|
44
|
+
**Reference**
|
|
45
|
+
- Learnings are searchable via `rulebook memory search`
|
|
46
|
+
- Use `rulebook learn list` to see all learnings
|
|
47
|
+
- Learnings captured during `rulebook task archive` have source `task-archive`
|
|
48
|
+
<!-- RULEBOOK:END -->
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: /rulebook-learn-list
|
|
3
|
+
id: rulebook-learn-list
|
|
4
|
+
category: Rulebook
|
|
5
|
+
description: List captured learnings with source and promotion status.
|
|
6
|
+
---
|
|
7
|
+
<!-- RULEBOOK:START -->
|
|
8
|
+
**Steps**
|
|
9
|
+
1. Run `rulebook learn list` to see all learnings (newest first).
|
|
10
|
+
2. Optionally limit: `rulebook learn list --limit 10`
|
|
11
|
+
3. Present results with source badge (manual/ralph/archive) and promotion status.
|
|
12
|
+
4. Suggest promotion for significant learnings: `rulebook learn promote <id> knowledge|decision`
|
|
13
|
+
<!-- RULEBOOK:END -->
|
|
@@ -62,6 +62,30 @@ description: Archive a completed Rulebook task and apply spec deltas to main spe
|
|
|
62
62
|
- Create migration guides (if needed)
|
|
63
63
|
- Unblock related tasks (if any)
|
|
64
64
|
|
|
65
|
+
8. **🚨 MANDATORY: Deferred Items → Tasks Rule**:
|
|
66
|
+
**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**.
|
|
67
|
+
|
|
68
|
+
```
|
|
69
|
+
❌ WRONG — defer without creating task:
|
|
70
|
+
1. Archive task with "- [ ] D1. feature X — deferred Phase 4"
|
|
71
|
+
→ Feature X is now forgotten forever
|
|
72
|
+
|
|
73
|
+
✅ CORRECT — defer with tracking:
|
|
74
|
+
1. Add "- [ ] D1. feature X — deferred Phase 4" to tasks.md
|
|
75
|
+
2. Call rulebook_task_create("phase4-feature-x")
|
|
76
|
+
3. Write tasks.md for the new task with full context
|
|
77
|
+
4. THEN call rulebook_task_archive
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
**Archive Checklist (ALL must be done before archiving):**
|
|
81
|
+
```
|
|
82
|
+
□ 1. tasks.md uses - [x] for implemented, - [ ] for deferred
|
|
83
|
+
□ 2. Each deferred item has a "Phase N" target
|
|
84
|
+
□ 3. A rulebook task exists for EVERY deferred item or group
|
|
85
|
+
□ 4. The new deferred tasks have tasks.md with full context
|
|
86
|
+
□ 5. THEN call rulebook_task_archive
|
|
87
|
+
```
|
|
88
|
+
|
|
65
89
|
**Reference**
|
|
66
90
|
- Use `rulebook task list --archived` to see archived tasks
|
|
67
91
|
- Use `rulebook task show <task-id>` to view task details
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "rulebook",
|
|
3
3
|
"description": "Standardize AI-generated projects with Ralph autonomous loop, persistent memory, and quality gates. Supports 28 languages, 17 frameworks, 13 MCP modules, and 20 services.",
|
|
4
|
-
"version": "
|
|
4
|
+
"version": "5.0.0",
|
|
5
5
|
"author": {
|
|
6
6
|
"name": "HiveLLM"
|
|
7
7
|
}
|
package/README.md
CHANGED
|
@@ -11,7 +11,7 @@
|
|
|
11
11
|
[](https://github.com/hivellm/rulebook/actions/workflows/build.yml)
|
|
12
12
|
[](https://github.com/hivellm/rulebook/actions/workflows/lint.yml)
|
|
13
13
|
|
|
14
|
-
>
|
|
14
|
+
> Tool-agnostic AI development framework. Standardize projects across Claude Code, Cursor, Gemini, Codex, Windsurf, Copilot with automated templates, quality gates, persistent memory, and framework detection for 28 languages, 17 frameworks, 13 MCP modules, and 20 services.
|
|
15
15
|
|
|
16
16
|
---
|
|
17
17
|
|
|
@@ -27,7 +27,7 @@ Large Language Models (LLMs) for software development need **clear directives**
|
|
|
27
27
|
- 🎯 **Normalized Deliverables**: Ensures consistent code quality across all AI-generated outputs
|
|
28
28
|
- 🛡️ **Error Reduction**: Catches issues early through automated quality gates and pre-commit/pre-push hooks
|
|
29
29
|
- ⚙️ **Process Automation**: Automates repetitive tasks like formatting, testing, and deployment
|
|
30
|
-
- 🔌 **MCP Integration**:
|
|
30
|
+
- 🔌 **MCP Integration**: 40 MCP tools for task management, skills, memory, decisions, knowledge, and learnings
|
|
31
31
|
- 📊 **Task Management**: Built-in task management system (OpenSpec-compatible format) for structured development
|
|
32
32
|
|
|
33
33
|
By giving LLMs a clear "rulebook" to follow, you ensure that every piece of generated code meets your project's standards—**automatically**.
|
|
@@ -35,29 +35,72 @@ By giving LLMs a clear "rulebook" to follow, you ensure that every piece of gene
|
|
|
35
35
|
## Quick Start
|
|
36
36
|
|
|
37
37
|
```bash
|
|
38
|
-
# New project — auto-detects languages,
|
|
38
|
+
# New project — auto-detects languages, tools, and complexity
|
|
39
39
|
npx @hivehub/rulebook@latest init
|
|
40
40
|
|
|
41
|
+
# Target specific AI tools
|
|
42
|
+
npx @hivehub/rulebook@latest init --tools claude-code,cursor,gemini
|
|
43
|
+
|
|
44
|
+
# Assess project complexity before configuring
|
|
45
|
+
npx @hivehub/rulebook@latest assess
|
|
46
|
+
|
|
41
47
|
# Minimal setup (essentials only)
|
|
42
48
|
npx @hivehub/rulebook@latest init --minimal
|
|
43
49
|
|
|
44
50
|
# Lean mode — AGENTS.md as <3KB index (fast AI loading)
|
|
45
51
|
npx @hivehub/rulebook@latest init --lean
|
|
46
52
|
|
|
47
|
-
# Update existing project
|
|
53
|
+
# Update existing project (re-projects rules to all detected tools)
|
|
48
54
|
npx @hivehub/rulebook@latest update
|
|
55
|
+
|
|
56
|
+
# Manage canonical rules
|
|
57
|
+
npx @hivehub/rulebook@latest rules list # List rules by tier
|
|
58
|
+
npx @hivehub/rulebook@latest rules add no-shortcuts # Install from library
|
|
59
|
+
npx @hivehub/rulebook@latest rules project # Project to all tools
|
|
49
60
|
```
|
|
50
61
|
|
|
51
62
|
## What's New
|
|
52
63
|
|
|
53
64
|
See the full [CHANGELOG](CHANGELOG.md) for details.
|
|
54
65
|
|
|
55
|
-
###
|
|
66
|
+
### v5.0.0 — Multi-Tool AI Framework
|
|
67
|
+
|
|
68
|
+
The biggest release yet. Rulebook becomes a **tool-agnostic AI development framework** — same quality directives for every AI tool, with graceful degradation.
|
|
69
|
+
|
|
70
|
+
**One Source, Multiple Projections**
|
|
71
|
+
- Canonical rules live in `.rulebook/rules/` with YAML frontmatter
|
|
72
|
+
- `rulebook update` projects them to **6 tool formats simultaneously**:
|
|
73
|
+
- Claude Code (`.claude/rules/*.md`), Cursor (`.cursor/rules/*.mdc`), Gemini (`GEMINI.md`), Copilot (`.github/copilot-instructions.md`), Windsurf (`.windsurf/rules/`), Continue.dev (`.continue/rules/`)
|
|
74
|
+
|
|
75
|
+
**Adaptive Agent Framework**
|
|
76
|
+
- 15 agent templates across 5 project types (game-engine, compiler, web-app, mobile, generic)
|
|
77
|
+
- Claude Code: full agents with memory directories
|
|
78
|
+
- Cursor: contextual `.mdc` rules activated by file glob patterns
|
|
79
|
+
- Gemini/Codex: inline conditional sections
|
|
80
|
+
|
|
81
|
+
**7 Tier 1 Prohibitions** (auto-installed, universal)
|
|
82
|
+
- No shortcuts/stubs/TODOs, git safety allow-list, no delete without authorization, research-first, sequential editing, no deferred tasks, **follow task sequence** (no cherry-picking)
|
|
83
|
+
|
|
84
|
+
**Project Complexity Detection**
|
|
85
|
+
- `rulebook assess` — auto-detects LOC, languages, structure
|
|
86
|
+
- Calibrated init: small projects get Tier 1 only, large/complex projects get full agent framework + Tier 2 rules
|
|
87
|
+
|
|
88
|
+
**Critical Performance Fixes**
|
|
89
|
+
- Replaced sql.js (WASM) with better-sqlite3 (native) — eliminates 100-500MB memory copies per save
|
|
90
|
+
- Replaced fs.watch with chokidar — stops node_modules event flood
|
|
91
|
+
- HNSW search optimized with MinHeap/MaxHeap (~100x faster)
|
|
92
|
+
|
|
93
|
+
**New MCP Tools**: `rulebook_session_start`, `rulebook_session_end`, `rulebook_rules_list`, `rulebook_blockers`
|
|
94
|
+
**New CLI**: `rulebook assess`, `rulebook rules list|add|project`, `rulebook task blockers|blocked-by`
|
|
95
|
+
|
|
96
|
+
### v4.4.0 — Context Intelligence Layer
|
|
56
97
|
|
|
57
|
-
-
|
|
58
|
-
-
|
|
59
|
-
-
|
|
60
|
-
- 🔌 **
|
|
98
|
+
- 🧠 **Decision Records**: `rulebook decision create|list|show|supersede` — Architecture Decision Records with auto-numbering and status lifecycle
|
|
99
|
+
- 📚 **Knowledge Base**: `rulebook knowledge add|list|show|remove` — Explicit patterns and anti-patterns auto-injected into AGENTS.md
|
|
100
|
+
- 💡 **Learn Phase**: `rulebook learn capture|from-ralph|list|promote` — Capture learnings, extract from Ralph, promote to patterns or decisions
|
|
101
|
+
- 🔌 **10 New MCP Tools**: Decision, knowledge, and learning management — **40 MCP tools total**
|
|
102
|
+
- 🤖 **Context Intelligence Agent**: New `context-intelligence` (haiku) agent for managing project knowledge
|
|
103
|
+
- 📋 **6 New Skills**: `/rulebook-decision-create`, `/rulebook-decision-list`, `/rulebook-knowledge-add`, `/rulebook-knowledge-list`, `/rulebook-learn-capture`, `/rulebook-learn-list`
|
|
61
104
|
|
|
62
105
|
### v4.3.0 — Agent Delegation & Cost Optimization
|
|
63
106
|
|
|
@@ -129,7 +172,7 @@ Every time you open a new tab or restart your editor, the AI loses all context a
|
|
|
129
172
|
### How It Works
|
|
130
173
|
|
|
131
174
|
```
|
|
132
|
-
Session 1: "
|
|
175
|
+
Session 1: "Chose event sourcing over CRUD for the audit trail"
|
|
133
176
|
→ Saved to memory automatically
|
|
134
177
|
|
|
135
178
|
Session 2 (new tab, days later):
|
package/dist/cli/commands.d.ts
CHANGED
|
@@ -189,5 +189,37 @@ export declare function workspaceAddCommand(projectPath: string): Promise<void>;
|
|
|
189
189
|
export declare function workspaceRemoveCommand(projectName: string): Promise<void>;
|
|
190
190
|
export declare function workspaceListCommand(): Promise<void>;
|
|
191
191
|
export declare function workspaceStatusCommand(): Promise<void>;
|
|
192
|
+
export declare function decisionCreateCommand(title: string, options: {
|
|
193
|
+
context?: string;
|
|
194
|
+
relatedTask?: string;
|
|
195
|
+
}): Promise<void>;
|
|
196
|
+
export declare function decisionListCommand(options: {
|
|
197
|
+
status?: string;
|
|
198
|
+
}): Promise<void>;
|
|
199
|
+
export declare function decisionShowCommand(id: string): Promise<void>;
|
|
200
|
+
export declare function decisionSupersedeCommand(oldId: string, newId: string): Promise<void>;
|
|
201
|
+
export declare function knowledgeAddCommand(type: string, title: string, options: {
|
|
202
|
+
category?: string;
|
|
203
|
+
description?: string;
|
|
204
|
+
}): Promise<void>;
|
|
205
|
+
export declare function knowledgeListCommand(options: {
|
|
206
|
+
type?: string;
|
|
207
|
+
category?: string;
|
|
208
|
+
}): Promise<void>;
|
|
209
|
+
export declare function knowledgeShowCommand(id: string): Promise<void>;
|
|
210
|
+
export declare function knowledgeRemoveCommand(id: string): Promise<void>;
|
|
211
|
+
export declare function learnCaptureCommand(options: {
|
|
212
|
+
title?: string;
|
|
213
|
+
content?: string;
|
|
214
|
+
relatedTask?: string;
|
|
215
|
+
tags?: string;
|
|
216
|
+
}): Promise<void>;
|
|
217
|
+
export declare function learnFromRalphCommand(): Promise<void>;
|
|
218
|
+
export declare function learnListCommand(options: {
|
|
219
|
+
limit?: string;
|
|
220
|
+
}): Promise<void>;
|
|
221
|
+
export declare function learnPromoteCommand(id: string, target: string, options: {
|
|
222
|
+
title?: string;
|
|
223
|
+
}): Promise<void>;
|
|
192
224
|
export {};
|
|
193
225
|
//# sourceMappingURL=commands.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"commands.d.ts","sourceRoot":"","sources":["../../src/cli/commands.ts"],"names":[],"mappings":"AAgEA,wBAAsB,WAAW,CAAC,OAAO,EAAE;IACzC,GAAG,CAAC,EAAE,OAAO,CAAC;IACd,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,qBAAqB,CAAC,EAAE,OAAO,CAAC;CACjC,GAAG,OAAO,CAAC,IAAI,CAAC,
|
|
1
|
+
{"version":3,"file":"commands.d.ts","sourceRoot":"","sources":["../../src/cli/commands.ts"],"names":[],"mappings":"AAgEA,wBAAsB,WAAW,CAAC,OAAO,EAAE;IACzC,GAAG,CAAC,EAAE,OAAO,CAAC;IACd,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,qBAAqB,CAAC,EAAE,OAAO,CAAC;CACjC,GAAG,OAAO,CAAC,IAAI,CAAC,CAwhBhB;AAED,wBAAsB,eAAe,IAAI,OAAO,CAAC,IAAI,CAAC,CA8DrD;AAED,wBAAsB,gBAAgB,IAAI,OAAO,CAAC,IAAI,CAAC,CAyCtD;AAED,wBAAsB,gBAAgB,IAAI,OAAO,CAAC,IAAI,CAAC,CA6DtD;AAED,wBAAsB,oBAAoB,CAAC,OAAO,EAAE;IAAE,SAAS,CAAC,EAAE,MAAM,CAAA;CAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAuDzF;AAED,wBAAsB,mBAAmB,CAAC,OAAO,EAAE;IAAE,GAAG,CAAC,EAAE,OAAO,CAAA;CAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CA8CnF;AAED,wBAAsB,cAAc,CAAC,OAAO,EAAE;IAC5C,IAAI,EAAE,OAAO,GAAG,OAAO,GAAG,OAAO,CAAC;CACnC,GAAG,OAAO,CAAC,IAAI,CAAC,CAoChB;AAED,wBAAsB,gBAAgB,CAAC,OAAO,EAAE;IAAE,OAAO,CAAC,EAAE,MAAM,CAAA;CAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CA6CnF;AAED,wBAAsB,aAAa,IAAI,OAAO,CAAC,IAAI,CAAC,CAoDnD;AAED,wBAAsB,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC,CA0DhD;AAED,wBAAsB,cAAc,IAAI,OAAO,CAAC,IAAI,CAAC,CAcpD;AAED,wBAAsB,YAAY,CAAC,OAAO,EAAE;IAC1C,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB,GAAG,OAAO,CAAC,IAAI,CAAC,CAuBhB;AAED,wBAAsB,aAAa,CAAC,OAAO,EAAE;IAC3C,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB,GAAG,OAAO,CAAC,IAAI,CAAC,CAmDhB;AAID,UAAU,oBAAoB;IAC5B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,WAAW,CAAC,EAAE,OAAO,CAAC;CACvB;AA+DD,wBAAsB,iBAAiB,CACrC,MAAM,EAAE,MAAM,EACd,SAAS,CAAC,EAAE,oBAAoB,GAC/B,OAAO,CAAC,IAAI,CAAC,CAiBf;AAED,wBAAsB,eAAe,CACnC,eAAe,GAAE,OAAe,EAChC,SAAS,CAAC,EAAE,oBAAoB,GAC/B,OAAO,CAAC,IAAI,CAAC,CA8Gf;AAED,wBAAsB,eAAe,CACnC,MAAM,EAAE,MAAM,EACd,SAAS,CAAC,EAAE,oBAAoB,GAC/B,OAAO,CAAC,IAAI,CAAC,CAyCf;AAED,wBAAsB,mBAAmB,CACvC,MAAM,EAAE,MAAM,EACd,SAAS,CAAC,EAAE,oBAAoB,GAC/B,OAAO,CAAC,IAAI,CAAC,CAgCf;AAED,wBAAsB,kBAAkB,CACtC,MAAM,EAAE,MAAM,EACd,cAAc,GAAE,OAAe,EAC/B,SAAS,CAAC,EAAE,oBAAoB,GAC/B,OAAO,CAAC,IAAI,CAAC,CAYf;AAED;;;GAGG;AACH,wBAAsB,cAAc,CAAC,OAAO,CAAC,EAAE;IAAE,SAAS,CAAC,EAAE,OAAO,CAAA;CAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAqHrF;AAED,wBAAsB,gBAAgB,IAAI,OAAO,CAAC,IAAI,CAAC,CAoBtD;AAGD,wBAAsB,YAAY,CAAC,OAAO,EAAE;IAC1C,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,GAAG,OAAO,CAAC,IAAI,CAAC,CAkBhB;AAED,wBAAsB,aAAa,CAAC,OAAO,EAAE;IAC3C,GAAG,CAAC,EAAE,OAAO,CAAC;IACd,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,IAAI,CAAC,EAAE,OAAO,CAAC;CAChB,GAAG,OAAO,CAAC,IAAI,CAAC,CAkFhB;AA+hBD;;GAEG;AACH,wBAAsB,gBAAgB,CAAC,OAAO,EAAE;IAC9C,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB,GAAG,OAAO,CAAC,IAAI,CAAC,CAoEhB;AAED;;GAEG;AACH,wBAAsB,eAAe,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAqEpE;AAED;;GAEG;AACH,wBAAsB,kBAAkB,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAsCvE;AAED;;GAEG;AACH,wBAAsB,gBAAgB,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAuFrE;AAED;;GAEG;AACH,wBAAsB,kBAAkB,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CA0CrE;AAMD,wBAAsB,mBAAmB,CACvC,KAAK,EAAE,MAAM,EACb,OAAO,EAAE;IAAE,IAAI,CAAC,EAAE,MAAM,CAAC;IAAC,KAAK,CAAC,EAAE,MAAM,CAAC;IAAC,IAAI,CAAC,EAAE,MAAM,CAAA;CAAE,GACxD,OAAO,CAAC,IAAI,CAAC,CA+Cf;AAED,wBAAsB,iBAAiB,CACrC,IAAI,EAAE,MAAM,EACZ,OAAO,EAAE;IAAE,IAAI,CAAC,EAAE,MAAM,CAAC;IAAC,KAAK,CAAC,EAAE,MAAM,CAAC;IAAC,IAAI,CAAC,EAAE,MAAM,CAAA;CAAE,GACxD,OAAO,CAAC,IAAI,CAAC,CAkCf;AAED,wBAAsB,iBAAiB,CAAC,OAAO,EAAE;IAAE,KAAK,CAAC,EAAE,MAAM,CAAC;IAAC,IAAI,CAAC,EAAE,MAAM,CAAA;CAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CA6CjG;AAED,wBAAsB,kBAAkB,IAAI,OAAO,CAAC,IAAI,CAAC,CA6CxD;AAED,wBAAsB,mBAAmB,IAAI,OAAO,CAAC,IAAI,CAAC,CA2DzD;AAED,wBAAsB,oBAAoB,CAAC,OAAO,EAAE;IAAE,KAAK,CAAC,EAAE,OAAO,CAAA;CAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAiCtF;AAED,wBAAsB,mBAAmB,CAAC,OAAO,EAAE;IACjD,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,GAAG,OAAO,CAAC,IAAI,CAAC,CAsChB;AAID,wBAAsB,gBAAgB,IAAI,OAAO,CAAC,IAAI,CAAC,CA2CtD;AAED,wBAAsB,eAAe,CAAC,OAAO,EAAE;IAC7C,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,IAAI,CAAC,EAAE,QAAQ,GAAG,KAAK,GAAG,QAAQ,CAAC;IACnC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB,GAAG,OAAO,CAAC,IAAI,CAAC,CAuWhB;AAuQD,wBAAsB,kBAAkB,IAAI,OAAO,CAAC,IAAI,CAAC,CA6CxD;AAED,wBAAsB,mBAAmB,CAAC,OAAO,EAAE;IAAE,KAAK,CAAC,EAAE,MAAM,CAAA;CAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAsDpF;AAED,wBAAsB,iBAAiB,IAAI,OAAO,CAAC,IAAI,CAAC,CA6BvD;AAED,wBAAsB,kBAAkB,IAAI,OAAO,CAAC,IAAI,CAAC,CA6BxD;AAED,wBAAsB,qBAAqB,IAAI,OAAO,CAAC,IAAI,CAAC,CAmF3D;AAqDD;;GAEG;AACH,wBAAsB,mBAAmB,IAAI,OAAO,CAAC,IAAI,CAAC,CAsBzD;AAED;;GAEG;AACH,wBAAsB,mBAAmB,IAAI,OAAO,CAAC,IAAI,CAAC,CAczD;AAED;;GAEG;AACH,wBAAsB,oBAAoB,IAAI,OAAO,CAAC,IAAI,CAAC,CAK1D;AAED;;GAEG;AACH,wBAAsB,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAuBzE;AAED;;GAEG;AACH,wBAAsB,gBAAgB,IAAI,OAAO,CAAC,IAAI,CAAC,CAgCtD;AAED;;GAEG;AACH,wBAAsB,gBAAgB,IAAI,OAAO,CAAC,IAAI,CAAC,CAWtD;AAED;;GAEG;AACH,wBAAsB,iBAAiB,IAAI,OAAO,CAAC,IAAI,CAAC,CAMvD;AAID;;;;;;;;;;GAUG;AACH,wBAAsB,eAAe,IAAI,OAAO,CAAC,IAAI,CAAC,CAoIrD;AAED,wBAAsB,sBAAsB,IAAI,OAAO,CAAC,IAAI,CAAC,CA2D5D;AAID;;;;;GAKG;AACH,wBAAsB,aAAa,CAAC,OAAO,EAAE;IAC3C,MAAM,CAAC,EAAE,UAAU,GAAG,gBAAgB,GAAG,MAAM,CAAC;IAChD,MAAM,CAAC,EAAE,UAAU,GAAG,OAAO,GAAG,OAAO,CAAC;IACxC,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,GAAG,OAAO,CAAC,IAAI,CAAC,CAmEhB;AAID,wBAAsB,wBAAwB,CAAC,OAAO,EAAE;IACtD,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB,GAAG,OAAO,CAAC,IAAI,CAAC,CAsFhB;AAWD,wBAAsB,oBAAoB,IAAI,OAAO,CAAC,IAAI,CAAC,CAoD1D;AAED,wBAAsB,mBAAmB,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAmC5E;AAED,wBAAsB,sBAAsB,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAwB/E;AAED,wBAAsB,oBAAoB,IAAI,OAAO,CAAC,IAAI,CAAC,CAyB1D;AAED,wBAAsB,sBAAsB,IAAI,OAAO,CAAC,IAAI,CAAC,CAmC5D;AAID,wBAAsB,qBAAqB,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE;IAAE,OAAO,CAAC,EAAE,MAAM,CAAC;IAAC,WAAW,CAAC,EAAE,MAAM,CAAA;CAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAa7H;AAED,wBAAsB,mBAAmB,CAAC,OAAO,EAAE;IAAE,MAAM,CAAC,EAAE,MAAM,CAAA;CAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAYrF;AAED,wBAAsB,mBAAmB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CASnE;AAED,wBAAsB,wBAAwB,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAS1F;AAED,wBAAsB,mBAAmB,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE;IAAE,QAAQ,CAAC,EAAE,MAAM,CAAC;IAAC,WAAW,CAAC,EAAE,MAAM,CAAA;CAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAa1I;AAED,wBAAsB,oBAAoB,CAAC,OAAO,EAAE;IAAE,IAAI,CAAC,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;CAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAYvG;AAED,wBAAsB,oBAAoB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CASpE;AAED,wBAAsB,sBAAsB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAStE;AAED,wBAAsB,mBAAmB,CAAC,OAAO,EAAE;IAAE,KAAK,CAAC,EAAE,MAAM,CAAC;IAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAAC,IAAI,CAAC,EAAE,MAAM,CAAA;CAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAoB3I;AAED,wBAAsB,qBAAqB,IAAI,OAAO,CAAC,IAAI,CAAC,CAc3D;AAED,wBAAsB,gBAAgB,CAAC,OAAO,EAAE;IAAE,KAAK,CAAC,EAAE,MAAM,CAAA;CAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAcjF;AAED,wBAAsB,mBAAmB,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE;IAAE,KAAK,CAAC,EAAE,MAAM,CAAA;CAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAoBhH"}
|