@hivehub/rulebook 4.2.2 → 4.3.1
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 +15 -1
- package/dist/cli/commands.d.ts.map +1 -1
- package/dist/cli/commands.js +43 -18
- package/dist/cli/commands.js.map +1 -1
- package/dist/core/claude-mcp.d.ts +10 -2
- package/dist/core/claude-mcp.d.ts.map +1 -1
- package/dist/core/claude-mcp.js +48 -9
- package/dist/core/claude-mcp.js.map +1 -1
- package/dist/core/config-manager.d.ts.map +1 -1
- package/dist/core/config-manager.js +1 -2
- package/dist/core/config-manager.js.map +1 -1
- package/dist/core/generator.d.ts +13 -0
- package/dist/core/generator.d.ts.map +1 -1
- package/dist/core/generator.js +283 -28
- package/dist/core/generator.js.map +1 -1
- package/dist/core/indexer/background-indexer.d.ts.map +1 -1
- package/dist/core/indexer/background-indexer.js +10 -3
- package/dist/core/indexer/background-indexer.js.map +1 -1
- package/dist/core/workspace/workspace-manager.d.ts.map +1 -1
- package/dist/core/workspace/workspace-manager.js +2 -6
- package/dist/core/workspace/workspace-manager.js.map +1 -1
- package/dist/index.js +1 -3
- package/dist/index.js.map +1 -1
- package/dist/mcp/rulebook-server.d.ts.map +1 -1
- package/dist/mcp/rulebook-server.js +23 -10
- package/dist/mcp/rulebook-server.js.map +1 -1
- package/package.json +21 -22
- package/templates/agents/accessibility-reviewer.md +43 -0
- package/templates/agents/api-designer.md +42 -0
- package/templates/agents/architect.md +51 -0
- package/templates/agents/build-engineer.md +36 -0
- package/templates/agents/code-reviewer.md +47 -0
- package/templates/agents/database-architect.md +41 -0
- package/templates/agents/devops-engineer.md +42 -0
- package/templates/agents/docs-writer.md +38 -0
- package/templates/agents/i18n-engineer.md +42 -0
- package/templates/agents/implementer.md +38 -35
- package/templates/agents/migration-engineer.md +42 -0
- package/templates/agents/performance-engineer.md +49 -0
- package/templates/agents/refactoring-agent.md +41 -0
- package/templates/agents/researcher.md +38 -34
- package/templates/agents/security-reviewer.md +40 -0
- package/templates/agents/team-lead.md +37 -34
- package/templates/agents/tester.md +45 -42
- package/templates/agents/ux-reviewer.md +43 -0
- 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 -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/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 -1935
- 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/dev/accessibility/SKILL.md +17 -0
- package/templates/skills/dev/api-design/SKILL.md +15 -0
- package/templates/skills/dev/architect/SKILL.md +17 -0
- package/templates/skills/dev/build-fix/SKILL.md +17 -0
- package/templates/skills/dev/db-design/SKILL.md +15 -0
- package/templates/skills/dev/debug/SKILL.md +16 -0
- package/templates/skills/dev/deploy/SKILL.md +17 -0
- package/templates/skills/dev/docs/SKILL.md +17 -0
- package/templates/skills/dev/migrate/SKILL.md +15 -0
- package/templates/skills/dev/perf/SKILL.md +17 -0
- package/templates/skills/dev/refactor/SKILL.md +17 -0
- package/templates/skills/dev/research/SKILL.md +14 -0
- package/templates/skills/dev/review/SKILL.md +18 -0
- package/templates/skills/dev/security-audit/SKILL.md +17 -0
- 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,33 +1,33 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: /continue
|
|
3
|
-
id: continue
|
|
4
|
-
category: Rulebook
|
|
5
|
-
description: Update tasks.md, archive completed tasks, and continue implementation.
|
|
6
|
-
---
|
|
7
|
-
<!-- RULEBOOK:START -->
|
|
8
|
-
**Steps**
|
|
9
|
-
|
|
10
|
-
1. **Update tasks.md for all active tasks**:
|
|
11
|
-
- Mark completed items as `[x]` in every active `tasks.md`
|
|
12
|
-
- Remove or update items that are no longer relevant
|
|
13
|
-
|
|
14
|
-
2. **Archive fully completed tasks**:
|
|
15
|
-
For each task where ALL items are `[x]`:
|
|
16
|
-
```bash
|
|
17
|
-
rulebook task archive <task-id>
|
|
18
|
-
```
|
|
19
|
-
|
|
20
|
-
3. **Get current session context**:
|
|
21
|
-
```bash
|
|
22
|
-
rulebook continue
|
|
23
|
-
```
|
|
24
|
-
Use this output to understand what's pending and what was done.
|
|
25
|
-
|
|
26
|
-
4. **Continue implementation**:
|
|
27
|
-
- Pick the next pending task from the context above
|
|
28
|
-
- Work through its `tasks.md` checklist item by item
|
|
29
|
-
- Follow priority order: tests → coverage → update tasks.md → commit
|
|
30
|
-
|
|
31
|
-
**Reference**
|
|
32
|
-
- See `/.rulebook/specs/RULEBOOK.md` for complete task management guidelines
|
|
33
|
-
<!-- RULEBOOK:END -->
|
|
1
|
+
---
|
|
2
|
+
name: /continue
|
|
3
|
+
id: continue
|
|
4
|
+
category: Rulebook
|
|
5
|
+
description: Update tasks.md, archive completed tasks, and continue implementation.
|
|
6
|
+
---
|
|
7
|
+
<!-- RULEBOOK:START -->
|
|
8
|
+
**Steps**
|
|
9
|
+
|
|
10
|
+
1. **Update tasks.md for all active tasks**:
|
|
11
|
+
- Mark completed items as `[x]` in every active `tasks.md`
|
|
12
|
+
- Remove or update items that are no longer relevant
|
|
13
|
+
|
|
14
|
+
2. **Archive fully completed tasks**:
|
|
15
|
+
For each task where ALL items are `[x]`:
|
|
16
|
+
```bash
|
|
17
|
+
rulebook task archive <task-id>
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
3. **Get current session context**:
|
|
21
|
+
```bash
|
|
22
|
+
rulebook continue
|
|
23
|
+
```
|
|
24
|
+
Use this output to understand what's pending and what was done.
|
|
25
|
+
|
|
26
|
+
4. **Continue implementation**:
|
|
27
|
+
- Pick the next pending task from the context above
|
|
28
|
+
- Work through its `tasks.md` checklist item by item
|
|
29
|
+
- Follow priority order: tests → coverage → update tasks.md → commit
|
|
30
|
+
|
|
31
|
+
**Reference**
|
|
32
|
+
- See `/.rulebook/specs/RULEBOOK.md` for complete task management guidelines
|
|
33
|
+
<!-- RULEBOOK:END -->
|
|
@@ -1,112 +1,112 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: /ralph-config
|
|
3
|
-
id: ralph-config
|
|
4
|
-
category: Ralph
|
|
5
|
-
description: Configure Ralph autonomous loop settings and parameters.
|
|
6
|
-
---
|
|
7
|
-
<!-- RALPH:START -->
|
|
8
|
-
**Overview**
|
|
9
|
-
Manage Ralph's configuration including max iterations, AI tool selection, and other loop parameters. Configuration is stored in `.rulebook/ralph/config.json`.
|
|
10
|
-
|
|
11
|
-
**Guardrails**
|
|
12
|
-
- Configuration applies to future iterations only
|
|
13
|
-
- Changing config mid-loop may not affect current iteration
|
|
14
|
-
- Save configuration changes before resuming loop
|
|
15
|
-
- Common settings: max_iterations, ai_tool, branch_name
|
|
16
|
-
|
|
17
|
-
**Configuration Options**
|
|
18
|
-
|
|
19
|
-
### Max Iterations
|
|
20
|
-
Maximum number of iterations Ralph will run before stopping.
|
|
21
|
-
```bash
|
|
22
|
-
rulebook ralph config set max_iterations 20
|
|
23
|
-
```
|
|
24
|
-
- Recommended: 5-20 for most projects
|
|
25
|
-
- Higher values allow more complex tasks to complete
|
|
26
|
-
- Lower values quick validation runs
|
|
27
|
-
|
|
28
|
-
### AI Tool
|
|
29
|
-
Which AI tool to use for solving tasks (claude, cursor, gemini).
|
|
30
|
-
```bash
|
|
31
|
-
rulebook ralph config set ai_tool claude
|
|
32
|
-
```
|
|
33
|
-
- `claude` (recommended): Best for complex reasoning
|
|
34
|
-
- `cursor`: Fast iteration if you have Cursor CLI
|
|
35
|
-
- `gemini`: Alternative option for diversity
|
|
36
|
-
- Note: Tool must be installed and available on CLI
|
|
37
|
-
|
|
38
|
-
### Branch Name
|
|
39
|
-
Git branch Ralph works on for this loop.
|
|
40
|
-
```bash
|
|
41
|
-
rulebook ralph config set branch_name ralph/my-feature
|
|
42
|
-
```
|
|
43
|
-
- Automatically set during init
|
|
44
|
-
- Change if working on different feature
|
|
45
|
-
- Ralph commits to this branch
|
|
46
|
-
|
|
47
|
-
### Project Name
|
|
48
|
-
Project name for documentation and tracking.
|
|
49
|
-
```bash
|
|
50
|
-
rulebook ralph config set project_name my-project
|
|
51
|
-
```
|
|
52
|
-
|
|
53
|
-
**Steps**
|
|
54
|
-
|
|
55
|
-
1. **View Current Configuration**:
|
|
56
|
-
```bash
|
|
57
|
-
rulebook ralph config show
|
|
58
|
-
```
|
|
59
|
-
Displays all current settings
|
|
60
|
-
|
|
61
|
-
2. **Update a Setting**:
|
|
62
|
-
```bash
|
|
63
|
-
rulebook ralph config set <key> <value>
|
|
64
|
-
```
|
|
65
|
-
Example:
|
|
66
|
-
```bash
|
|
67
|
-
rulebook ralph config set max_iterations 15
|
|
68
|
-
rulebook ralph config set ai_tool cursor
|
|
69
|
-
```
|
|
70
|
-
|
|
71
|
-
3. **Reset to Defaults**:
|
|
72
|
-
```bash
|
|
73
|
-
rulebook ralph config reset
|
|
74
|
-
```
|
|
75
|
-
Resets to default values from init
|
|
76
|
-
|
|
77
|
-
4. **Verify Changes**:
|
|
78
|
-
```bash
|
|
79
|
-
rulebook ralph status
|
|
80
|
-
```
|
|
81
|
-
Shows updated config in status output
|
|
82
|
-
|
|
83
|
-
**Configuration File**
|
|
84
|
-
Location: `.rulebook/ralph/config.json`
|
|
85
|
-
|
|
86
|
-
Example structure:
|
|
87
|
-
```json
|
|
88
|
-
{
|
|
89
|
-
"enabled": true,
|
|
90
|
-
"max_iterations": 10,
|
|
91
|
-
"current_iteration": 0,
|
|
92
|
-
"ai_tool": "claude",
|
|
93
|
-
"project_name": "my-project",
|
|
94
|
-
"branch_name": "ralph/my-project",
|
|
95
|
-
"paused": false
|
|
96
|
-
}
|
|
97
|
-
```
|
|
98
|
-
|
|
99
|
-
**Workflow**
|
|
100
|
-
1. Initialize Ralph: `rulebook ralph init` (sets initial config)
|
|
101
|
-
2. Review config: `rulebook ralph config show`
|
|
102
|
-
3. Adjust as needed: `rulebook ralph config set <key> <value>`
|
|
103
|
-
4. Start loop: `rulebook ralph run`
|
|
104
|
-
5. Monitor with: `rulebook ralph status`
|
|
105
|
-
|
|
106
|
-
**Troubleshooting**
|
|
107
|
-
- **Config file missing**: Run `rulebook ralph init` again
|
|
108
|
-
- **Settings not updating**: Ensure you're using correct key name
|
|
109
|
-
- **Changes not taking effect**: Pause loop, update config, then resume
|
|
110
|
-
- **Invalid ai_tool**: Check tool is installed (e.g., `claude --version`)
|
|
111
|
-
|
|
112
|
-
<!-- RALPH:END -->
|
|
1
|
+
---
|
|
2
|
+
name: /ralph-config
|
|
3
|
+
id: ralph-config
|
|
4
|
+
category: Ralph
|
|
5
|
+
description: Configure Ralph autonomous loop settings and parameters.
|
|
6
|
+
---
|
|
7
|
+
<!-- RALPH:START -->
|
|
8
|
+
**Overview**
|
|
9
|
+
Manage Ralph's configuration including max iterations, AI tool selection, and other loop parameters. Configuration is stored in `.rulebook/ralph/config.json`.
|
|
10
|
+
|
|
11
|
+
**Guardrails**
|
|
12
|
+
- Configuration applies to future iterations only
|
|
13
|
+
- Changing config mid-loop may not affect current iteration
|
|
14
|
+
- Save configuration changes before resuming loop
|
|
15
|
+
- Common settings: max_iterations, ai_tool, branch_name
|
|
16
|
+
|
|
17
|
+
**Configuration Options**
|
|
18
|
+
|
|
19
|
+
### Max Iterations
|
|
20
|
+
Maximum number of iterations Ralph will run before stopping.
|
|
21
|
+
```bash
|
|
22
|
+
rulebook ralph config set max_iterations 20
|
|
23
|
+
```
|
|
24
|
+
- Recommended: 5-20 for most projects
|
|
25
|
+
- Higher values allow more complex tasks to complete
|
|
26
|
+
- Lower values quick validation runs
|
|
27
|
+
|
|
28
|
+
### AI Tool
|
|
29
|
+
Which AI tool to use for solving tasks (claude, cursor, gemini).
|
|
30
|
+
```bash
|
|
31
|
+
rulebook ralph config set ai_tool claude
|
|
32
|
+
```
|
|
33
|
+
- `claude` (recommended): Best for complex reasoning
|
|
34
|
+
- `cursor`: Fast iteration if you have Cursor CLI
|
|
35
|
+
- `gemini`: Alternative option for diversity
|
|
36
|
+
- Note: Tool must be installed and available on CLI
|
|
37
|
+
|
|
38
|
+
### Branch Name
|
|
39
|
+
Git branch Ralph works on for this loop.
|
|
40
|
+
```bash
|
|
41
|
+
rulebook ralph config set branch_name ralph/my-feature
|
|
42
|
+
```
|
|
43
|
+
- Automatically set during init
|
|
44
|
+
- Change if working on different feature
|
|
45
|
+
- Ralph commits to this branch
|
|
46
|
+
|
|
47
|
+
### Project Name
|
|
48
|
+
Project name for documentation and tracking.
|
|
49
|
+
```bash
|
|
50
|
+
rulebook ralph config set project_name my-project
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
**Steps**
|
|
54
|
+
|
|
55
|
+
1. **View Current Configuration**:
|
|
56
|
+
```bash
|
|
57
|
+
rulebook ralph config show
|
|
58
|
+
```
|
|
59
|
+
Displays all current settings
|
|
60
|
+
|
|
61
|
+
2. **Update a Setting**:
|
|
62
|
+
```bash
|
|
63
|
+
rulebook ralph config set <key> <value>
|
|
64
|
+
```
|
|
65
|
+
Example:
|
|
66
|
+
```bash
|
|
67
|
+
rulebook ralph config set max_iterations 15
|
|
68
|
+
rulebook ralph config set ai_tool cursor
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
3. **Reset to Defaults**:
|
|
72
|
+
```bash
|
|
73
|
+
rulebook ralph config reset
|
|
74
|
+
```
|
|
75
|
+
Resets to default values from init
|
|
76
|
+
|
|
77
|
+
4. **Verify Changes**:
|
|
78
|
+
```bash
|
|
79
|
+
rulebook ralph status
|
|
80
|
+
```
|
|
81
|
+
Shows updated config in status output
|
|
82
|
+
|
|
83
|
+
**Configuration File**
|
|
84
|
+
Location: `.rulebook/ralph/config.json`
|
|
85
|
+
|
|
86
|
+
Example structure:
|
|
87
|
+
```json
|
|
88
|
+
{
|
|
89
|
+
"enabled": true,
|
|
90
|
+
"max_iterations": 10,
|
|
91
|
+
"current_iteration": 0,
|
|
92
|
+
"ai_tool": "claude",
|
|
93
|
+
"project_name": "my-project",
|
|
94
|
+
"branch_name": "ralph/my-project",
|
|
95
|
+
"paused": false
|
|
96
|
+
}
|
|
97
|
+
```
|
|
98
|
+
|
|
99
|
+
**Workflow**
|
|
100
|
+
1. Initialize Ralph: `rulebook ralph init` (sets initial config)
|
|
101
|
+
2. Review config: `rulebook ralph config show`
|
|
102
|
+
3. Adjust as needed: `rulebook ralph config set <key> <value>`
|
|
103
|
+
4. Start loop: `rulebook ralph run`
|
|
104
|
+
5. Monitor with: `rulebook ralph status`
|
|
105
|
+
|
|
106
|
+
**Troubleshooting**
|
|
107
|
+
- **Config file missing**: Run `rulebook ralph init` again
|
|
108
|
+
- **Settings not updating**: Ensure you're using correct key name
|
|
109
|
+
- **Changes not taking effect**: Pause loop, update config, then resume
|
|
110
|
+
- **Invalid ai_tool**: Check tool is installed (e.g., `claude --version`)
|
|
111
|
+
|
|
112
|
+
<!-- RALPH:END -->
|
|
@@ -1,110 +1,110 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: /ralph-history
|
|
3
|
-
id: ralph-history
|
|
4
|
-
category: Ralph
|
|
5
|
-
description: View past Ralph iterations, quality check results, and learnings.
|
|
6
|
-
---
|
|
7
|
-
<!-- RALPH:START -->
|
|
8
|
-
**Overview**
|
|
9
|
-
Review detailed records of all Ralph iterations, including:
|
|
10
|
-
- Task completion status
|
|
11
|
-
- Quality gate results (type-check, lint, tests, coverage)
|
|
12
|
-
- Execution time and performance metrics
|
|
13
|
-
- Errors encountered and learnings discovered
|
|
14
|
-
- Git commits associated with each iteration
|
|
15
|
-
|
|
16
|
-
**Guardrails**
|
|
17
|
-
- History is automatically recorded by Ralph during execution
|
|
18
|
-
- Read-only view - use to analyze and debug past iterations
|
|
19
|
-
- Useful for identifying patterns in failures or learning opportunities
|
|
20
|
-
- Each iteration is stored separately for audit trail
|
|
21
|
-
|
|
22
|
-
**Steps**
|
|
23
|
-
1. **View All Iterations**:
|
|
24
|
-
```bash
|
|
25
|
-
rulebook ralph history
|
|
26
|
-
```
|
|
27
|
-
Shows summary of all iterations with status and task info
|
|
28
|
-
|
|
29
|
-
2. **View Latest Iterations**:
|
|
30
|
-
```bash
|
|
31
|
-
rulebook ralph history --limit 5
|
|
32
|
-
```
|
|
33
|
-
Shows most recent N iterations (useful for large iteration counts)
|
|
34
|
-
|
|
35
|
-
3. **View Specific Iteration**:
|
|
36
|
-
```bash
|
|
37
|
-
rulebook ralph history --iteration 3
|
|
38
|
-
```
|
|
39
|
-
Shows detailed information for iteration 3
|
|
40
|
-
|
|
41
|
-
4. **Export History**:
|
|
42
|
-
```bash
|
|
43
|
-
rulebook ralph history --export history.json
|
|
44
|
-
```
|
|
45
|
-
Exports full iteration history for analysis
|
|
46
|
-
|
|
47
|
-
**Iteration Record Fields**
|
|
48
|
-
Each iteration record contains:
|
|
49
|
-
- **Metadata**:
|
|
50
|
-
- Iteration number
|
|
51
|
-
- Timestamp
|
|
52
|
-
- Task ID and title
|
|
53
|
-
- AI tool used
|
|
54
|
-
- Execution time (ms)
|
|
55
|
-
- Status: success / partial / failed
|
|
56
|
-
|
|
57
|
-
- **Quality Checks**:
|
|
58
|
-
- type-check: TypeScript compilation result
|
|
59
|
-
- lint: ESLint check result
|
|
60
|
-
- tests: Test suite result
|
|
61
|
-
- coverage_met: Coverage threshold result
|
|
62
|
-
|
|
63
|
-
- **Output**:
|
|
64
|
-
- output_summary: Summary of what was done
|
|
65
|
-
- learnings: Insights discovered during iteration
|
|
66
|
-
- errors: Any errors encountered
|
|
67
|
-
|
|
68
|
-
- **Git**:
|
|
69
|
-
- git_commit: Commit hash if changes were committed
|
|
70
|
-
- branch: Branch used for this iteration
|
|
71
|
-
|
|
72
|
-
**Analyzing History**
|
|
73
|
-
1. **Success Rate**:
|
|
74
|
-
```bash
|
|
75
|
-
# Successful iterations / total iterations
|
|
76
|
-
# Shows loop health and AI tool effectiveness
|
|
77
|
-
```
|
|
78
|
-
|
|
79
|
-
2. **Quality Gate Patterns**:
|
|
80
|
-
- Check which gates fail most often
|
|
81
|
-
- Identify systematic issues (e.g., always failing lint)
|
|
82
|
-
- Plan improvements based on failure patterns
|
|
83
|
-
|
|
84
|
-
3. **Learnings Extraction**:
|
|
85
|
-
- Ralph records lessons learned from each iteration
|
|
86
|
-
- Use these to improve task definitions or AI prompts
|
|
87
|
-
- Share with team for knowledge base
|
|
88
|
-
|
|
89
|
-
4. **Performance Metrics**:
|
|
90
|
-
- Track execution time per iteration
|
|
91
|
-
- Identify slow tasks or AI tools
|
|
92
|
-
- Optimize based on trends
|
|
93
|
-
|
|
94
|
-
**Location**
|
|
95
|
-
- Iteration records stored in: `.rulebook/ralph/history/`
|
|
96
|
-
- Each file named: `iteration-<N>.json`
|
|
97
|
-
- Full history also available in: `.rulebook/ralph/history-all.json`
|
|
98
|
-
|
|
99
|
-
**Using History for Debugging**
|
|
100
|
-
1. **Failed iteration**: Check error field for root cause
|
|
101
|
-
2. **Partial success**: Review which quality gates failed
|
|
102
|
-
3. **Slow iteration**: Check execution_time_ms
|
|
103
|
-
4. **Pattern analysis**: Compare multiple iterations for trends
|
|
104
|
-
|
|
105
|
-
**Next Steps**
|
|
106
|
-
- After reviewing history, fix issues and retry: `rulebook ralph run`
|
|
107
|
-
- Save learnings to persistent memory: `rulebook memory save "learning from iteration" ...`
|
|
108
|
-
- Update PRD based on discoveries from history analysis
|
|
109
|
-
|
|
110
|
-
<!-- RALPH:END -->
|
|
1
|
+
---
|
|
2
|
+
name: /ralph-history
|
|
3
|
+
id: ralph-history
|
|
4
|
+
category: Ralph
|
|
5
|
+
description: View past Ralph iterations, quality check results, and learnings.
|
|
6
|
+
---
|
|
7
|
+
<!-- RALPH:START -->
|
|
8
|
+
**Overview**
|
|
9
|
+
Review detailed records of all Ralph iterations, including:
|
|
10
|
+
- Task completion status
|
|
11
|
+
- Quality gate results (type-check, lint, tests, coverage)
|
|
12
|
+
- Execution time and performance metrics
|
|
13
|
+
- Errors encountered and learnings discovered
|
|
14
|
+
- Git commits associated with each iteration
|
|
15
|
+
|
|
16
|
+
**Guardrails**
|
|
17
|
+
- History is automatically recorded by Ralph during execution
|
|
18
|
+
- Read-only view - use to analyze and debug past iterations
|
|
19
|
+
- Useful for identifying patterns in failures or learning opportunities
|
|
20
|
+
- Each iteration is stored separately for audit trail
|
|
21
|
+
|
|
22
|
+
**Steps**
|
|
23
|
+
1. **View All Iterations**:
|
|
24
|
+
```bash
|
|
25
|
+
rulebook ralph history
|
|
26
|
+
```
|
|
27
|
+
Shows summary of all iterations with status and task info
|
|
28
|
+
|
|
29
|
+
2. **View Latest Iterations**:
|
|
30
|
+
```bash
|
|
31
|
+
rulebook ralph history --limit 5
|
|
32
|
+
```
|
|
33
|
+
Shows most recent N iterations (useful for large iteration counts)
|
|
34
|
+
|
|
35
|
+
3. **View Specific Iteration**:
|
|
36
|
+
```bash
|
|
37
|
+
rulebook ralph history --iteration 3
|
|
38
|
+
```
|
|
39
|
+
Shows detailed information for iteration 3
|
|
40
|
+
|
|
41
|
+
4. **Export History**:
|
|
42
|
+
```bash
|
|
43
|
+
rulebook ralph history --export history.json
|
|
44
|
+
```
|
|
45
|
+
Exports full iteration history for analysis
|
|
46
|
+
|
|
47
|
+
**Iteration Record Fields**
|
|
48
|
+
Each iteration record contains:
|
|
49
|
+
- **Metadata**:
|
|
50
|
+
- Iteration number
|
|
51
|
+
- Timestamp
|
|
52
|
+
- Task ID and title
|
|
53
|
+
- AI tool used
|
|
54
|
+
- Execution time (ms)
|
|
55
|
+
- Status: success / partial / failed
|
|
56
|
+
|
|
57
|
+
- **Quality Checks**:
|
|
58
|
+
- type-check: TypeScript compilation result
|
|
59
|
+
- lint: ESLint check result
|
|
60
|
+
- tests: Test suite result
|
|
61
|
+
- coverage_met: Coverage threshold result
|
|
62
|
+
|
|
63
|
+
- **Output**:
|
|
64
|
+
- output_summary: Summary of what was done
|
|
65
|
+
- learnings: Insights discovered during iteration
|
|
66
|
+
- errors: Any errors encountered
|
|
67
|
+
|
|
68
|
+
- **Git**:
|
|
69
|
+
- git_commit: Commit hash if changes were committed
|
|
70
|
+
- branch: Branch used for this iteration
|
|
71
|
+
|
|
72
|
+
**Analyzing History**
|
|
73
|
+
1. **Success Rate**:
|
|
74
|
+
```bash
|
|
75
|
+
# Successful iterations / total iterations
|
|
76
|
+
# Shows loop health and AI tool effectiveness
|
|
77
|
+
```
|
|
78
|
+
|
|
79
|
+
2. **Quality Gate Patterns**:
|
|
80
|
+
- Check which gates fail most often
|
|
81
|
+
- Identify systematic issues (e.g., always failing lint)
|
|
82
|
+
- Plan improvements based on failure patterns
|
|
83
|
+
|
|
84
|
+
3. **Learnings Extraction**:
|
|
85
|
+
- Ralph records lessons learned from each iteration
|
|
86
|
+
- Use these to improve task definitions or AI prompts
|
|
87
|
+
- Share with team for knowledge base
|
|
88
|
+
|
|
89
|
+
4. **Performance Metrics**:
|
|
90
|
+
- Track execution time per iteration
|
|
91
|
+
- Identify slow tasks or AI tools
|
|
92
|
+
- Optimize based on trends
|
|
93
|
+
|
|
94
|
+
**Location**
|
|
95
|
+
- Iteration records stored in: `.rulebook/ralph/history/`
|
|
96
|
+
- Each file named: `iteration-<N>.json`
|
|
97
|
+
- Full history also available in: `.rulebook/ralph/history-all.json`
|
|
98
|
+
|
|
99
|
+
**Using History for Debugging**
|
|
100
|
+
1. **Failed iteration**: Check error field for root cause
|
|
101
|
+
2. **Partial success**: Review which quality gates failed
|
|
102
|
+
3. **Slow iteration**: Check execution_time_ms
|
|
103
|
+
4. **Pattern analysis**: Compare multiple iterations for trends
|
|
104
|
+
|
|
105
|
+
**Next Steps**
|
|
106
|
+
- After reviewing history, fix issues and retry: `rulebook ralph run`
|
|
107
|
+
- Save learnings to persistent memory: `rulebook memory save "learning from iteration" ...`
|
|
108
|
+
- Update PRD based on discoveries from history analysis
|
|
109
|
+
|
|
110
|
+
<!-- RALPH:END -->
|
|
@@ -1,72 +1,72 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: /ralph-init
|
|
3
|
-
id: ralph-init
|
|
4
|
-
category: Ralph
|
|
5
|
-
description: Initialize Ralph autonomous loop for AI-driven task completion in a project.
|
|
6
|
-
---
|
|
7
|
-
<!-- RALPH:START -->
|
|
8
|
-
**Overview**
|
|
9
|
-
Ralph is an autonomous AI loop that iteratively solves tasks from a PRD (Product Requirements Document). It runs your AI tool (Claude, Cursor, Gemini) in a continuous loop, tracks iterations, and learns from execution results.
|
|
10
|
-
|
|
11
|
-
**Guardrails**
|
|
12
|
-
- Always initialize Ralph before running iterations
|
|
13
|
-
- Use `rulebook ralph status` to check initialization and loop state
|
|
14
|
-
- Set appropriate max iterations (5-20 recommended for most projects)
|
|
15
|
-
- Keep the AI tool consistent across iterations for learning continuity
|
|
16
|
-
|
|
17
|
-
**Prerequisites**
|
|
18
|
-
- Project must be initialized with `rulebook init`
|
|
19
|
-
- Git repository must be set up with a remote origin
|
|
20
|
-
- Current branch will be used as the base for Ralph work
|
|
21
|
-
|
|
22
|
-
**Steps**
|
|
23
|
-
1. **Initialize Ralph**:
|
|
24
|
-
```bash
|
|
25
|
-
rulebook ralph init
|
|
26
|
-
```
|
|
27
|
-
|
|
28
|
-
2. **Interactive Setup**:
|
|
29
|
-
- Select max iterations (number of attempts to complete tasks)
|
|
30
|
-
- Choose AI tool: `claude` (recommended), `cursor`, or `gemini`
|
|
31
|
-
- Creates `.rulebook/ralph/` directory with configuration and PRD
|
|
32
|
-
|
|
33
|
-
3. **Verify Initialization**:
|
|
34
|
-
```bash
|
|
35
|
-
rulebook ralph status
|
|
36
|
-
```
|
|
37
|
-
Should show:
|
|
38
|
-
- `enabled: true`
|
|
39
|
-
- `current_iteration: 0`
|
|
40
|
-
- `max_iterations: <your choice>`
|
|
41
|
-
- `ai_tool: <your choice>`
|
|
42
|
-
|
|
43
|
-
4. **Review Generated PRD**:
|
|
44
|
-
- View `.rulebook/ralph/prd.json` for generated user stories
|
|
45
|
-
- Each story has: `id`, `title`, `description`, `acceptanceCriteria`, `priority`, `passes`, `notes`
|
|
46
|
-
- `passes: false` indicates pending stories
|
|
47
|
-
|
|
48
|
-
5. **Optional: Customize PRD**:
|
|
49
|
-
- Edit user stories directly in `prd.json`
|
|
50
|
-
- Adjust priorities, add acceptance criteria, refine descriptions
|
|
51
|
-
- Ralph will track which stories are completed (`passes: true`)
|
|
52
|
-
|
|
53
|
-
**Output**
|
|
54
|
-
Ralph creates:
|
|
55
|
-
- `.rulebook/ralph/prd.json` - The product requirements document
|
|
56
|
-
- `.rulebook/ralph/config.json` - Loop configuration (max_iterations, ai_tool)
|
|
57
|
-
- `.rulebook/ralph/history/` - Directory for iteration records
|
|
58
|
-
|
|
59
|
-
**Next Steps**
|
|
60
|
-
After initialization, use:
|
|
61
|
-
- `rulebook ralph run` - Start the autonomous loop
|
|
62
|
-
- `rulebook ralph pause` - Pause ongoing iterations
|
|
63
|
-
- `rulebook ralph resume` - Resume paused loop
|
|
64
|
-
- `rulebook ralph status` - Check current state
|
|
65
|
-
- `rulebook ralph history` - View past iterations
|
|
66
|
-
|
|
67
|
-
**Troubleshooting**
|
|
68
|
-
- **Init hangs**: Check git remote is properly configured (`git remote -v`)
|
|
69
|
-
- **PRD not generated**: Ensure project has valid task/context for Ralph to work with
|
|
70
|
-
- **Configuration lost**: Check `.rulebook/ralph/config.json` exists
|
|
71
|
-
|
|
72
|
-
<!-- RALPH:END -->
|
|
1
|
+
---
|
|
2
|
+
name: /ralph-init
|
|
3
|
+
id: ralph-init
|
|
4
|
+
category: Ralph
|
|
5
|
+
description: Initialize Ralph autonomous loop for AI-driven task completion in a project.
|
|
6
|
+
---
|
|
7
|
+
<!-- RALPH:START -->
|
|
8
|
+
**Overview**
|
|
9
|
+
Ralph is an autonomous AI loop that iteratively solves tasks from a PRD (Product Requirements Document). It runs your AI tool (Claude, Cursor, Gemini) in a continuous loop, tracks iterations, and learns from execution results.
|
|
10
|
+
|
|
11
|
+
**Guardrails**
|
|
12
|
+
- Always initialize Ralph before running iterations
|
|
13
|
+
- Use `rulebook ralph status` to check initialization and loop state
|
|
14
|
+
- Set appropriate max iterations (5-20 recommended for most projects)
|
|
15
|
+
- Keep the AI tool consistent across iterations for learning continuity
|
|
16
|
+
|
|
17
|
+
**Prerequisites**
|
|
18
|
+
- Project must be initialized with `rulebook init`
|
|
19
|
+
- Git repository must be set up with a remote origin
|
|
20
|
+
- Current branch will be used as the base for Ralph work
|
|
21
|
+
|
|
22
|
+
**Steps**
|
|
23
|
+
1. **Initialize Ralph**:
|
|
24
|
+
```bash
|
|
25
|
+
rulebook ralph init
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
2. **Interactive Setup**:
|
|
29
|
+
- Select max iterations (number of attempts to complete tasks)
|
|
30
|
+
- Choose AI tool: `claude` (recommended), `cursor`, or `gemini`
|
|
31
|
+
- Creates `.rulebook/ralph/` directory with configuration and PRD
|
|
32
|
+
|
|
33
|
+
3. **Verify Initialization**:
|
|
34
|
+
```bash
|
|
35
|
+
rulebook ralph status
|
|
36
|
+
```
|
|
37
|
+
Should show:
|
|
38
|
+
- `enabled: true`
|
|
39
|
+
- `current_iteration: 0`
|
|
40
|
+
- `max_iterations: <your choice>`
|
|
41
|
+
- `ai_tool: <your choice>`
|
|
42
|
+
|
|
43
|
+
4. **Review Generated PRD**:
|
|
44
|
+
- View `.rulebook/ralph/prd.json` for generated user stories
|
|
45
|
+
- Each story has: `id`, `title`, `description`, `acceptanceCriteria`, `priority`, `passes`, `notes`
|
|
46
|
+
- `passes: false` indicates pending stories
|
|
47
|
+
|
|
48
|
+
5. **Optional: Customize PRD**:
|
|
49
|
+
- Edit user stories directly in `prd.json`
|
|
50
|
+
- Adjust priorities, add acceptance criteria, refine descriptions
|
|
51
|
+
- Ralph will track which stories are completed (`passes: true`)
|
|
52
|
+
|
|
53
|
+
**Output**
|
|
54
|
+
Ralph creates:
|
|
55
|
+
- `.rulebook/ralph/prd.json` - The product requirements document
|
|
56
|
+
- `.rulebook/ralph/config.json` - Loop configuration (max_iterations, ai_tool)
|
|
57
|
+
- `.rulebook/ralph/history/` - Directory for iteration records
|
|
58
|
+
|
|
59
|
+
**Next Steps**
|
|
60
|
+
After initialization, use:
|
|
61
|
+
- `rulebook ralph run` - Start the autonomous loop
|
|
62
|
+
- `rulebook ralph pause` - Pause ongoing iterations
|
|
63
|
+
- `rulebook ralph resume` - Resume paused loop
|
|
64
|
+
- `rulebook ralph status` - Check current state
|
|
65
|
+
- `rulebook ralph history` - View past iterations
|
|
66
|
+
|
|
67
|
+
**Troubleshooting**
|
|
68
|
+
- **Init hangs**: Check git remote is properly configured (`git remote -v`)
|
|
69
|
+
- **PRD not generated**: Ensure project has valid task/context for Ralph to work with
|
|
70
|
+
- **Configuration lost**: Check `.rulebook/ralph/config.json` exists
|
|
71
|
+
|
|
72
|
+
<!-- RALPH:END -->
|