@cloudstreamsoftware/claude-tools 1.0.0 → 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/README.md +152 -37
- package/agents/INDEX.md +183 -0
- package/agents/architect.md +247 -0
- package/agents/build-error-resolver.md +555 -0
- package/agents/catalyst-deployer.md +132 -0
- package/agents/code-reviewer.md +121 -0
- package/agents/compliance-auditor.md +148 -0
- package/agents/creator-architect.md +395 -0
- package/agents/deluge-reviewer.md +98 -0
- package/agents/doc-updater.md +471 -0
- package/agents/e2e-runner.md +711 -0
- package/agents/planner.md +122 -0
- package/agents/refactor-cleaner.md +309 -0
- package/agents/security-reviewer.md +582 -0
- package/agents/tdd-guide.md +302 -0
- package/bin/cloudstream-setup.js +16 -6
- package/config/versions.json +63 -0
- package/dist/hooks/hooks.json +209 -0
- package/dist/index.js +47 -0
- package/dist/lib/asset-value.js +609 -0
- package/dist/lib/client-manager.js +300 -0
- package/dist/lib/command-matcher.js +242 -0
- package/dist/lib/cross-session-patterns.js +754 -0
- package/dist/lib/intent-classifier.js +1075 -0
- package/dist/lib/package-manager.js +374 -0
- package/dist/lib/recommendation-engine.js +597 -0
- package/dist/lib/session-memory.js +489 -0
- package/dist/lib/skill-effectiveness.js +486 -0
- package/dist/lib/skill-matcher.js +595 -0
- package/dist/lib/tutorial-metrics.js +242 -0
- package/dist/lib/tutorial-progress.js +209 -0
- package/dist/lib/tutorial-renderer.js +431 -0
- package/dist/lib/utils.js +380 -0
- package/dist/lib/verify-formatter.js +143 -0
- package/dist/lib/workflow-state.js +249 -0
- package/hooks/hooks.json +209 -0
- package/package.json +5 -1
- package/scripts/aggregate-sessions.js +290 -0
- package/scripts/branch-name-validator.js +291 -0
- package/scripts/build.js +101 -0
- package/scripts/commands/client-switch.js +231 -0
- package/scripts/deprecate-skill.js +610 -0
- package/scripts/diagnose.js +324 -0
- package/scripts/doc-freshness.js +168 -0
- package/scripts/generate-weekly-digest.js +393 -0
- package/scripts/health-check.js +270 -0
- package/scripts/hooks/credential-check.js +101 -0
- package/scripts/hooks/evaluate-session.js +81 -0
- package/scripts/hooks/pre-compact.js +66 -0
- package/scripts/hooks/prompt-analyzer.js +276 -0
- package/scripts/hooks/prompt-router.js +422 -0
- package/scripts/hooks/quality-gate-enforcer.js +371 -0
- package/scripts/hooks/session-end.js +156 -0
- package/scripts/hooks/session-start.js +195 -0
- package/scripts/hooks/skill-injector.js +333 -0
- package/scripts/hooks/suggest-compact.js +58 -0
- package/scripts/lib/asset-value.js +609 -0
- package/scripts/lib/client-manager.js +300 -0
- package/scripts/lib/command-matcher.js +242 -0
- package/scripts/lib/cross-session-patterns.js +754 -0
- package/scripts/lib/intent-classifier.js +1075 -0
- package/scripts/lib/package-manager.js +374 -0
- package/scripts/lib/recommendation-engine.js +597 -0
- package/scripts/lib/session-memory.js +489 -0
- package/scripts/lib/skill-effectiveness.js +486 -0
- package/scripts/lib/skill-matcher.js +595 -0
- package/scripts/lib/tutorial-metrics.js +242 -0
- package/scripts/lib/tutorial-progress.js +209 -0
- package/scripts/lib/tutorial-renderer.js +431 -0
- package/scripts/lib/utils.js +380 -0
- package/scripts/lib/verify-formatter.js +143 -0
- package/scripts/lib/workflow-state.js +249 -0
- package/scripts/onboard.js +363 -0
- package/scripts/quarterly-report.js +692 -0
- package/scripts/setup-package-manager.js +204 -0
- package/scripts/sync-upstream.js +391 -0
- package/scripts/test.js +108 -0
- package/scripts/tutorial-runner.js +351 -0
- package/scripts/validate-all.js +201 -0
- package/scripts/verifiers/agents.js +245 -0
- package/scripts/verifiers/config.js +186 -0
- package/scripts/verifiers/environment.js +123 -0
- package/scripts/verifiers/hooks.js +188 -0
- package/scripts/verifiers/index.js +38 -0
- package/scripts/verifiers/persistence.js +140 -0
- package/scripts/verifiers/plugin.js +215 -0
- package/scripts/verifiers/skills.js +209 -0
- package/scripts/verify-setup.js +164 -0
- package/skills/INDEX.md +157 -0
- package/skills/backend-patterns/SKILL.md +586 -0
- package/skills/backend-patterns/catalyst-patterns.md +128 -0
- package/skills/bigquery-patterns/SKILL.md +27 -0
- package/skills/bigquery-patterns/performance-optimization.md +518 -0
- package/skills/bigquery-patterns/query-patterns.md +372 -0
- package/skills/bigquery-patterns/schema-design.md +78 -0
- package/skills/cloudstream-project-template/SKILL.md +20 -0
- package/skills/cloudstream-project-template/structure.md +65 -0
- package/skills/coding-standards/SKILL.md +524 -0
- package/skills/coding-standards/deluge-standards.md +83 -0
- package/skills/compliance-patterns/SKILL.md +28 -0
- package/skills/compliance-patterns/hipaa/audit-requirements.md +251 -0
- package/skills/compliance-patterns/hipaa/baa-process.md +298 -0
- package/skills/compliance-patterns/hipaa/data-archival-strategy.md +387 -0
- package/skills/compliance-patterns/hipaa/phi-handling.md +52 -0
- package/skills/compliance-patterns/pci-dss/saq-a-requirements.md +307 -0
- package/skills/compliance-patterns/pci-dss/tokenization-patterns.md +382 -0
- package/skills/compliance-patterns/pci-dss/zoho-checkout-patterns.md +56 -0
- package/skills/compliance-patterns/soc2/access-controls.md +344 -0
- package/skills/compliance-patterns/soc2/audit-logging.md +458 -0
- package/skills/compliance-patterns/soc2/change-management.md +403 -0
- package/skills/compliance-patterns/soc2/deluge-execution-logging.md +407 -0
- package/skills/consultancy-workflows/SKILL.md +19 -0
- package/skills/consultancy-workflows/client-isolation.md +21 -0
- package/skills/consultancy-workflows/documentation-automation.md +454 -0
- package/skills/consultancy-workflows/handoff-procedures.md +257 -0
- package/skills/consultancy-workflows/knowledge-capture.md +513 -0
- package/skills/consultancy-workflows/time-tracking.md +26 -0
- package/skills/continuous-learning/SKILL.md +84 -0
- package/skills/continuous-learning/config.json +18 -0
- package/skills/continuous-learning/evaluate-session.sh +60 -0
- package/skills/continuous-learning-v2/SKILL.md +126 -0
- package/skills/continuous-learning-v2/config.json +61 -0
- package/skills/frontend-patterns/SKILL.md +635 -0
- package/skills/frontend-patterns/zoho-widget-patterns.md +103 -0
- package/skills/gcp-data-engineering/SKILL.md +36 -0
- package/skills/gcp-data-engineering/bigquery/performance-optimization.md +337 -0
- package/skills/gcp-data-engineering/dataflow/error-handling.md +496 -0
- package/skills/gcp-data-engineering/dataflow/pipeline-patterns.md +444 -0
- package/skills/gcp-data-engineering/dbt/model-organization.md +63 -0
- package/skills/gcp-data-engineering/dbt/testing-patterns.md +503 -0
- package/skills/gcp-data-engineering/medallion-architecture/bronze-layer.md +60 -0
- package/skills/gcp-data-engineering/medallion-architecture/gold-layer.md +311 -0
- package/skills/gcp-data-engineering/medallion-architecture/layer-transitions.md +517 -0
- package/skills/gcp-data-engineering/medallion-architecture/silver-layer.md +305 -0
- package/skills/gcp-data-engineering/zoho-to-gcp/data-extraction.md +543 -0
- package/skills/gcp-data-engineering/zoho-to-gcp/real-time-vs-batch.md +337 -0
- package/skills/security-review/SKILL.md +498 -0
- package/skills/security-review/compliance-checklist.md +53 -0
- package/skills/strategic-compact/SKILL.md +67 -0
- package/skills/tdd-workflow/SKILL.md +413 -0
- package/skills/tdd-workflow/zoho-testing.md +124 -0
- package/skills/tutorial/SKILL.md +249 -0
- package/skills/tutorial/docs/ACCESSIBILITY.md +169 -0
- package/skills/tutorial/lessons/00-philosophy-and-workflow.md +198 -0
- package/skills/tutorial/lessons/01-basics.md +81 -0
- package/skills/tutorial/lessons/02-training.md +86 -0
- package/skills/tutorial/lessons/03-commands.md +109 -0
- package/skills/tutorial/lessons/04-workflows.md +115 -0
- package/skills/tutorial/lessons/05-compliance.md +116 -0
- package/skills/tutorial/lessons/06-zoho.md +121 -0
- package/skills/tutorial/lessons/07-hooks-system.md +277 -0
- package/skills/tutorial/lessons/08-mcp-servers.md +316 -0
- package/skills/tutorial/lessons/09-client-management.md +215 -0
- package/skills/tutorial/lessons/10-testing-e2e.md +260 -0
- package/skills/tutorial/lessons/11-skills-deep-dive.md +272 -0
- package/skills/tutorial/lessons/12-rules-system.md +326 -0
- package/skills/tutorial/lessons/13-golden-standard-graduation.md +213 -0
- package/skills/tutorial/lessons/14-fork-setup-and-sync.md +312 -0
- package/skills/tutorial/lessons/15-living-examples-system.md +221 -0
- package/skills/tutorial/tracks/accelerated/README.md +134 -0
- package/skills/tutorial/tracks/accelerated/assessment/checkpoint-1.md +161 -0
- package/skills/tutorial/tracks/accelerated/assessment/checkpoint-2.md +175 -0
- package/skills/tutorial/tracks/accelerated/day-1-core-concepts.md +234 -0
- package/skills/tutorial/tracks/accelerated/day-2-essential-commands.md +270 -0
- package/skills/tutorial/tracks/accelerated/day-3-workflow-mastery.md +305 -0
- package/skills/tutorial/tracks/accelerated/day-4-compliance-zoho.md +304 -0
- package/skills/tutorial/tracks/accelerated/day-5-hooks-skills.md +344 -0
- package/skills/tutorial/tracks/accelerated/day-6-client-testing.md +386 -0
- package/skills/tutorial/tracks/accelerated/day-7-graduation.md +369 -0
- package/skills/zoho-patterns/CHANGELOG.md +108 -0
- package/skills/zoho-patterns/SKILL.md +446 -0
- package/skills/zoho-patterns/analytics/dashboard-patterns.md +352 -0
- package/skills/zoho-patterns/analytics/zoho-to-bigquery-pipeline.md +427 -0
- package/skills/zoho-patterns/catalyst/appsail-deployment.md +349 -0
- package/skills/zoho-patterns/catalyst/context-close-patterns.md +354 -0
- package/skills/zoho-patterns/catalyst/cron-batch-processing.md +374 -0
- package/skills/zoho-patterns/catalyst/function-patterns.md +439 -0
- package/skills/zoho-patterns/creator/form-design.md +304 -0
- package/skills/zoho-patterns/creator/publish-api-patterns.md +313 -0
- package/skills/zoho-patterns/creator/widget-integration.md +306 -0
- package/skills/zoho-patterns/creator/workflow-automation.md +253 -0
- package/skills/zoho-patterns/deluge/api-patterns.md +468 -0
- package/skills/zoho-patterns/deluge/batch-processing.md +403 -0
- package/skills/zoho-patterns/deluge/cross-app-integration.md +356 -0
- package/skills/zoho-patterns/deluge/error-handling.md +423 -0
- package/skills/zoho-patterns/deluge/syntax-reference.md +65 -0
- package/skills/zoho-patterns/integration/cors-proxy-architecture.md +426 -0
- package/skills/zoho-patterns/integration/crm-books-native-sync.md +277 -0
- package/skills/zoho-patterns/integration/oauth-token-management.md +461 -0
- package/skills/zoho-patterns/integration/zoho-flow-patterns.md +334 -0
|
@@ -0,0 +1,213 @@
|
|
|
1
|
+
# Lesson 13: Golden Standard Graduation
|
|
2
|
+
|
|
3
|
+
You've learned the system. Now understand the quality bar that defines CloudStream Software.
|
|
4
|
+
|
|
5
|
+
## The Golden Standard Defined
|
|
6
|
+
|
|
7
|
+
All work produced must meet **top 1% enterprise professional quality** - the standard expected from a 500-person professional development team at a Fortune 500 company.
|
|
8
|
+
|
|
9
|
+
This is not aspirational. This is the baseline.
|
|
10
|
+
|
|
11
|
+
## The Quality Bar
|
|
12
|
+
|
|
13
|
+
| Aspect | Requirement |
|
|
14
|
+
|--------|-------------|
|
|
15
|
+
| **Code Quality** | Production-ready, bulletproof, auditable |
|
|
16
|
+
| **Test Coverage** | 80%+ minimum, TDD workflow mandatory |
|
|
17
|
+
| **Security** | OWASP Top 10 awareness, security review on all changes |
|
|
18
|
+
| **Documentation** | Handoff-ready at all times |
|
|
19
|
+
| **Compliance** | HIPAA/SOC2/PCI-DSS aware based on client context |
|
|
20
|
+
| **Performance** | Optimized, profiled, no unnecessary operations |
|
|
21
|
+
| **Accessibility** | WCAG 2.1 AA compliance for all user-facing work |
|
|
22
|
+
|
|
23
|
+
## What "Top 1%" Means
|
|
24
|
+
|
|
25
|
+
1. **Zero assumptions** - Verify everything, research when uncertain
|
|
26
|
+
2. **Defensive coding** - Handle edge cases, validate inputs at boundaries
|
|
27
|
+
3. **Audit trail** - Every action explainable and traceable
|
|
28
|
+
4. **Cutting-edge awareness** - Use modern best practices, not legacy patterns
|
|
29
|
+
5. **Peer-review quality** - Code must pass scrutiny from expert reviewers
|
|
30
|
+
6. **No shortcuts** - Technical debt is not acceptable
|
|
31
|
+
7. **Complete solutions** - Half-measures are failures
|
|
32
|
+
|
|
33
|
+
## Verification Checklist
|
|
34
|
+
|
|
35
|
+
Before ANY work is marked complete:
|
|
36
|
+
|
|
37
|
+
- [ ] Would this pass review at Google/Microsoft/Amazon?
|
|
38
|
+
- [ ] Is this handoff-ready if I'm unavailable tomorrow?
|
|
39
|
+
- [ ] Are there any shortcuts or technical debt?
|
|
40
|
+
- [ ] Have all edge cases been considered?
|
|
41
|
+
- [ ] Is the security posture defensible?
|
|
42
|
+
- [ ] Are tests comprehensive (not just happy path)?
|
|
43
|
+
- [ ] Is documentation current and accurate?
|
|
44
|
+
|
|
45
|
+
## Anti-Patterns (Never Acceptable)
|
|
46
|
+
|
|
47
|
+
- "It works" without tests
|
|
48
|
+
- "We can fix it later" technical debt
|
|
49
|
+
- Assumptions about requirements
|
|
50
|
+
- Skipping security review
|
|
51
|
+
- Incomplete error handling
|
|
52
|
+
- Missing edge case coverage
|
|
53
|
+
- Copy-paste without understanding
|
|
54
|
+
- "Good enough" mentality
|
|
55
|
+
|
|
56
|
+
## Tutorial Graduation Checklist
|
|
57
|
+
|
|
58
|
+
You are ready to use CloudStream Claude Tools at Golden Standard quality if you can:
|
|
59
|
+
|
|
60
|
+
### Philosophy & Workflow (Lesson 0)
|
|
61
|
+
- [ ] Explain the daily workflow lifecycle
|
|
62
|
+
- [ ] Describe the "aha moment" about knowledge compounding
|
|
63
|
+
- [ ] Understand how training mode teaches while you work
|
|
64
|
+
|
|
65
|
+
### Core Architecture (Lesson 1)
|
|
66
|
+
- [ ] Explain Commands → Agents → Rules → Skills
|
|
67
|
+
- [ ] Run `/verify` confidently
|
|
68
|
+
|
|
69
|
+
### Training Mode (Lesson 2)
|
|
70
|
+
- [ ] Enable training mode in CLAUDE.md
|
|
71
|
+
- [ ] Recognize intent detection suggestions
|
|
72
|
+
- [ ] Understand verbosity levels
|
|
73
|
+
|
|
74
|
+
### Essential Commands (Lessons 3-4)
|
|
75
|
+
- [ ] Run `/plan` for complex features
|
|
76
|
+
- [ ] Execute `/tdd` workflow (RED → GREEN → REFACTOR)
|
|
77
|
+
- [ ] Use `/code-review` before PRs
|
|
78
|
+
- [ ] Create `/checkpoint` before risky changes
|
|
79
|
+
- [ ] Apply correct workflow for task type
|
|
80
|
+
|
|
81
|
+
### Compliance (Lesson 5)
|
|
82
|
+
- [ ] Set compliance mode in CLAUDE.md
|
|
83
|
+
- [ ] Run `/compliance-check` for regulated industries
|
|
84
|
+
- [ ] Understand HIPAA/SOC2/PCI-DSS differences
|
|
85
|
+
|
|
86
|
+
### Zoho Development (Lesson 6)
|
|
87
|
+
- [ ] Use `/zoho-scaffold` for components
|
|
88
|
+
- [ ] Generate Deluge code with `/deluge`
|
|
89
|
+
- [ ] Understand platform constraints
|
|
90
|
+
|
|
91
|
+
### Hooks System (Lesson 7)
|
|
92
|
+
- [ ] Understand 6 hook lifecycle events
|
|
93
|
+
- [ ] Know which hooks block vs. warn
|
|
94
|
+
- [ ] Find and read hooks.json
|
|
95
|
+
|
|
96
|
+
### MCP Servers (Lesson 8)
|
|
97
|
+
- [ ] Verify 3 core MCPs are configured
|
|
98
|
+
- [ ] Understand 3 MCP tiers (core, per-client, optional)
|
|
99
|
+
- [ ] Know when to add client-specific MCPs
|
|
100
|
+
|
|
101
|
+
### Client Management (Lesson 9)
|
|
102
|
+
- [ ] Use `/client-switch` for multi-client work
|
|
103
|
+
- [ ] Generate `/handoff` documentation
|
|
104
|
+
|
|
105
|
+
### Testing & E2E (Lesson 10)
|
|
106
|
+
- [ ] Run `/e2e` tests
|
|
107
|
+
- [ ] Use `/build-fix` for TypeScript errors
|
|
108
|
+
- [ ] Invoke security-reviewer agent proactively
|
|
109
|
+
|
|
110
|
+
### Skills (Lesson 11)
|
|
111
|
+
- [ ] List all 16 skills
|
|
112
|
+
- [ ] Understand skill-agent relationships
|
|
113
|
+
- [ ] Explore skill subdirectories
|
|
114
|
+
|
|
115
|
+
### Rules (Lesson 12)
|
|
116
|
+
- [ ] Know rule loading priority
|
|
117
|
+
- [ ] Understand always vs. conditional rules
|
|
118
|
+
- [ ] Read and apply golden-standard.md
|
|
119
|
+
|
|
120
|
+
## Your Daily Workflow
|
|
121
|
+
|
|
122
|
+
```
|
|
123
|
+
SESSION START:
|
|
124
|
+
- Context automatically restored
|
|
125
|
+
- Check client/compliance mode
|
|
126
|
+
|
|
127
|
+
WORKING:
|
|
128
|
+
/client-switch <client> # Set context if needed
|
|
129
|
+
/plan <feature> # Complex work: plan first
|
|
130
|
+
/tdd <component> # Code: tests first
|
|
131
|
+
/code-review # Quality: review changes
|
|
132
|
+
/verify # Validate: before commit
|
|
133
|
+
|
|
134
|
+
SESSION END:
|
|
135
|
+
/learn # Capture patterns (optional)
|
|
136
|
+
- State automatically saved
|
|
137
|
+
```
|
|
138
|
+
|
|
139
|
+
## Quick Reference Card
|
|
140
|
+
|
|
141
|
+
```
|
|
142
|
+
ESSENTIAL COMMANDS:
|
|
143
|
+
/verify - Validate project (before every commit)
|
|
144
|
+
/plan - Design implementation
|
|
145
|
+
/tdd - Test-driven development
|
|
146
|
+
/code-review - Quality check
|
|
147
|
+
/checkpoint - Create safe restore point
|
|
148
|
+
/audit - System health check
|
|
149
|
+
|
|
150
|
+
ZOHO COMMANDS:
|
|
151
|
+
/zoho-scaffold - Create components
|
|
152
|
+
/deluge - Generate Deluge code
|
|
153
|
+
/compliance-check - Compliance audit
|
|
154
|
+
|
|
155
|
+
ADVANCED COMMANDS:
|
|
156
|
+
/client-switch - Switch client context
|
|
157
|
+
/handoff - Generate handoff docs
|
|
158
|
+
/e2e - End-to-end tests
|
|
159
|
+
/build-fix - Fix build errors
|
|
160
|
+
/learn - Capture patterns
|
|
161
|
+
|
|
162
|
+
SYSTEM:
|
|
163
|
+
Hooks: PreToolUse, PostToolUse, Stop, SessionStart, SessionEnd, PreCompact
|
|
164
|
+
MCPs: memory, sequential-thinking, context7 (+ 9 optional)
|
|
165
|
+
Skills: 16 across 5 categories
|
|
166
|
+
Rules: 15 files (golden-standard is primary)
|
|
167
|
+
```
|
|
168
|
+
|
|
169
|
+
## Final Exercise
|
|
170
|
+
|
|
171
|
+
Run a complete self-audit:
|
|
172
|
+
|
|
173
|
+
```
|
|
174
|
+
/audit
|
|
175
|
+
```
|
|
176
|
+
|
|
177
|
+
**Expected output:**
|
|
178
|
+
- Configuration: OK
|
|
179
|
+
- Memory MCP: OK
|
|
180
|
+
- Features: All loaded
|
|
181
|
+
- Quality: Tests passing
|
|
182
|
+
- Golden Standard: Aligned
|
|
183
|
+
|
|
184
|
+
If any section fails, review the relevant lesson.
|
|
185
|
+
|
|
186
|
+
## Congratulations!
|
|
187
|
+
|
|
188
|
+
You have completed the core curriculum of the CloudStream Claude Tools tutorial.
|
|
189
|
+
|
|
190
|
+
You now understand:
|
|
191
|
+
- **The philosophy** behind guided workflows
|
|
192
|
+
- **The architecture** of commands, agents, rules, and skills
|
|
193
|
+
- **All 36 commands** and their purposes
|
|
194
|
+
- **All 13 agents** and when they activate
|
|
195
|
+
- **The Hooks system** for automation
|
|
196
|
+
- **27 MCP tools** for extended capabilities
|
|
197
|
+
- **16 skills** for domain expertise
|
|
198
|
+
- **15 rules** for behavioral constraints
|
|
199
|
+
- **The Golden Standard** quality bar
|
|
200
|
+
|
|
201
|
+
**You are now equipped to produce work at the top 1% enterprise professional quality level.**
|
|
202
|
+
|
|
203
|
+
## What's Next?
|
|
204
|
+
|
|
205
|
+
**Lesson 14** covers Fork Setup & Sync - how to keep your copy of CloudStream Claude Tools updated with the latest features.
|
|
206
|
+
|
|
207
|
+
**Lesson 15** covers the Living Examples System - community-curated code examples with validation and trust levels.
|
|
208
|
+
|
|
209
|
+
---
|
|
210
|
+
|
|
211
|
+
**Tutorial milestone**: Core curriculum complete (13/16 lessons)
|
|
212
|
+
**Quality bar**: Golden Standard - top 1% enterprise professional quality
|
|
213
|
+
**Key insight**: The system enforces quality automatically through rules, hooks, and guided workflows
|
|
@@ -0,0 +1,312 @@
|
|
|
1
|
+
# Lesson 14: Fork Setup & Staying Updated
|
|
2
|
+
|
|
3
|
+
You've forked CloudStream Claude Tools. Now learn how to stay updated with new features while preserving your customizations.
|
|
4
|
+
|
|
5
|
+
## Concept
|
|
6
|
+
|
|
7
|
+
When you fork this repository, you have two goals:
|
|
8
|
+
1. **Configure** the fork for your organization
|
|
9
|
+
2. **Stay updated** when upstream releases new features
|
|
10
|
+
|
|
11
|
+
The system is designed for this:
|
|
12
|
+
- Core directories (agents/, commands/, skills/, rules/) can be synced safely
|
|
13
|
+
- Your customizations (.env, personal/, private/) are protected
|
|
14
|
+
|
|
15
|
+
## Initial Fork Setup
|
|
16
|
+
|
|
17
|
+
### Step 1: Fork the Repository
|
|
18
|
+
|
|
19
|
+
On GitHub:
|
|
20
|
+
1. Navigate to the upstream repository
|
|
21
|
+
2. Click "Fork"
|
|
22
|
+
3. Clone your fork locally
|
|
23
|
+
|
|
24
|
+
```bash
|
|
25
|
+
git clone https://github.com/YOUR-ORG/everything-claude-code.git
|
|
26
|
+
cd everything-claude-code
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
### Step 2: Add Upstream Remote
|
|
30
|
+
|
|
31
|
+
```bash
|
|
32
|
+
git remote add upstream https://github.com/affaan-m/everything-claude-code.git
|
|
33
|
+
git fetch upstream
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
Verify remotes:
|
|
37
|
+
```bash
|
|
38
|
+
git remote -v
|
|
39
|
+
# origin https://github.com/YOUR-ORG/everything-claude-code.git (fetch)
|
|
40
|
+
# origin https://github.com/YOUR-ORG/everything-claude-code.git (push)
|
|
41
|
+
# upstream https://github.com/affaan-m/everything-claude-code.git (fetch)
|
|
42
|
+
# upstream https://github.com/affaan-m/everything-claude-code.git (push)
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
### Step 3: Initial Configuration
|
|
46
|
+
|
|
47
|
+
1. **Set up credentials**: Copy `.env.example` to `.env` and fill in your values
|
|
48
|
+
2. **Configure MCPs**: Update `.mcp.json` with your paths
|
|
49
|
+
3. **Set project settings**: Customize CLAUDE.md for your organization
|
|
50
|
+
|
|
51
|
+
## What Syncs vs. What's Protected
|
|
52
|
+
|
|
53
|
+
| Directory | Sync? | Reason |
|
|
54
|
+
|-----------|-------|--------|
|
|
55
|
+
| `agents/` | YES | Core agent definitions |
|
|
56
|
+
| `commands/` | YES | Command definitions |
|
|
57
|
+
| `skills/` | YES | Knowledge patterns |
|
|
58
|
+
| `rules/` | YES | Behavioral constraints |
|
|
59
|
+
| `mcp-configs/` | YES | MCP server catalog |
|
|
60
|
+
| `scripts/` | YES | Tooling scripts |
|
|
61
|
+
| `tests/` | CAUTION | May have custom tests |
|
|
62
|
+
| `hooks/` | CAUTION | May have customizations |
|
|
63
|
+
| `.env*` | NEVER | Your credentials |
|
|
64
|
+
| `personal/` | NEVER | Your custom additions |
|
|
65
|
+
| `private/` | NEVER | Your secrets |
|
|
66
|
+
| `CLAUDE.md` | CAUTION | Your project settings |
|
|
67
|
+
|
|
68
|
+
## Staying Updated
|
|
69
|
+
|
|
70
|
+
### Manual Sync (Recommended)
|
|
71
|
+
|
|
72
|
+
Use these npm commands:
|
|
73
|
+
|
|
74
|
+
```bash
|
|
75
|
+
# See what would change
|
|
76
|
+
npm run sync-check
|
|
77
|
+
|
|
78
|
+
# Test merge without committing
|
|
79
|
+
npm run sync-dry-run
|
|
80
|
+
|
|
81
|
+
# Full sync + tests + commit
|
|
82
|
+
npm run sync-auto
|
|
83
|
+
|
|
84
|
+
# Cancel in-progress merge
|
|
85
|
+
npm run sync-abort
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
### Under the Hood
|
|
89
|
+
|
|
90
|
+
The sync commands run:
|
|
91
|
+
```bash
|
|
92
|
+
git fetch upstream
|
|
93
|
+
git merge -X ours upstream/main -- agents/ commands/ skills/ rules/
|
|
94
|
+
npm test # Validate everything works
|
|
95
|
+
git push origin main # Deploy to your fork
|
|
96
|
+
```
|
|
97
|
+
|
|
98
|
+
The `-X ours` flag means:
|
|
99
|
+
- Accept upstream changes for new files
|
|
100
|
+
- **Keep your version** if there's a conflict
|
|
101
|
+
- Your customizations are preserved
|
|
102
|
+
|
|
103
|
+
### When to Sync
|
|
104
|
+
|
|
105
|
+
| Trigger | Action |
|
|
106
|
+
|---------|--------|
|
|
107
|
+
| Weekly | Run `npm run sync-check` to see changes |
|
|
108
|
+
| New release announced | Run `npm run sync-auto` |
|
|
109
|
+
| Before major project | Ensure latest features |
|
|
110
|
+
|
|
111
|
+
## Breaking Changes
|
|
112
|
+
|
|
113
|
+
Semantic versioning tells you what to expect:
|
|
114
|
+
|
|
115
|
+
| Version Change | Meaning | Action |
|
|
116
|
+
|----------------|---------|--------|
|
|
117
|
+
| 1.x.x → 2.x.x | BREAKING | Manual review required |
|
|
118
|
+
| 1.1.x → 1.2.x | Minor | Safe with tests |
|
|
119
|
+
| 1.1.0 → 1.1.1 | Patch | Safe with tests |
|
|
120
|
+
|
|
121
|
+
The sync script warns you about major version changes.
|
|
122
|
+
|
|
123
|
+
## Customization Guidelines
|
|
124
|
+
|
|
125
|
+
### Safe to Customize
|
|
126
|
+
|
|
127
|
+
These files are yours to modify:
|
|
128
|
+
|
|
129
|
+
| File/Directory | Purpose |
|
|
130
|
+
|----------------|---------|
|
|
131
|
+
| `CLAUDE.md` | Your project settings |
|
|
132
|
+
| `.env` files | Your credentials |
|
|
133
|
+
| `personal/` | Your custom additions |
|
|
134
|
+
| `private/` | Your secrets |
|
|
135
|
+
| `hooks/hooks.json` | Your hook customizations |
|
|
136
|
+
|
|
137
|
+
### Creating Custom Components
|
|
138
|
+
|
|
139
|
+
To add components that won't conflict with upstream:
|
|
140
|
+
|
|
141
|
+
**Custom Agents:**
|
|
142
|
+
```
|
|
143
|
+
personal/agents/your-agent.md
|
|
144
|
+
```
|
|
145
|
+
|
|
146
|
+
**Custom Commands:**
|
|
147
|
+
```
|
|
148
|
+
personal/commands/your-command.md
|
|
149
|
+
```
|
|
150
|
+
|
|
151
|
+
**Custom Skills:**
|
|
152
|
+
```
|
|
153
|
+
personal/skills/your-skill/SKILL.md
|
|
154
|
+
```
|
|
155
|
+
|
|
156
|
+
**Custom Rules:**
|
|
157
|
+
```
|
|
158
|
+
personal/rules/your-rule.md
|
|
159
|
+
```
|
|
160
|
+
|
|
161
|
+
Files in `personal/` are:
|
|
162
|
+
- Never overwritten by sync
|
|
163
|
+
- Not tracked by upstream
|
|
164
|
+
- Your organization's extensions
|
|
165
|
+
|
|
166
|
+
### Don't Customize (Will Be Overwritten)
|
|
167
|
+
|
|
168
|
+
Unless you disable sync, don't modify:
|
|
169
|
+
- Core agent files in `agents/`
|
|
170
|
+
- Core command files in `commands/`
|
|
171
|
+
- Core skill files in `skills/`
|
|
172
|
+
- Core rule files in `rules/`
|
|
173
|
+
|
|
174
|
+
## Conflict Resolution
|
|
175
|
+
|
|
176
|
+
If a sync has conflicts:
|
|
177
|
+
|
|
178
|
+
**Step 1**: See conflicting files:
|
|
179
|
+
```bash
|
|
180
|
+
git status
|
|
181
|
+
```
|
|
182
|
+
|
|
183
|
+
**Step 2**: For each conflict, choose:
|
|
184
|
+
- Keep yours: The `-X ours` flag already does this
|
|
185
|
+
- Take theirs: Manually copy from upstream
|
|
186
|
+
- Merge: Edit the file to combine both
|
|
187
|
+
|
|
188
|
+
**Step 3**: Complete the merge:
|
|
189
|
+
```bash
|
|
190
|
+
git add .
|
|
191
|
+
git commit -m "Merge upstream changes"
|
|
192
|
+
```
|
|
193
|
+
|
|
194
|
+
**Step 4**: Run tests:
|
|
195
|
+
```bash
|
|
196
|
+
npm test
|
|
197
|
+
```
|
|
198
|
+
|
|
199
|
+
## Exercise
|
|
200
|
+
|
|
201
|
+
### Exercise 14.1: Check Upstream Status
|
|
202
|
+
|
|
203
|
+
**Step 1**: Verify you have upstream configured:
|
|
204
|
+
```bash
|
|
205
|
+
git remote -v | grep upstream
|
|
206
|
+
```
|
|
207
|
+
|
|
208
|
+
If not, add it:
|
|
209
|
+
```bash
|
|
210
|
+
git remote add upstream https://github.com/affaan-m/everything-claude-code.git
|
|
211
|
+
```
|
|
212
|
+
|
|
213
|
+
### Exercise 14.2: Preview Changes
|
|
214
|
+
|
|
215
|
+
**Step 1**: Fetch upstream:
|
|
216
|
+
```bash
|
|
217
|
+
git fetch upstream
|
|
218
|
+
```
|
|
219
|
+
|
|
220
|
+
**Step 2**: See what's new:
|
|
221
|
+
```bash
|
|
222
|
+
git log upstream/main --oneline -10
|
|
223
|
+
```
|
|
224
|
+
|
|
225
|
+
**Step 3**: Preview sync:
|
|
226
|
+
```bash
|
|
227
|
+
npm run sync-check
|
|
228
|
+
```
|
|
229
|
+
|
|
230
|
+
### Exercise 14.3: Create a Protected Customization
|
|
231
|
+
|
|
232
|
+
**Step 1**: Create the personal directory:
|
|
233
|
+
```bash
|
|
234
|
+
mkdir -p personal/rules
|
|
235
|
+
```
|
|
236
|
+
|
|
237
|
+
**Step 2**: Add a custom rule:
|
|
238
|
+
```bash
|
|
239
|
+
cat > personal/rules/my-org-rule.md << 'EOF'
|
|
240
|
+
---
|
|
241
|
+
name: my-org-rule
|
|
242
|
+
description: Custom rule for my organization
|
|
243
|
+
always: true
|
|
244
|
+
---
|
|
245
|
+
|
|
246
|
+
# My Organization Rule
|
|
247
|
+
|
|
248
|
+
Custom guidelines for our team.
|
|
249
|
+
EOF
|
|
250
|
+
```
|
|
251
|
+
|
|
252
|
+
**Step 3**: This file is now protected from sync.
|
|
253
|
+
|
|
254
|
+
## Verification
|
|
255
|
+
|
|
256
|
+
You've completed this exercise successfully if:
|
|
257
|
+
- [ ] Upstream remote is configured
|
|
258
|
+
- [ ] You understand sync-safe vs. protected directories
|
|
259
|
+
- [ ] You've run `npm run sync-check` at least once
|
|
260
|
+
- [ ] You know where to put customizations
|
|
261
|
+
|
|
262
|
+
## Sync Quick Reference
|
|
263
|
+
|
|
264
|
+
```
|
|
265
|
+
COMMANDS:
|
|
266
|
+
npm run sync-check # Preview changes
|
|
267
|
+
npm run sync-dry-run # Test merge
|
|
268
|
+
npm run sync-auto # Full sync
|
|
269
|
+
npm run sync-abort # Cancel merge
|
|
270
|
+
|
|
271
|
+
PROTECTED:
|
|
272
|
+
.env*, personal/, private/, CLAUDE.md
|
|
273
|
+
|
|
274
|
+
SYNCED:
|
|
275
|
+
agents/, commands/, skills/, rules/, mcp-configs/
|
|
276
|
+
|
|
277
|
+
REMOTES:
|
|
278
|
+
origin = Your fork
|
|
279
|
+
upstream = Source repository
|
|
280
|
+
```
|
|
281
|
+
|
|
282
|
+
## Tutorial Complete!
|
|
283
|
+
|
|
284
|
+
Congratulations! You have completed all 14 lessons of the CloudStream Claude Tools tutorial.
|
|
285
|
+
|
|
286
|
+
### What You've Learned
|
|
287
|
+
|
|
288
|
+
1. **Philosophy** - Why this system exists and how to approach development
|
|
289
|
+
2. **Architecture** - Commands → Agents → Rules → Skills
|
|
290
|
+
3. **Training Mode** - How the system teaches while you work
|
|
291
|
+
4. **Essential Commands** - verify, plan, tdd, code-review, checkpoint
|
|
292
|
+
5. **Workflows** - plan → tdd → review → verify
|
|
293
|
+
6. **Compliance** - HIPAA, SOC2, PCI-DSS modes
|
|
294
|
+
7. **Zoho Development** - Creator, Catalyst, Deluge
|
|
295
|
+
8. **Hooks** - Automated quality checks
|
|
296
|
+
9. **MCPs** - External capabilities
|
|
297
|
+
10. **Client Management** - Multi-client context
|
|
298
|
+
11. **Testing** - E2E, security review
|
|
299
|
+
12. **Skills** - 16 knowledge packages
|
|
300
|
+
13. **Rules** - 15 behavioral constraints
|
|
301
|
+
14. **Fork Setup** - Staying updated
|
|
302
|
+
15. **Living Examples** - Community-curated examples
|
|
303
|
+
|
|
304
|
+
### Next Steps
|
|
305
|
+
|
|
306
|
+
Continue to [Lesson 15: Living Examples System](./15-living-examples-system.md) to learn about the community-curated example system.
|
|
307
|
+
|
|
308
|
+
---
|
|
309
|
+
|
|
310
|
+
**Progress**: 14 of 16 lessons complete
|
|
311
|
+
**Next**: Living Examples System
|
|
312
|
+
**Remember**: The system teaches while you work - let it guide you
|