@hivehub/rulebook 5.8.1 → 6.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/README.md +86 -216
- package/dist/cli/commands/claude.d.ts.map +1 -1
- package/dist/cli/commands/claude.js +10 -4
- package/dist/cli/commands/claude.js.map +1 -1
- package/dist/cli/commands/context-intelligence.d.ts.map +1 -1
- package/dist/cli/commands/context-intelligence.js.map +1 -1
- package/dist/cli/commands/index.d.ts +1 -2
- package/dist/cli/commands/index.d.ts.map +1 -1
- package/dist/cli/commands/index.js +1 -2
- package/dist/cli/commands/index.js.map +1 -1
- package/dist/cli/commands/init.d.ts.map +1 -1
- package/dist/cli/commands/init.js +16 -91
- package/dist/cli/commands/init.js.map +1 -1
- package/dist/cli/commands/mcp.d.ts.map +1 -1
- package/dist/cli/commands/mcp.js.map +1 -1
- package/dist/cli/commands/misc.d.ts +0 -1
- package/dist/cli/commands/misc.d.ts.map +1 -1
- package/dist/cli/commands/misc.js +0 -76
- package/dist/cli/commands/misc.js.map +1 -1
- package/dist/cli/commands/plans.d.ts.map +1 -1
- package/dist/cli/commands/plans.js.map +1 -1
- package/dist/cli/commands/skills.d.ts.map +1 -1
- package/dist/cli/commands/skills.js +6 -2
- package/dist/cli/commands/skills.js.map +1 -1
- package/dist/cli/commands/task.d.ts.map +1 -1
- package/dist/cli/commands/task.js +3 -1
- package/dist/cli/commands/task.js.map +1 -1
- package/dist/cli/commands/update.d.ts +7 -0
- package/dist/cli/commands/update.d.ts.map +1 -1
- package/dist/cli/commands/update.js +61 -165
- package/dist/cli/commands/update.js.map +1 -1
- package/dist/cli/commands/workspace.d.ts.map +1 -1
- package/dist/cli/commands/workspace.js +4 -3
- package/dist/cli/commands/workspace.js.map +1 -1
- package/dist/cli/prompts.d.ts.map +1 -1
- package/dist/cli/prompts.js +0 -40
- package/dist/cli/prompts.js.map +1 -1
- package/dist/core/claude/claude-mcp.d.ts.map +1 -1
- package/dist/core/claude/claude-mcp.js +1 -1
- package/dist/core/claude/claude-mcp.js.map +1 -1
- package/dist/core/claude/claude-md-generator.d.ts.map +1 -1
- package/dist/core/claude/claude-md-generator.js.map +1 -1
- package/dist/core/claude/claude-settings-manager.d.ts.map +1 -1
- package/dist/core/claude/claude-settings-manager.js +9 -6
- package/dist/core/claude/claude-settings-manager.js.map +1 -1
- package/dist/core/custom-templates.d.ts.map +1 -1
- package/dist/core/custom-templates.js.map +1 -1
- package/dist/core/detect/detector.d.ts +0 -28
- package/dist/core/detect/detector.d.ts.map +1 -1
- package/dist/core/detect/detector.js +5 -84
- package/dist/core/detect/detector.js.map +1 -1
- package/dist/core/detect/library-registry.d.ts.map +1 -1
- package/dist/core/detect/library-registry.js.map +1 -1
- package/dist/core/docs/docs-generator.d.ts.map +1 -1
- package/dist/core/docs/docs-generator.js.map +1 -1
- package/dist/core/docs/mcp-reference-generator.d.ts.map +1 -1
- package/dist/core/docs/mcp-reference-generator.js.map +1 -1
- package/dist/core/generators/generator.d.ts.map +1 -1
- package/dist/core/generators/generator.js +0 -72
- package/dist/core/generators/generator.js.map +1 -1
- package/dist/core/generators/gitignore-generator.d.ts.map +1 -1
- package/dist/core/generators/gitignore-generator.js +12 -1
- package/dist/core/generators/gitignore-generator.js.map +1 -1
- package/dist/core/generators/minimal-scaffolder.d.ts.map +1 -1
- package/dist/core/generators/minimal-scaffolder.js.map +1 -1
- package/dist/core/generators/rules-generator.d.ts.map +1 -1
- package/dist/core/generators/rules-generator.js.map +1 -1
- package/dist/core/generators/workflow-generator.d.ts +0 -10
- package/dist/core/generators/workflow-generator.d.ts.map +1 -1
- package/dist/core/generators/workflow-generator.js +0 -307
- package/dist/core/generators/workflow-generator.js.map +1 -1
- package/dist/core/logger.d.ts.map +1 -1
- package/dist/core/logger.js.map +1 -1
- package/dist/core/merger.d.ts.map +1 -1
- package/dist/core/merger.js.map +1 -1
- package/dist/core/migrator.d.ts.map +1 -1
- package/dist/core/migrator.js +2 -1
- package/dist/core/migrator.js.map +1 -1
- package/dist/core/quality/coverage-checker.d.ts.map +1 -1
- package/dist/core/quality/coverage-checker.js.map +1 -1
- package/dist/core/quality/dependency-checker.d.ts.map +1 -1
- package/dist/core/quality/dependency-checker.js +3 -1
- package/dist/core/quality/dependency-checker.js.map +1 -1
- package/dist/core/quality/doctor.d.ts.map +1 -1
- package/dist/core/quality/doctor.js.map +1 -1
- package/dist/core/quality/validator.d.ts.map +1 -1
- package/dist/core/quality/validator.js.map +1 -1
- package/dist/core/rule-engine.d.ts +5 -21
- package/dist/core/rule-engine.d.ts.map +1 -1
- package/dist/core/rule-engine.js +9 -191
- package/dist/core/rule-engine.js.map +1 -1
- package/dist/core/skills/skills-manager.d.ts.map +1 -1
- package/dist/core/skills/skills-manager.js.map +1 -1
- package/dist/core/state/config-manager.d.ts.map +1 -1
- package/dist/core/state/config-manager.js +6 -50
- package/dist/core/state/config-manager.js.map +1 -1
- package/dist/core/state/override-manager.js.map +1 -1
- package/dist/core/state/state-writer.d.ts.map +1 -1
- package/dist/core/state/state-writer.js.map +1 -1
- package/dist/core/state/version-bumper.d.ts.map +1 -1
- package/dist/core/state/version-bumper.js.map +1 -1
- package/dist/core/tasks/decision-manager.d.ts.map +1 -1
- package/dist/core/tasks/decision-manager.js +6 -1
- package/dist/core/tasks/decision-manager.js.map +1 -1
- package/dist/core/tasks/knowledge-manager.d.ts.map +1 -1
- package/dist/core/tasks/knowledge-manager.js.map +1 -1
- package/dist/core/tasks/learn-manager.d.ts.map +1 -1
- package/dist/core/tasks/learn-manager.js.map +1 -1
- package/dist/core/tasks/plans-manager.d.ts.map +1 -1
- package/dist/core/tasks/plans-manager.js.map +1 -1
- package/dist/core/tasks/task-manager.d.ts.map +1 -1
- package/dist/core/tasks/task-manager.js.map +1 -1
- package/dist/core/workspace/legacy-migrator.d.ts.map +1 -1
- package/dist/core/workspace/legacy-migrator.js.map +1 -1
- package/dist/core/workspace/project-worker.d.ts +0 -4
- package/dist/core/workspace/project-worker.d.ts.map +1 -1
- package/dist/core/workspace/project-worker.js +0 -28
- package/dist/core/workspace/project-worker.js.map +1 -1
- package/dist/core/workspace/workspace-manager.d.ts +0 -11
- package/dist/core/workspace/workspace-manager.d.ts.map +1 -1
- package/dist/core/workspace/workspace-manager.js +6 -30
- package/dist/core/workspace/workspace-manager.js.map +1 -1
- package/dist/core/workspace/workspace-types.d.ts +0 -1
- package/dist/core/workspace/workspace-types.d.ts.map +1 -1
- package/dist/hooks/safe-flag-io.js.map +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +3 -82
- package/dist/index.js.map +1 -1
- package/dist/mcp/rulebook-server.d.ts.map +1 -1
- package/dist/mcp/rulebook-server.js +55 -1634
- package/dist/mcp/rulebook-server.js.map +1 -1
- package/dist/mcp/tools/context.d.ts +23 -0
- package/dist/mcp/tools/context.d.ts.map +1 -0
- package/dist/mcp/tools/context.js +2 -0
- package/dist/mcp/tools/context.js.map +1 -0
- package/dist/mcp/tools/decision-tools.d.ts +5 -0
- package/dist/mcp/tools/decision-tools.d.ts.map +1 -0
- package/dist/mcp/tools/decision-tools.js +220 -0
- package/dist/mcp/tools/decision-tools.js.map +1 -0
- package/dist/mcp/tools/knowledge-tools.d.ts +5 -0
- package/dist/mcp/tools/knowledge-tools.d.ts.map +1 -0
- package/dist/mcp/tools/knowledge-tools.js +157 -0
- package/dist/mcp/tools/knowledge-tools.js.map +1 -0
- package/dist/mcp/tools/learn-tools.d.ts +5 -0
- package/dist/mcp/tools/learn-tools.d.ts.map +1 -0
- package/dist/mcp/tools/learn-tools.js +150 -0
- package/dist/mcp/tools/learn-tools.js.map +1 -0
- package/dist/mcp/tools/rules-tools.d.ts +4 -0
- package/dist/mcp/tools/rules-tools.d.ts.map +1 -0
- package/dist/mcp/tools/rules-tools.js +47 -0
- package/dist/mcp/tools/rules-tools.js.map +1 -0
- package/dist/mcp/tools/skill-tools.d.ts +5 -0
- package/dist/mcp/tools/skill-tools.d.ts.map +1 -0
- package/dist/mcp/tools/skill-tools.js +330 -0
- package/dist/mcp/tools/skill-tools.js.map +1 -0
- package/dist/mcp/tools/task-tools.d.ts +5 -0
- package/dist/mcp/tools/task-tools.d.ts.map +1 -0
- package/dist/mcp/tools/task-tools.js +185 -0
- package/dist/mcp/tools/task-tools.js.map +1 -0
- package/dist/mcp/tools/workspace-tools.d.ts +6 -0
- package/dist/mcp/tools/workspace-tools.d.ts.map +1 -0
- package/dist/mcp/tools/workspace-tools.js +118 -0
- package/dist/mcp/tools/workspace-tools.js.map +1 -0
- package/dist/types.d.ts +1 -46
- package/dist/types.d.ts.map +1 -1
- package/dist/utils/file-system.d.ts.map +1 -1
- package/dist/utils/file-system.js.map +1 -1
- package/dist/utils/git-hooks.d.ts.map +1 -1
- package/dist/utils/git-hooks.js.map +1 -1
- package/dist/utils/gitignore.d.ts.map +1 -1
- package/dist/utils/gitignore.js.map +1 -1
- package/dist/utils/rulesignore.d.ts.map +1 -1
- package/dist/utils/rulesignore.js.map +1 -1
- package/package.json +25 -27
- package/templates/agents/architect.md +51 -51
- package/templates/agents/build-engineer.md +36 -36
- package/templates/agents/code-reviewer.md +47 -47
- package/templates/agents/docs-writer.md +38 -38
- package/templates/agents/implementer.md +42 -42
- package/templates/agents/performance-engineer.md +49 -49
- package/templates/agents/researcher.md +38 -38
- package/templates/agents/security-reviewer.md +40 -40
- package/templates/agents/team-lead.md +37 -37
- package/templates/agents/tester.md +48 -48
- package/templates/ci/rulebook-review.yml +26 -26
- package/templates/claude-workflows/review-fanout.js +2 -2
- package/templates/claude-workflows/rulebook-driver.js +16 -4
- package/templates/cli/CLAUDE.md +102 -117
- package/templates/cli/_GENERIC_TEMPLATE.md +29 -29
- package/templates/commands/rulebook-decision-create.md +55 -55
- package/templates/commands/rulebook-decision-list.md +15 -15
- package/templates/commands/rulebook-knowledge-add.md +41 -41
- package/templates/commands/rulebook-knowledge-list.md +15 -15
- package/templates/commands/rulebook-learn-capture.md +1 -2
- package/templates/commands/rulebook-task-apply.md +67 -67
- package/templates/commands/rulebook-task-archive.md +94 -94
- package/templates/commands/rulebook-task-create.md +93 -93
- package/templates/commands/rulebook-task-list.md +42 -42
- package/templates/commands/rulebook-task-show.md +52 -52
- package/templates/commands/rulebook-task-validate.md +53 -53
- package/templates/compact-context/_default.md +23 -23
- package/templates/compact-context/cpp.md +26 -26
- package/templates/compact-context/go.md +26 -26
- package/templates/compact-context/python.md +26 -26
- package/templates/compact-context/rust.md +28 -28
- package/templates/compact-context/typescript.md +29 -29
- package/templates/core/AGENTS_LEAN.md +4 -9
- package/templates/core/AGENTS_OVERRIDE.md +16 -16
- package/templates/core/AGENT_AUTOMATION.md +273 -296
- package/templates/core/CLAUDE_MD_v2.md +85 -90
- package/templates/core/DAG.md +304 -304
- package/templates/core/DECISIONS.md +38 -38
- package/templates/core/DOCUMENTATION_RULES.md +36 -36
- package/templates/core/KNOWLEDGE.md +49 -49
- package/templates/core/MULTI_AGENT.md +74 -74
- package/templates/core/PLANS.md +28 -28
- package/templates/core/QUALITY_ENFORCEMENT.md +68 -68
- package/templates/core/RULEBOOK.md +1936 -1947
- package/templates/core/TIER1_PROHIBITIONS.md +154 -154
- package/templates/core/TOKEN_OPTIMIZATION.md +49 -49
- package/templates/core/WORKSPACE.md +4 -8
- package/templates/git/CI_CD_PATTERNS.md +661 -661
- package/templates/git/GITHUB_ACTIONS.md +728 -728
- package/templates/git/GITLAB_CI.md +730 -730
- package/templates/git/GIT_WORKFLOW.md +1192 -1192
- package/templates/git/SECRETS_MANAGEMENT.md +585 -585
- package/templates/hooks/COMMIT_MSG.md +530 -530
- package/templates/hooks/POST_CHECKOUT.md +546 -546
- package/templates/hooks/PREPARE_COMMIT_MSG.md +619 -619
- package/templates/hooks/PRE_COMMIT.md +414 -414
- package/templates/hooks/PRE_PUSH.md +601 -601
- package/templates/hooks/enforce-pre-tool.sh +26 -9
- package/templates/hooks/update-check.ps1 +84 -84
- package/templates/hooks/update-check.sh +45 -21
- package/templates/languages/C.md +333 -333
- package/templates/languages/CPP.md +743 -743
- package/templates/languages/CSHARP.md +417 -417
- package/templates/languages/ELIXIR.md +454 -454
- package/templates/languages/ERLANG.md +361 -361
- package/templates/languages/GO.md +645 -645
- package/templates/languages/HASKELL.md +177 -177
- package/templates/languages/JAVA.md +607 -607
- package/templates/languages/JAVASCRIPT.md +631 -631
- package/templates/languages/JULIA.md +97 -97
- package/templates/languages/KOTLIN.md +511 -511
- package/templates/languages/LISP.md +100 -100
- package/templates/languages/LUA.md +74 -74
- package/templates/languages/OBJECTIVEC.md +90 -90
- package/templates/languages/PHP.md +416 -416
- package/templates/languages/PYTHON.md +682 -682
- package/templates/languages/RUBY.md +421 -421
- package/templates/languages/RUST.md +477 -477
- package/templates/languages/SAS.md +73 -73
- package/templates/languages/SCALA.md +348 -348
- package/templates/languages/SOLIDITY.md +580 -580
- package/templates/languages/SQL.md +137 -137
- package/templates/languages/SWIFT.md +466 -466
- package/templates/languages/TYPESCRIPT.md +591 -591
- package/templates/languages/ZIG.md +265 -265
- package/templates/modules/CONTEXT7.md +54 -54
- package/templates/modules/GITHUB_MCP.md +64 -64
- package/templates/modules/PLAYWRIGHT.md +90 -90
- package/templates/modules/RULEBOOK_MCP.md +208 -208
- package/templates/modules/SERENA.md +337 -337
- package/templates/modules/SUPABASE.md +223 -223
- package/templates/modules/SYNAP.md +69 -69
- package/templates/modules/VECTORIZER.md +63 -63
- package/templates/modules/sequential-thinking.md +42 -42
- package/templates/rules/consult-analysis-before-implementing.md +21 -23
- package/templates/rules/cpp.md +46 -46
- package/templates/rules/csharp.md +44 -44
- package/templates/rules/diagnostic-first.md +39 -39
- package/templates/rules/fail-twice-escalate.md +46 -46
- package/templates/rules/follow-task-sequence.md +36 -36
- package/templates/rules/git-safety.md +29 -29
- package/templates/rules/go.md +40 -40
- package/templates/rules/incremental-implementation.md +56 -56
- package/templates/rules/incremental-tests.md +29 -29
- package/templates/rules/java.md +43 -43
- package/templates/rules/javascript.md +39 -39
- package/templates/rules/knowledge-base-usage.md +41 -41
- package/templates/rules/multi-agent-teams.md +75 -75
- package/templates/rules/no-deferred.md +31 -31
- package/templates/rules/no-shortcuts.md +30 -30
- package/templates/rules/python.md +43 -43
- package/templates/rules/research-first.md +30 -30
- package/templates/rules/respect-handoff-trigger.md +41 -41
- package/templates/rules/rust.md +40 -40
- package/templates/rules/sequential-editing.md +21 -21
- package/templates/rules/session-workflow.md +24 -24
- package/templates/rules/task-decomposition.md +32 -32
- package/templates/rules/typescript.md +40 -40
- package/templates/skills/cli/claude/SKILL.md +42 -42
- package/templates/skills/core/agent-automation/SKILL.md +194 -194
- package/templates/skills/core/dag/SKILL.md +314 -314
- package/templates/skills/core/documentation-rules/SKILL.md +46 -46
- package/templates/skills/core/quality-enforcement/SKILL.md +78 -78
- package/templates/skills/core/rulebook/SKILL.md +176 -176
- package/templates/skills/core/rulebook-terse/SKILL.md +116 -116
- package/templates/skills/core/rulebook-terse-commit/SKILL.md +96 -96
- package/templates/skills/core/rulebook-terse-review/SKILL.md +112 -112
- package/templates/skills/dev/accessibility/SKILL.md +17 -17
- package/templates/skills/dev/analysis/SKILL.md +19 -19
- package/templates/skills/dev/api-design/SKILL.md +15 -15
- package/templates/skills/dev/architect/SKILL.md +17 -17
- package/templates/skills/dev/build-fix/SKILL.md +17 -17
- package/templates/skills/dev/db-design/SKILL.md +15 -15
- package/templates/skills/dev/debug/SKILL.md +16 -16
- package/templates/skills/dev/deploy/SKILL.md +17 -17
- package/templates/skills/dev/docs/SKILL.md +17 -17
- package/templates/skills/dev/handoff/SKILL.md +27 -27
- package/templates/skills/dev/migrate/SKILL.md +15 -15
- package/templates/skills/dev/perf/SKILL.md +17 -17
- package/templates/skills/dev/refactor/SKILL.md +17 -17
- package/templates/skills/dev/research/SKILL.md +14 -14
- package/templates/skills/dev/review/SKILL.md +18 -18
- package/templates/skills/dev/security-audit/SKILL.md +17 -17
- package/templates/skills/languages/c/SKILL.md +343 -343
- package/templates/skills/languages/cpp/SKILL.md +753 -753
- package/templates/skills/languages/csharp/SKILL.md +427 -427
- package/templates/skills/languages/elixir/SKILL.md +464 -464
- package/templates/skills/languages/erlang/SKILL.md +371 -371
- package/templates/skills/languages/go/SKILL.md +655 -655
- package/templates/skills/languages/haskell/SKILL.md +187 -187
- package/templates/skills/languages/java/SKILL.md +617 -617
- package/templates/skills/languages/javascript/SKILL.md +641 -641
- package/templates/skills/languages/julia/SKILL.md +107 -107
- package/templates/skills/languages/kotlin/SKILL.md +521 -521
- package/templates/skills/languages/lisp/SKILL.md +110 -110
- package/templates/skills/languages/lua/SKILL.md +84 -84
- package/templates/skills/languages/objectivec/SKILL.md +100 -100
- package/templates/skills/languages/php/SKILL.md +426 -426
- package/templates/skills/languages/python/SKILL.md +692 -692
- package/templates/skills/languages/ruby/SKILL.md +431 -431
- package/templates/skills/languages/rust/SKILL.md +487 -487
- package/templates/skills/languages/sas/SKILL.md +83 -83
- package/templates/skills/languages/scala/SKILL.md +358 -358
- package/templates/skills/languages/solidity/SKILL.md +590 -590
- package/templates/skills/languages/sql/SKILL.md +147 -147
- package/templates/skills/languages/swift/SKILL.md +476 -476
- package/templates/skills/languages/typescript/SKILL.md +302 -302
- package/templates/skills/languages/zig/SKILL.md +275 -275
- package/templates/skills/modules/context7/SKILL.md +64 -64
- package/templates/skills/modules/github-mcp/SKILL.md +74 -74
- package/templates/skills/modules/playwright/SKILL.md +100 -100
- package/templates/skills/modules/rulebook-mcp/SKILL.md +166 -166
- package/templates/skills/modules/serena/SKILL.md +347 -347
- package/templates/skills/modules/supabase/SKILL.md +233 -233
- package/templates/skills/modules/synap/SKILL.md +79 -79
- package/templates/skills/modules/vectorizer/SKILL.md +73 -73
- package/.claude/commands/analysis.md +0 -35
- package/.claude/commands/continue.md +0 -33
- package/.claude/commands/rulebook-decision-create.md +0 -55
- package/.claude/commands/rulebook-decision-list.md +0 -15
- package/.claude/commands/rulebook-knowledge-add.md +0 -41
- package/.claude/commands/rulebook-knowledge-list.md +0 -15
- package/.claude/commands/rulebook-learn-capture.md +0 -41
- package/.claude/commands/rulebook-learn-list.md +0 -13
- package/.claude/commands/rulebook-memory-save.md +0 -48
- package/.claude/commands/rulebook-memory-search.md +0 -47
- package/.claude/commands/rulebook-task-apply.md +0 -67
- package/.claude/commands/rulebook-task-archive.md +0 -94
- package/.claude/commands/rulebook-task-create.md +0 -93
- package/.claude/commands/rulebook-task-list.md +0 -42
- package/.claude/commands/rulebook-task-show.md +0 -52
- package/.claude/commands/rulebook-task-validate.md +0 -53
- package/.claude-plugin/marketplace.json +0 -28
- package/.claude-plugin/plugin.json +0 -8
- package/dist/agents/claude-code.d.ts +0 -69
- package/dist/agents/claude-code.d.ts.map +0 -1
- package/dist/agents/claude-code.js +0 -180
- package/dist/agents/claude-code.js.map +0 -1
- package/dist/agents/cursor-agent.d.ts +0 -184
- package/dist/agents/cursor-agent.d.ts.map +0 -1
- package/dist/agents/cursor-agent.js +0 -299
- package/dist/agents/cursor-agent.js.map +0 -1
- package/dist/agents/gemini-cli.d.ts +0 -69
- package/dist/agents/gemini-cli.d.ts.map +0 -1
- package/dist/agents/gemini-cli.js +0 -180
- package/dist/agents/gemini-cli.js.map +0 -1
- package/dist/cli/commands/memory.d.ts +0 -30
- package/dist/cli/commands/memory.d.ts.map +0 -1
- package/dist/cli/commands/memory.js +0 -259
- package/dist/cli/commands/memory.js.map +0 -1
- package/dist/core/console/cli-bridge.d.ts +0 -113
- package/dist/core/console/cli-bridge.d.ts.map +0 -1
- package/dist/core/console/cli-bridge.js +0 -1094
- package/dist/core/console/cli-bridge.js.map +0 -1
- package/dist/core/ide/multi-tool-generator.d.ts +0 -59
- package/dist/core/ide/multi-tool-generator.d.ts.map +0 -1
- package/dist/core/ide/multi-tool-generator.js +0 -157
- package/dist/core/ide/multi-tool-generator.js.map +0 -1
- package/dist/core/ide/opencode-generator.d.ts +0 -72
- package/dist/core/ide/opencode-generator.d.ts.map +0 -1
- package/dist/core/ide/opencode-generator.js +0 -450
- package/dist/core/ide/opencode-generator.js.map +0 -1
- package/dist/core/indexer/background-indexer.d.ts +0 -35
- package/dist/core/indexer/background-indexer.d.ts.map +0 -1
- package/dist/core/indexer/background-indexer.js +0 -267
- package/dist/core/indexer/background-indexer.js.map +0 -1
- package/dist/core/indexer/file-parser.d.ts +0 -28
- package/dist/core/indexer/file-parser.d.ts.map +0 -1
- package/dist/core/indexer/file-parser.js +0 -171
- package/dist/core/indexer/file-parser.js.map +0 -1
- package/dist/core/indexer/indexer-types.d.ts +0 -37
- package/dist/core/indexer/indexer-types.d.ts.map +0 -1
- package/dist/core/indexer/indexer-types.js +0 -8
- package/dist/core/indexer/indexer-types.js.map +0 -1
- package/dist/memory/file-search.d.ts +0 -43
- package/dist/memory/file-search.d.ts.map +0 -1
- package/dist/memory/file-search.js +0 -228
- package/dist/memory/file-search.js.map +0 -1
- package/dist/memory/file-store.d.ts +0 -99
- package/dist/memory/file-store.d.ts.map +0 -1
- package/dist/memory/file-store.js +0 -615
- package/dist/memory/file-store.js.map +0 -1
- package/dist/memory/legacy-migrator.d.ts +0 -27
- package/dist/memory/legacy-migrator.d.ts.map +0 -1
- package/dist/memory/legacy-migrator.js +0 -185
- package/dist/memory/legacy-migrator.js.map +0 -1
- package/dist/memory/memory-hooks.d.ts +0 -48
- package/dist/memory/memory-hooks.d.ts.map +0 -1
- package/dist/memory/memory-hooks.js +0 -248
- package/dist/memory/memory-hooks.js.map +0 -1
- package/dist/memory/memory-manager.d.ts +0 -65
- package/dist/memory/memory-manager.d.ts.map +0 -1
- package/dist/memory/memory-manager.js +0 -223
- package/dist/memory/memory-manager.js.map +0 -1
- package/dist/memory/memory-types.d.ts +0 -85
- package/dist/memory/memory-types.d.ts.map +0 -1
- package/dist/memory/memory-types.js +0 -7
- package/dist/memory/memory-types.js.map +0 -1
- package/templates/agents/accessibility-reviewer.md +0 -43
- package/templates/agents/api-designer.md +0 -42
- package/templates/agents/compiler/codegen-debugger.md +0 -34
- package/templates/agents/compiler/stdlib-engineer.md +0 -28
- package/templates/agents/compiler/test-coverage-guardian.md +0 -31
- package/templates/agents/context-intelligence.md +0 -50
- package/templates/agents/database-architect.md +0 -41
- package/templates/agents/devops-engineer.md +0 -42
- package/templates/agents/game-engine/cpp-core-expert.md +0 -35
- package/templates/agents/game-engine/render-engineer.md +0 -22
- package/templates/agents/game-engine/shader-engineer.md +0 -38
- package/templates/agents/game-engine/systems-integration.md +0 -43
- package/templates/agents/generic/code-reviewer.md +0 -41
- package/templates/agents/generic/docs-writer.md +0 -25
- package/templates/agents/generic/project-manager.md +0 -36
- package/templates/agents/generic/researcher.md +0 -34
- package/templates/agents/generic/test-engineer.md +0 -41
- package/templates/agents/i18n-engineer.md +0 -42
- package/templates/agents/migration-engineer.md +0 -42
- package/templates/agents/mobile/platform-specialist.md +0 -22
- package/templates/agents/mobile/ui-engineer.md +0 -22
- package/templates/agents/project-manager.md +0 -217
- package/templates/agents/refactoring-agent.md +0 -41
- package/templates/agents/ux-reviewer.md +0 -43
- package/templates/agents/web-app/api-designer.md +0 -22
- package/templates/agents/web-app/backend-engineer.md +0 -30
- package/templates/agents/web-app/database-engineer.md +0 -22
- package/templates/agents/web-app/frontend-engineer.md +0 -29
- package/templates/agents/web-app/security-reviewer.md +0 -32
- package/templates/cli/AIDER.md +0 -49
- package/templates/cli/AMAZON_Q.md +0 -25
- package/templates/cli/AUGGIE.md +0 -32
- package/templates/cli/CLINE.md +0 -99
- package/templates/cli/CODEBUDDY.md +0 -20
- package/templates/cli/CODEIUM.md +0 -20
- package/templates/cli/CODEX.md +0 -21
- package/templates/cli/CONTINUE.md +0 -34
- package/templates/cli/CURSOR_CLI.md +0 -62
- package/templates/cli/FACTORY.md +0 -18
- package/templates/cli/GEMINI.md +0 -35
- package/templates/cli/KILOCODE.md +0 -18
- package/templates/cli/OPENCODE.md +0 -85
- package/templates/cli/gemini-extension.json +0 -77
- package/templates/commands/rulebook-memory-save.md +0 -48
- package/templates/commands/rulebook-memory-search.md +0 -47
- package/templates/ides/CONTINUE_RULES.md +0 -16
- package/templates/ides/COPILOT_INSTRUCTIONS.md +0 -23
- package/templates/ides/GEMINI_RULES.md +0 -17
- package/templates/ides/OPENCODE.md +0 -63
- package/templates/ides/WINDSURF_RULES.md +0 -14
- package/templates/modules/ATLASSIAN.md +0 -255
- package/templates/modules/FIGMA.md +0 -267
- package/templates/modules/GRAFANA.md +0 -328
- package/templates/modules/MEMORY.md +0 -126
- package/templates/modules/NOTION.md +0 -247
- package/templates/skills/cli/aider/SKILL.md +0 -59
- package/templates/skills/cli/amazon-q/SKILL.md +0 -35
- package/templates/skills/cli/auggie/SKILL.md +0 -42
- package/templates/skills/cli/cline/SKILL.md +0 -42
- package/templates/skills/cli/codebuddy/SKILL.md +0 -30
- package/templates/skills/cli/codeium/SKILL.md +0 -30
- package/templates/skills/cli/codex/SKILL.md +0 -31
- package/templates/skills/cli/continue/SKILL.md +0 -44
- package/templates/skills/cli/cursor-cli/SKILL.md +0 -38
- package/templates/skills/cli/factory/SKILL.md +0 -28
- package/templates/skills/cli/gemini/SKILL.md +0 -45
- package/templates/skills/cli/kilocode/SKILL.md +0 -28
- package/templates/skills/cli/opencode/SKILL.md +0 -82
- package/templates/skills/ides/copilot/SKILL.md +0 -47
- package/templates/skills/ides/cursor/SKILL.md +0 -53
- package/templates/skills/ides/jetbrains-ai/SKILL.md +0 -45
- package/templates/skills/ides/replit/SKILL.md +0 -46
- package/templates/skills/ides/tabnine/SKILL.md +0 -39
- package/templates/skills/ides/vscode/SKILL.md +0 -50
- package/templates/skills/ides/windsurf/SKILL.md +0 -46
- package/templates/skills/ides/zed/SKILL.md +0 -42
- package/templates/skills/modules/atlassian/SKILL.md +0 -265
- package/templates/skills/modules/figma/SKILL.md +0 -277
- package/templates/skills/modules/grafana/SKILL.md +0 -338
- package/templates/skills/modules/memory/SKILL.md +0 -73
- package/templates/skills/modules/notion/SKILL.md +0 -257
package/templates/cli/CLAUDE.md
CHANGED
|
@@ -1,117 +1,102 @@
|
|
|
1
|
-
<!-- CLAUDE:START -->
|
|
2
|
-
# Claude API/CLI Rules
|
|
3
|
-
|
|
4
|
-
**Tool**: Anthropic Claude API with 200K context window
|
|
5
|
-
|
|
6
|
-
## Quick Start
|
|
7
|
-
|
|
8
|
-
```bash
|
|
9
|
-
export ANTHROPIC_API_KEY=your_key
|
|
10
|
-
# Use via API or compatible CLIs
|
|
11
|
-
```
|
|
12
|
-
|
|
13
|
-
## Usage
|
|
14
|
-
|
|
15
|
-
In API requests or CLI prompts, include:
|
|
16
|
-
```
|
|
17
|
-
"Follow these project standards from AGENTS.md:
|
|
18
|
-
[paste relevant AGENTS.md sections]
|
|
19
|
-
|
|
20
|
-
Implement [feature] with tests first (95%+ coverage)."
|
|
21
|
-
```
|
|
22
|
-
|
|
23
|
-
## Workflow
|
|
24
|
-
|
|
25
|
-
1. Include AGENTS.md content in system prompt or context
|
|
26
|
-
2. Request features with standards reference
|
|
27
|
-
3. Review generated code
|
|
28
|
-
4. Run quality checks
|
|
29
|
-
5.
|
|
30
|
-
|
|
31
|
-
**Critical**: Claude has 200K context - paste full AGENTS.md for best results.
|
|
32
|
-
|
|
33
|
-
## ⚠️ Token Optimization (CRITICAL)
|
|
34
|
-
|
|
35
|
-
**MINIMIZE unnecessary output to reduce token consumption:**
|
|
36
|
-
|
|
37
|
-
### DO ✅
|
|
38
|
-
- Output code directly without explanations
|
|
39
|
-
- Use code comments for complex logic instead of markdown
|
|
40
|
-
- Return results concisely: "✅ Done" or "❌ Error: reason"
|
|
41
|
-
- Use tables only when absolutely necessary
|
|
42
|
-
- Combine multiple small outputs into single response
|
|
43
|
-
|
|
44
|
-
### DON'T ❌
|
|
45
|
-
- **NEVER generate markdown reports or summaries** unless explicitly requested
|
|
46
|
-
- **NEVER use excessive heading levels** (#, ##, ###, etc.)
|
|
47
|
-
- **NEVER create "Quality Checks" sections** with status boxes
|
|
48
|
-
- **NEVER output commit messages verbatim** - just say "committed"
|
|
49
|
-
- **NEVER explain what you did** - assume user knows project structure
|
|
50
|
-
- **NEVER use emoji status lines** (✅ Type check: Passed) - too verbose
|
|
51
|
-
- **NEVER generate "Next Steps" sections** - just do the work
|
|
52
|
-
- **NEVER output implementation details in plain text** - put in code comments
|
|
53
|
-
|
|
54
|
-
### Example: BAD (Wastes Tokens)
|
|
55
|
-
```
|
|
56
|
-
✅ Implementation Complete
|
|
57
|
-
|
|
58
|
-
📝 Changes:
|
|
59
|
-
- Added UserService class
|
|
60
|
-
- Added authentication middleware
|
|
61
|
-
- Updated routes configuration
|
|
62
|
-
|
|
63
|
-
🧪 Quality Checks:
|
|
64
|
-
- ✅ Type check: Passed
|
|
65
|
-
- ✅ Linting: Passed (0 warnings)
|
|
66
|
-
- ✅ Tests: 45/45 passed (100%)
|
|
67
|
-
- ✅ Coverage: 96% (threshold: 95%)
|
|
68
|
-
|
|
69
|
-
📊 Summary:
|
|
70
|
-
This implementation adds...
|
|
71
|
-
|
|
72
|
-
Next Steps:
|
|
73
|
-
1. Review the code
|
|
74
|
-
2. Deploy to production
|
|
75
|
-
```
|
|
76
|
-
|
|
77
|
-
### Example: GOOD (Efficient)
|
|
78
|
-
```
|
|
79
|
-
✅ Done. UserService added with auth middleware.
|
|
80
|
-
```
|
|
81
|
-
|
|
82
|
-
Put details in code comments, not markdown.
|
|
83
|
-
|
|
84
|
-
##
|
|
85
|
-
|
|
86
|
-
###
|
|
87
|
-
Before implementing a feature,
|
|
88
|
-
|
|
89
|
-
```bash
|
|
90
|
-
|
|
91
|
-
rulebook
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
# Save bugfix insights
|
|
105
|
-
rulebook memory save "Fixed [bug] by [solution]. Root cause: [why it happened]. Test case: [added validation]" --type bugfix --title "[Bug description]" --tags bugfix,area
|
|
106
|
-
|
|
107
|
-
# Save architectural decisions
|
|
108
|
-
rulebook memory save "Chose [approach] over [alternative] because [reasoning]. Tradeoffs: [what was sacrificed]. Future implications: [impact on architecture]" --type decision --title "[Decision name]" --tags architecture,decision
|
|
109
|
-
```
|
|
110
|
-
|
|
111
|
-
### Use Context from Memory
|
|
112
|
-
When Claude Code returns, your memory system auto-captures learnings. Review and augment:
|
|
113
|
-
1. Search relevant memories: `rulebook memory search "your topic"`
|
|
114
|
-
2. Review 3-layer search results: compact → timeline → full details
|
|
115
|
-
3. Reference past patterns in new implementations
|
|
116
|
-
|
|
117
|
-
<!-- CLAUDE:END -->
|
|
1
|
+
<!-- CLAUDE:START -->
|
|
2
|
+
# Claude API/CLI Rules
|
|
3
|
+
|
|
4
|
+
**Tool**: Anthropic Claude API with 200K context window
|
|
5
|
+
|
|
6
|
+
## Quick Start
|
|
7
|
+
|
|
8
|
+
```bash
|
|
9
|
+
export ANTHROPIC_API_KEY=your_key
|
|
10
|
+
# Use via API or compatible CLIs
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Usage
|
|
14
|
+
|
|
15
|
+
In API requests or CLI prompts, include:
|
|
16
|
+
```
|
|
17
|
+
"Follow these project standards from AGENTS.md:
|
|
18
|
+
[paste relevant AGENTS.md sections]
|
|
19
|
+
|
|
20
|
+
Implement [feature] with tests first (95%+ coverage)."
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
## Workflow
|
|
24
|
+
|
|
25
|
+
1. Include AGENTS.md content in system prompt or context
|
|
26
|
+
2. Request features with standards reference
|
|
27
|
+
3. Review generated code
|
|
28
|
+
4. Run quality checks
|
|
29
|
+
5. Capture knowledge/learnings/decisions
|
|
30
|
+
|
|
31
|
+
**Critical**: Claude has 200K context - paste full AGENTS.md for best results.
|
|
32
|
+
|
|
33
|
+
## ⚠️ Token Optimization (CRITICAL)
|
|
34
|
+
|
|
35
|
+
**MINIMIZE unnecessary output to reduce token consumption:**
|
|
36
|
+
|
|
37
|
+
### DO ✅
|
|
38
|
+
- Output code directly without explanations
|
|
39
|
+
- Use code comments for complex logic instead of markdown
|
|
40
|
+
- Return results concisely: "✅ Done" or "❌ Error: reason"
|
|
41
|
+
- Use tables only when absolutely necessary
|
|
42
|
+
- Combine multiple small outputs into single response
|
|
43
|
+
|
|
44
|
+
### DON'T ❌
|
|
45
|
+
- **NEVER generate markdown reports or summaries** unless explicitly requested
|
|
46
|
+
- **NEVER use excessive heading levels** (#, ##, ###, etc.)
|
|
47
|
+
- **NEVER create "Quality Checks" sections** with status boxes
|
|
48
|
+
- **NEVER output commit messages verbatim** - just say "committed"
|
|
49
|
+
- **NEVER explain what you did** - assume user knows project structure
|
|
50
|
+
- **NEVER use emoji status lines** (✅ Type check: Passed) - too verbose
|
|
51
|
+
- **NEVER generate "Next Steps" sections** - just do the work
|
|
52
|
+
- **NEVER output implementation details in plain text** - put in code comments
|
|
53
|
+
|
|
54
|
+
### Example: BAD (Wastes Tokens)
|
|
55
|
+
```
|
|
56
|
+
✅ Implementation Complete
|
|
57
|
+
|
|
58
|
+
📝 Changes:
|
|
59
|
+
- Added UserService class
|
|
60
|
+
- Added authentication middleware
|
|
61
|
+
- Updated routes configuration
|
|
62
|
+
|
|
63
|
+
🧪 Quality Checks:
|
|
64
|
+
- ✅ Type check: Passed
|
|
65
|
+
- ✅ Linting: Passed (0 warnings)
|
|
66
|
+
- ✅ Tests: 45/45 passed (100%)
|
|
67
|
+
- ✅ Coverage: 96% (threshold: 95%)
|
|
68
|
+
|
|
69
|
+
📊 Summary:
|
|
70
|
+
This implementation adds...
|
|
71
|
+
|
|
72
|
+
Next Steps:
|
|
73
|
+
1. Review the code
|
|
74
|
+
2. Deploy to production
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
### Example: GOOD (Efficient)
|
|
78
|
+
```
|
|
79
|
+
✅ Done. UserService added with auth middleware.
|
|
80
|
+
```
|
|
81
|
+
|
|
82
|
+
Put details in code comments, not markdown.
|
|
83
|
+
|
|
84
|
+
## Knowledge Capture
|
|
85
|
+
|
|
86
|
+
### Review Past Context
|
|
87
|
+
Before implementing a feature, review the file-based knowledge base for similar past work:
|
|
88
|
+
|
|
89
|
+
```bash
|
|
90
|
+
rulebook knowledge list
|
|
91
|
+
rulebook learn list
|
|
92
|
+
rulebook decision list
|
|
93
|
+
```
|
|
94
|
+
|
|
95
|
+
### Capture Implementation Insights
|
|
96
|
+
After completing implementation, record key learnings (committed with the repo):
|
|
97
|
+
|
|
98
|
+
- `rulebook_knowledge_add` — reusable patterns and anti-patterns.
|
|
99
|
+
- `rulebook_learn_capture` — gotchas, edge cases, and performance insights.
|
|
100
|
+
- `rulebook_decision_create` — architectural decisions and their tradeoffs.
|
|
101
|
+
|
|
102
|
+
<!-- CLAUDE:END -->
|
|
@@ -1,29 +1,29 @@
|
|
|
1
|
-
<!-- {TOOL}:START -->
|
|
2
|
-
# {Tool Name} CLI Rules
|
|
3
|
-
|
|
4
|
-
**Tool**: {Brief description}
|
|
5
|
-
|
|
6
|
-
## Quick Start
|
|
7
|
-
|
|
8
|
-
```bash
|
|
9
|
-
{installation command}
|
|
10
|
-
```
|
|
11
|
-
|
|
12
|
-
## Usage
|
|
13
|
-
|
|
14
|
-
Always reference AGENTS.md in prompts:
|
|
15
|
-
```
|
|
16
|
-
"Follow @AGENTS.md standards. Implement [feature] with tests first (95%+ coverage)."
|
|
17
|
-
```
|
|
18
|
-
|
|
19
|
-
## Workflow
|
|
20
|
-
|
|
21
|
-
1. Include AGENTS.md in context (tool-specific method)
|
|
22
|
-
2. Request features with "@AGENTS.md" reference
|
|
23
|
-
3. Review generated code
|
|
24
|
-
4. Run quality checks: `npm run lint && npm test`
|
|
25
|
-
|
|
26
|
-
**Critical**: Reference AGENTS.md for consistent standards.
|
|
27
|
-
|
|
28
|
-
<!-- {TOOL}:END -->
|
|
29
|
-
|
|
1
|
+
<!-- {TOOL}:START -->
|
|
2
|
+
# {Tool Name} CLI Rules
|
|
3
|
+
|
|
4
|
+
**Tool**: {Brief description}
|
|
5
|
+
|
|
6
|
+
## Quick Start
|
|
7
|
+
|
|
8
|
+
```bash
|
|
9
|
+
{installation command}
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
## Usage
|
|
13
|
+
|
|
14
|
+
Always reference AGENTS.md in prompts:
|
|
15
|
+
```
|
|
16
|
+
"Follow @AGENTS.md standards. Implement [feature] with tests first (95%+ coverage)."
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
## Workflow
|
|
20
|
+
|
|
21
|
+
1. Include AGENTS.md in context (tool-specific method)
|
|
22
|
+
2. Request features with "@AGENTS.md" reference
|
|
23
|
+
3. Review generated code
|
|
24
|
+
4. Run quality checks: `npm run lint && npm test`
|
|
25
|
+
|
|
26
|
+
**Critical**: Reference AGENTS.md for consistent standards.
|
|
27
|
+
|
|
28
|
+
<!-- {TOOL}:END -->
|
|
29
|
+
|
|
@@ -1,55 +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 -->
|
|
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 -->
|
|
@@ -1,15 +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 -->
|
|
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 -->
|
|
@@ -1,41 +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 -->
|
|
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 -->
|
|
@@ -1,15 +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 -->
|
|
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 -->
|
|
@@ -6,7 +6,7 @@ description: Capture a learning from implementation work for future reference.
|
|
|
6
6
|
---
|
|
7
7
|
<!-- RULEBOOK:START -->
|
|
8
8
|
**Guardrails**
|
|
9
|
-
- Learnings are saved
|
|
9
|
+
- Learnings are saved as markdown under `.rulebook/learnings/`, committed with the repo.
|
|
10
10
|
- Learnings can be promoted to patterns/decisions later via `rulebook learn promote`.
|
|
11
11
|
|
|
12
12
|
**Steps**
|
|
@@ -35,7 +35,6 @@ rulebook learn promote <id> decision # → creates an ADR
|
|
|
35
35
|
```
|
|
36
36
|
|
|
37
37
|
**Reference**
|
|
38
|
-
- Learnings are searchable via `rulebook memory search`
|
|
39
38
|
- Use `rulebook learn list` to see all learnings
|
|
40
39
|
- Learnings captured during `rulebook task archive` have source `task-archive`
|
|
41
40
|
<!-- RULEBOOK:END -->
|