@heyai-rules/pilo-masterkit 1.2.2 → 3.1.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/.agent/agents/architect.md +211 -211
- package/.agent/agents/build-error-resolver.md +114 -114
- package/.agent/agents/chief-of-staff.md +151 -151
- package/.agent/agents/code-reviewer.md +237 -237
- package/.agent/agents/cpp-build-resolver.md +90 -90
- package/.agent/agents/cpp-reviewer.md +72 -72
- package/.agent/agents/csharp-reviewer.md +101 -0
- package/.agent/agents/dart-build-resolver.md +201 -0
- package/.agent/agents/database-reviewer.md +91 -91
- package/.agent/agents/doc-updater.md +107 -107
- package/.agent/agents/docs-lookup.md +68 -68
- package/.agent/agents/e2e-runner.md +107 -107
- package/.agent/agents/flutter-reviewer.md +243 -243
- package/.agent/agents/gan-evaluator.md +209 -0
- package/.agent/agents/gan-generator.md +131 -0
- package/.agent/agents/gan-planner.md +99 -0
- package/.agent/agents/go-build-resolver.md +94 -94
- package/.agent/agents/go-reviewer.md +76 -76
- package/.agent/agents/harness-optimizer.md +35 -35
- package/.agent/agents/healthcare-reviewer.md +83 -0
- package/.agent/agents/java-build-resolver.md +153 -153
- package/.agent/agents/java-reviewer.md +92 -92
- package/.agent/agents/kotlin-build-resolver.md +118 -118
- package/.agent/agents/kotlin-reviewer.md +159 -159
- package/.agent/agents/loop-operator.md +36 -36
- package/.agent/agents/opensource-forker.md +198 -0
- package/.agent/agents/opensource-packager.md +249 -0
- package/.agent/agents/opensource-sanitizer.md +188 -0
- package/.agent/agents/performance-optimizer.md +392 -133
- package/.agent/agents/personas/athena-agent/agent.json +10 -0
- package/.agent/agents/personas/athena-agent/athena-backend-logic-architecture-profile.md +189 -0
- package/.agent/agents/personas/athena-agent/context-files/agents.md +55 -0
- package/.agent/agents/personas/athena-agent/context-files/identity.md +23 -0
- package/.agent/agents/personas/athena-agent/context-files/soul.md +51 -0
- package/.agent/agents/personas/athena-agent/context-files/user-predefined.md +15 -0
- package/.agent/agents/personas/athena-agent/user-context-files/system/bootstrap.md +37 -0
- package/.agent/agents/personas/athena-agent/user-context-files/system/user.md +45 -0
- package/.agent/agents/personas/da-vinci-agent/agent.json +10 -0
- package/.agent/agents/personas/da-vinci-agent/context-files/agents.md +55 -0
- package/.agent/agents/personas/da-vinci-agent/context-files/identity.md +23 -0
- package/.agent/agents/personas/da-vinci-agent/context-files/soul.md +51 -0
- package/.agent/agents/personas/da-vinci-agent/context-files/user-predefined.md +15 -0
- package/.agent/agents/personas/da-vinci-agent/da-vinci-frontend-ui-ux-design-profile.md +189 -0
- package/.agent/agents/personas/da-vinci-agent/user-context-files/system/bootstrap.md +37 -0
- package/.agent/agents/personas/da-vinci-agent/user-context-files/system/user.md +45 -0
- package/.agent/agents/personas/duong-tang-agent/agent.json +10 -0
- package/.agent/agents/personas/duong-tang-agent/context-files/agents.md +55 -0
- package/.agent/agents/personas/duong-tang-agent/context-files/identity.md +23 -0
- package/.agent/agents/personas/duong-tang-agent/context-files/soul.md +51 -0
- package/.agent/agents/personas/duong-tang-agent/context-files/user-predefined.md +15 -0
- package/.agent/agents/personas/duong-tang-agent/tang-monk-quality-testing-documentation-profile.md +189 -0
- package/.agent/agents/personas/duong-tang-agent/user-context-files/system/bootstrap.md +37 -0
- package/.agent/agents/personas/duong-tang-agent/user-context-files/system/user.md +45 -0
- package/.agent/agents/personas/gia-cat-luong-agent/agent.json +10 -0
- package/.agent/agents/personas/gia-cat-luong-agent/context-files/agents.md +55 -0
- package/.agent/agents/personas/gia-cat-luong-agent/context-files/identity.md +23 -0
- package/.agent/agents/personas/gia-cat-luong-agent/context-files/soul.md +51 -0
- package/.agent/agents/personas/gia-cat-luong-agent/context-files/user-predefined.md +15 -0
- package/.agent/agents/personas/gia-cat-luong-agent/kongming-research-strategy-analysis-profile.md +189 -0
- package/.agent/agents/personas/gia-cat-luong-agent/user-context-files/system/bootstrap.md +37 -0
- package/.agent/agents/personas/gia-cat-luong-agent/user-context-files/system/user.md +45 -0
- package/.agent/agents/personas/mihata-agent/agent.json +10 -0
- package/.agent/agents/personas/mihata-agent/context-files/agents.md +55 -0
- package/.agent/agents/personas/mihata-agent/context-files/identity.md +23 -0
- package/.agent/agents/personas/mihata-agent/context-files/soul.md +51 -0
- package/.agent/agents/personas/mihata-agent/context-files/user-predefined.md +15 -0
- package/.agent/agents/personas/mihata-agent/mihata-multi-agent-orchestration-profile.md +189 -0
- package/.agent/agents/personas/mihata-agent/user-context-files/system/bootstrap.md +37 -0
- package/.agent/agents/personas/mihata-agent/user-context-files/system/user.md +45 -0
- package/.agent/agents/personas/tesla-agent/agent.json +10 -0
- package/.agent/agents/personas/tesla-agent/context-files/agents.md +55 -0
- package/.agent/agents/personas/tesla-agent/context-files/identity.md +23 -0
- package/.agent/agents/personas/tesla-agent/context-files/soul.md +51 -0
- package/.agent/agents/personas/tesla-agent/context-files/user-predefined.md +15 -0
- package/.agent/agents/personas/tesla-agent/tesla-fullstack-system-optimization-profile.md +189 -0
- package/.agent/agents/personas/tesla-agent/user-context-files/system/bootstrap.md +37 -0
- package/.agent/agents/personas/tesla-agent/user-context-files/system/user.md +45 -0
- package/.agent/agents/personas/tu-ma-y-agent/agent.json +10 -0
- package/.agent/agents/personas/tu-ma-y-agent/context-files/agents.md +55 -0
- package/.agent/agents/personas/tu-ma-y-agent/context-files/identity.md +23 -0
- package/.agent/agents/personas/tu-ma-y-agent/context-files/soul.md +51 -0
- package/.agent/agents/personas/tu-ma-y-agent/context-files/user-predefined.md +15 -0
- package/.agent/agents/personas/tu-ma-y-agent/simayi-feasibility-risk-control-profile.md +189 -0
- package/.agent/agents/personas/tu-ma-y-agent/user-context-files/system/bootstrap.md +37 -0
- package/.agent/agents/personas/tu-ma-y-agent/user-context-files/system/user.md +45 -0
- package/.agent/agents/personas/venti-agent/agent.json +10 -0
- package/.agent/agents/personas/venti-agent/context-files/agents.md +55 -0
- package/.agent/agents/personas/venti-agent/context-files/identity.md +23 -0
- package/.agent/agents/personas/venti-agent/context-files/soul.md +51 -0
- package/.agent/agents/personas/venti-agent/context-files/user-predefined.md +15 -0
- package/.agent/agents/personas/venti-agent/user-context-files/system/bootstrap.md +37 -0
- package/.agent/agents/personas/venti-agent/user-context-files/system/user.md +45 -0
- package/.agent/agents/personas/venti-agent/venti-learning-communication-mentoring-profile.md +189 -0
- package/.agent/agents/planner.md +212 -212
- package/.agent/agents/python-reviewer.md +98 -98
- package/.agent/agents/pytorch-build-resolver.md +120 -120
- package/.agent/agents/refactor-cleaner.md +85 -85
- package/.agent/agents/rust-build-resolver.md +148 -148
- package/.agent/agents/rust-reviewer.md +94 -94
- package/.agent/agents/security-reviewer.md +108 -108
- package/.agent/agents/tdd-guide.md +91 -91
- package/.agent/agents/typescript-reviewer.md +112 -112
- package/.agent/contexts/dev.md +20 -0
- package/.agent/contexts/research.md +26 -0
- package/.agent/contexts/review.md +22 -0
- package/.agent/hooks/hooks.json +395 -0
- package/.agent/hooks/readme.md +222 -0
- package/.agent/mcp-configs/mcp-servers.json +181 -0
- package/.agent/rules/common/agents.md +50 -0
- package/.agent/rules/common/code-review.md +124 -0
- package/.agent/rules/common/coding-style.md +48 -0
- package/.agent/rules/common/development-workflow.md +44 -0
- package/.agent/rules/common/git-workflow.md +24 -0
- package/.agent/rules/common/hooks.md +30 -0
- package/.agent/rules/common/patterns.md +31 -0
- package/.agent/rules/common/performance.md +55 -0
- package/.agent/rules/common/security.md +29 -0
- package/.agent/rules/common/testing.md +29 -0
- package/.agent/rules/cpp/coding-style.md +44 -0
- package/.agent/rules/cpp/hooks.md +39 -0
- package/.agent/rules/cpp/patterns.md +51 -0
- package/.agent/rules/cpp/security.md +51 -0
- package/.agent/rules/cpp/testing.md +44 -0
- package/.agent/rules/csharp/coding-style.md +72 -0
- package/.agent/rules/csharp/hooks.md +25 -0
- package/.agent/rules/csharp/patterns.md +50 -0
- package/.agent/rules/csharp/security.md +58 -0
- package/.agent/rules/csharp/testing.md +46 -0
- package/.agent/rules/dart/coding-style.md +159 -0
- package/.agent/rules/dart/hooks.md +66 -0
- package/.agent/rules/dart/patterns.md +261 -0
- package/.agent/rules/dart/security.md +135 -0
- package/.agent/rules/dart/testing.md +215 -0
- package/.agent/rules/golang/coding-style.md +32 -0
- package/.agent/rules/golang/hooks.md +17 -0
- package/.agent/rules/golang/patterns.md +45 -0
- package/.agent/rules/golang/security.md +34 -0
- package/.agent/rules/golang/testing.md +31 -0
- package/.agent/rules/java/coding-style.md +114 -0
- package/.agent/rules/java/hooks.md +18 -0
- package/.agent/rules/java/patterns.md +146 -0
- package/.agent/rules/java/security.md +100 -0
- package/.agent/rules/java/testing.md +131 -0
- package/.agent/rules/kotlin/coding-style.md +86 -0
- package/.agent/rules/kotlin/hooks.md +17 -0
- package/.agent/rules/kotlin/patterns.md +146 -0
- package/.agent/rules/kotlin/security.md +82 -0
- package/.agent/rules/kotlin/testing.md +128 -0
- package/.agent/rules/perl/coding-style.md +46 -0
- package/.agent/rules/perl/hooks.md +22 -0
- package/.agent/rules/perl/patterns.md +76 -0
- package/.agent/rules/perl/security.md +69 -0
- package/.agent/rules/perl/testing.md +54 -0
- package/.agent/rules/php/coding-style.md +40 -0
- package/.agent/rules/php/hooks.md +24 -0
- package/.agent/rules/php/patterns.md +33 -0
- package/.agent/rules/php/security.md +37 -0
- package/.agent/rules/php/testing.md +39 -0
- package/.agent/rules/python/coding-style.md +42 -0
- package/.agent/rules/python/hooks.md +19 -0
- package/.agent/rules/python/patterns.md +39 -0
- package/.agent/rules/python/security.md +30 -0
- package/.agent/rules/python/testing.md +38 -0
- package/.agent/rules/readme.md +111 -0
- package/.agent/rules/rust/coding-style.md +151 -0
- package/.agent/rules/rust/hooks.md +16 -0
- package/.agent/rules/rust/patterns.md +168 -0
- package/.agent/rules/rust/security.md +141 -0
- package/.agent/rules/rust/testing.md +154 -0
- package/.agent/rules/swift/coding-style.md +47 -0
- package/.agent/rules/swift/hooks.md +20 -0
- package/.agent/rules/swift/patterns.md +66 -0
- package/.agent/rules/swift/security.md +33 -0
- package/.agent/rules/swift/testing.md +45 -0
- package/.agent/rules/typescript/coding-style.md +199 -0
- package/.agent/rules/typescript/hooks.md +22 -0
- package/.agent/rules/typescript/patterns.md +52 -0
- package/.agent/rules/typescript/security.md +28 -0
- package/.agent/rules/typescript/testing.md +18 -0
- package/.agent/rules/web/coding-style.md +96 -0
- package/.agent/rules/web/design-quality.md +63 -0
- package/.agent/rules/web/hooks.md +120 -0
- package/.agent/rules/web/patterns.md +79 -0
- package/.agent/rules/web/performance.md +64 -0
- package/.agent/rules/web/security.md +57 -0
- package/.agent/rules/web/testing.md +55 -0
- package/.agent/rules/zh/agents.md +50 -0
- package/.agent/rules/zh/code-review.md +124 -0
- package/.agent/rules/zh/coding-style.md +48 -0
- package/.agent/rules/zh/development-workflow.md +44 -0
- package/.agent/rules/zh/git-workflow.md +24 -0
- package/.agent/rules/zh/hooks.md +30 -0
- package/.agent/rules/zh/patterns.md +31 -0
- package/.agent/rules/zh/performance.md +55 -0
- package/.agent/rules/zh/readme.md +108 -0
- package/.agent/rules/zh/security.md +29 -0
- package/.agent/rules/zh/testing.md +29 -0
- package/.agent/skills/agent-eval/SKILL.md +145 -0
- package/.agent/skills/agent-harness-construction/SKILL.md +73 -0
- package/.agent/skills/agent-payment-x402/SKILL.md +178 -0
- package/.agent/skills/agentic-engineering/SKILL.md +63 -0
- package/.agent/skills/ai-first-engineering/SKILL.md +51 -0
- package/.agent/skills/ai-regression-testing/SKILL.md +385 -0
- package/.agent/skills/android-clean-architecture/SKILL.md +339 -0
- package/.agent/skills/api-design/SKILL.md +523 -0
- package/.agent/skills/architecture-decision-records/SKILL.md +179 -0
- package/.agent/skills/article-writing/SKILL.md +79 -0
- package/.agent/skills/autonomous-agent-harness/SKILL.md +267 -0
- package/.agent/skills/autonomous-loops/SKILL.md +610 -0
- package/.agent/skills/backend-patterns/SKILL.md +598 -0
- package/.agent/skills/benchmark/SKILL.md +93 -0
- package/.agent/skills/blueprint/SKILL.md +105 -0
- package/.agent/skills/brand-voice/SKILL.md +97 -0
- package/.agent/skills/brand-voice/references/voice-profile-schema.md +55 -0
- package/.agent/skills/browser-qa/SKILL.md +87 -0
- package/.agent/skills/bun-runtime/SKILL.md +84 -0
- package/.agent/skills/canary-watch/SKILL.md +99 -0
- package/.agent/skills/carrier-relationship-management/SKILL.md +212 -0
- package/.agent/skills/ck/SKILL.md +147 -0
- package/.agent/skills/ck/commands/forget.mjs +44 -0
- package/.agent/skills/ck/commands/info.mjs +24 -0
- package/.agent/skills/ck/commands/init.mjs +143 -0
- package/.agent/skills/ck/commands/list.mjs +40 -0
- package/.agent/skills/ck/commands/migrate.mjs +202 -0
- package/.agent/skills/ck/commands/resume.mjs +36 -0
- package/.agent/skills/ck/commands/save.mjs +210 -0
- package/.agent/skills/ck/commands/shared.mjs +387 -0
- package/.agent/skills/ck/hooks/session-start.mjs +224 -0
- package/.agent/skills/claude-api/SKILL.md +337 -0
- package/.agent/skills/claude-devfleet/SKILL.md +103 -0
- package/.agent/skills/click-path-audit/SKILL.md +244 -0
- package/.agent/skills/clickhouse-io/SKILL.md +439 -0
- package/.agent/skills/codebase-onboarding/SKILL.md +233 -0
- package/.agent/skills/coding-standards/SKILL.md +530 -0
- package/.agent/skills/compose-multiplatform-patterns/SKILL.md +299 -0
- package/.agent/skills/configure-ecc/SKILL.md +367 -0
- package/.agent/skills/connections-optimizer/SKILL.md +189 -0
- package/.agent/skills/content-engine/SKILL.md +131 -0
- package/.agent/skills/content-hash-cache-pattern/SKILL.md +161 -0
- package/.agent/skills/context-budget/SKILL.md +135 -0
- package/.agent/skills/continuous-agent-loop/SKILL.md +45 -0
- package/.agent/skills/continuous-learning/SKILL.md +119 -0
- package/.agent/skills/continuous-learning/config.json +18 -0
- package/.agent/skills/continuous-learning/evaluate-session.sh +69 -0
- package/.agent/skills/continuous-learning-v2/SKILL.md +365 -0
- package/.agent/skills/continuous-learning-v2/agents/observer-loop.sh +271 -0
- package/.agent/skills/continuous-learning-v2/agents/observer.md +198 -0
- package/.agent/skills/continuous-learning-v2/agents/session-guardian.sh +150 -0
- package/.agent/skills/continuous-learning-v2/agents/start-observer.sh +244 -0
- package/.agent/skills/continuous-learning-v2/config.json +8 -0
- package/.agent/skills/continuous-learning-v2/hooks/observe.sh +428 -0
- package/.agent/skills/continuous-learning-v2/scripts/detect-project.sh +228 -0
- package/.agent/skills/continuous-learning-v2/scripts/instinct-cli.py +1426 -0
- package/.agent/skills/continuous-learning-v2/scripts/test-parse-instinct.py +984 -0
- package/.agent/skills/cost-aware-llm-pipeline/SKILL.md +183 -0
- package/.agent/skills/cpp-coding-standards/SKILL.md +723 -0
- package/.agent/skills/cpp-testing/SKILL.md +324 -0
- package/.agent/skills/crosspost/SKILL.md +111 -0
- package/.agent/skills/csharp-testing/SKILL.md +321 -0
- package/.agent/skills/customer-billing-ops/SKILL.md +140 -0
- package/.agent/skills/customs-trade-compliance/SKILL.md +263 -0
- package/.agent/skills/dart-flutter-patterns/SKILL.md +563 -0
- package/.agent/skills/data-scraper-agent/SKILL.md +764 -0
- package/.agent/skills/database-migrations/SKILL.md +429 -0
- package/.agent/skills/deep-research/SKILL.md +155 -0
- package/.agent/skills/deployment-patterns/SKILL.md +427 -0
- package/.agent/skills/design-system/SKILL.md +82 -0
- package/.agent/skills/django-patterns/SKILL.md +734 -0
- package/.agent/skills/django-security/SKILL.md +593 -0
- package/.agent/skills/django-tdd/SKILL.md +729 -0
- package/.agent/skills/django-verification/SKILL.md +469 -0
- package/.agent/skills/dmux-workflows/SKILL.md +191 -0
- package/.agent/skills/docker-patterns/SKILL.md +364 -0
- package/.agent/skills/documentation-lookup/SKILL.md +90 -0
- package/.agent/skills/dotnet-patterns/SKILL.md +321 -0
- package/.agent/skills/e2e-testing/SKILL.md +326 -0
- package/.agent/skills/energy-procurement/SKILL.md +228 -0
- package/.agent/skills/enterprise-agent-ops/SKILL.md +50 -0
- package/.agent/skills/eval-harness/SKILL.md +270 -0
- package/.agent/skills/exa-search/SKILL.md +103 -0
- package/.agent/skills/fal-ai-media/SKILL.md +284 -0
- package/.agent/skills/flutter-dart-code-review/SKILL.md +435 -0
- package/.agent/skills/foundation-models-on-device/SKILL.md +243 -0
- package/.agent/skills/frontend-patterns/SKILL.md +642 -0
- package/.agent/skills/frontend-slides/SKILL.md +184 -0
- package/.agent/skills/frontend-slides/style-presets.md +330 -0
- package/.agent/skills/gan-style-harness/SKILL.md +278 -0
- package/.agent/skills/git-workflow/SKILL.md +715 -0
- package/.agent/skills/golang-patterns/SKILL.md +674 -0
- package/.agent/skills/golang-testing/SKILL.md +720 -0
- package/.agent/skills/google-workspace-ops/SKILL.md +95 -0
- package/.agent/skills/healthcare-cdss-patterns/SKILL.md +245 -0
- package/.agent/skills/healthcare-emr-patterns/SKILL.md +159 -0
- package/.agent/skills/healthcare-eval-harness/SKILL.md +207 -0
- package/.agent/skills/healthcare-phi-compliance/SKILL.md +145 -0
- package/.agent/skills/hexagonal-architecture/SKILL.md +276 -0
- package/.agent/skills/inventory-demand-planning/SKILL.md +247 -0
- package/.agent/skills/investor-materials/SKILL.md +96 -0
- package/.agent/skills/investor-outreach/SKILL.md +91 -0
- package/.agent/skills/iterative-retrieval/SKILL.md +211 -0
- package/.agent/skills/java-coding-standards/SKILL.md +147 -0
- package/.agent/skills/jira-integration/SKILL.md +293 -0
- package/.agent/skills/jpa-patterns/SKILL.md +151 -0
- package/.agent/skills/kotlin-coroutines-flows/SKILL.md +284 -0
- package/.agent/skills/kotlin-exposed-patterns/SKILL.md +719 -0
- package/.agent/skills/kotlin-ktor-patterns/SKILL.md +689 -0
- package/.agent/skills/kotlin-patterns/SKILL.md +711 -0
- package/.agent/skills/kotlin-testing/SKILL.md +824 -0
- package/.agent/skills/laravel-patterns/SKILL.md +415 -0
- package/.agent/skills/laravel-plugin-discovery/SKILL.md +229 -0
- package/.agent/skills/laravel-security/SKILL.md +285 -0
- package/.agent/skills/laravel-tdd/SKILL.md +283 -0
- package/.agent/skills/laravel-verification/SKILL.md +179 -0
- package/.agent/skills/lead-intelligence/SKILL.md +321 -0
- package/.agent/skills/lead-intelligence/agents/enrichment-agent.md +85 -0
- package/.agent/skills/lead-intelligence/agents/mutual-mapper.md +75 -0
- package/.agent/skills/lead-intelligence/agents/outreach-drafter.md +98 -0
- package/.agent/skills/lead-intelligence/agents/signal-scorer.md +60 -0
- package/.agent/skills/liquid-glass-design/SKILL.md +279 -0
- package/.agent/skills/logistics-exception-management/SKILL.md +222 -0
- package/.agent/skills/manim-video/SKILL.md +89 -0
- package/.agent/skills/manim-video/assets/network-graph-scene.py +52 -0
- package/.agent/skills/market-research/SKILL.md +75 -0
- package/.agent/skills/mcp-builder/SKILL.md +173 -113
- package/.agent/skills/mcp-builder/license.txt +202 -0
- package/.agent/skills/mcp-builder/reference/evaluation.md +602 -0
- package/.agent/skills/mcp-builder/reference/mcp-best-practices.md +249 -0
- package/.agent/skills/mcp-builder/reference/node-mcp-server.md +970 -0
- package/.agent/skills/mcp-builder/reference/python-mcp-server.md +719 -0
- package/.agent/skills/mcp-builder/scripts/connections.py +151 -0
- package/.agent/skills/mcp-builder/scripts/evaluation.py +373 -0
- package/.agent/skills/mcp-builder/scripts/example-evaluation.xml +22 -0
- package/.agent/skills/mcp-builder/scripts/requirements.txt +2 -0
- package/.agent/skills/mcp-server-patterns/SKILL.md +67 -0
- package/.agent/skills/nanoclaw-repl/SKILL.md +33 -0
- package/.agent/skills/nestjs-patterns/SKILL.md +230 -0
- package/.agent/skills/nextjs-turbopack/SKILL.md +44 -0
- package/.agent/skills/nutrient-document-processing/SKILL.md +167 -0
- package/.agent/skills/nuxt4-patterns/SKILL.md +100 -0
- package/.agent/skills/openclaw-persona-forge/SKILL.md +296 -0
- package/.agent/skills/openclaw-persona-forge/gacha.py +224 -0
- package/.agent/skills/openclaw-persona-forge/gacha.sh +5 -0
- package/.agent/skills/openclaw-persona-forge/references/avatar-style.md +124 -0
- package/.agent/skills/openclaw-persona-forge/references/boundary-rules.md +53 -0
- package/.agent/skills/openclaw-persona-forge/references/error-handling.md +53 -0
- package/.agent/skills/openclaw-persona-forge/references/identity-tension.md +48 -0
- package/.agent/skills/openclaw-persona-forge/references/naming-system.md +39 -0
- package/.agent/skills/openclaw-persona-forge/references/output-template.md +166 -0
- package/.agent/skills/opensource-pipeline/SKILL.md +255 -0
- package/.agent/skills/perl-patterns/SKILL.md +504 -0
- package/.agent/skills/perl-security/SKILL.md +503 -0
- package/.agent/skills/perl-testing/SKILL.md +475 -0
- package/.agent/skills/plankton-code-quality/SKILL.md +236 -0
- package/.agent/skills/postgres-patterns/SKILL.md +147 -0
- package/.agent/skills/product-lens/SKILL.md +85 -0
- package/.agent/skills/production-scheduling/SKILL.md +238 -0
- package/.agent/skills/project-flow-ops/SKILL.md +111 -0
- package/.agent/skills/project-guidelines-example/SKILL.md +349 -0
- package/.agent/skills/prompt-optimizer/SKILL.md +397 -0
- package/.agent/skills/python-patterns/SKILL.md +622 -313
- package/.agent/skills/python-testing/SKILL.md +816 -0
- package/.agent/skills/pytorch-patterns/SKILL.md +396 -0
- package/.agent/skills/quality-nonconformance/SKILL.md +260 -0
- package/.agent/skills/ralphinho-rfc-pipeline/SKILL.md +67 -0
- package/.agent/skills/regex-vs-llm-structured-text/SKILL.md +220 -0
- package/.agent/skills/remotion-video-creation/SKILL.md +43 -0
- package/.agent/skills/remotion-video-creation/rules/3d.md +86 -0
- package/.agent/skills/remotion-video-creation/rules/animations.md +29 -0
- package/.agent/skills/remotion-video-creation/rules/assets/charts-bar-chart.tsx +173 -0
- package/.agent/skills/remotion-video-creation/rules/assets/text-animations-typewriter.tsx +100 -0
- package/.agent/skills/remotion-video-creation/rules/assets/text-animations-word-highlight.tsx +108 -0
- package/.agent/skills/remotion-video-creation/rules/assets.md +78 -0
- package/.agent/skills/remotion-video-creation/rules/audio.md +172 -0
- package/.agent/skills/remotion-video-creation/rules/calculate-metadata.md +104 -0
- package/.agent/skills/remotion-video-creation/rules/can-decode.md +75 -0
- package/.agent/skills/remotion-video-creation/rules/charts.md +58 -0
- package/.agent/skills/remotion-video-creation/rules/compositions.md +146 -0
- package/.agent/skills/remotion-video-creation/rules/display-captions.md +126 -0
- package/.agent/skills/remotion-video-creation/rules/extract-frames.md +229 -0
- package/.agent/skills/remotion-video-creation/rules/fonts.md +152 -0
- package/.agent/skills/remotion-video-creation/rules/get-audio-duration.md +58 -0
- package/.agent/skills/remotion-video-creation/rules/get-video-dimensions.md +68 -0
- package/.agent/skills/remotion-video-creation/rules/get-video-duration.md +58 -0
- package/.agent/skills/remotion-video-creation/rules/gifs.md +138 -0
- package/.agent/skills/remotion-video-creation/rules/images.md +130 -0
- package/.agent/skills/remotion-video-creation/rules/import-srt-captions.md +67 -0
- package/.agent/skills/remotion-video-creation/rules/lottie.md +67 -0
- package/.agent/skills/remotion-video-creation/rules/measuring-dom-nodes.md +34 -0
- package/.agent/skills/remotion-video-creation/rules/measuring-text.md +143 -0
- package/.agent/skills/remotion-video-creation/rules/sequencing.md +106 -0
- package/.agent/skills/remotion-video-creation/rules/tailwind.md +11 -0
- package/.agent/skills/remotion-video-creation/rules/text-animations.md +20 -0
- package/.agent/skills/remotion-video-creation/rules/timing.md +179 -0
- package/.agent/skills/remotion-video-creation/rules/transcribe-captions.md +19 -0
- package/.agent/skills/remotion-video-creation/rules/transitions.md +122 -0
- package/.agent/skills/remotion-video-creation/rules/trimming.md +52 -0
- package/.agent/skills/remotion-video-creation/rules/videos.md +171 -0
- package/.agent/skills/repo-scan/SKILL.md +78 -0
- package/.agent/skills/returns-reverse-logistics/SKILL.md +240 -0
- package/.agent/skills/rules-distill/SKILL.md +264 -0
- package/.agent/skills/rules-distill/scripts/scan-rules.sh +58 -0
- package/.agent/skills/rules-distill/scripts/scan-skills.sh +129 -0
- package/.agent/skills/rust-patterns/SKILL.md +499 -0
- package/.agent/skills/rust-testing/SKILL.md +500 -0
- package/.agent/skills/safety-guard/SKILL.md +75 -0
- package/.agent/skills/santa-method/SKILL.md +306 -0
- package/.agent/skills/search-first/SKILL.md +161 -0
- package/.agent/skills/security-review/SKILL.md +495 -0
- package/.agent/skills/security-review/cloud-infrastructure-security.md +361 -0
- package/.agent/skills/security-scan/SKILL.md +165 -0
- package/.agent/skills/skill-comply/SKILL.md +58 -0
- package/.agent/skills/skill-comply/fixtures/compliant-trace.jsonl +5 -0
- package/.agent/skills/skill-comply/fixtures/noncompliant-trace.jsonl +3 -0
- package/.agent/skills/skill-comply/fixtures/tdd-spec.yaml +44 -0
- package/.agent/skills/skill-comply/prompts/classifier.md +24 -0
- package/.agent/skills/skill-comply/prompts/scenario-generator.md +62 -0
- package/.agent/skills/skill-comply/prompts/spec-generator.md +42 -0
- package/.agent/skills/skill-comply/pyproject.toml +15 -0
- package/.agent/skills/skill-comply/scripts/classifier.py +85 -0
- package/.agent/skills/skill-comply/scripts/grader.py +122 -0
- package/.agent/skills/skill-comply/scripts/init.py +0 -0
- package/.agent/skills/skill-comply/scripts/parser.py +107 -0
- package/.agent/skills/skill-comply/scripts/report.py +170 -0
- package/.agent/skills/skill-comply/scripts/run.py +127 -0
- package/.agent/skills/skill-comply/scripts/runner.py +161 -0
- package/.agent/skills/skill-comply/scripts/scenario-generator.py +70 -0
- package/.agent/skills/skill-comply/scripts/spec-generator.py +72 -0
- package/.agent/skills/skill-comply/scripts/utils.py +13 -0
- package/.agent/skills/skill-comply/tests/test-grader.py +137 -0
- package/.agent/skills/skill-comply/tests/test-parser.py +90 -0
- package/.agent/skills/skill-creator/SKILL.md +485 -0
- package/.agent/skills/skill-creator/agents/analyzer.md +274 -0
- package/.agent/skills/skill-creator/agents/comparator.md +202 -0
- package/.agent/skills/skill-creator/agents/grader.md +223 -0
- package/.agent/skills/skill-creator/assets/eval-review.html +146 -0
- package/.agent/skills/skill-creator/eval-viewer/generate-review.py +471 -0
- package/.agent/skills/skill-creator/eval-viewer/viewer.html +1325 -0
- package/.agent/skills/skill-creator/license.txt +202 -0
- package/.agent/skills/skill-creator/references/schemas.md +430 -0
- package/.agent/skills/skill-creator/scripts/aggregate-benchmark.py +401 -0
- package/.agent/skills/skill-creator/scripts/generate-report.py +326 -0
- package/.agent/skills/skill-creator/scripts/improve-description.py +247 -0
- package/.agent/skills/skill-creator/scripts/init.py +0 -0
- package/.agent/skills/skill-creator/scripts/package-skill.py +136 -0
- package/.agent/skills/skill-creator/scripts/quick-validate.py +103 -0
- package/.agent/skills/skill-creator/scripts/run-eval.py +310 -0
- package/.agent/skills/skill-creator/scripts/run-loop.py +328 -0
- package/.agent/skills/skill-creator/scripts/utils.py +47 -0
- package/.agent/skills/skill-stocktake/SKILL.md +193 -0
- package/.agent/skills/skill-stocktake/scripts/quick-diff.sh +87 -0
- package/.agent/skills/skill-stocktake/scripts/save-results.sh +56 -0
- package/.agent/skills/skill-stocktake/scripts/scan.sh +170 -0
- package/.agent/skills/social-graph-ranker/SKILL.md +154 -0
- package/.agent/skills/springboot-patterns/SKILL.md +314 -0
- package/.agent/skills/springboot-security/SKILL.md +272 -0
- package/.agent/skills/springboot-tdd/SKILL.md +158 -0
- package/.agent/skills/springboot-verification/SKILL.md +231 -0
- package/.agent/skills/strategic-compact/SKILL.md +131 -0
- package/.agent/skills/strategic-compact/suggest-compact.sh +54 -0
- package/.agent/skills/swift-actor-persistence/SKILL.md +143 -0
- package/.agent/skills/swift-concurrency-6-2/SKILL.md +216 -0
- package/.agent/skills/swift-protocol-di-testing/SKILL.md +190 -0
- package/.agent/skills/swiftui-patterns/SKILL.md +259 -0
- package/.agent/skills/tdd-workflow/SKILL.md +412 -98
- package/.agent/skills/team-builder/SKILL.md +168 -0
- package/.agent/skills/token-budget-advisor/SKILL.md +133 -0
- package/.agent/skills/ui-demo/SKILL.md +465 -0
- package/.agent/skills/ui-ux-pro-max/data/charts.csv +26 -26
- package/.agent/skills/ui-ux-pro-max/data/colors.csv +97 -97
- package/.agent/skills/ui-ux-pro-max/data/landing.csv +28 -28
- package/.agent/skills/ui-ux-pro-max/data/products.csv +96 -96
- package/.agent/skills/ui-ux-pro-max/data/stacks/flutter.csv +53 -53
- package/.agent/skills/ui-ux-pro-max/data/stacks/html-tailwind.csv +56 -56
- package/.agent/skills/ui-ux-pro-max/data/stacks/nextjs.csv +53 -53
- package/.agent/skills/ui-ux-pro-max/data/stacks/react-native.csv +52 -52
- package/.agent/skills/ui-ux-pro-max/data/stacks/react.csv +54 -54
- package/.agent/skills/ui-ux-pro-max/data/stacks/svelte.csv +54 -54
- package/.agent/skills/ui-ux-pro-max/data/stacks/swiftui.csv +51 -51
- package/.agent/skills/ui-ux-pro-max/data/stacks/vue.csv +50 -50
- package/.agent/skills/ui-ux-pro-max/data/styles.csv +68 -68
- package/.agent/skills/ui-ux-pro-max/data/ux-guidelines.csv +99 -99
- package/.agent/skills/ui-ux-pro-max/scripts/search.py +114 -114
- package/.agent/skills/verification-loop/SKILL.md +126 -0
- package/.agent/skills/video-editing/SKILL.md +310 -0
- package/.agent/skills/videodb/SKILL.md +374 -0
- package/.agent/skills/videodb/reference/api-reference.md +550 -0
- package/.agent/skills/videodb/reference/capture-reference.md +407 -0
- package/.agent/skills/videodb/reference/capture.md +101 -0
- package/.agent/skills/videodb/reference/editor.md +443 -0
- package/.agent/skills/videodb/reference/generative.md +331 -0
- package/.agent/skills/videodb/reference/rtstream-reference.md +564 -0
- package/.agent/skills/videodb/reference/rtstream.md +65 -0
- package/.agent/skills/videodb/reference/search.md +230 -0
- package/.agent/skills/videodb/reference/streaming.md +406 -0
- package/.agent/skills/videodb/reference/use-cases.md +118 -0
- package/.agent/skills/videodb/scripts/ws-listener.py +282 -0
- package/.agent/skills/visa-doc-translate/SKILL.md +117 -0
- package/.agent/skills/visa-doc-translate/readme.md +86 -0
- package/.agent/skills/workspace-surface-audit/SKILL.md +125 -0
- package/.agent/skills/x-api/SKILL.md +230 -0
- package/.agent/tasks/two-track-merge-contract.md +29 -0
- package/.agent/workflows/aside.md +164 -164
- package/.agent/workflows/build-fix.md +62 -62
- package/.agent/workflows/checkpoint.md +74 -74
- package/.agent/workflows/claw.md +23 -51
- package/.agent/workflows/clean-memory.md +34 -0
- package/.agent/workflows/code-review.md +289 -40
- package/.agent/workflows/context-budget.md +23 -29
- package/.agent/workflows/cpp-build.md +173 -173
- package/.agent/workflows/cpp-review.md +132 -132
- package/.agent/workflows/cpp-test.md +251 -251
- package/.agent/workflows/devfleet.md +23 -92
- package/.agent/workflows/docs.md +23 -31
- package/.agent/workflows/e2e.md +268 -365
- package/.agent/workflows/eval.md +23 -120
- package/.agent/workflows/evolve.md +178 -178
- package/.agent/workflows/flutter-build.md +164 -0
- package/.agent/workflows/flutter-review.md +116 -0
- package/.agent/workflows/flutter-test.md +144 -0
- package/.agent/workflows/gan-build.md +99 -0
- package/.agent/workflows/gan-design.md +35 -0
- package/.agent/workflows/go-build.md +183 -183
- package/.agent/workflows/go-review.md +148 -148
- package/.agent/workflows/go-test.md +268 -268
- package/.agent/workflows/gradle-build.md +70 -70
- package/.agent/workflows/harness-audit.md +73 -71
- package/.agent/workflows/instinct-export.md +66 -66
- package/.agent/workflows/instinct-import.md +114 -114
- package/.agent/workflows/instinct-status.md +59 -59
- package/.agent/workflows/jira.md +106 -0
- package/.agent/workflows/kotlin-build.md +174 -174
- package/.agent/workflows/kotlin-review.md +140 -140
- package/.agent/workflows/kotlin-test.md +312 -312
- package/.agent/workflows/learn-eval.md +116 -116
- package/.agent/workflows/learn.md +70 -70
- package/.agent/workflows/loop-start.md +32 -32
- package/.agent/workflows/loop-status.md +24 -24
- package/.agent/workflows/model-route.md +26 -26
- package/.agent/workflows/multi-backend.md +158 -158
- package/.agent/workflows/multi-execute.md +315 -315
- package/.agent/workflows/multi-frontend.md +158 -158
- package/.agent/workflows/multi-plan.md +268 -268
- package/.agent/workflows/multi-workflow.md +191 -191
- package/.agent/workflows/orchestrate.md +135 -231
- package/.agent/workflows/plan.md +117 -115
- package/.agent/workflows/pm2.md +272 -272
- package/.agent/workflows/projects.md +39 -39
- package/.agent/workflows/promote.md +41 -41
- package/.agent/workflows/prompt-optimize.md +23 -38
- package/.agent/workflows/prp-commit.md +112 -0
- package/.agent/workflows/prp-implement.md +385 -0
- package/.agent/workflows/prp-plan.md +502 -0
- package/.agent/workflows/prp-pr.md +184 -0
- package/.agent/workflows/prp-prd.md +447 -0
- package/.agent/workflows/prune.md +31 -31
- package/.agent/workflows/python-review.md +297 -297
- package/.agent/workflows/quality-gate.md +29 -29
- package/.agent/workflows/refactor-clean.md +80 -80
- package/.agent/workflows/resume-session.md +156 -156
- package/.agent/workflows/rules-distill.md +20 -11
- package/.agent/workflows/rust-build.md +187 -187
- package/.agent/workflows/rust-review.md +142 -142
- package/.agent/workflows/rust-test.md +308 -308
- package/.agent/workflows/santa-loop.md +175 -0
- package/.agent/workflows/save-session.md +275 -275
- package/.agent/workflows/sessions.md +333 -333
- package/.agent/workflows/setup-pm.md +80 -80
- package/.agent/workflows/skill-create.md +174 -174
- package/.agent/workflows/skill-health.md +54 -54
- package/.agent/workflows/tdd.md +231 -328
- package/.agent/workflows/test-coverage.md +69 -69
- package/.agent/workflows/update-codemaps.md +72 -72
- package/.agent/workflows/update-docs.md +84 -84
- package/.agent/workflows/verify.md +23 -59
- package/LICENSE +176 -176
- package/README.md +28 -20
- package/RELEASE.md +32 -36
- package/package.json +87 -79
- package/scripts/release-check.js +55 -55
- package/src/bin/cli.js +399 -53
- package/src/lib/installer.js +360 -114
- package/src/lib/manifests/stacks.js +122 -0
- package/src/lib/slash-commands.js +28 -0
- package/src/templates/claude/CLAUDE.en.md +42 -0
- package/src/templates/claude/CLAUDE.md +42 -0
- package/src/templates/claude/CLAUDE.vi.md +42 -0
- package/src/templates/codex/AGENTS.en.md +40 -0
- package/src/templates/codex/AGENTS.md +40 -0
- package/src/templates/codex/AGENTS.vi.md +40 -0
- package/src/templates/cursor/pilo-masterkit.mdc +20 -0
- package/src/templates/gemini/GEMINI.en.md +56 -0
- package/src/templates/gemini/GEMINI.md +56 -0
- package/src/templates/gemini/GEMINI.vi.md +56 -0
- package/src/templates/github/copilot-instructions.md +16 -0
|
@@ -0,0 +1,439 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: clickhouse-io
|
|
3
|
+
description: ClickHouse database patterns, query optimization, analytics, and data engineering best practices for high-performance analytical workloads.
|
|
4
|
+
origin: ECC
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# ClickHouse Analytics Patterns
|
|
8
|
+
|
|
9
|
+
ClickHouse-specific patterns for high-performance analytics and data engineering.
|
|
10
|
+
|
|
11
|
+
## When to Activate
|
|
12
|
+
|
|
13
|
+
- Designing ClickHouse table schemas (MergeTree engine selection)
|
|
14
|
+
- Writing analytical queries (aggregations, window functions, joins)
|
|
15
|
+
- Optimizing query performance (partition pruning, projections, materialized views)
|
|
16
|
+
- Ingesting large volumes of data (batch inserts, Kafka integration)
|
|
17
|
+
- Migrating from PostgreSQL/MySQL to ClickHouse for analytics
|
|
18
|
+
- Implementing real-time dashboards or time-series analytics
|
|
19
|
+
|
|
20
|
+
## Overview
|
|
21
|
+
|
|
22
|
+
ClickHouse is a column-oriented database management system (DBMS) for online analytical processing (OLAP). It's optimized for fast analytical queries on large datasets.
|
|
23
|
+
|
|
24
|
+
**Key Features:**
|
|
25
|
+
- Column-oriented storage
|
|
26
|
+
- Data compression
|
|
27
|
+
- Parallel query execution
|
|
28
|
+
- Distributed queries
|
|
29
|
+
- Real-time analytics
|
|
30
|
+
|
|
31
|
+
## Table Design Patterns
|
|
32
|
+
|
|
33
|
+
### MergeTree Engine (Most Common)
|
|
34
|
+
|
|
35
|
+
```sql
|
|
36
|
+
CREATE TABLE markets_analytics (
|
|
37
|
+
date Date,
|
|
38
|
+
market_id String,
|
|
39
|
+
market_name String,
|
|
40
|
+
volume UInt64,
|
|
41
|
+
trades UInt32,
|
|
42
|
+
unique_traders UInt32,
|
|
43
|
+
avg_trade_size Float64,
|
|
44
|
+
created_at DateTime
|
|
45
|
+
) ENGINE = MergeTree()
|
|
46
|
+
PARTITION BY toYYYYMM(date)
|
|
47
|
+
ORDER BY (date, market_id)
|
|
48
|
+
SETTINGS index_granularity = 8192;
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
### ReplacingMergeTree (Deduplication)
|
|
52
|
+
|
|
53
|
+
```sql
|
|
54
|
+
-- For data that may have duplicates (e.g., from multiple sources)
|
|
55
|
+
CREATE TABLE user_events (
|
|
56
|
+
event_id String,
|
|
57
|
+
user_id String,
|
|
58
|
+
event_type String,
|
|
59
|
+
timestamp DateTime,
|
|
60
|
+
properties String
|
|
61
|
+
) ENGINE = ReplacingMergeTree()
|
|
62
|
+
PARTITION BY toYYYYMM(timestamp)
|
|
63
|
+
ORDER BY (user_id, event_id, timestamp)
|
|
64
|
+
PRIMARY KEY (user_id, event_id);
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
### AggregatingMergeTree (Pre-aggregation)
|
|
68
|
+
|
|
69
|
+
```sql
|
|
70
|
+
-- For maintaining aggregated metrics
|
|
71
|
+
CREATE TABLE market_stats_hourly (
|
|
72
|
+
hour DateTime,
|
|
73
|
+
market_id String,
|
|
74
|
+
total_volume AggregateFunction(sum, UInt64),
|
|
75
|
+
total_trades AggregateFunction(count, UInt32),
|
|
76
|
+
unique_users AggregateFunction(uniq, String)
|
|
77
|
+
) ENGINE = AggregatingMergeTree()
|
|
78
|
+
PARTITION BY toYYYYMM(hour)
|
|
79
|
+
ORDER BY (hour, market_id);
|
|
80
|
+
|
|
81
|
+
-- Query aggregated data
|
|
82
|
+
SELECT
|
|
83
|
+
hour,
|
|
84
|
+
market_id,
|
|
85
|
+
sumMerge(total_volume) AS volume,
|
|
86
|
+
countMerge(total_trades) AS trades,
|
|
87
|
+
uniqMerge(unique_users) AS users
|
|
88
|
+
FROM market_stats_hourly
|
|
89
|
+
WHERE hour >= toStartOfHour(now() - INTERVAL 24 HOUR)
|
|
90
|
+
GROUP BY hour, market_id
|
|
91
|
+
ORDER BY hour DESC;
|
|
92
|
+
```
|
|
93
|
+
|
|
94
|
+
## Query Optimization Patterns
|
|
95
|
+
|
|
96
|
+
### Efficient Filtering
|
|
97
|
+
|
|
98
|
+
```sql
|
|
99
|
+
-- PASS: GOOD: Use indexed columns first
|
|
100
|
+
SELECT *
|
|
101
|
+
FROM markets_analytics
|
|
102
|
+
WHERE date >= '2025-01-01'
|
|
103
|
+
AND market_id = 'market-123'
|
|
104
|
+
AND volume > 1000
|
|
105
|
+
ORDER BY date DESC
|
|
106
|
+
LIMIT 100;
|
|
107
|
+
|
|
108
|
+
-- FAIL: BAD: Filter on non-indexed columns first
|
|
109
|
+
SELECT *
|
|
110
|
+
FROM markets_analytics
|
|
111
|
+
WHERE volume > 1000
|
|
112
|
+
AND market_name LIKE '%election%'
|
|
113
|
+
AND date >= '2025-01-01';
|
|
114
|
+
```
|
|
115
|
+
|
|
116
|
+
### Aggregations
|
|
117
|
+
|
|
118
|
+
```sql
|
|
119
|
+
-- PASS: GOOD: Use ClickHouse-specific aggregation functions
|
|
120
|
+
SELECT
|
|
121
|
+
toStartOfDay(created_at) AS day,
|
|
122
|
+
market_id,
|
|
123
|
+
sum(volume) AS total_volume,
|
|
124
|
+
count() AS total_trades,
|
|
125
|
+
uniq(trader_id) AS unique_traders,
|
|
126
|
+
avg(trade_size) AS avg_size
|
|
127
|
+
FROM trades
|
|
128
|
+
WHERE created_at >= today() - INTERVAL 7 DAY
|
|
129
|
+
GROUP BY day, market_id
|
|
130
|
+
ORDER BY day DESC, total_volume DESC;
|
|
131
|
+
|
|
132
|
+
-- PASS: Use quantile for percentiles (more efficient than percentile)
|
|
133
|
+
SELECT
|
|
134
|
+
quantile(0.50)(trade_size) AS median,
|
|
135
|
+
quantile(0.95)(trade_size) AS p95,
|
|
136
|
+
quantile(0.99)(trade_size) AS p99
|
|
137
|
+
FROM trades
|
|
138
|
+
WHERE created_at >= now() - INTERVAL 1 HOUR;
|
|
139
|
+
```
|
|
140
|
+
|
|
141
|
+
### Window Functions
|
|
142
|
+
|
|
143
|
+
```sql
|
|
144
|
+
-- Calculate running totals
|
|
145
|
+
SELECT
|
|
146
|
+
date,
|
|
147
|
+
market_id,
|
|
148
|
+
volume,
|
|
149
|
+
sum(volume) OVER (
|
|
150
|
+
PARTITION BY market_id
|
|
151
|
+
ORDER BY date
|
|
152
|
+
ROWS BETWEEN UNBOUNDED PRECEDING AND CURRENT ROW
|
|
153
|
+
) AS cumulative_volume
|
|
154
|
+
FROM markets_analytics
|
|
155
|
+
WHERE date >= today() - INTERVAL 30 DAY
|
|
156
|
+
ORDER BY market_id, date;
|
|
157
|
+
```
|
|
158
|
+
|
|
159
|
+
## Data Insertion Patterns
|
|
160
|
+
|
|
161
|
+
### Bulk Insert (Recommended)
|
|
162
|
+
|
|
163
|
+
```typescript
|
|
164
|
+
import { ClickHouse } from 'clickhouse'
|
|
165
|
+
|
|
166
|
+
const clickhouse = new ClickHouse({
|
|
167
|
+
url: process.env.CLICKHOUSE_URL,
|
|
168
|
+
port: 8123,
|
|
169
|
+
basicAuth: {
|
|
170
|
+
username: process.env.CLICKHOUSE_USER,
|
|
171
|
+
password: process.env.CLICKHOUSE_PASSWORD
|
|
172
|
+
}
|
|
173
|
+
})
|
|
174
|
+
|
|
175
|
+
// PASS: Batch insert (efficient)
|
|
176
|
+
async function bulkInsertTrades(trades: Trade[]) {
|
|
177
|
+
const values = trades.map(trade => `(
|
|
178
|
+
'${trade.id}',
|
|
179
|
+
'${trade.market_id}',
|
|
180
|
+
'${trade.user_id}',
|
|
181
|
+
${trade.amount},
|
|
182
|
+
'${trade.timestamp.toISOString()}'
|
|
183
|
+
)`).join(',')
|
|
184
|
+
|
|
185
|
+
await clickhouse.query(`
|
|
186
|
+
INSERT INTO trades (id, market_id, user_id, amount, timestamp)
|
|
187
|
+
VALUES ${values}
|
|
188
|
+
`).toPromise()
|
|
189
|
+
}
|
|
190
|
+
|
|
191
|
+
// FAIL: Individual inserts (slow)
|
|
192
|
+
async function insertTrade(trade: Trade) {
|
|
193
|
+
// Don't do this in a loop!
|
|
194
|
+
await clickhouse.query(`
|
|
195
|
+
INSERT INTO trades VALUES ('${trade.id}', ...)
|
|
196
|
+
`).toPromise()
|
|
197
|
+
}
|
|
198
|
+
```
|
|
199
|
+
|
|
200
|
+
### Streaming Insert
|
|
201
|
+
|
|
202
|
+
```typescript
|
|
203
|
+
// For continuous data ingestion
|
|
204
|
+
import { createWriteStream } from 'fs'
|
|
205
|
+
import { pipeline } from 'stream/promises'
|
|
206
|
+
|
|
207
|
+
async function streamInserts() {
|
|
208
|
+
const stream = clickhouse.insert('trades').stream()
|
|
209
|
+
|
|
210
|
+
for await (const batch of dataSource) {
|
|
211
|
+
stream.write(batch)
|
|
212
|
+
}
|
|
213
|
+
|
|
214
|
+
await stream.end()
|
|
215
|
+
}
|
|
216
|
+
```
|
|
217
|
+
|
|
218
|
+
## Materialized Views
|
|
219
|
+
|
|
220
|
+
### Real-time Aggregations
|
|
221
|
+
|
|
222
|
+
```sql
|
|
223
|
+
-- Create materialized view for hourly stats
|
|
224
|
+
CREATE MATERIALIZED VIEW market_stats_hourly_mv
|
|
225
|
+
TO market_stats_hourly
|
|
226
|
+
AS SELECT
|
|
227
|
+
toStartOfHour(timestamp) AS hour,
|
|
228
|
+
market_id,
|
|
229
|
+
sumState(amount) AS total_volume,
|
|
230
|
+
countState() AS total_trades,
|
|
231
|
+
uniqState(user_id) AS unique_users
|
|
232
|
+
FROM trades
|
|
233
|
+
GROUP BY hour, market_id;
|
|
234
|
+
|
|
235
|
+
-- Query the materialized view
|
|
236
|
+
SELECT
|
|
237
|
+
hour,
|
|
238
|
+
market_id,
|
|
239
|
+
sumMerge(total_volume) AS volume,
|
|
240
|
+
countMerge(total_trades) AS trades,
|
|
241
|
+
uniqMerge(unique_users) AS users
|
|
242
|
+
FROM market_stats_hourly
|
|
243
|
+
WHERE hour >= now() - INTERVAL 24 HOUR
|
|
244
|
+
GROUP BY hour, market_id;
|
|
245
|
+
```
|
|
246
|
+
|
|
247
|
+
## Performance Monitoring
|
|
248
|
+
|
|
249
|
+
### Query Performance
|
|
250
|
+
|
|
251
|
+
```sql
|
|
252
|
+
-- Check slow queries
|
|
253
|
+
SELECT
|
|
254
|
+
query_id,
|
|
255
|
+
user,
|
|
256
|
+
query,
|
|
257
|
+
query_duration_ms,
|
|
258
|
+
read_rows,
|
|
259
|
+
read_bytes,
|
|
260
|
+
memory_usage
|
|
261
|
+
FROM system.query_log
|
|
262
|
+
WHERE type = 'QueryFinish'
|
|
263
|
+
AND query_duration_ms > 1000
|
|
264
|
+
AND event_time >= now() - INTERVAL 1 HOUR
|
|
265
|
+
ORDER BY query_duration_ms DESC
|
|
266
|
+
LIMIT 10;
|
|
267
|
+
```
|
|
268
|
+
|
|
269
|
+
### Table Statistics
|
|
270
|
+
|
|
271
|
+
```sql
|
|
272
|
+
-- Check table sizes
|
|
273
|
+
SELECT
|
|
274
|
+
database,
|
|
275
|
+
table,
|
|
276
|
+
formatReadableSize(sum(bytes)) AS size,
|
|
277
|
+
sum(rows) AS rows,
|
|
278
|
+
max(modification_time) AS latest_modification
|
|
279
|
+
FROM system.parts
|
|
280
|
+
WHERE active
|
|
281
|
+
GROUP BY database, table
|
|
282
|
+
ORDER BY sum(bytes) DESC;
|
|
283
|
+
```
|
|
284
|
+
|
|
285
|
+
## Common Analytics Queries
|
|
286
|
+
|
|
287
|
+
### Time Series Analysis
|
|
288
|
+
|
|
289
|
+
```sql
|
|
290
|
+
-- Daily active users
|
|
291
|
+
SELECT
|
|
292
|
+
toDate(timestamp) AS date,
|
|
293
|
+
uniq(user_id) AS daily_active_users
|
|
294
|
+
FROM events
|
|
295
|
+
WHERE timestamp >= today() - INTERVAL 30 DAY
|
|
296
|
+
GROUP BY date
|
|
297
|
+
ORDER BY date;
|
|
298
|
+
|
|
299
|
+
-- Retention analysis
|
|
300
|
+
SELECT
|
|
301
|
+
signup_date,
|
|
302
|
+
countIf(days_since_signup = 0) AS day_0,
|
|
303
|
+
countIf(days_since_signup = 1) AS day_1,
|
|
304
|
+
countIf(days_since_signup = 7) AS day_7,
|
|
305
|
+
countIf(days_since_signup = 30) AS day_30
|
|
306
|
+
FROM (
|
|
307
|
+
SELECT
|
|
308
|
+
user_id,
|
|
309
|
+
min(toDate(timestamp)) AS signup_date,
|
|
310
|
+
toDate(timestamp) AS activity_date,
|
|
311
|
+
dateDiff('day', signup_date, activity_date) AS days_since_signup
|
|
312
|
+
FROM events
|
|
313
|
+
GROUP BY user_id, activity_date
|
|
314
|
+
)
|
|
315
|
+
GROUP BY signup_date
|
|
316
|
+
ORDER BY signup_date DESC;
|
|
317
|
+
```
|
|
318
|
+
|
|
319
|
+
### Funnel Analysis
|
|
320
|
+
|
|
321
|
+
```sql
|
|
322
|
+
-- Conversion funnel
|
|
323
|
+
SELECT
|
|
324
|
+
countIf(step = 'viewed_market') AS viewed,
|
|
325
|
+
countIf(step = 'clicked_trade') AS clicked,
|
|
326
|
+
countIf(step = 'completed_trade') AS completed,
|
|
327
|
+
round(clicked / viewed * 100, 2) AS view_to_click_rate,
|
|
328
|
+
round(completed / clicked * 100, 2) AS click_to_completion_rate
|
|
329
|
+
FROM (
|
|
330
|
+
SELECT
|
|
331
|
+
user_id,
|
|
332
|
+
session_id,
|
|
333
|
+
event_type AS step
|
|
334
|
+
FROM events
|
|
335
|
+
WHERE event_date = today()
|
|
336
|
+
)
|
|
337
|
+
GROUP BY session_id;
|
|
338
|
+
```
|
|
339
|
+
|
|
340
|
+
### Cohort Analysis
|
|
341
|
+
|
|
342
|
+
```sql
|
|
343
|
+
-- User cohorts by signup month
|
|
344
|
+
SELECT
|
|
345
|
+
toStartOfMonth(signup_date) AS cohort,
|
|
346
|
+
toStartOfMonth(activity_date) AS month,
|
|
347
|
+
dateDiff('month', cohort, month) AS months_since_signup,
|
|
348
|
+
count(DISTINCT user_id) AS active_users
|
|
349
|
+
FROM (
|
|
350
|
+
SELECT
|
|
351
|
+
user_id,
|
|
352
|
+
min(toDate(timestamp)) OVER (PARTITION BY user_id) AS signup_date,
|
|
353
|
+
toDate(timestamp) AS activity_date
|
|
354
|
+
FROM events
|
|
355
|
+
)
|
|
356
|
+
GROUP BY cohort, month, months_since_signup
|
|
357
|
+
ORDER BY cohort, months_since_signup;
|
|
358
|
+
```
|
|
359
|
+
|
|
360
|
+
## Data Pipeline Patterns
|
|
361
|
+
|
|
362
|
+
### ETL Pattern
|
|
363
|
+
|
|
364
|
+
```typescript
|
|
365
|
+
// Extract, Transform, Load
|
|
366
|
+
async function etlPipeline() {
|
|
367
|
+
// 1. Extract from source
|
|
368
|
+
const rawData = await extractFromPostgres()
|
|
369
|
+
|
|
370
|
+
// 2. Transform
|
|
371
|
+
const transformed = rawData.map(row => ({
|
|
372
|
+
date: new Date(row.created_at).toISOString().split('T')[0],
|
|
373
|
+
market_id: row.market_slug,
|
|
374
|
+
volume: parseFloat(row.total_volume),
|
|
375
|
+
trades: parseInt(row.trade_count)
|
|
376
|
+
}))
|
|
377
|
+
|
|
378
|
+
// 3. Load to ClickHouse
|
|
379
|
+
await bulkInsertToClickHouse(transformed)
|
|
380
|
+
}
|
|
381
|
+
|
|
382
|
+
// Run periodically
|
|
383
|
+
setInterval(etlPipeline, 60 * 60 * 1000) // Every hour
|
|
384
|
+
```
|
|
385
|
+
|
|
386
|
+
### Change Data Capture (CDC)
|
|
387
|
+
|
|
388
|
+
```typescript
|
|
389
|
+
// Listen to PostgreSQL changes and sync to ClickHouse
|
|
390
|
+
import { Client } from 'pg'
|
|
391
|
+
|
|
392
|
+
const pgClient = new Client({ connectionString: process.env.DATABASE_URL })
|
|
393
|
+
|
|
394
|
+
pgClient.query('LISTEN market_updates')
|
|
395
|
+
|
|
396
|
+
pgClient.on('notification', async (msg) => {
|
|
397
|
+
const update = JSON.parse(msg.payload)
|
|
398
|
+
|
|
399
|
+
await clickhouse.insert('market_updates', [
|
|
400
|
+
{
|
|
401
|
+
market_id: update.id,
|
|
402
|
+
event_type: update.operation, // INSERT, UPDATE, DELETE
|
|
403
|
+
timestamp: new Date(),
|
|
404
|
+
data: JSON.stringify(update.new_data)
|
|
405
|
+
}
|
|
406
|
+
])
|
|
407
|
+
})
|
|
408
|
+
```
|
|
409
|
+
|
|
410
|
+
## Best Practices
|
|
411
|
+
|
|
412
|
+
### 1. Partitioning Strategy
|
|
413
|
+
- Partition by time (usually month or day)
|
|
414
|
+
- Avoid too many partitions (performance impact)
|
|
415
|
+
- Use DATE type for partition key
|
|
416
|
+
|
|
417
|
+
### 2. Ordering Key
|
|
418
|
+
- Put most frequently filtered columns first
|
|
419
|
+
- Consider cardinality (high cardinality first)
|
|
420
|
+
- Order impacts compression
|
|
421
|
+
|
|
422
|
+
### 3. Data Types
|
|
423
|
+
- Use smallest appropriate type (UInt32 vs UInt64)
|
|
424
|
+
- Use LowCardinality for repeated strings
|
|
425
|
+
- Use Enum for categorical data
|
|
426
|
+
|
|
427
|
+
### 4. Avoid
|
|
428
|
+
- SELECT * (specify columns)
|
|
429
|
+
- FINAL (merge data before query instead)
|
|
430
|
+
- Too many JOINs (denormalize for analytics)
|
|
431
|
+
- Small frequent inserts (batch instead)
|
|
432
|
+
|
|
433
|
+
### 5. Monitoring
|
|
434
|
+
- Track query performance
|
|
435
|
+
- Monitor disk usage
|
|
436
|
+
- Check merge operations
|
|
437
|
+
- Review slow query log
|
|
438
|
+
|
|
439
|
+
**Remember**: ClickHouse excels at analytical workloads. Design tables for your query patterns, batch inserts, and leverage materialized views for real-time aggregations.
|
|
@@ -0,0 +1,233 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: codebase-onboarding
|
|
3
|
+
description: Analyze an unfamiliar codebase and generate a structured onboarding guide with architecture map, key entry points, conventions, and a starter CLAUDE.md. Use when joining a new project or setting up Claude Code for the first time in a repo.
|
|
4
|
+
origin: ECC
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Codebase Onboarding
|
|
8
|
+
|
|
9
|
+
Systematically analyze an unfamiliar codebase and produce a structured onboarding guide. Designed for developers joining a new project or setting up Claude Code in an existing repo for the first time.
|
|
10
|
+
|
|
11
|
+
## When to Use
|
|
12
|
+
|
|
13
|
+
- First time opening a project with Claude Code
|
|
14
|
+
- Joining a new team or repository
|
|
15
|
+
- User asks "help me understand this codebase"
|
|
16
|
+
- User asks to generate a CLAUDE.md for a project
|
|
17
|
+
- User says "onboard me" or "walk me through this repo"
|
|
18
|
+
|
|
19
|
+
## How It Works
|
|
20
|
+
|
|
21
|
+
### Phase 1: Reconnaissance
|
|
22
|
+
|
|
23
|
+
Gather raw signals about the project without reading every file. Run these checks in parallel:
|
|
24
|
+
|
|
25
|
+
```
|
|
26
|
+
1. Package manifest detection
|
|
27
|
+
→ package.json, go.mod, Cargo.toml, pyproject.toml, pom.xml, build.gradle,
|
|
28
|
+
Gemfile, composer.json, mix.exs, pubspec.yaml
|
|
29
|
+
|
|
30
|
+
2. Framework fingerprinting
|
|
31
|
+
→ next.config.*, nuxt.config.*, angular.json, vite.config.*,
|
|
32
|
+
django settings, flask app factory, fastapi main, rails config
|
|
33
|
+
|
|
34
|
+
3. Entry point identification
|
|
35
|
+
→ main.*, index.*, app.*, server.*, cmd/, src/main/
|
|
36
|
+
|
|
37
|
+
4. Directory structure snapshot
|
|
38
|
+
→ Top 2 levels of the directory tree, ignoring node_modules, vendor,
|
|
39
|
+
.git, dist, build, __pycache__, .next
|
|
40
|
+
|
|
41
|
+
5. Config and tooling detection
|
|
42
|
+
→ .eslintrc*, .prettierrc*, tsconfig.json, Makefile, Dockerfile,
|
|
43
|
+
docker-compose*, .github/workflows/, .env.example, CI configs
|
|
44
|
+
|
|
45
|
+
6. Test structure detection
|
|
46
|
+
→ tests/, test/, __tests__/, *_test.go, *.spec.ts, *.test.js,
|
|
47
|
+
pytest.ini, jest.config.*, vitest.config.*
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
### Phase 2: Architecture Mapping
|
|
51
|
+
|
|
52
|
+
From the reconnaissance data, identify:
|
|
53
|
+
|
|
54
|
+
**Tech Stack**
|
|
55
|
+
- Language(s) and version constraints
|
|
56
|
+
- Framework(s) and major libraries
|
|
57
|
+
- Database(s) and ORMs
|
|
58
|
+
- Build tools and bundlers
|
|
59
|
+
- CI/CD platform
|
|
60
|
+
|
|
61
|
+
**Architecture Pattern**
|
|
62
|
+
- Monolith, monorepo, microservices, or serverless
|
|
63
|
+
- Frontend/backend split or full-stack
|
|
64
|
+
- API style: REST, GraphQL, gRPC, tRPC
|
|
65
|
+
|
|
66
|
+
**Key Directories**
|
|
67
|
+
Map the top-level directories to their purpose:
|
|
68
|
+
|
|
69
|
+
<!-- Example for a React project — replace with detected directories -->
|
|
70
|
+
```
|
|
71
|
+
src/components/ → React UI components
|
|
72
|
+
src/api/ → API route handlers
|
|
73
|
+
src/lib/ → Shared utilities
|
|
74
|
+
src/db/ → Database models and migrations
|
|
75
|
+
tests/ → Test suites
|
|
76
|
+
scripts/ → Build and deployment scripts
|
|
77
|
+
```
|
|
78
|
+
|
|
79
|
+
**Data Flow**
|
|
80
|
+
Trace one request from entry to response:
|
|
81
|
+
- Where does a request enter? (router, handler, controller)
|
|
82
|
+
- How is it validated? (middleware, schemas, guards)
|
|
83
|
+
- Where is business logic? (services, models, use cases)
|
|
84
|
+
- How does it reach the database? (ORM, raw queries, repositories)
|
|
85
|
+
|
|
86
|
+
### Phase 3: Convention Detection
|
|
87
|
+
|
|
88
|
+
Identify patterns the codebase already follows:
|
|
89
|
+
|
|
90
|
+
**Naming Conventions**
|
|
91
|
+
- File naming: kebab-case, camelCase, PascalCase, snake_case
|
|
92
|
+
- Component/class naming patterns
|
|
93
|
+
- Test file naming: `*.test.ts`, `*.spec.ts`, `*_test.go`
|
|
94
|
+
|
|
95
|
+
**Code Patterns**
|
|
96
|
+
- Error handling style: try/catch, Result types, error codes
|
|
97
|
+
- Dependency injection or direct imports
|
|
98
|
+
- State management approach
|
|
99
|
+
- Async patterns: callbacks, promises, async/await, channels
|
|
100
|
+
|
|
101
|
+
**Git Conventions**
|
|
102
|
+
- Branch naming from recent branches
|
|
103
|
+
- Commit message style from recent commits
|
|
104
|
+
- PR workflow (squash, merge, rebase)
|
|
105
|
+
- If the repo has no commits yet or only a shallow history (e.g. `git clone --depth 1`), skip this section and note "Git history unavailable or too shallow to detect conventions"
|
|
106
|
+
|
|
107
|
+
### Phase 4: Generate Onboarding Artifacts
|
|
108
|
+
|
|
109
|
+
Produce two outputs:
|
|
110
|
+
|
|
111
|
+
#### Output 1: Onboarding Guide
|
|
112
|
+
|
|
113
|
+
```markdown
|
|
114
|
+
# Onboarding Guide: [Project Name]
|
|
115
|
+
|
|
116
|
+
## Overview
|
|
117
|
+
[2-3 sentences: what this project does and who it serves]
|
|
118
|
+
|
|
119
|
+
## Tech Stack
|
|
120
|
+
<!-- Example for a Next.js project — replace with detected stack -->
|
|
121
|
+
| Layer | Technology | Version |
|
|
122
|
+
|-------|-----------|---------|
|
|
123
|
+
| Language | TypeScript | 5.x |
|
|
124
|
+
| Framework | Next.js | 14.x |
|
|
125
|
+
| Database | PostgreSQL | 16 |
|
|
126
|
+
| ORM | Prisma | 5.x |
|
|
127
|
+
| Testing | Jest + Playwright | - |
|
|
128
|
+
|
|
129
|
+
## Architecture
|
|
130
|
+
[Diagram or description of how components connect]
|
|
131
|
+
|
|
132
|
+
## Key Entry Points
|
|
133
|
+
<!-- Example for a Next.js project — replace with detected paths -->
|
|
134
|
+
- **API routes**: `src/app/api/` — Next.js route handlers
|
|
135
|
+
- **UI pages**: `src/app/(dashboard)/` — authenticated pages
|
|
136
|
+
- **Database**: `prisma/schema.prisma` — data model source of truth
|
|
137
|
+
- **Config**: `next.config.ts` — build and runtime config
|
|
138
|
+
|
|
139
|
+
## Directory Map
|
|
140
|
+
[Top-level directory → purpose mapping]
|
|
141
|
+
|
|
142
|
+
## Request Lifecycle
|
|
143
|
+
[Trace one API request from entry to response]
|
|
144
|
+
|
|
145
|
+
## Conventions
|
|
146
|
+
- [File naming pattern]
|
|
147
|
+
- [Error handling approach]
|
|
148
|
+
- [Testing patterns]
|
|
149
|
+
- [Git workflow]
|
|
150
|
+
|
|
151
|
+
## Common Tasks
|
|
152
|
+
<!-- Example for a Node.js project — replace with detected commands -->
|
|
153
|
+
- **Run dev server**: `npm run dev`
|
|
154
|
+
- **Run tests**: `npm test`
|
|
155
|
+
- **Run linter**: `npm run lint`
|
|
156
|
+
- **Database migrations**: `npx prisma migrate dev`
|
|
157
|
+
- **Build for production**: `npm run build`
|
|
158
|
+
|
|
159
|
+
## Where to Look
|
|
160
|
+
<!-- Example for a Next.js project — replace with detected paths -->
|
|
161
|
+
| I want to... | Look at... |
|
|
162
|
+
|--------------|-----------|
|
|
163
|
+
| Add an API endpoint | `src/app/api/` |
|
|
164
|
+
| Add a UI page | `src/app/(dashboard)/` |
|
|
165
|
+
| Add a database table | `prisma/schema.prisma` |
|
|
166
|
+
| Add a test | `tests/` matching the source path |
|
|
167
|
+
| Change build config | `next.config.ts` |
|
|
168
|
+
```
|
|
169
|
+
|
|
170
|
+
#### Output 2: Starter CLAUDE.md
|
|
171
|
+
|
|
172
|
+
Generate or update a project-specific CLAUDE.md based on detected conventions. If `CLAUDE.md` already exists, read it first and enhance it — preserve existing project-specific instructions and clearly call out what was added or changed.
|
|
173
|
+
|
|
174
|
+
```markdown
|
|
175
|
+
# Project Instructions
|
|
176
|
+
|
|
177
|
+
## Tech Stack
|
|
178
|
+
[Detected stack summary]
|
|
179
|
+
|
|
180
|
+
## Code Style
|
|
181
|
+
- [Detected naming conventions]
|
|
182
|
+
- [Detected patterns to follow]
|
|
183
|
+
|
|
184
|
+
## Testing
|
|
185
|
+
- Run tests: `[detected test command]`
|
|
186
|
+
- Test pattern: [detected test file convention]
|
|
187
|
+
- Coverage: [if configured, the coverage command]
|
|
188
|
+
|
|
189
|
+
## Build & Run
|
|
190
|
+
- Dev: `[detected dev command]`
|
|
191
|
+
- Build: `[detected build command]`
|
|
192
|
+
- Lint: `[detected lint command]`
|
|
193
|
+
|
|
194
|
+
## Project Structure
|
|
195
|
+
[Key directory → purpose map]
|
|
196
|
+
|
|
197
|
+
## Conventions
|
|
198
|
+
- [Commit style if detectable]
|
|
199
|
+
- [PR workflow if detectable]
|
|
200
|
+
- [Error handling patterns]
|
|
201
|
+
```
|
|
202
|
+
|
|
203
|
+
## Best Practices
|
|
204
|
+
|
|
205
|
+
1. **Don't read everything** — reconnaissance should use Glob and Grep, not Read on every file. Read selectively only for ambiguous signals.
|
|
206
|
+
2. **Verify, don't guess** — if a framework is detected from config but the actual code uses something different, trust the code.
|
|
207
|
+
3. **Respect existing CLAUDE.md** — if one already exists, enhance it rather than replacing it. Call out what's new vs existing.
|
|
208
|
+
4. **Stay concise** — the onboarding guide should be scannable in 2 minutes. Details belong in the code, not the guide.
|
|
209
|
+
5. **Flag unknowns** — if a convention can't be confidently detected, say so rather than guessing. "Could not determine test runner" is better than a wrong answer.
|
|
210
|
+
|
|
211
|
+
## Anti-Patterns to Avoid
|
|
212
|
+
|
|
213
|
+
- Generating a CLAUDE.md that's longer than 100 lines — keep it focused
|
|
214
|
+
- Listing every dependency — highlight only the ones that shape how you write code
|
|
215
|
+
- Describing obvious directory names — `src/` doesn't need an explanation
|
|
216
|
+
- Copying the README — the onboarding guide adds structural insight the README lacks
|
|
217
|
+
|
|
218
|
+
## Examples
|
|
219
|
+
|
|
220
|
+
### Example 1: First time in a new repo
|
|
221
|
+
**User**: "Onboard me to this codebase"
|
|
222
|
+
**Action**: Run full 4-phase workflow → produce Onboarding Guide + Starter CLAUDE.md
|
|
223
|
+
**Output**: Onboarding Guide printed directly to the conversation, plus a `CLAUDE.md` written to the project root
|
|
224
|
+
|
|
225
|
+
### Example 2: Generate CLAUDE.md for existing project
|
|
226
|
+
**User**: "Generate a CLAUDE.md for this project"
|
|
227
|
+
**Action**: Run Phases 1-3, skip Onboarding Guide, produce only CLAUDE.md
|
|
228
|
+
**Output**: Project-specific `CLAUDE.md` with detected conventions
|
|
229
|
+
|
|
230
|
+
### Example 3: Enhance existing CLAUDE.md
|
|
231
|
+
**User**: "Update the CLAUDE.md with current project conventions"
|
|
232
|
+
**Action**: Read existing CLAUDE.md, run Phases 1-3, merge new findings
|
|
233
|
+
**Output**: Updated `CLAUDE.md` with additions clearly marked
|