@hivehub/rulebook 4.0.0 → 4.2.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/continue.md +33 -33
- package/.claude/commands/ralph-config.md +112 -112
- package/.claude/commands/ralph-history.md +110 -110
- package/.claude/commands/ralph-init.md +72 -72
- package/.claude/commands/ralph-pause-resume.md +105 -105
- package/.claude/commands/ralph-run.md +101 -101
- package/.claude/commands/ralph-status.md +76 -76
- package/.claude/commands/rulebook-memory-save.md +48 -48
- package/.claude/commands/rulebook-memory-search.md +47 -47
- package/.claude/commands/rulebook-task-apply.md +67 -67
- package/.claude/commands/rulebook-task-archive.md +70 -70
- package/.claude/commands/rulebook-task-create.md +93 -93
- package/.claude/commands/rulebook-task-list.md +42 -42
- package/.claude/commands/rulebook-task-show.md +52 -52
- package/.claude/commands/rulebook-task-validate.md +53 -53
- package/.claude-plugin/marketplace.json +28 -28
- package/.claude-plugin/plugin.json +8 -8
- package/README.md +34 -0
- package/dist/cli/commands.d.ts +18 -6
- package/dist/cli/commands.d.ts.map +1 -1
- package/dist/cli/commands.js +717 -406
- package/dist/cli/commands.js.map +1 -1
- package/dist/core/claude-mcp.d.ts +4 -2
- package/dist/core/claude-mcp.d.ts.map +1 -1
- package/dist/core/claude-mcp.js +14 -9
- package/dist/core/claude-mcp.js.map +1 -1
- package/dist/core/generator.d.ts.map +1 -1
- package/dist/core/generator.js +13 -0
- package/dist/core/generator.js.map +1 -1
- package/dist/core/indexer/background-indexer.d.ts +27 -0
- package/dist/core/indexer/background-indexer.d.ts.map +1 -0
- package/dist/core/indexer/background-indexer.js +156 -0
- package/dist/core/indexer/background-indexer.js.map +1 -0
- package/dist/core/indexer/file-parser.d.ts +28 -0
- package/dist/core/indexer/file-parser.d.ts.map +1 -0
- package/dist/core/indexer/file-parser.js +171 -0
- package/dist/core/indexer/file-parser.js.map +1 -0
- package/dist/core/indexer/indexer-types.d.ts +35 -0
- package/dist/core/indexer/indexer-types.d.ts.map +1 -0
- package/dist/core/indexer/indexer-types.js +8 -0
- package/dist/core/indexer/indexer-types.js.map +1 -0
- package/dist/core/workspace/legacy-migrator.d.ts +29 -0
- package/dist/core/workspace/legacy-migrator.d.ts.map +1 -0
- package/dist/core/workspace/legacy-migrator.js +142 -0
- package/dist/core/workspace/legacy-migrator.js.map +1 -0
- package/dist/core/workspace/project-worker.d.ts +49 -0
- package/dist/core/workspace/project-worker.d.ts.map +1 -0
- package/dist/core/workspace/project-worker.js +108 -0
- package/dist/core/workspace/project-worker.js.map +1 -0
- package/dist/core/workspace/workspace-manager.d.ts +90 -0
- package/dist/core/workspace/workspace-manager.d.ts.map +1 -0
- package/dist/core/workspace/workspace-manager.js +337 -0
- package/dist/core/workspace/workspace-manager.js.map +1 -0
- package/dist/core/workspace/workspace-types.d.ts +37 -0
- package/dist/core/workspace/workspace-types.d.ts.map +1 -0
- package/dist/core/workspace/workspace-types.js +8 -0
- package/dist/core/workspace/workspace-types.js.map +1 -0
- package/dist/index.js +43 -7
- package/dist/index.js.map +1 -1
- package/dist/mcp/rulebook-server.d.ts.map +1 -1
- package/dist/mcp/rulebook-server.js +450 -81
- package/dist/mcp/rulebook-server.js.map +1 -1
- package/dist/memory/memory-manager.d.ts +4 -1
- package/dist/memory/memory-manager.d.ts.map +1 -1
- package/dist/memory/memory-manager.js +33 -4
- package/dist/memory/memory-manager.js.map +1 -1
- package/dist/memory/memory-search.d.ts +2 -2
- package/dist/memory/memory-search.d.ts.map +1 -1
- package/dist/memory/memory-search.js +19 -0
- package/dist/memory/memory-search.js.map +1 -1
- package/dist/memory/memory-store.d.ts +13 -0
- package/dist/memory/memory-store.d.ts.map +1 -1
- package/dist/memory/memory-store.js +88 -1
- package/dist/memory/memory-store.js.map +1 -1
- package/dist/memory/memory-types.d.ts +15 -0
- package/dist/memory/memory-types.d.ts.map +1 -1
- package/dist/types.d.ts +1 -0
- package/dist/types.d.ts.map +1 -1
- package/package.json +22 -21
- package/templates/agents/implementer.md +35 -35
- package/templates/agents/researcher.md +34 -34
- package/templates/agents/team-lead.md +34 -34
- package/templates/agents/tester.md +42 -42
- package/templates/ci/rulebook-review.yml +26 -26
- package/templates/cli/AIDER.md +49 -49
- package/templates/cli/AMAZON_Q.md +25 -25
- package/templates/cli/AUGGIE.md +32 -32
- package/templates/cli/CLAUDE.md +117 -117
- package/templates/cli/CLINE.md +99 -99
- package/templates/cli/CODEBUDDY.md +20 -20
- package/templates/cli/CODEIUM.md +20 -20
- package/templates/cli/CODEX.md +21 -21
- package/templates/cli/CONTINUE.md +34 -34
- package/templates/cli/CURSOR_CLI.md +62 -62
- package/templates/cli/FACTORY.md +18 -18
- package/templates/cli/GEMINI.md +35 -35
- package/templates/cli/KILOCODE.md +18 -18
- package/templates/cli/OPENCODE.md +18 -18
- package/templates/cli/_GENERIC_TEMPLATE.md +29 -29
- package/templates/commands/rulebook-memory-save.md +48 -48
- package/templates/commands/rulebook-memory-search.md +47 -47
- package/templates/commands/rulebook-task-apply.md +67 -67
- package/templates/commands/rulebook-task-archive.md +94 -70
- 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/core/AGENTS_LEAN.md +25 -25
- package/templates/core/AGENTS_OVERRIDE.md +16 -16
- package/templates/core/AGENT_AUTOMATION.md +288 -288
- package/templates/core/DAG.md +304 -304
- package/templates/core/DOCUMENTATION_RULES.md +36 -36
- 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/RALPH.md +471 -471
- package/templates/core/RULEBOOK.md +1935 -1893
- package/templates/core/WORKSPACE.md +69 -0
- package/templates/frameworks/ANGULAR.md +36 -36
- package/templates/frameworks/DJANGO.md +83 -83
- package/templates/frameworks/ELECTRON.md +147 -147
- package/templates/frameworks/FLASK.md +38 -38
- package/templates/frameworks/FLUTTER.md +55 -55
- package/templates/frameworks/JQUERY.md +32 -32
- package/templates/frameworks/LARAVEL.md +38 -38
- package/templates/frameworks/NESTJS.md +43 -43
- package/templates/frameworks/NEXTJS.md +127 -127
- package/templates/frameworks/NUXT.md +40 -40
- package/templates/frameworks/RAILS.md +66 -66
- package/templates/frameworks/REACT.md +38 -38
- package/templates/frameworks/REACT_NATIVE.md +47 -47
- package/templates/frameworks/SPRING.md +39 -39
- package/templates/frameworks/SYMFONY.md +36 -36
- package/templates/frameworks/VUE.md +36 -36
- package/templates/frameworks/ZEND.md +35 -35
- 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 +1157 -1157
- 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/ides/CONTINUE_RULES.md +16 -16
- package/templates/ides/COPILOT.md +37 -37
- package/templates/ides/COPILOT_INSTRUCTIONS.md +23 -23
- package/templates/ides/CURSOR.md +43 -43
- package/templates/ides/GEMINI_RULES.md +17 -17
- package/templates/ides/JETBRAINS_AI.md +35 -35
- package/templates/ides/REPLIT.md +36 -36
- package/templates/ides/TABNINE.md +29 -29
- package/templates/ides/VSCODE.md +40 -40
- package/templates/ides/WINDSURF.md +36 -36
- package/templates/ides/WINDSURF_RULES.md +14 -14
- package/templates/ides/ZED.md +32 -32
- package/templates/ides/cursor-mdc/go.mdc +24 -24
- package/templates/ides/cursor-mdc/python.mdc +24 -24
- package/templates/ides/cursor-mdc/quality.mdc +25 -25
- package/templates/ides/cursor-mdc/ralph.mdc +39 -39
- package/templates/ides/cursor-mdc/rulebook.mdc +38 -38
- package/templates/ides/cursor-mdc/rust.mdc +24 -24
- package/templates/ides/cursor-mdc/typescript.mdc +25 -25
- 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/ATLASSIAN.md +255 -255
- package/templates/modules/CONTEXT7.md +54 -54
- package/templates/modules/FIGMA.md +267 -267
- package/templates/modules/GITHUB_MCP.md +64 -64
- package/templates/modules/GRAFANA.md +328 -328
- package/templates/modules/MEMORY.md +126 -126
- package/templates/modules/NOTION.md +247 -247
- package/templates/modules/PLAYWRIGHT.md +90 -90
- package/templates/modules/RULEBOOK_MCP.md +156 -156
- 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/ralph/ralph-history.bat +4 -4
- package/templates/ralph/ralph-history.sh +5 -5
- package/templates/ralph/ralph-init.bat +5 -5
- package/templates/ralph/ralph-init.sh +5 -5
- package/templates/ralph/ralph-pause.bat +5 -5
- package/templates/ralph/ralph-pause.sh +5 -5
- package/templates/ralph/ralph-run.bat +5 -5
- package/templates/ralph/ralph-run.sh +5 -5
- package/templates/ralph/ralph-status.bat +4 -4
- package/templates/ralph/ralph-status.sh +5 -5
- package/templates/services/AZURE_BLOB.md +184 -184
- package/templates/services/CASSANDRA.md +239 -239
- package/templates/services/DATADOG.md +26 -26
- package/templates/services/DOCKER.md +124 -124
- package/templates/services/DOCKER_COMPOSE.md +168 -168
- package/templates/services/DYNAMODB.md +308 -308
- package/templates/services/ELASTICSEARCH.md +347 -347
- package/templates/services/GCS.md +178 -178
- package/templates/services/HELM.md +194 -194
- package/templates/services/INFLUXDB.md +265 -265
- package/templates/services/KAFKA.md +341 -341
- package/templates/services/KUBERNETES.md +208 -208
- package/templates/services/MARIADB.md +183 -183
- package/templates/services/MEMCACHED.md +242 -242
- package/templates/services/MINIO.md +201 -201
- package/templates/services/MONGODB.md +268 -268
- package/templates/services/MYSQL.md +358 -358
- package/templates/services/NEO4J.md +247 -247
- package/templates/services/OPENTELEMETRY.md +25 -25
- package/templates/services/ORACLE.md +290 -290
- package/templates/services/PINO.md +24 -24
- package/templates/services/POSTGRESQL.md +326 -326
- package/templates/services/PROMETHEUS.md +33 -33
- package/templates/services/RABBITMQ.md +286 -286
- package/templates/services/REDIS.md +292 -292
- package/templates/services/S3.md +298 -298
- package/templates/services/SENTRY.md +23 -23
- package/templates/services/SQLITE.md +294 -294
- package/templates/services/SQLSERVER.md +294 -294
- package/templates/services/WINSTON.md +30 -30
- package/templates/skills/cli/aider/SKILL.md +59 -59
- package/templates/skills/cli/amazon-q/SKILL.md +35 -35
- package/templates/skills/cli/auggie/SKILL.md +42 -42
- package/templates/skills/cli/claude/SKILL.md +42 -42
- package/templates/skills/cli/cline/SKILL.md +42 -42
- package/templates/skills/cli/codebuddy/SKILL.md +30 -30
- package/templates/skills/cli/codeium/SKILL.md +30 -30
- package/templates/skills/cli/codex/SKILL.md +31 -31
- package/templates/skills/cli/continue/SKILL.md +44 -44
- package/templates/skills/cli/cursor-cli/SKILL.md +38 -38
- package/templates/skills/cli/factory/SKILL.md +28 -28
- package/templates/skills/cli/gemini/SKILL.md +45 -45
- package/templates/skills/cli/kilocode/SKILL.md +28 -28
- package/templates/skills/cli/opencode/SKILL.md +28 -28
- 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/frameworks/angular/SKILL.md +46 -46
- package/templates/skills/frameworks/django/SKILL.md +93 -93
- package/templates/skills/frameworks/electron/SKILL.md +157 -157
- package/templates/skills/frameworks/flask/SKILL.md +48 -48
- package/templates/skills/frameworks/flutter/SKILL.md +65 -65
- package/templates/skills/frameworks/jquery/SKILL.md +42 -42
- package/templates/skills/frameworks/laravel/SKILL.md +48 -48
- package/templates/skills/frameworks/nestjs/SKILL.md +53 -53
- package/templates/skills/frameworks/nextjs/SKILL.md +137 -137
- package/templates/skills/frameworks/nuxt/SKILL.md +50 -50
- package/templates/skills/frameworks/rails/SKILL.md +76 -76
- package/templates/skills/frameworks/react/SKILL.md +48 -48
- package/templates/skills/frameworks/react-native/SKILL.md +57 -57
- package/templates/skills/frameworks/spring/SKILL.md +49 -49
- package/templates/skills/frameworks/symfony/SKILL.md +46 -46
- package/templates/skills/frameworks/vue/SKILL.md +46 -46
- package/templates/skills/frameworks/zend/SKILL.md +45 -45
- package/templates/skills/ides/copilot/SKILL.md +47 -47
- package/templates/skills/ides/cursor/SKILL.md +53 -53
- package/templates/skills/ides/jetbrains-ai/SKILL.md +45 -45
- package/templates/skills/ides/replit/SKILL.md +46 -46
- package/templates/skills/ides/tabnine/SKILL.md +39 -39
- package/templates/skills/ides/vscode/SKILL.md +50 -50
- package/templates/skills/ides/windsurf/SKILL.md +46 -46
- package/templates/skills/ides/zed/SKILL.md +42 -42
- 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/atlassian/SKILL.md +265 -265
- package/templates/skills/modules/context7/SKILL.md +64 -64
- package/templates/skills/modules/figma/SKILL.md +277 -277
- package/templates/skills/modules/github-mcp/SKILL.md +74 -74
- package/templates/skills/modules/grafana/SKILL.md +338 -338
- package/templates/skills/modules/memory/SKILL.md +73 -73
- package/templates/skills/modules/notion/SKILL.md +257 -257
- 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/templates/skills/services/azure-blob/SKILL.md +194 -194
- package/templates/skills/services/cassandra/SKILL.md +249 -249
- package/templates/skills/services/dynamodb/SKILL.md +318 -318
- package/templates/skills/services/elasticsearch/SKILL.md +357 -357
- package/templates/skills/services/gcs/SKILL.md +188 -188
- package/templates/skills/services/influxdb/SKILL.md +275 -275
- package/templates/skills/services/kafka/SKILL.md +351 -351
- package/templates/skills/services/mariadb/SKILL.md +193 -193
- package/templates/skills/services/memcached/SKILL.md +252 -252
- package/templates/skills/services/minio/SKILL.md +211 -211
- package/templates/skills/services/mongodb/SKILL.md +278 -278
- package/templates/skills/services/mysql/SKILL.md +368 -368
- package/templates/skills/services/neo4j/SKILL.md +257 -257
- package/templates/skills/services/oracle/SKILL.md +300 -300
- package/templates/skills/services/postgresql/SKILL.md +336 -336
- package/templates/skills/services/rabbitmq/SKILL.md +296 -296
- package/templates/skills/services/redis/SKILL.md +302 -302
- package/templates/skills/services/s3/SKILL.md +308 -308
- package/templates/skills/services/sqlite/SKILL.md +304 -304
- package/templates/skills/services/sqlserver/SKILL.md +304 -304
- package/templates/skills/workflows/ralph/SKILL.md +309 -309
- package/templates/skills/workflows/ralph/install.sh +87 -87
- package/templates/skills/workflows/ralph/manifest.json +158 -158
|
@@ -1,20 +1,20 @@
|
|
|
1
|
-
<!-- CODEBUDDY:START -->
|
|
2
|
-
# CodeBuddy Code Rules
|
|
3
|
-
|
|
4
|
-
**Tool**: Intelligent pair programming assistant
|
|
5
|
-
|
|
6
|
-
## Usage
|
|
7
|
-
|
|
8
|
-
Reference AGENTS.md in all requests:
|
|
9
|
-
```
|
|
10
|
-
"Follow @AGENTS.md standards. Implement [feature] with tests first."
|
|
11
|
-
```
|
|
12
|
-
|
|
13
|
-
## Workflow
|
|
14
|
-
|
|
15
|
-
1. Include AGENTS.md in context
|
|
16
|
-
2. Request features with standards reference
|
|
17
|
-
3. Review code
|
|
18
|
-
4. Run `npm run lint && npm test`
|
|
19
|
-
|
|
20
|
-
<!-- CODEBUDDY:END -->
|
|
1
|
+
<!-- CODEBUDDY:START -->
|
|
2
|
+
# CodeBuddy Code Rules
|
|
3
|
+
|
|
4
|
+
**Tool**: Intelligent pair programming assistant
|
|
5
|
+
|
|
6
|
+
## Usage
|
|
7
|
+
|
|
8
|
+
Reference AGENTS.md in all requests:
|
|
9
|
+
```
|
|
10
|
+
"Follow @AGENTS.md standards. Implement [feature] with tests first."
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Workflow
|
|
14
|
+
|
|
15
|
+
1. Include AGENTS.md in context
|
|
16
|
+
2. Request features with standards reference
|
|
17
|
+
3. Review code
|
|
18
|
+
4. Run `npm run lint && npm test`
|
|
19
|
+
|
|
20
|
+
<!-- CODEBUDDY:END -->
|
package/templates/cli/CODEIUM.md
CHANGED
|
@@ -1,20 +1,20 @@
|
|
|
1
|
-
<!-- CODEIUM:START -->
|
|
2
|
-
# Codeium CLI/Extension Rules
|
|
3
|
-
|
|
4
|
-
**Tool**: Free AI coding assistant
|
|
5
|
-
|
|
6
|
-
## Usage
|
|
7
|
-
|
|
8
|
-
Reference AGENTS.md in prompts:
|
|
9
|
-
```
|
|
10
|
-
"Follow @AGENTS.md. Implement [feature] with tests (95%+ coverage)."
|
|
11
|
-
```
|
|
12
|
-
|
|
13
|
-
## Workflow
|
|
14
|
-
|
|
15
|
-
1. Keep AGENTS.md open for context
|
|
16
|
-
2. Use inline suggestions or chat
|
|
17
|
-
3. Review generated code
|
|
18
|
-
4. Run quality checks
|
|
19
|
-
|
|
20
|
-
<!-- CODEIUM:END -->
|
|
1
|
+
<!-- CODEIUM:START -->
|
|
2
|
+
# Codeium CLI/Extension Rules
|
|
3
|
+
|
|
4
|
+
**Tool**: Free AI coding assistant
|
|
5
|
+
|
|
6
|
+
## Usage
|
|
7
|
+
|
|
8
|
+
Reference AGENTS.md in prompts:
|
|
9
|
+
```
|
|
10
|
+
"Follow @AGENTS.md. Implement [feature] with tests (95%+ coverage)."
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Workflow
|
|
14
|
+
|
|
15
|
+
1. Keep AGENTS.md open for context
|
|
16
|
+
2. Use inline suggestions or chat
|
|
17
|
+
3. Review generated code
|
|
18
|
+
4. Run quality checks
|
|
19
|
+
|
|
20
|
+
<!-- CODEIUM:END -->
|
package/templates/cli/CODEX.md
CHANGED
|
@@ -1,21 +1,21 @@
|
|
|
1
|
-
<!-- CODEX:START -->
|
|
2
|
-
# Codex (OpenAI) Rules
|
|
3
|
-
|
|
4
|
-
**Tool**: OpenAI code generation API
|
|
5
|
-
|
|
6
|
-
## Usage
|
|
7
|
-
|
|
8
|
-
Include AGENTS.md content in API system prompt:
|
|
9
|
-
```
|
|
10
|
-
System: "Follow these standards: [AGENTS.md content]"
|
|
11
|
-
User: "Implement [feature] with tests (95%+ coverage)."
|
|
12
|
-
```
|
|
13
|
-
|
|
14
|
-
## Workflow
|
|
15
|
-
|
|
16
|
-
1. Paste AGENTS.md into system prompt
|
|
17
|
-
2. Request features
|
|
18
|
-
3. Review code
|
|
19
|
-
4. Run quality checks
|
|
20
|
-
|
|
21
|
-
<!-- CODEX:END -->
|
|
1
|
+
<!-- CODEX:START -->
|
|
2
|
+
# Codex (OpenAI) Rules
|
|
3
|
+
|
|
4
|
+
**Tool**: OpenAI code generation API
|
|
5
|
+
|
|
6
|
+
## Usage
|
|
7
|
+
|
|
8
|
+
Include AGENTS.md content in API system prompt:
|
|
9
|
+
```
|
|
10
|
+
System: "Follow these standards: [AGENTS.md content]"
|
|
11
|
+
User: "Implement [feature] with tests (95%+ coverage)."
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
## Workflow
|
|
15
|
+
|
|
16
|
+
1. Paste AGENTS.md into system prompt
|
|
17
|
+
2. Request features
|
|
18
|
+
3. Review code
|
|
19
|
+
4. Run quality checks
|
|
20
|
+
|
|
21
|
+
<!-- CODEX:END -->
|
|
@@ -1,34 +1,34 @@
|
|
|
1
|
-
<!-- CONTINUE:START -->
|
|
2
|
-
# Continue CLI/Extension Rules
|
|
3
|
-
|
|
4
|
-
**Tool**: Open-source Copilot alternative (VS Code extension + CLI)
|
|
5
|
-
|
|
6
|
-
## Quick Start
|
|
7
|
-
|
|
8
|
-
```bash
|
|
9
|
-
# In VS Code: Install Continue extension
|
|
10
|
-
# Or CLI: npm install -g continue-cli
|
|
11
|
-
```
|
|
12
|
-
|
|
13
|
-
## Usage
|
|
14
|
-
|
|
15
|
-
```bash
|
|
16
|
-
# Always reference AGENTS.md in prompts:
|
|
17
|
-
"Follow @AGENTS.md standards. Implement [feature] with tests (95%+ coverage)."
|
|
18
|
-
|
|
19
|
-
# Slash commands:
|
|
20
|
-
/edit # Edit files
|
|
21
|
-
/chat # Ask questions
|
|
22
|
-
/cmd # Run terminal commands
|
|
23
|
-
```
|
|
24
|
-
|
|
25
|
-
## Workflow
|
|
26
|
-
|
|
27
|
-
1. Open AGENTS.md in editor for Continue to read
|
|
28
|
-
2. Use `/edit` to modify code following standards
|
|
29
|
-
3. Reference AGENTS.md in every request
|
|
30
|
-
4. Run quality checks after changes
|
|
31
|
-
|
|
32
|
-
**Critical**: Keep AGENTS.md open or reference it explicitly in prompts.
|
|
33
|
-
|
|
34
|
-
<!-- CONTINUE:END -->
|
|
1
|
+
<!-- CONTINUE:START -->
|
|
2
|
+
# Continue CLI/Extension Rules
|
|
3
|
+
|
|
4
|
+
**Tool**: Open-source Copilot alternative (VS Code extension + CLI)
|
|
5
|
+
|
|
6
|
+
## Quick Start
|
|
7
|
+
|
|
8
|
+
```bash
|
|
9
|
+
# In VS Code: Install Continue extension
|
|
10
|
+
# Or CLI: npm install -g continue-cli
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Usage
|
|
14
|
+
|
|
15
|
+
```bash
|
|
16
|
+
# Always reference AGENTS.md in prompts:
|
|
17
|
+
"Follow @AGENTS.md standards. Implement [feature] with tests (95%+ coverage)."
|
|
18
|
+
|
|
19
|
+
# Slash commands:
|
|
20
|
+
/edit # Edit files
|
|
21
|
+
/chat # Ask questions
|
|
22
|
+
/cmd # Run terminal commands
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
## Workflow
|
|
26
|
+
|
|
27
|
+
1. Open AGENTS.md in editor for Continue to read
|
|
28
|
+
2. Use `/edit` to modify code following standards
|
|
29
|
+
3. Reference AGENTS.md in every request
|
|
30
|
+
4. Run quality checks after changes
|
|
31
|
+
|
|
32
|
+
**Critical**: Keep AGENTS.md open or reference it explicitly in prompts.
|
|
33
|
+
|
|
34
|
+
<!-- CONTINUE:END -->
|
|
@@ -1,62 +1,62 @@
|
|
|
1
|
-
<!-- CURSOR_CLI:START -->
|
|
2
|
-
# Cursor CLI Rules
|
|
3
|
-
|
|
4
|
-
**Tool**: Cursor IDE automation and scripting
|
|
5
|
-
|
|
6
|
-
## Quick Start
|
|
7
|
-
|
|
8
|
-
```bash
|
|
9
|
-
# Cursor reads .cursorrules automatically
|
|
10
|
-
# This file is generated by rulebook init
|
|
11
|
-
```
|
|
12
|
-
|
|
13
|
-
## Usage
|
|
14
|
-
|
|
15
|
-
Cursor automatically references:
|
|
16
|
-
- `.cursorrules` (generated by rulebook)
|
|
17
|
-
- `AGENTS.md` (via @AGENTS.md references)
|
|
18
|
-
|
|
19
|
-
## Workflow
|
|
20
|
-
|
|
21
|
-
1. Use `@AGENTS.md` in chat to reference standards
|
|
22
|
-
2. Check past implementations in memory before starting
|
|
23
|
-
3. Request: "Follow @AGENTS.md. Implement [feature] with tests."
|
|
24
|
-
4. Cursor respects .cursorrules and AGENTS.md automatically
|
|
25
|
-
5. Save implementation learnings to memory
|
|
26
|
-
6. Review and accept changes
|
|
27
|
-
|
|
28
|
-
**Critical**: Generated `.cursorrules` points to AGENTS.md. Use @ mentions for explicit references.
|
|
29
|
-
|
|
30
|
-
## Persistent Memory Integration
|
|
31
|
-
|
|
32
|
-
### Using Memory in Cursor
|
|
33
|
-
When requesting features, include memory context:
|
|
34
|
-
|
|
35
|
-
```
|
|
36
|
-
@AGENTS.md
|
|
37
|
-
@.rulebook/memory.md (if available)
|
|
38
|
-
|
|
39
|
-
Search memory for similar implementations and include in your reasoning before implementing.
|
|
40
|
-
Implement [feature]...
|
|
41
|
-
```
|
|
42
|
-
|
|
43
|
-
### Capturing Implementation Learnings
|
|
44
|
-
After Cursor completes work:
|
|
45
|
-
|
|
46
|
-
```bash
|
|
47
|
-
# Review auto-captured memories
|
|
48
|
-
rulebook memory search "feature name"
|
|
49
|
-
|
|
50
|
-
# Augment with additional insights
|
|
51
|
-
rulebook memory save "Implementation approach, patterns discovered, edge cases handled..." --type feature --title "Feature name" --tags relevant,tags
|
|
52
|
-
```
|
|
53
|
-
|
|
54
|
-
### Memory-Enhanced Development
|
|
55
|
-
Cursor + Memory workflow:
|
|
56
|
-
1. **Search**: Find past implementations with similar patterns
|
|
57
|
-
2. **Reference**: Include relevant memories in prompts for context
|
|
58
|
-
3. **Implement**: Cursor generates code informed by past solutions
|
|
59
|
-
4. **Capture**: Save learnings for future sessions
|
|
60
|
-
5. **Search Again**: Next session finds and leverages the work
|
|
61
|
-
|
|
62
|
-
<!-- CURSOR_CLI:END -->
|
|
1
|
+
<!-- CURSOR_CLI:START -->
|
|
2
|
+
# Cursor CLI Rules
|
|
3
|
+
|
|
4
|
+
**Tool**: Cursor IDE automation and scripting
|
|
5
|
+
|
|
6
|
+
## Quick Start
|
|
7
|
+
|
|
8
|
+
```bash
|
|
9
|
+
# Cursor reads .cursorrules automatically
|
|
10
|
+
# This file is generated by rulebook init
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Usage
|
|
14
|
+
|
|
15
|
+
Cursor automatically references:
|
|
16
|
+
- `.cursorrules` (generated by rulebook)
|
|
17
|
+
- `AGENTS.md` (via @AGENTS.md references)
|
|
18
|
+
|
|
19
|
+
## Workflow
|
|
20
|
+
|
|
21
|
+
1. Use `@AGENTS.md` in chat to reference standards
|
|
22
|
+
2. Check past implementations in memory before starting
|
|
23
|
+
3. Request: "Follow @AGENTS.md. Implement [feature] with tests."
|
|
24
|
+
4. Cursor respects .cursorrules and AGENTS.md automatically
|
|
25
|
+
5. Save implementation learnings to memory
|
|
26
|
+
6. Review and accept changes
|
|
27
|
+
|
|
28
|
+
**Critical**: Generated `.cursorrules` points to AGENTS.md. Use @ mentions for explicit references.
|
|
29
|
+
|
|
30
|
+
## Persistent Memory Integration
|
|
31
|
+
|
|
32
|
+
### Using Memory in Cursor
|
|
33
|
+
When requesting features, include memory context:
|
|
34
|
+
|
|
35
|
+
```
|
|
36
|
+
@AGENTS.md
|
|
37
|
+
@.rulebook/memory.md (if available)
|
|
38
|
+
|
|
39
|
+
Search memory for similar implementations and include in your reasoning before implementing.
|
|
40
|
+
Implement [feature]...
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
### Capturing Implementation Learnings
|
|
44
|
+
After Cursor completes work:
|
|
45
|
+
|
|
46
|
+
```bash
|
|
47
|
+
# Review auto-captured memories
|
|
48
|
+
rulebook memory search "feature name"
|
|
49
|
+
|
|
50
|
+
# Augment with additional insights
|
|
51
|
+
rulebook memory save "Implementation approach, patterns discovered, edge cases handled..." --type feature --title "Feature name" --tags relevant,tags
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
### Memory-Enhanced Development
|
|
55
|
+
Cursor + Memory workflow:
|
|
56
|
+
1. **Search**: Find past implementations with similar patterns
|
|
57
|
+
2. **Reference**: Include relevant memories in prompts for context
|
|
58
|
+
3. **Implement**: Cursor generates code informed by past solutions
|
|
59
|
+
4. **Capture**: Save learnings for future sessions
|
|
60
|
+
5. **Search Again**: Next session finds and leverages the work
|
|
61
|
+
|
|
62
|
+
<!-- CURSOR_CLI:END -->
|
package/templates/cli/FACTORY.md
CHANGED
|
@@ -1,18 +1,18 @@
|
|
|
1
|
-
<!-- FACTORY:START -->
|
|
2
|
-
# Factory Droid Rules
|
|
3
|
-
|
|
4
|
-
**Tool**: Code generation and automation
|
|
5
|
-
|
|
6
|
-
## Usage
|
|
7
|
-
|
|
8
|
-
```
|
|
9
|
-
"Follow @AGENTS.md standards. Generate [code] with tests."
|
|
10
|
-
```
|
|
11
|
-
|
|
12
|
-
## Workflow
|
|
13
|
-
|
|
14
|
-
1. Reference AGENTS.md in prompts
|
|
15
|
-
2. Review generated code
|
|
16
|
-
3. Run quality checks
|
|
17
|
-
|
|
18
|
-
<!-- FACTORY:END -->
|
|
1
|
+
<!-- FACTORY:START -->
|
|
2
|
+
# Factory Droid Rules
|
|
3
|
+
|
|
4
|
+
**Tool**: Code generation and automation
|
|
5
|
+
|
|
6
|
+
## Usage
|
|
7
|
+
|
|
8
|
+
```
|
|
9
|
+
"Follow @AGENTS.md standards. Generate [code] with tests."
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
## Workflow
|
|
13
|
+
|
|
14
|
+
1. Reference AGENTS.md in prompts
|
|
15
|
+
2. Review generated code
|
|
16
|
+
3. Run quality checks
|
|
17
|
+
|
|
18
|
+
<!-- FACTORY:END -->
|
package/templates/cli/GEMINI.md
CHANGED
|
@@ -1,35 +1,35 @@
|
|
|
1
|
-
<!-- GEMINI:START -->
|
|
2
|
-
# Gemini CLI Rules
|
|
3
|
-
|
|
4
|
-
**Tool**: Google Gemini API with 2M token context
|
|
5
|
-
|
|
6
|
-
## Quick Start
|
|
7
|
-
|
|
8
|
-
```bash
|
|
9
|
-
# Install gemini CLI
|
|
10
|
-
npm install -g @google/generative-ai-cli
|
|
11
|
-
|
|
12
|
-
# Set API key
|
|
13
|
-
export GEMINI_API_KEY=your_key
|
|
14
|
-
```
|
|
15
|
-
|
|
16
|
-
## Usage
|
|
17
|
-
|
|
18
|
-
```bash
|
|
19
|
-
# Always reference AGENTS.md:
|
|
20
|
-
gemini --prompt "Read @AGENTS.md. Implement [feature] with tests (95%+ coverage)."
|
|
21
|
-
|
|
22
|
-
# Include files:
|
|
23
|
-
gemini --files AGENTS.md,src/feature.ts
|
|
24
|
-
```
|
|
25
|
-
|
|
26
|
-
## Workflow
|
|
27
|
-
|
|
28
|
-
1. Include AGENTS.md in context with `--files AGENTS.md`
|
|
29
|
-
2. Request: "Follow @AGENTS.md. Implement [feature] with tests."
|
|
30
|
-
3. Review output
|
|
31
|
-
4. Run quality checks: `npm run lint && npm test`
|
|
32
|
-
|
|
33
|
-
**Critical**: Reference @AGENTS.md for consistent code generation.
|
|
34
|
-
|
|
35
|
-
<!-- GEMINI:END -->
|
|
1
|
+
<!-- GEMINI:START -->
|
|
2
|
+
# Gemini CLI Rules
|
|
3
|
+
|
|
4
|
+
**Tool**: Google Gemini API with 2M token context
|
|
5
|
+
|
|
6
|
+
## Quick Start
|
|
7
|
+
|
|
8
|
+
```bash
|
|
9
|
+
# Install gemini CLI
|
|
10
|
+
npm install -g @google/generative-ai-cli
|
|
11
|
+
|
|
12
|
+
# Set API key
|
|
13
|
+
export GEMINI_API_KEY=your_key
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
## Usage
|
|
17
|
+
|
|
18
|
+
```bash
|
|
19
|
+
# Always reference AGENTS.md:
|
|
20
|
+
gemini --prompt "Read @AGENTS.md. Implement [feature] with tests (95%+ coverage)."
|
|
21
|
+
|
|
22
|
+
# Include files:
|
|
23
|
+
gemini --files AGENTS.md,src/feature.ts
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
## Workflow
|
|
27
|
+
|
|
28
|
+
1. Include AGENTS.md in context with `--files AGENTS.md`
|
|
29
|
+
2. Request: "Follow @AGENTS.md. Implement [feature] with tests."
|
|
30
|
+
3. Review output
|
|
31
|
+
4. Run quality checks: `npm run lint && npm test`
|
|
32
|
+
|
|
33
|
+
**Critical**: Reference @AGENTS.md for consistent code generation.
|
|
34
|
+
|
|
35
|
+
<!-- GEMINI:END -->
|
|
@@ -1,18 +1,18 @@
|
|
|
1
|
-
<!-- KILOCODE:START -->
|
|
2
|
-
# Kilo Code Rules
|
|
3
|
-
|
|
4
|
-
**Tool**: Lightweight coding companion
|
|
5
|
-
|
|
6
|
-
## Usage
|
|
7
|
-
|
|
8
|
-
```
|
|
9
|
-
"Follow @AGENTS.md. Implement [feature] with tests."
|
|
10
|
-
```
|
|
11
|
-
|
|
12
|
-
## Workflow
|
|
13
|
-
|
|
14
|
-
1. Reference AGENTS.md
|
|
15
|
-
2. Review code
|
|
16
|
-
3. Run quality checks
|
|
17
|
-
|
|
18
|
-
<!-- KILOCODE:END -->
|
|
1
|
+
<!-- KILOCODE:START -->
|
|
2
|
+
# Kilo Code Rules
|
|
3
|
+
|
|
4
|
+
**Tool**: Lightweight coding companion
|
|
5
|
+
|
|
6
|
+
## Usage
|
|
7
|
+
|
|
8
|
+
```
|
|
9
|
+
"Follow @AGENTS.md. Implement [feature] with tests."
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
## Workflow
|
|
13
|
+
|
|
14
|
+
1. Reference AGENTS.md
|
|
15
|
+
2. Review code
|
|
16
|
+
3. Run quality checks
|
|
17
|
+
|
|
18
|
+
<!-- KILOCODE:END -->
|
|
@@ -1,18 +1,18 @@
|
|
|
1
|
-
<!-- OPENCODE:START -->
|
|
2
|
-
# OpenCode Rules
|
|
3
|
-
|
|
4
|
-
**Tool**: Open-source AI assistant
|
|
5
|
-
|
|
6
|
-
## Usage
|
|
7
|
-
|
|
8
|
-
```
|
|
9
|
-
"Follow @AGENTS.md. Implement [feature] with tests."
|
|
10
|
-
```
|
|
11
|
-
|
|
12
|
-
## Workflow
|
|
13
|
-
|
|
14
|
-
1. Reference AGENTS.md
|
|
15
|
-
2. Review code
|
|
16
|
-
3. Run quality checks
|
|
17
|
-
|
|
18
|
-
<!-- OPENCODE:END -->
|
|
1
|
+
<!-- OPENCODE:START -->
|
|
2
|
+
# OpenCode Rules
|
|
3
|
+
|
|
4
|
+
**Tool**: Open-source AI assistant
|
|
5
|
+
|
|
6
|
+
## Usage
|
|
7
|
+
|
|
8
|
+
```
|
|
9
|
+
"Follow @AGENTS.md. Implement [feature] with tests."
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
## Workflow
|
|
13
|
+
|
|
14
|
+
1. Reference AGENTS.md
|
|
15
|
+
2. Review code
|
|
16
|
+
3. Run quality checks
|
|
17
|
+
|
|
18
|
+
<!-- OPENCODE: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,48 +1,48 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: /rulebook-memory-save
|
|
3
|
-
id: rulebook-memory-save
|
|
4
|
-
category: Rulebook
|
|
5
|
-
description: Save a new persistent memory for context across AI sessions.
|
|
6
|
-
---
|
|
7
|
-
<!-- RULEBOOK:START -->
|
|
8
|
-
**Guardrails**
|
|
9
|
-
- Use the MCP memory tools when available (preferred over CLI commands).
|
|
10
|
-
- Choose the correct memory type for accurate classification and search.
|
|
11
|
-
- Keep titles concise and content descriptive.
|
|
12
|
-
- Use tags for better discoverability.
|
|
13
|
-
|
|
14
|
-
**Steps**
|
|
15
|
-
1. **Save a memory** using the MCP tool or CLI:
|
|
16
|
-
```
|
|
17
|
-
# Via MCP (preferred)
|
|
18
|
-
rulebook_memory_save({
|
|
19
|
-
type: "feature",
|
|
20
|
-
title: "Short descriptive title",
|
|
21
|
-
content: "Detailed description of what happened, why, and context",
|
|
22
|
-
tags: ["relevant", "tags"]
|
|
23
|
-
})
|
|
24
|
-
|
|
25
|
-
# Via CLI
|
|
26
|
-
rulebook memory save "content text" --type feature --title "Title" --tags tag1,tag2
|
|
27
|
-
```
|
|
28
|
-
|
|
29
|
-
2. **Choose the right type**:
|
|
30
|
-
- `bugfix` - Fixed a bug or resolved an error
|
|
31
|
-
- `feature` - Added new functionality
|
|
32
|
-
- `refactor` - Restructured code without changing behavior
|
|
33
|
-
- `decision` - Made an architecture or design choice (protected from eviction)
|
|
34
|
-
- `discovery` - Found something important about the codebase
|
|
35
|
-
- `change` - General code modification
|
|
36
|
-
- `observation` - Noted something worth remembering
|
|
37
|
-
|
|
38
|
-
3. **Verify** the memory was saved:
|
|
39
|
-
```
|
|
40
|
-
rulebook_memory_search({ query: "your title keywords" })
|
|
41
|
-
```
|
|
42
|
-
|
|
43
|
-
**Best Practices**
|
|
44
|
-
- Save decisions early - they are protected from cache eviction
|
|
45
|
-
- Include "why" in content, not just "what"
|
|
46
|
-
- Use consistent tags across related memories
|
|
47
|
-
- Content within `<private>...</private>` tags will be automatically redacted
|
|
48
|
-
<!-- RULEBOOK:END -->
|
|
1
|
+
---
|
|
2
|
+
name: /rulebook-memory-save
|
|
3
|
+
id: rulebook-memory-save
|
|
4
|
+
category: Rulebook
|
|
5
|
+
description: Save a new persistent memory for context across AI sessions.
|
|
6
|
+
---
|
|
7
|
+
<!-- RULEBOOK:START -->
|
|
8
|
+
**Guardrails**
|
|
9
|
+
- Use the MCP memory tools when available (preferred over CLI commands).
|
|
10
|
+
- Choose the correct memory type for accurate classification and search.
|
|
11
|
+
- Keep titles concise and content descriptive.
|
|
12
|
+
- Use tags for better discoverability.
|
|
13
|
+
|
|
14
|
+
**Steps**
|
|
15
|
+
1. **Save a memory** using the MCP tool or CLI:
|
|
16
|
+
```
|
|
17
|
+
# Via MCP (preferred)
|
|
18
|
+
rulebook_memory_save({
|
|
19
|
+
type: "feature",
|
|
20
|
+
title: "Short descriptive title",
|
|
21
|
+
content: "Detailed description of what happened, why, and context",
|
|
22
|
+
tags: ["relevant", "tags"]
|
|
23
|
+
})
|
|
24
|
+
|
|
25
|
+
# Via CLI
|
|
26
|
+
rulebook memory save "content text" --type feature --title "Title" --tags tag1,tag2
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
2. **Choose the right type**:
|
|
30
|
+
- `bugfix` - Fixed a bug or resolved an error
|
|
31
|
+
- `feature` - Added new functionality
|
|
32
|
+
- `refactor` - Restructured code without changing behavior
|
|
33
|
+
- `decision` - Made an architecture or design choice (protected from eviction)
|
|
34
|
+
- `discovery` - Found something important about the codebase
|
|
35
|
+
- `change` - General code modification
|
|
36
|
+
- `observation` - Noted something worth remembering
|
|
37
|
+
|
|
38
|
+
3. **Verify** the memory was saved:
|
|
39
|
+
```
|
|
40
|
+
rulebook_memory_search({ query: "your title keywords" })
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
**Best Practices**
|
|
44
|
+
- Save decisions early - they are protected from cache eviction
|
|
45
|
+
- Include "why" in content, not just "what"
|
|
46
|
+
- Use consistent tags across related memories
|
|
47
|
+
- Content within `<private>...</private>` tags will be automatically redacted
|
|
48
|
+
<!-- RULEBOOK:END -->
|