@hivehub/rulebook 1.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/LICENSE +191 -0
- package/README.md +539 -0
- package/dist/agents/claude-code.d.ts +69 -0
- package/dist/agents/claude-code.d.ts.map +1 -0
- package/dist/agents/claude-code.js +180 -0
- package/dist/agents/claude-code.js.map +1 -0
- package/dist/agents/cursor-agent.d.ts +184 -0
- package/dist/agents/cursor-agent.d.ts.map +1 -0
- package/dist/agents/cursor-agent.js +299 -0
- package/dist/agents/cursor-agent.js.map +1 -0
- package/dist/agents/gemini-cli.d.ts +69 -0
- package/dist/agents/gemini-cli.d.ts.map +1 -0
- package/dist/agents/gemini-cli.js +180 -0
- package/dist/agents/gemini-cli.js.map +1 -0
- package/dist/cli/commands.d.ts +57 -0
- package/dist/cli/commands.d.ts.map +1 -0
- package/dist/cli/commands.js +1370 -0
- package/dist/cli/commands.js.map +1 -0
- package/dist/cli/docs-prompts.d.ts +3 -0
- package/dist/cli/docs-prompts.d.ts.map +1 -0
- package/dist/cli/docs-prompts.js +45 -0
- package/dist/cli/docs-prompts.js.map +1 -0
- package/dist/cli/prompts.d.ts +6 -0
- package/dist/cli/prompts.d.ts.map +1 -0
- package/dist/cli/prompts.js +376 -0
- package/dist/cli/prompts.js.map +1 -0
- package/dist/core/agent-manager.d.ts +89 -0
- package/dist/core/agent-manager.d.ts.map +1 -0
- package/dist/core/agent-manager.js +546 -0
- package/dist/core/agent-manager.js.map +1 -0
- package/dist/core/auto-fixer.d.ts +14 -0
- package/dist/core/auto-fixer.d.ts.map +1 -0
- package/dist/core/auto-fixer.js +207 -0
- package/dist/core/auto-fixer.js.map +1 -0
- package/dist/core/changelog-generator.d.ts +44 -0
- package/dist/core/changelog-generator.d.ts.map +1 -0
- package/dist/core/changelog-generator.js +222 -0
- package/dist/core/changelog-generator.js.map +1 -0
- package/dist/core/cli-bridge.d.ts +113 -0
- package/dist/core/cli-bridge.d.ts.map +1 -0
- package/dist/core/cli-bridge.js +1094 -0
- package/dist/core/cli-bridge.js.map +1 -0
- package/dist/core/config-manager.d.ts +65 -0
- package/dist/core/config-manager.d.ts.map +1 -0
- package/dist/core/config-manager.js +266 -0
- package/dist/core/config-manager.js.map +1 -0
- package/dist/core/coverage-checker.d.ts +14 -0
- package/dist/core/coverage-checker.d.ts.map +1 -0
- package/dist/core/coverage-checker.js +176 -0
- package/dist/core/coverage-checker.js.map +1 -0
- package/dist/core/custom-templates.d.ts +27 -0
- package/dist/core/custom-templates.d.ts.map +1 -0
- package/dist/core/custom-templates.js +122 -0
- package/dist/core/custom-templates.js.map +1 -0
- package/dist/core/dependency-checker.d.ts +21 -0
- package/dist/core/dependency-checker.d.ts.map +1 -0
- package/dist/core/dependency-checker.js +247 -0
- package/dist/core/dependency-checker.js.map +1 -0
- package/dist/core/detector.d.ts +3 -0
- package/dist/core/detector.d.ts.map +1 -0
- package/dist/core/detector.js +1443 -0
- package/dist/core/detector.js.map +1 -0
- package/dist/core/docs-generator.d.ts +9 -0
- package/dist/core/docs-generator.d.ts.map +1 -0
- package/dist/core/docs-generator.js +531 -0
- package/dist/core/docs-generator.js.map +1 -0
- package/dist/core/generator.d.ts +16 -0
- package/dist/core/generator.d.ts.map +1 -0
- package/dist/core/generator.js +561 -0
- package/dist/core/generator.js.map +1 -0
- package/dist/core/gitignore-generator.d.ts +13 -0
- package/dist/core/gitignore-generator.d.ts.map +1 -0
- package/dist/core/gitignore-generator.js +307 -0
- package/dist/core/gitignore-generator.js.map +1 -0
- package/dist/core/health-scorer.d.ts +22 -0
- package/dist/core/health-scorer.d.ts.map +1 -0
- package/dist/core/health-scorer.js +395 -0
- package/dist/core/health-scorer.js.map +1 -0
- package/dist/core/logger.d.ts +116 -0
- package/dist/core/logger.d.ts.map +1 -0
- package/dist/core/logger.js +289 -0
- package/dist/core/logger.js.map +1 -0
- package/dist/core/merger.d.ts +6 -0
- package/dist/core/merger.d.ts.map +1 -0
- package/dist/core/merger.js +131 -0
- package/dist/core/merger.js.map +1 -0
- package/dist/core/migrator.d.ts +19 -0
- package/dist/core/migrator.d.ts.map +1 -0
- package/dist/core/migrator.js +102 -0
- package/dist/core/migrator.js.map +1 -0
- package/dist/core/minimal-scaffolder.d.ts +8 -0
- package/dist/core/minimal-scaffolder.d.ts.map +1 -0
- package/dist/core/minimal-scaffolder.js +51 -0
- package/dist/core/minimal-scaffolder.js.map +1 -0
- package/dist/core/modern-console-new.d.ts +81 -0
- package/dist/core/modern-console-new.d.ts.map +1 -0
- package/dist/core/modern-console-new.js +340 -0
- package/dist/core/modern-console-new.js.map +1 -0
- package/dist/core/modern-console.d.ts +99 -0
- package/dist/core/modern-console.d.ts.map +1 -0
- package/dist/core/modern-console.js +568 -0
- package/dist/core/modern-console.js.map +1 -0
- package/dist/core/openspec-manager.d.ts +133 -0
- package/dist/core/openspec-manager.d.ts.map +1 -0
- package/dist/core/openspec-manager.js +605 -0
- package/dist/core/openspec-manager.js.map +1 -0
- package/dist/core/openspec-migrator.d.ts +27 -0
- package/dist/core/openspec-migrator.d.ts.map +1 -0
- package/dist/core/openspec-migrator.js +255 -0
- package/dist/core/openspec-migrator.js.map +1 -0
- package/dist/core/task-manager.d.ts +65 -0
- package/dist/core/task-manager.d.ts.map +1 -0
- package/dist/core/task-manager.js +318 -0
- package/dist/core/task-manager.js.map +1 -0
- package/dist/core/test-task-manager.d.ts +49 -0
- package/dist/core/test-task-manager.d.ts.map +1 -0
- package/dist/core/test-task-manager.js +121 -0
- package/dist/core/test-task-manager.js.map +1 -0
- package/dist/core/validator.d.ts +21 -0
- package/dist/core/validator.d.ts.map +1 -0
- package/dist/core/validator.js +177 -0
- package/dist/core/validator.js.map +1 -0
- package/dist/core/version-bumper.d.ts +19 -0
- package/dist/core/version-bumper.d.ts.map +1 -0
- package/dist/core/version-bumper.js +180 -0
- package/dist/core/version-bumper.js.map +1 -0
- package/dist/core/watcher.d.ts +9 -0
- package/dist/core/watcher.d.ts.map +1 -0
- package/dist/core/watcher.js +22 -0
- package/dist/core/watcher.js.map +1 -0
- package/dist/core/workflow-generator.d.ts +10 -0
- package/dist/core/workflow-generator.d.ts.map +1 -0
- package/dist/core/workflow-generator.js +279 -0
- package/dist/core/workflow-generator.js.map +1 -0
- package/dist/index.d.ts +3 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +159 -0
- package/dist/index.js.map +1 -0
- package/dist/mcp/handlers/archive-task.d.ts +17 -0
- package/dist/mcp/handlers/archive-task.d.ts.map +1 -0
- package/dist/mcp/handlers/archive-task.js +36 -0
- package/dist/mcp/handlers/archive-task.js.map +1 -0
- package/dist/mcp/handlers/create-task.d.ts +17 -0
- package/dist/mcp/handlers/create-task.d.ts.map +1 -0
- package/dist/mcp/handlers/create-task.js +56 -0
- package/dist/mcp/handlers/create-task.js.map +1 -0
- package/dist/mcp/handlers/list-tasks.d.ts +22 -0
- package/dist/mcp/handlers/list-tasks.d.ts.map +1 -0
- package/dist/mcp/handlers/list-tasks.js +42 -0
- package/dist/mcp/handlers/list-tasks.js.map +1 -0
- package/dist/mcp/handlers/show-task.d.ts +25 -0
- package/dist/mcp/handlers/show-task.d.ts.map +1 -0
- package/dist/mcp/handlers/show-task.js +43 -0
- package/dist/mcp/handlers/show-task.js.map +1 -0
- package/dist/mcp/handlers/update-task.d.ts +17 -0
- package/dist/mcp/handlers/update-task.d.ts.map +1 -0
- package/dist/mcp/handlers/update-task.js +35 -0
- package/dist/mcp/handlers/update-task.js.map +1 -0
- package/dist/mcp/handlers/validate-task.d.ts +15 -0
- package/dist/mcp/handlers/validate-task.d.ts.map +1 -0
- package/dist/mcp/handlers/validate-task.js +27 -0
- package/dist/mcp/handlers/validate-task.js.map +1 -0
- package/dist/mcp/rulebook-config.d.ts +22 -0
- package/dist/mcp/rulebook-config.d.ts.map +1 -0
- package/dist/mcp/rulebook-config.js +65 -0
- package/dist/mcp/rulebook-config.js.map +1 -0
- package/dist/mcp/rulebook-server.d.ts +4 -0
- package/dist/mcp/rulebook-server.d.ts.map +1 -0
- package/dist/mcp/rulebook-server.js +246 -0
- package/dist/mcp/rulebook-server.js.map +1 -0
- package/dist/types.d.ts +190 -0
- package/dist/types.d.ts.map +1 -0
- package/dist/types.js +2 -0
- package/dist/types.js.map +1 -0
- package/dist/utils/file-system.d.ts +9 -0
- package/dist/utils/file-system.d.ts.map +1 -0
- package/dist/utils/file-system.js +51 -0
- package/dist/utils/file-system.js.map +1 -0
- package/dist/utils/git-hooks.d.ts +8 -0
- package/dist/utils/git-hooks.d.ts.map +1 -0
- package/dist/utils/git-hooks.js +440 -0
- package/dist/utils/git-hooks.js.map +1 -0
- package/dist/utils/rulesignore.d.ts +9 -0
- package/dist/utils/rulesignore.d.ts.map +1 -0
- package/dist/utils/rulesignore.js +42 -0
- package/dist/utils/rulesignore.js.map +1 -0
- package/package.json +106 -0
- package/templates/cli/AIDER.md +49 -0
- package/templates/cli/AMAZON_Q.md +25 -0
- package/templates/cli/AUGGIE.md +32 -0
- package/templates/cli/CLAUDE.md +32 -0
- package/templates/cli/CLAUDE_CODE.md +35 -0
- package/templates/cli/CLINE.md +32 -0
- package/templates/cli/CODEBUDDY.md +20 -0
- package/templates/cli/CODEIUM.md +20 -0
- package/templates/cli/CODEX.md +21 -0
- package/templates/cli/CONTINUE.md +34 -0
- package/templates/cli/CURSOR_CLI.md +28 -0
- package/templates/cli/FACTORY.md +18 -0
- package/templates/cli/GEMINI.md +35 -0
- package/templates/cli/KILOCODE.md +18 -0
- package/templates/cli/OPENCODE.md +18 -0
- package/templates/cli/_GENERIC_TEMPLATE.md +29 -0
- package/templates/commands/rulebook-task-apply.md +67 -0
- package/templates/commands/rulebook-task-archive.md +70 -0
- package/templates/commands/rulebook-task-create.md +93 -0
- package/templates/commands/rulebook-task-list.md +42 -0
- package/templates/commands/rulebook-task-show.md +52 -0
- package/templates/commands/rulebook-task-validate.md +53 -0
- package/templates/core/AGENT_AUTOMATION.md +184 -0
- package/templates/core/DAG.md +304 -0
- package/templates/core/DOCUMENTATION_RULES.md +37 -0
- package/templates/core/QUALITY_ENFORCEMENT.md +68 -0
- package/templates/core/RULEBOOK.md +1874 -0
- package/templates/frameworks/ANGULAR.md +36 -0
- package/templates/frameworks/DJANGO.md +83 -0
- package/templates/frameworks/ELECTRON.md +147 -0
- package/templates/frameworks/FLASK.md +38 -0
- package/templates/frameworks/FLUTTER.md +55 -0
- package/templates/frameworks/JQUERY.md +32 -0
- package/templates/frameworks/LARAVEL.md +38 -0
- package/templates/frameworks/NESTJS.md +43 -0
- package/templates/frameworks/NEXTJS.md +127 -0
- package/templates/frameworks/NUXT.md +40 -0
- package/templates/frameworks/RAILS.md +66 -0
- package/templates/frameworks/REACT.md +38 -0
- package/templates/frameworks/REACT_NATIVE.md +47 -0
- package/templates/frameworks/SPRING.md +39 -0
- package/templates/frameworks/SYMFONY.md +36 -0
- package/templates/frameworks/VUE.md +36 -0
- package/templates/frameworks/ZEND.md +35 -0
- package/templates/git/CI_CD_PATTERNS.md +661 -0
- package/templates/git/GITHUB_ACTIONS.md +728 -0
- package/templates/git/GITLAB_CI.md +730 -0
- package/templates/git/GIT_WORKFLOW.md +1157 -0
- package/templates/git/SECRETS_MANAGEMENT.md +585 -0
- package/templates/hooks/COMMIT_MSG.md +530 -0
- package/templates/hooks/POST_CHECKOUT.md +546 -0
- package/templates/hooks/PREPARE_COMMIT_MSG.md +619 -0
- package/templates/hooks/PRE_COMMIT.md +414 -0
- package/templates/hooks/PRE_PUSH.md +601 -0
- package/templates/hooks/csharp-pre-commit.sh +23 -0
- package/templates/hooks/csharp-pre-push.sh +23 -0
- package/templates/hooks/dart-pre-commit.sh +30 -0
- package/templates/hooks/dart-pre-push.sh +25 -0
- package/templates/hooks/elixir-pre-commit.sh +32 -0
- package/templates/hooks/elixir-pre-push.sh +31 -0
- package/templates/hooks/erlang-pre-commit.sh +30 -0
- package/templates/hooks/erlang-pre-push.sh +37 -0
- package/templates/hooks/go-pre-commit.sh +40 -0
- package/templates/hooks/go-pre-push.sh +31 -0
- package/templates/hooks/haskell-pre-commit.sh +41 -0
- package/templates/hooks/haskell-pre-push.sh +37 -0
- package/templates/hooks/java-pre-commit.sh +34 -0
- package/templates/hooks/java-pre-push.sh +24 -0
- package/templates/hooks/kotlin-pre-commit.sh +32 -0
- package/templates/hooks/kotlin-pre-push.sh +16 -0
- package/templates/hooks/php-pre-commit.sh +36 -0
- package/templates/hooks/php-pre-push.sh +26 -0
- package/templates/hooks/python-pre-commit.sh +51 -0
- package/templates/hooks/python-pre-push.sh +25 -0
- package/templates/hooks/ruby-pre-commit.sh +33 -0
- package/templates/hooks/ruby-pre-push.sh +32 -0
- package/templates/hooks/rust-pre-commit.sh +30 -0
- package/templates/hooks/rust-pre-push.sh +30 -0
- package/templates/hooks/scala-pre-commit.sh +32 -0
- package/templates/hooks/scala-pre-push.sh +24 -0
- package/templates/hooks/swift-pre-commit.sh +25 -0
- package/templates/hooks/swift-pre-push.sh +23 -0
- package/templates/hooks/typescript-pre-commit.sh +37 -0
- package/templates/hooks/typescript-pre-push.sh +36 -0
- package/templates/ides/COPILOT.md +37 -0
- package/templates/ides/CURSOR.md +43 -0
- package/templates/ides/JETBRAINS_AI.md +35 -0
- package/templates/ides/REPLIT.md +36 -0
- package/templates/ides/TABNINE.md +29 -0
- package/templates/ides/VSCODE.md +40 -0
- package/templates/ides/WINDSURF.md +36 -0
- package/templates/ides/ZED.md +32 -0
- package/templates/languages/ADA.md +58 -0
- package/templates/languages/C.md +333 -0
- package/templates/languages/CPP.md +743 -0
- package/templates/languages/CSHARP.md +417 -0
- package/templates/languages/DART.md +332 -0
- package/templates/languages/ELIXIR.md +454 -0
- package/templates/languages/ERLANG.md +361 -0
- package/templates/languages/GO.md +645 -0
- package/templates/languages/HASKELL.md +177 -0
- package/templates/languages/JAVA.md +607 -0
- package/templates/languages/JAVASCRIPT.md +631 -0
- package/templates/languages/JULIA.md +97 -0
- package/templates/languages/KOTLIN.md +511 -0
- package/templates/languages/LISP.md +100 -0
- package/templates/languages/LUA.md +74 -0
- package/templates/languages/OBJECTIVEC.md +90 -0
- package/templates/languages/PHP.md +416 -0
- package/templates/languages/PYTHON.md +682 -0
- package/templates/languages/R.md +350 -0
- package/templates/languages/RUBY.md +421 -0
- package/templates/languages/RUST.md +477 -0
- package/templates/languages/SAS.md +73 -0
- package/templates/languages/SCALA.md +348 -0
- package/templates/languages/SOLIDITY.md +580 -0
- package/templates/languages/SQL.md +137 -0
- package/templates/languages/SWIFT.md +466 -0
- package/templates/languages/TYPESCRIPT.md +591 -0
- package/templates/languages/ZIG.md +265 -0
- package/templates/modules/ATLASSIAN.md +255 -0
- package/templates/modules/CONTEXT7.md +54 -0
- package/templates/modules/FIGMA.md +267 -0
- package/templates/modules/GITHUB_MCP.md +64 -0
- package/templates/modules/GRAFANA.md +328 -0
- package/templates/modules/NOTION.md +247 -0
- package/templates/modules/PLAYWRIGHT.md +90 -0
- package/templates/modules/RULEBOOK_MCP.md +156 -0
- package/templates/modules/SERENA.md +337 -0
- package/templates/modules/SUPABASE.md +223 -0
- package/templates/modules/SYNAP.md +69 -0
- package/templates/modules/VECTORIZER.md +63 -0
- package/templates/services/AZURE_BLOB.md +184 -0
- package/templates/services/CASSANDRA.md +239 -0
- package/templates/services/DYNAMODB.md +308 -0
- package/templates/services/ELASTICSEARCH.md +347 -0
- package/templates/services/GCS.md +178 -0
- package/templates/services/INFLUXDB.md +265 -0
- package/templates/services/KAFKA.md +341 -0
- package/templates/services/MARIADB.md +183 -0
- package/templates/services/MEMCACHED.md +242 -0
- package/templates/services/MINIO.md +201 -0
- package/templates/services/MONGODB.md +268 -0
- package/templates/services/MYSQL.md +358 -0
- package/templates/services/NEO4J.md +247 -0
- package/templates/services/ORACLE.md +290 -0
- package/templates/services/POSTGRESQL.md +326 -0
- package/templates/services/RABBITMQ.md +286 -0
- package/templates/services/REDIS.md +292 -0
- package/templates/services/S3.md +298 -0
- package/templates/services/SQLITE.md +294 -0
- package/templates/services/SQLSERVER.md +294 -0
- package/templates/workflows/codespell.yml +31 -0
- package/templates/workflows/cpp-lint.yml +47 -0
- package/templates/workflows/cpp-publish.yml +119 -0
- package/templates/workflows/cpp-test.yml +77 -0
- package/templates/workflows/dotnet-lint.yml +29 -0
- package/templates/workflows/dotnet-publish.yml +40 -0
- package/templates/workflows/dotnet-test.yml +41 -0
- package/templates/workflows/elixir-lint.yml +45 -0
- package/templates/workflows/elixir-publish.yml +49 -0
- package/templates/workflows/elixir-test.yml +54 -0
- package/templates/workflows/erlang-lint.yml +47 -0
- package/templates/workflows/erlang-test.yml +62 -0
- package/templates/workflows/go-lint.yml +39 -0
- package/templates/workflows/go-publish.yml +95 -0
- package/templates/workflows/go-test.yml +59 -0
- package/templates/workflows/java-lint.yml +60 -0
- package/templates/workflows/java-publish.yml +120 -0
- package/templates/workflows/java-test.yml +85 -0
- package/templates/workflows/kotlin-lint.yml +34 -0
- package/templates/workflows/kotlin-publish.yml +56 -0
- package/templates/workflows/kotlin-test.yml +48 -0
- package/templates/workflows/php-lint.yml +39 -0
- package/templates/workflows/php-publish.yml +50 -0
- package/templates/workflows/php-test.yml +54 -0
- package/templates/workflows/python-lint.yml +47 -0
- package/templates/workflows/python-publish.yml +91 -0
- package/templates/workflows/python-test.yml +59 -0
- package/templates/workflows/rust-lint.yml +54 -0
- package/templates/workflows/rust-publish.yml +66 -0
- package/templates/workflows/rust-test.yml +75 -0
- package/templates/workflows/solidity-lint.yml +41 -0
- package/templates/workflows/solidity-test.yml +47 -0
- package/templates/workflows/swift-lint.yml +32 -0
- package/templates/workflows/swift-publish.yml +58 -0
- package/templates/workflows/swift-test.yml +44 -0
- package/templates/workflows/typescript-lint.yml +61 -0
- package/templates/workflows/typescript-publish.yml +60 -0
- package/templates/workflows/typescript-test.yml +73 -0
- package/templates/workflows/zig-lint.yml +27 -0
- package/templates/workflows/zig-test.yml +40 -0
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
<!-- AIDER:START -->
|
|
2
|
+
# Aider CLI Rules
|
|
3
|
+
|
|
4
|
+
**Tool**: AI pair programming in terminal (`pip install aider-chat`)
|
|
5
|
+
|
|
6
|
+
## Quick Start
|
|
7
|
+
|
|
8
|
+
```bash
|
|
9
|
+
# Always include AGENTS.md
|
|
10
|
+
aider AGENTS.md src/feature.ts tests/feature.test.ts
|
|
11
|
+
|
|
12
|
+
# In chat:
|
|
13
|
+
"Follow AGENTS.md standards. Implement [feature] with tests first."
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
## Essential Commands
|
|
17
|
+
|
|
18
|
+
```bash
|
|
19
|
+
/add file.ts # Add files to context
|
|
20
|
+
/drop file.ts # Remove from context
|
|
21
|
+
/run npm test # Run command
|
|
22
|
+
/commit "message" # Commit changes
|
|
23
|
+
/undo # Undo last change
|
|
24
|
+
/diff # Review changes
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
## Configuration (.aider.conf.yml)
|
|
28
|
+
|
|
29
|
+
```yaml
|
|
30
|
+
model: gpt-4
|
|
31
|
+
read: [AGENTS.md]
|
|
32
|
+
lint: true
|
|
33
|
+
lint-cmd: "npm run lint"
|
|
34
|
+
test-cmd: "npm test"
|
|
35
|
+
auto-commits: true
|
|
36
|
+
commit-prompt: true
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
## Workflow
|
|
40
|
+
|
|
41
|
+
1. Start session with `aider AGENTS.md [files]`
|
|
42
|
+
2. Request: "Follow AGENTS.md. Implement [feature] with tests first (95%+ coverage)"
|
|
43
|
+
3. Review diffs with `/diff`
|
|
44
|
+
4. Test with `/run npm test`
|
|
45
|
+
5. Commit with `/commit "feat: description"`
|
|
46
|
+
|
|
47
|
+
**Critical**: Always reference AGENTS.md in your requests for consistent standards.
|
|
48
|
+
|
|
49
|
+
<!-- AIDER:END -->
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
<!-- AMAZON_Q:START -->
|
|
2
|
+
# Amazon Q Developer Rules
|
|
3
|
+
|
|
4
|
+
**Tool**: AWS-focused AI assistant with security scanning
|
|
5
|
+
|
|
6
|
+
## Quick Start
|
|
7
|
+
|
|
8
|
+
Available in AWS IDE Toolkit or via AWS Console.
|
|
9
|
+
|
|
10
|
+
## Usage
|
|
11
|
+
|
|
12
|
+
```
|
|
13
|
+
"Follow @AGENTS.md standards. Implement [feature] with tests (95%+ coverage)."
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
## Workflow
|
|
17
|
+
|
|
18
|
+
1. Reference AGENTS.md in prompts
|
|
19
|
+
2. Leverage Q's security scanning for vulnerabilities
|
|
20
|
+
3. Review generated code
|
|
21
|
+
4. Run quality checks
|
|
22
|
+
|
|
23
|
+
**Critical**: Q excels at AWS/security - combine with AGENTS.md standards.
|
|
24
|
+
|
|
25
|
+
<!-- AMAZON_Q:END -->
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
<!-- AUGGIE:START -->
|
|
2
|
+
# Auggie (Augment CLI) Rules
|
|
3
|
+
|
|
4
|
+
**Tool**: TDD mode and intelligent refactoring
|
|
5
|
+
|
|
6
|
+
## Quick Start
|
|
7
|
+
|
|
8
|
+
```bash
|
|
9
|
+
npm install -g augment-cli
|
|
10
|
+
augment --tdd
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Usage
|
|
14
|
+
|
|
15
|
+
```bash
|
|
16
|
+
# TDD mode with AGENTS.md:
|
|
17
|
+
augment --tdd --context AGENTS.md
|
|
18
|
+
|
|
19
|
+
# In prompts:
|
|
20
|
+
"Follow @AGENTS.md. Write tests for [feature], then implement."
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
## Workflow
|
|
24
|
+
|
|
25
|
+
1. Use `--tdd` flag for test-first development
|
|
26
|
+
2. Include `--context AGENTS.md`
|
|
27
|
+
3. Auggie writes tests, then implementation
|
|
28
|
+
4. Review and verify coverage
|
|
29
|
+
|
|
30
|
+
**Critical**: TDD mode aligns perfectly with AGENTS.md test-first approach.
|
|
31
|
+
|
|
32
|
+
<!-- AUGGIE:END -->
|
|
@@ -0,0 +1,32 @@
|
|
|
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
|
+
|
|
30
|
+
**Critical**: Claude has 200K context - paste full AGENTS.md for best results.
|
|
31
|
+
|
|
32
|
+
<!-- CLAUDE:END -->
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
<!-- CLAUDE_CODE:START -->
|
|
2
|
+
# Claude Code CLI Rules
|
|
3
|
+
|
|
4
|
+
**Tool**: Anthropic Claude coding assistant (`npm install -g @anthropic-ai/claude-code`)
|
|
5
|
+
|
|
6
|
+
## Quick Start
|
|
7
|
+
|
|
8
|
+
```bash
|
|
9
|
+
export ANTHROPIC_API_KEY=your_key
|
|
10
|
+
claude-code --model claude-3-5-sonnet --files AGENTS.md
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Essential Usage
|
|
14
|
+
|
|
15
|
+
```bash
|
|
16
|
+
# Load AGENTS.md for standards
|
|
17
|
+
claude-code --files AGENTS.md --task "Implement [feature] following AGENTS.md with tests"
|
|
18
|
+
|
|
19
|
+
# Key flags:
|
|
20
|
+
--model claude-3-5-sonnet # Model selection
|
|
21
|
+
--files AGENTS.md # Include standards
|
|
22
|
+
--stream # Real-time output
|
|
23
|
+
--verbose # Debug mode
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
## Workflow
|
|
27
|
+
|
|
28
|
+
1. Always include `--files AGENTS.md` for project standards
|
|
29
|
+
2. Request: "Follow AGENTS.md. Implement [feature] with tests (95%+ coverage)"
|
|
30
|
+
3. Review generated code
|
|
31
|
+
4. Run quality checks: `npm run lint && npm test`
|
|
32
|
+
|
|
33
|
+
**Critical**: Reference AGENTS.md in prompts for consistent code generation.
|
|
34
|
+
|
|
35
|
+
<!-- CLAUDE_CODE:END -->
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
<!-- CLINE:START -->
|
|
2
|
+
# Cline CLI Rules
|
|
3
|
+
|
|
4
|
+
**Tool**: VS Code extension with autonomous mode
|
|
5
|
+
|
|
6
|
+
## Quick Start
|
|
7
|
+
|
|
8
|
+
Install Cline extension in VS Code or use CLI mode.
|
|
9
|
+
|
|
10
|
+
## Usage
|
|
11
|
+
|
|
12
|
+
```bash
|
|
13
|
+
# In prompts, always reference standards:
|
|
14
|
+
"Follow @AGENTS.md. Implement [feature] with tests first (95%+ coverage)."
|
|
15
|
+
|
|
16
|
+
# Cline will:
|
|
17
|
+
- Read AGENTS.md
|
|
18
|
+
- Write tests
|
|
19
|
+
- Implement feature
|
|
20
|
+
- Run quality checks
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
## Workflow
|
|
24
|
+
|
|
25
|
+
1. Keep AGENTS.md open in workspace
|
|
26
|
+
2. Request features with "Follow @AGENTS.md" prefix
|
|
27
|
+
3. Review proposed changes before approval
|
|
28
|
+
4. Verify tests pass after implementation
|
|
29
|
+
|
|
30
|
+
**Critical**: Reference @AGENTS.md in every prompt for consistent output.
|
|
31
|
+
|
|
32
|
+
<!-- CLINE:END -->
|
|
@@ -0,0 +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 -->
|
|
@@ -0,0 +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 -->
|
|
@@ -0,0 +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 -->
|
|
@@ -0,0 +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 -->
|
|
@@ -0,0 +1,28 @@
|
|
|
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. Request: "Follow @AGENTS.md. Implement [feature] with tests."
|
|
23
|
+
3. Cursor respects .cursorrules and AGENTS.md automatically
|
|
24
|
+
4. Review and accept changes
|
|
25
|
+
|
|
26
|
+
**Critical**: Generated `.cursorrules` points to AGENTS.md. Use @ mentions for explicit references.
|
|
27
|
+
|
|
28
|
+
<!-- CURSOR_CLI:END -->
|
|
@@ -0,0 +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 -->
|
|
@@ -0,0 +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 -->
|
|
@@ -0,0 +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 -->
|
|
@@ -0,0 +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 -->
|
|
@@ -0,0 +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
|
+
|
|
@@ -0,0 +1,67 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: /rulebook-task-apply
|
|
3
|
+
id: rulebook-task-apply
|
|
4
|
+
category: Rulebook
|
|
5
|
+
description: Implement an approved Rulebook task and keep tasks checklist in sync.
|
|
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
|
+
- Refer to `/rulebook/RULEBOOK.md` for complete task management guidelines.
|
|
12
|
+
- **CRITICAL**: Update `tasks.md` IMMEDIATELY after completing and testing each implementation step.
|
|
13
|
+
|
|
14
|
+
**Steps**
|
|
15
|
+
Track these steps as TODOs and complete them one by one.
|
|
16
|
+
|
|
17
|
+
1. **Read Task Details**:
|
|
18
|
+
```bash
|
|
19
|
+
rulebook task show <task-id>
|
|
20
|
+
```
|
|
21
|
+
Read `proposal.md`, `design.md` (if present), and `tasks.md` to confirm scope and acceptance criteria.
|
|
22
|
+
|
|
23
|
+
2. **Follow Priority Order (MANDATORY)**:
|
|
24
|
+
- **Tests** (HIGHEST PRIORITY) - Write tests first
|
|
25
|
+
- **Coverage Verification** (CRITICAL) - Verify coverage ≥95%
|
|
26
|
+
- **Update Task Status** (MANDATORY) - Mark completed items as `[x]` in `tasks.md`
|
|
27
|
+
- **Next Task** (Only after above steps)
|
|
28
|
+
|
|
29
|
+
3. **Work Through Tasks Sequentially**:
|
|
30
|
+
- Work through `tasks.md` checklist item by item
|
|
31
|
+
- Keep edits minimal and focused on the requested change
|
|
32
|
+
- Follow priority order (most critical first)
|
|
33
|
+
|
|
34
|
+
4. **After Each Implementation Step**:
|
|
35
|
+
- ✅ Implement the feature
|
|
36
|
+
- ✅ Test the implementation
|
|
37
|
+
- ✅ Verify test coverage (run `npm test -- --coverage`)
|
|
38
|
+
- ✅ Update `tasks.md` IMMEDIATELY (mark as `[x]`)
|
|
39
|
+
- ✅ Commit locally (backup)
|
|
40
|
+
- ✅ Only then proceed to next task
|
|
41
|
+
|
|
42
|
+
5. **Update Tasks Checklist**:
|
|
43
|
+
After completing and testing each item:
|
|
44
|
+
```markdown
|
|
45
|
+
## 1. Implementation Phase
|
|
46
|
+
- [x] 1.1 Create task manager module <!-- tested, coverage: 95% -->
|
|
47
|
+
- [x] 1.2 Add validation logic <!-- tested, coverage: 92%, status: complete -->
|
|
48
|
+
- [ ] 1.3 Add archive functionality <!-- next: will start after status update -->
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
6. **Confirm Completion**:
|
|
52
|
+
- Make sure every item in `tasks.md` is finished
|
|
53
|
+
- All tests pass
|
|
54
|
+
- Coverage meets thresholds
|
|
55
|
+
- Documentation updated
|
|
56
|
+
|
|
57
|
+
7. **Update Checklist After All Work**:
|
|
58
|
+
- Mark each completed task as `[x]`
|
|
59
|
+
- Add comments with test status and coverage
|
|
60
|
+
- Reflect reality in the checklist
|
|
61
|
+
|
|
62
|
+
**Reference**
|
|
63
|
+
- Use `rulebook task show <task-id>` when additional context is required
|
|
64
|
+
- Use `rulebook task validate <task-id>` to check format before archiving
|
|
65
|
+
- See `/rulebook/RULEBOOK.md` for complete task management guidelines and priority order
|
|
66
|
+
<!-- RULEBOOK:END -->
|
|
67
|
+
|
|
@@ -0,0 +1,70 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: /rulebook-task-archive
|
|
3
|
+
id: rulebook-task-archive
|
|
4
|
+
category: Rulebook
|
|
5
|
+
description: Archive a completed Rulebook task and apply spec deltas to main specifications.
|
|
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
|
+
- Refer to `/rulebook/RULEBOOK.md` for complete task management guidelines.
|
|
12
|
+
|
|
13
|
+
**Steps**
|
|
14
|
+
1. **Verify Task Completion**:
|
|
15
|
+
- All items in `tasks.md` must be marked as `[x]`
|
|
16
|
+
- All tests must pass
|
|
17
|
+
- Code review complete (if applicable)
|
|
18
|
+
- Documentation updated (README, CHANGELOG, specs)
|
|
19
|
+
|
|
20
|
+
2. **Run Quality Checks**:
|
|
21
|
+
```bash
|
|
22
|
+
npm test
|
|
23
|
+
npm run lint
|
|
24
|
+
npm run type-check
|
|
25
|
+
npm run build
|
|
26
|
+
```
|
|
27
|
+
Ensure all checks pass before archiving.
|
|
28
|
+
|
|
29
|
+
3. **Validate Task Format**:
|
|
30
|
+
```bash
|
|
31
|
+
rulebook task validate <task-id>
|
|
32
|
+
```
|
|
33
|
+
Must pass all format checks.
|
|
34
|
+
|
|
35
|
+
4. **Archive Task**:
|
|
36
|
+
```bash
|
|
37
|
+
rulebook task archive <task-id>
|
|
38
|
+
```
|
|
39
|
+
Or without prompts:
|
|
40
|
+
```bash
|
|
41
|
+
rulebook task archive <task-id> --skip-validation
|
|
42
|
+
```
|
|
43
|
+
(Only use `--skip-validation` if you're certain the task is valid)
|
|
44
|
+
|
|
45
|
+
5. **Archive Process**:
|
|
46
|
+
- Validates task format (unless skipped)
|
|
47
|
+
- Checks task completion status
|
|
48
|
+
- Applies spec deltas to main specifications
|
|
49
|
+
- Moves task to `/rulebook/tasks/archive/YYYY-MM-DD-<task-id>/`
|
|
50
|
+
- Updates related specifications
|
|
51
|
+
|
|
52
|
+
6. **Verify Archive**:
|
|
53
|
+
```bash
|
|
54
|
+
rulebook task list --archived
|
|
55
|
+
```
|
|
56
|
+
Task should appear in archived list.
|
|
57
|
+
|
|
58
|
+
7. **Post-Archive Actions**:
|
|
59
|
+
- Ensure spec deltas are applied to main specifications
|
|
60
|
+
- Update CHANGELOG.md with the change
|
|
61
|
+
- Document any breaking changes
|
|
62
|
+
- Create migration guides (if needed)
|
|
63
|
+
- Unblock related tasks (if any)
|
|
64
|
+
|
|
65
|
+
**Reference**
|
|
66
|
+
- Use `rulebook task list --archived` to see archived tasks
|
|
67
|
+
- Use `rulebook task show <task-id>` to view task details
|
|
68
|
+
- See `/rulebook/RULEBOOK.md` for complete task management guidelines
|
|
69
|
+
<!-- RULEBOOK:END -->
|
|
70
|
+
|
|
@@ -0,0 +1,93 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: /rulebook-task-create
|
|
3
|
+
id: rulebook-task-create
|
|
4
|
+
category: Rulebook
|
|
5
|
+
description: Create a new Rulebook task following OpenSpec-compatible format with Context7 MCP validation.
|
|
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
|
+
- Refer to `/rulebook/RULEBOOK.md` for complete task management guidelines and format requirements.
|
|
12
|
+
- **CRITICAL**: Context7 MCP is REQUIRED for task creation to ensure correct OpenSpec-compatible format.
|
|
13
|
+
- Identify any vague or ambiguous details and ask the necessary follow-up questions before editing files.
|
|
14
|
+
|
|
15
|
+
**Steps**
|
|
16
|
+
1. **Check Context7 MCP (MANDATORY)**: Query Context7 for OpenSpec documentation to get the official format:
|
|
17
|
+
```
|
|
18
|
+
@Context7 /fission-ai/openspec task creation format spec structure
|
|
19
|
+
```
|
|
20
|
+
Review official format requirements: spec delta format, requirement structure, scenario formatting, delta headers (ADDED/MODIFIED/REMOVED/RENAMED).
|
|
21
|
+
|
|
22
|
+
2. **Explore Current State**:
|
|
23
|
+
- Run `rulebook task list` to see existing tasks
|
|
24
|
+
- Review related code or docs (e.g., via `rg`/`ls`) to understand current behavior
|
|
25
|
+
- Note any gaps that require clarification
|
|
26
|
+
|
|
27
|
+
3. **Choose Task ID**: Use verb-led kebab-case (e.g., `add-feature`, `update-api`, `refactor-module`). Must be unique.
|
|
28
|
+
|
|
29
|
+
4. **Create Task Structure**:
|
|
30
|
+
```bash
|
|
31
|
+
rulebook task create <task-id>
|
|
32
|
+
```
|
|
33
|
+
This creates `/rulebook/tasks/<task-id>/` with:
|
|
34
|
+
- `proposal.md` - Why and what changes
|
|
35
|
+
- `tasks.md` - Implementation checklist
|
|
36
|
+
- `specs/` - Directory for spec deltas
|
|
37
|
+
|
|
38
|
+
5. **Write Proposal** (`proposal.md`):
|
|
39
|
+
- **Why**: Minimum 20 characters explaining why this change is needed
|
|
40
|
+
- **What Changes**: Detailed description of what will change
|
|
41
|
+
- **Impact**: Affected specs, code, breaking changes, user benefits
|
|
42
|
+
|
|
43
|
+
6. **Write Tasks Checklist** (`tasks.md`):
|
|
44
|
+
- Organize by phases (Implementation, Testing, Documentation)
|
|
45
|
+
- Use checkbox format: `- [ ] Task description`
|
|
46
|
+
- Include validation steps (tests, coverage checks)
|
|
47
|
+
|
|
48
|
+
7. **Write Spec Delta** (`specs/<module>/spec.md`):
|
|
49
|
+
- Use `## ADDED|MODIFIED|REMOVED|RENAMED Requirements` headers
|
|
50
|
+
- Requirements MUST use `### Requirement: [Name]` with SHALL/MUST keywords
|
|
51
|
+
- Scenarios MUST use `#### Scenario:` (4 hashtags, NOT 3)
|
|
52
|
+
- Scenarios MUST use Given/When/Then structure
|
|
53
|
+
- Example:
|
|
54
|
+
```markdown
|
|
55
|
+
## ADDED Requirements
|
|
56
|
+
|
|
57
|
+
### Requirement: Feature Name
|
|
58
|
+
The system SHALL do something specific and testable.
|
|
59
|
+
|
|
60
|
+
#### Scenario: Scenario Name
|
|
61
|
+
Given some precondition
|
|
62
|
+
When an action occurs
|
|
63
|
+
Then an expected outcome happens
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
8. **Validate Task**:
|
|
67
|
+
```bash
|
|
68
|
+
rulebook task validate <task-id>
|
|
69
|
+
```
|
|
70
|
+
Fix any validation errors before proceeding.
|
|
71
|
+
|
|
72
|
+
9. **Verify Format**:
|
|
73
|
+
- Purpose section: ≥20 characters ✅
|
|
74
|
+
- Requirements: Contain SHALL or MUST ✅
|
|
75
|
+
- Scenarios: Use `#### Scenario:` (4 hashtags) ✅
|
|
76
|
+
- Scenarios: Use Given/When/Then structure ✅
|
|
77
|
+
- Delta headers: Use ADDED/MODIFIED/REMOVED/RENAMED ✅
|
|
78
|
+
|
|
79
|
+
**Reference**
|
|
80
|
+
- See `/rulebook/RULEBOOK.md` for complete task management guidelines
|
|
81
|
+
- Use `rulebook task show <task-id>` to view task details
|
|
82
|
+
- Use `rulebook task list` to see all tasks
|
|
83
|
+
- Search existing requirements with `rg -n "Requirement:|Scenario:" rulebook/tasks` before writing new ones
|
|
84
|
+
- Explore the codebase with `rg <keyword>`, `ls`, or direct file reads so proposals align with current implementation realities
|
|
85
|
+
|
|
86
|
+
**Common Pitfalls to Avoid**
|
|
87
|
+
- ❌ Using 3 hashtags for scenarios (`### Scenario:`) - MUST use 4 (`#### Scenario:`)
|
|
88
|
+
- ❌ Missing SHALL/MUST keywords in requirements
|
|
89
|
+
- ❌ Using bullet points for scenarios instead of Given/When/Then
|
|
90
|
+
- ❌ Purpose section too short (<20 characters)
|
|
91
|
+
- ❌ Wrong delta headers (use ADDED/MODIFIED/REMOVED/RENAMED, not "New Requirements" or "Changes")
|
|
92
|
+
<!-- RULEBOOK:END -->
|
|
93
|
+
|