@cloudstreamsoftware/claude-tools 1.0.0 → 1.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/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/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,249 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: tutorial
|
|
3
|
+
description: Interactive tutorial that guides users through the CloudStream Claude Tools system with hands-on exercises and progressive learning.
|
|
4
|
+
version: 1.0.0
|
|
5
|
+
status: active
|
|
6
|
+
introduced: 1.0.0
|
|
7
|
+
lastUpdated: 2026-01-25
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
# Interactive Tutorial Skill
|
|
11
|
+
|
|
12
|
+
This skill provides a guided, interactive learning experience for the CloudStream Claude Tools system.
|
|
13
|
+
|
|
14
|
+
## When to Activate
|
|
15
|
+
|
|
16
|
+
- User types `/tutorial` to start the tutorial
|
|
17
|
+
- User asks "how do I learn this system" or similar questions
|
|
18
|
+
- New users who need onboarding to the plugin architecture
|
|
19
|
+
|
|
20
|
+
## Track Selection
|
|
21
|
+
|
|
22
|
+
The tutorial offers two learning tracks:
|
|
23
|
+
|
|
24
|
+
### Standard Track (14 days, 15 lessons)
|
|
25
|
+
- Comprehensive onboarding for all skill levels
|
|
26
|
+
- 1-2 lessons per day
|
|
27
|
+
- Detailed exercises with verification
|
|
28
|
+
- No prerequisites required
|
|
29
|
+
|
|
30
|
+
```
|
|
31
|
+
/tutorial
|
|
32
|
+
/tutorial 3 # Jump to lesson 3
|
|
33
|
+
/tutorial status # Check progress
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
### Accelerated Track (7 days, 7 lessons)
|
|
37
|
+
- Intensive track for experienced developers (2+ years)
|
|
38
|
+
- 2-3 lessons per day (condensed from standard)
|
|
39
|
+
- Two required checkpoints (80% passing)
|
|
40
|
+
- Prerequisites: TypeScript, TDD familiarity
|
|
41
|
+
|
|
42
|
+
```
|
|
43
|
+
/tutorial accelerated
|
|
44
|
+
/tutorial accelerated day-3 # Jump to day 3
|
|
45
|
+
/tutorial checkpoint-1 # Take checkpoint 1
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
### Track Comparison
|
|
49
|
+
|
|
50
|
+
| Aspect | Standard | Accelerated |
|
|
51
|
+
|--------|----------|-------------|
|
|
52
|
+
| Duration | 14 days | 7 days |
|
|
53
|
+
| Lessons | 15 separate | 7 combined |
|
|
54
|
+
| Checkpoints | None | 2 required |
|
|
55
|
+
| Prerequisites | None | 2+ years exp |
|
|
56
|
+
| Recommended for | New developers | Senior developers |
|
|
57
|
+
|
|
58
|
+
### Milestone Tracking
|
|
59
|
+
|
|
60
|
+
Both tracks support milestone tracking:
|
|
61
|
+
|
|
62
|
+
```
|
|
63
|
+
/milestone status # View milestone progress
|
|
64
|
+
/milestone record first-commit # Record milestone
|
|
65
|
+
/milestone report # Generate report
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
Key milestones:
|
|
69
|
+
- First Session Complete
|
|
70
|
+
- First Unassisted Commit (target: 8 hours)
|
|
71
|
+
- First Complete Workflow (target: 16 hours)
|
|
72
|
+
- Tutorial Completion
|
|
73
|
+
- Client-Ready Work (target: 14 days)
|
|
74
|
+
|
|
75
|
+
## Standard Tutorial Structure
|
|
76
|
+
|
|
77
|
+
The standard tutorial consists of 15 progressive lessons (0-14) covering 100% of features:
|
|
78
|
+
|
|
79
|
+
| # | Lesson | Topics Covered |
|
|
80
|
+
|---|--------|----------------|
|
|
81
|
+
| 0 | Philosophy & Workflow | Daily lifecycle, "aha moment", training mode philosophy |
|
|
82
|
+
| 1 | Core Concepts | Mental model, architecture, Golden Standard intro |
|
|
83
|
+
| 2 | Training Mode | Intent detection, workflow suggestions |
|
|
84
|
+
| 3 | Essential Commands | Top 6 commands including /audit |
|
|
85
|
+
| 4 | Workflow Patterns | plan→tdd→review→verify flow |
|
|
86
|
+
| 5 | Compliance | HIPAA, SOC2, PCI-DSS modes |
|
|
87
|
+
| 6 | Zoho Development | Creator, Catalyst, Deluge integration |
|
|
88
|
+
| 7 | Hooks System | 6 lifecycle events, blocking vs. warning hooks |
|
|
89
|
+
| 8 | MCP Servers | All 12 MCPs across 3 tiers |
|
|
90
|
+
| 9 | Client Management | /client-switch, /handoff, isolation |
|
|
91
|
+
| 10 | Testing & E2E | /e2e, /build-fix, /test-coverage, /eval |
|
|
92
|
+
| 11 | Skills Deep Dive | All 16 skills, agent relationships |
|
|
93
|
+
| 12 | Rules System | 11 rules, loading priority, frontmatter |
|
|
94
|
+
| 13 | Golden Standard Graduation | Quality bar, verification checklist |
|
|
95
|
+
| 14 | Fork Setup & Sync | Staying updated, sync tooling |
|
|
96
|
+
|
|
97
|
+
## How to Run
|
|
98
|
+
|
|
99
|
+
### Start from Beginning
|
|
100
|
+
```
|
|
101
|
+
/tutorial
|
|
102
|
+
```
|
|
103
|
+
|
|
104
|
+
### Jump to Specific Lesson
|
|
105
|
+
```
|
|
106
|
+
/tutorial 3
|
|
107
|
+
```
|
|
108
|
+
|
|
109
|
+
### Check Progress
|
|
110
|
+
```
|
|
111
|
+
/tutorial status
|
|
112
|
+
```
|
|
113
|
+
|
|
114
|
+
## Lesson Format
|
|
115
|
+
|
|
116
|
+
Each lesson follows this structure:
|
|
117
|
+
|
|
118
|
+
1. **Concept** (2-3 paragraphs)
|
|
119
|
+
- What is this feature?
|
|
120
|
+
- Why does it matter?
|
|
121
|
+
- How does it fit in the system?
|
|
122
|
+
|
|
123
|
+
2. **Exercise** (hands-on practice)
|
|
124
|
+
- Specific command to run
|
|
125
|
+
- Expected output to observe
|
|
126
|
+
- What to look for
|
|
127
|
+
|
|
128
|
+
3. **Verification** (confirm understanding)
|
|
129
|
+
- Check that the exercise worked
|
|
130
|
+
- Common mistakes to avoid
|
|
131
|
+
|
|
132
|
+
4. **Quiz** (optional knowledge check)
|
|
133
|
+
- Quick question to confirm understanding
|
|
134
|
+
- Immediate feedback
|
|
135
|
+
|
|
136
|
+
## Progress Tracking
|
|
137
|
+
|
|
138
|
+
Tutorial progress is tracked in session memory:
|
|
139
|
+
|
|
140
|
+
```
|
|
141
|
+
Tutorial Progress: [=====> ] 5/14 lessons complete
|
|
142
|
+
Last Completed: Lesson 4 - Workflow Patterns
|
|
143
|
+
Next: Lesson 5 - Compliance
|
|
144
|
+
```
|
|
145
|
+
|
|
146
|
+
## Lesson Flow
|
|
147
|
+
|
|
148
|
+
### Starting a Lesson
|
|
149
|
+
|
|
150
|
+
When user starts a lesson:
|
|
151
|
+
1. Read the lesson file from `lessons/XX-name.md`
|
|
152
|
+
2. Present the Concept section
|
|
153
|
+
3. Wait for user acknowledgment
|
|
154
|
+
4. Present the Exercise with clear instructions
|
|
155
|
+
5. Guide user through verification
|
|
156
|
+
6. Mark lesson complete and offer next lesson
|
|
157
|
+
|
|
158
|
+
### Completing Tutorial
|
|
159
|
+
|
|
160
|
+
After all 14 lessons:
|
|
161
|
+
1. Congratulate user
|
|
162
|
+
2. Provide quick reference card
|
|
163
|
+
3. Suggest next steps (enable training mode on a real project)
|
|
164
|
+
|
|
165
|
+
## Integration Points
|
|
166
|
+
|
|
167
|
+
### With Training Mode
|
|
168
|
+
After lesson 2, user can enable training mode to see workflow suggestions in action.
|
|
169
|
+
|
|
170
|
+
### With Commands
|
|
171
|
+
Lessons involve running actual commands throughout:
|
|
172
|
+
- `/verify`, `/audit` in lessons 1, 3
|
|
173
|
+
- `/plan`, `/tdd`, `/code-review` in lessons 3-4
|
|
174
|
+
- `/compliance-check` in lesson 5
|
|
175
|
+
- `/zoho-scaffold`, `/deluge` in lesson 6
|
|
176
|
+
- `/client-switch`, `/handoff` in lesson 9
|
|
177
|
+
- `/e2e`, `/build-fix`, `/test-coverage` in lesson 10
|
|
178
|
+
|
|
179
|
+
### With Memory
|
|
180
|
+
Progress is persisted to allow resume:
|
|
181
|
+
- Lesson completion status
|
|
182
|
+
- Exercise verification status
|
|
183
|
+
- User preferences (verbosity, pace)
|
|
184
|
+
|
|
185
|
+
## Error Handling
|
|
186
|
+
|
|
187
|
+
### User Skips Exercise
|
|
188
|
+
Allow skipping with note that hands-on practice is recommended.
|
|
189
|
+
|
|
190
|
+
### Exercise Fails
|
|
191
|
+
Provide troubleshooting steps:
|
|
192
|
+
1. Check prerequisites (correct directory, files exist)
|
|
193
|
+
2. Common error messages and fixes
|
|
194
|
+
3. Option to retry or skip
|
|
195
|
+
|
|
196
|
+
### User Wants to Restart
|
|
197
|
+
```
|
|
198
|
+
/tutorial reset
|
|
199
|
+
```
|
|
200
|
+
Clears progress and starts from lesson 1.
|
|
201
|
+
|
|
202
|
+
## Customization
|
|
203
|
+
|
|
204
|
+
### Verbosity Levels
|
|
205
|
+
|
|
206
|
+
**Quick Mode** (for experienced devs):
|
|
207
|
+
- Concept summary only
|
|
208
|
+
- Exercise with minimal guidance
|
|
209
|
+
- Skip verification
|
|
210
|
+
|
|
211
|
+
**Standard Mode** (default):
|
|
212
|
+
- Full concept explanation
|
|
213
|
+
- Step-by-step exercise
|
|
214
|
+
- Verification checks
|
|
215
|
+
|
|
216
|
+
**Detailed Mode** (for thorough learning):
|
|
217
|
+
- Extended explanations
|
|
218
|
+
- Additional examples
|
|
219
|
+
- Related skill references
|
|
220
|
+
|
|
221
|
+
## Success Criteria
|
|
222
|
+
|
|
223
|
+
Tutorial is considered successful when user can:
|
|
224
|
+
1. Explain the daily workflow lifecycle and philosophy
|
|
225
|
+
2. Explain the mental model (commands → agents → rules → skills)
|
|
226
|
+
3. Enable and use training mode
|
|
227
|
+
4. Run the top 6 commands confidently (including /audit)
|
|
228
|
+
5. Execute a complete plan→tdd→review→verify workflow
|
|
229
|
+
6. Set up compliance mode for a project
|
|
230
|
+
7. Scaffold a Zoho component
|
|
231
|
+
8. Understand hooks and when they fire
|
|
232
|
+
9. Configure and use MCP servers
|
|
233
|
+
10. Manage multiple client contexts
|
|
234
|
+
11. Run E2E tests and fix build errors
|
|
235
|
+
12. Navigate and utilize all 16 skills
|
|
236
|
+
13. Apply the Golden Standard quality bar
|
|
237
|
+
14. Keep their fork updated with upstream
|
|
238
|
+
|
|
239
|
+
## Metrics
|
|
240
|
+
|
|
241
|
+
Track tutorial effectiveness:
|
|
242
|
+
- Completion rate per lesson
|
|
243
|
+
- Time spent per lesson
|
|
244
|
+
- Exercise success rate
|
|
245
|
+
- User feedback ratings
|
|
246
|
+
|
|
247
|
+
---
|
|
248
|
+
|
|
249
|
+
**Remember**: The goal is not just to teach features, but to build muscle memory for productive workflows. Hands-on practice is essential.
|
|
@@ -0,0 +1,169 @@
|
|
|
1
|
+
# Accessibility
|
|
2
|
+
|
|
3
|
+
CloudStream Claude Tools Tutorial is designed to be accessible to all users, including those using screen readers, high-contrast displays, or terminal environments that don't support colors.
|
|
4
|
+
|
|
5
|
+
## WCAG 2.1 AA Compliance
|
|
6
|
+
|
|
7
|
+
The tutorial system follows Web Content Accessibility Guidelines (WCAG) 2.1 Level AA where applicable to CLI environments.
|
|
8
|
+
|
|
9
|
+
## Enabling Accessible Mode
|
|
10
|
+
|
|
11
|
+
### Option 1: NO_COLOR Environment Variable (Recommended)
|
|
12
|
+
|
|
13
|
+
Set the standard `NO_COLOR` environment variable:
|
|
14
|
+
|
|
15
|
+
```bash
|
|
16
|
+
# Linux/macOS
|
|
17
|
+
export NO_COLOR=1
|
|
18
|
+
node scripts/tutorial-runner.js status
|
|
19
|
+
|
|
20
|
+
# Windows PowerShell
|
|
21
|
+
$env:NO_COLOR = "1"
|
|
22
|
+
node scripts/tutorial-runner.js status
|
|
23
|
+
|
|
24
|
+
# Windows CMD
|
|
25
|
+
set NO_COLOR=1
|
|
26
|
+
node scripts/tutorial-runner.js status
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
### Option 2: Command Line Flags
|
|
30
|
+
|
|
31
|
+
```bash
|
|
32
|
+
# Use --accessible flag
|
|
33
|
+
node scripts/tutorial-runner.js --accessible status
|
|
34
|
+
|
|
35
|
+
# Or --no-color flag
|
|
36
|
+
node scripts/tutorial-runner.js --no-color status
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
### Option 3: TERM Environment Variable
|
|
40
|
+
|
|
41
|
+
Setting `TERM=dumb` also activates accessible mode:
|
|
42
|
+
|
|
43
|
+
```bash
|
|
44
|
+
TERM=dumb node scripts/tutorial-runner.js status
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
## Accessibility Features
|
|
48
|
+
|
|
49
|
+
### 1. Semantic Indicators
|
|
50
|
+
|
|
51
|
+
The tutorial never relies on color alone to convey information:
|
|
52
|
+
|
|
53
|
+
| Status | Symbol | Text Indicator |
|
|
54
|
+
|--------|--------|----------------|
|
|
55
|
+
| Completed | ✓ | Checkmark visible |
|
|
56
|
+
| Current | → | "YOU ARE HERE" label |
|
|
57
|
+
| Pending | ○ | Circle indicator |
|
|
58
|
+
|
|
59
|
+
### 2. Progress Information
|
|
60
|
+
|
|
61
|
+
Progress is always conveyed through multiple channels:
|
|
62
|
+
|
|
63
|
+
```
|
|
64
|
+
Progress: [████░░░░░░░░░░░░░░░░] 3/9 lessons (33%)
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
- Visual progress bar
|
|
68
|
+
- Numeric count (3/9)
|
|
69
|
+
- Percentage (33%)
|
|
70
|
+
|
|
71
|
+
### 3. High Contrast
|
|
72
|
+
|
|
73
|
+
In standard mode, the tutorial uses high-contrast color combinations:
|
|
74
|
+
|
|
75
|
+
| Element | Color | Contrast Ratio |
|
|
76
|
+
|---------|-------|----------------|
|
|
77
|
+
| Title | Cyan on black | >7:1 |
|
|
78
|
+
| Completed | Green on black | >4.5:1 |
|
|
79
|
+
| Current | Yellow on black | >4.5:1 |
|
|
80
|
+
| Pending | Gray on black | >4.5:1 |
|
|
81
|
+
|
|
82
|
+
### 4. Plain Text Fallbacks
|
|
83
|
+
|
|
84
|
+
In accessible mode, all visual elements degrade to readable plain text:
|
|
85
|
+
|
|
86
|
+
```
|
|
87
|
+
════════════════════════════════════════════════════════
|
|
88
|
+
|
|
89
|
+
EVERYTHING CLAUDE CODE TUTORIAL
|
|
90
|
+
Learn the system in 9 interactive lessons
|
|
91
|
+
|
|
92
|
+
════════════════════════════════════════════════════════
|
|
93
|
+
|
|
94
|
+
Progress: [░░░░░░░░░░░░░░░░░░░░] 0/9 lessons (0%)
|
|
95
|
+
|
|
96
|
+
→ Lesson 1: Core Concepts <- YOU ARE HERE
|
|
97
|
+
○ Lesson 2: Training Mode
|
|
98
|
+
○ Lesson 3: Essential Commands
|
|
99
|
+
...
|
|
100
|
+
```
|
|
101
|
+
|
|
102
|
+
### 5. Error Messages
|
|
103
|
+
|
|
104
|
+
Error messages are clear and descriptive without relying on color:
|
|
105
|
+
|
|
106
|
+
```
|
|
107
|
+
Invalid lesson number: 99. Valid: 1-9
|
|
108
|
+
```
|
|
109
|
+
|
|
110
|
+
## Screen Reader Compatibility
|
|
111
|
+
|
|
112
|
+
The tutorial output is designed to be screen reader friendly:
|
|
113
|
+
|
|
114
|
+
1. **Linear reading order** - Content flows logically from top to bottom
|
|
115
|
+
2. **No hidden content** - All information is in the text stream
|
|
116
|
+
3. **Clear labels** - Elements like "Progress:" and "Lesson 1:" are labeled
|
|
117
|
+
4. **No timing** - No time-limited interactions or animations
|
|
118
|
+
|
|
119
|
+
### Tested Screen Readers
|
|
120
|
+
|
|
121
|
+
- NVDA (Windows)
|
|
122
|
+
- VoiceOver (macOS)
|
|
123
|
+
- JAWS (Windows)
|
|
124
|
+
|
|
125
|
+
## Known Limitations
|
|
126
|
+
|
|
127
|
+
1. **Box-drawing characters** - Unicode box characters (╔, ║, ╚) may not be announced by all screen readers. The content inside is always readable.
|
|
128
|
+
|
|
129
|
+
2. **Progress bar characters** - Block characters (█, ░) may be read as "block" or similar. The numeric percentage is always provided.
|
|
130
|
+
|
|
131
|
+
3. **Terminal limitations** - Some terminal emulators may not support all Unicode characters. The tutorial degrades gracefully.
|
|
132
|
+
|
|
133
|
+
## Reporting Accessibility Issues
|
|
134
|
+
|
|
135
|
+
If you encounter accessibility issues:
|
|
136
|
+
|
|
137
|
+
1. Open an issue on GitHub
|
|
138
|
+
2. Describe your assistive technology (screen reader, terminal, etc.)
|
|
139
|
+
3. Include the specific output or behavior
|
|
140
|
+
4. Suggest improvements if possible
|
|
141
|
+
|
|
142
|
+
## Testing Accessibility
|
|
143
|
+
|
|
144
|
+
Run the accessibility test suite:
|
|
145
|
+
|
|
146
|
+
```bash
|
|
147
|
+
node tests/accessibility.test.js
|
|
148
|
+
```
|
|
149
|
+
|
|
150
|
+
Expected output:
|
|
151
|
+
|
|
152
|
+
```
|
|
153
|
+
=== Accessibility Tests (WCAG 2.1 AA) ===
|
|
154
|
+
|
|
155
|
+
NO_COLOR Environment Variable:
|
|
156
|
+
✓ NO_COLOR=1 produces output without ANSI escape codes
|
|
157
|
+
✓ --accessible flag produces output without ANSI codes
|
|
158
|
+
...
|
|
159
|
+
|
|
160
|
+
=== Accessibility Test Results ===
|
|
161
|
+
Passed: 13
|
|
162
|
+
Failed: 0
|
|
163
|
+
```
|
|
164
|
+
|
|
165
|
+
## References
|
|
166
|
+
|
|
167
|
+
- [NO_COLOR Standard](https://no-color.org/)
|
|
168
|
+
- [WCAG 2.1 Guidelines](https://www.w3.org/WAI/WCAG21/quickref/)
|
|
169
|
+
- [CLI Accessibility Best Practices](https://clig.dev/#accessibility)
|
|
@@ -0,0 +1,198 @@
|
|
|
1
|
+
# Lesson 0: The Philosophy - How to Approach Development
|
|
2
|
+
|
|
3
|
+
Before learning any commands, understand **why** this system exists and **how** to approach development with it.
|
|
4
|
+
|
|
5
|
+
## Why This System Exists
|
|
6
|
+
|
|
7
|
+
CloudStream Software LLC is a consultancy. Every engagement means:
|
|
8
|
+
- **Billable work** that must be traceable
|
|
9
|
+
- **Multiple clients** that require isolation
|
|
10
|
+
- **Regulated industries** (HIPAA, SOC2, PCI-DSS) with compliance requirements
|
|
11
|
+
- **Knowledge that compounds** across projects
|
|
12
|
+
|
|
13
|
+
The "CloudStream Claude Tools" system was built to solve these challenges with a single principle:
|
|
14
|
+
|
|
15
|
+
> **All work must meet top 1% enterprise professional quality - the Golden Standard.**
|
|
16
|
+
|
|
17
|
+
This means code that would pass review at Google, Microsoft, or Amazon. Every commit auditable. Every pattern reusable.
|
|
18
|
+
|
|
19
|
+
## The Daily Workflow Lifecycle
|
|
20
|
+
|
|
21
|
+
Your day with this system follows a predictable pattern:
|
|
22
|
+
|
|
23
|
+
### Session Start (Automatic)
|
|
24
|
+
|
|
25
|
+
When you launch Claude Code, the system automatically:
|
|
26
|
+
- Restores context from your previous session
|
|
27
|
+
- Detects which client you're working on (credentials, compliance mode)
|
|
28
|
+
- Shows tutorial progress if you haven't completed it
|
|
29
|
+
- Loads learned patterns from previous work
|
|
30
|
+
|
|
31
|
+
**You don't start with a blank slate - the system remembers.**
|
|
32
|
+
|
|
33
|
+
### Working on a Feature (The Core Loop)
|
|
34
|
+
|
|
35
|
+
Every feature follows the same four-step sequence:
|
|
36
|
+
|
|
37
|
+
```
|
|
38
|
+
/plan --> /tdd --> /code-review --> /verify
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
| Step | Command | Why It Matters |
|
|
42
|
+
|------|---------|----------------|
|
|
43
|
+
| 1 | `/plan` | Design before coding (prevents scope creep) |
|
|
44
|
+
| 2 | `/tdd` | Tests first (ensures testability) |
|
|
45
|
+
| 3 | `/code-review` | Quality gate (catches issues) |
|
|
46
|
+
| 4 | `/verify` | Final validation (before commit) |
|
|
47
|
+
|
|
48
|
+
This sequence isn't arbitrary - it's battle-tested to prevent the most common development mistakes:
|
|
49
|
+
- Planning prevents "I coded for 2 hours, now we're changing requirements"
|
|
50
|
+
- TDD prevents untestable spaghetti code
|
|
51
|
+
- Code review catches security issues before production
|
|
52
|
+
- Verify ensures no broken builds are committed
|
|
53
|
+
|
|
54
|
+
### Session End (Automatic)
|
|
55
|
+
|
|
56
|
+
When your session ends:
|
|
57
|
+
- Session state is saved automatically
|
|
58
|
+
- Use `/learn` to capture reusable patterns from today's work
|
|
59
|
+
- Your discoveries become available for future projects
|
|
60
|
+
|
|
61
|
+
## The "Aha Moment"
|
|
62
|
+
|
|
63
|
+
The breakthrough understanding that makes this system powerful:
|
|
64
|
+
|
|
65
|
+
**Your work on one client directly accelerates delivery for the next client.**
|
|
66
|
+
|
|
67
|
+
How it works:
|
|
68
|
+
1. You solve a problem for Client A
|
|
69
|
+
2. You run `/learn` to extract the pattern (sanitized - no client-specific data)
|
|
70
|
+
3. That pattern goes into the knowledge base with tags (industry, compliance, technology)
|
|
71
|
+
4. Next quarter, when Client B has a similar problem, the pattern is ready
|
|
72
|
+
|
|
73
|
+
In consulting, this is rare. Most firms rebuild the same solutions repeatedly. This system creates compounding returns on your expertise.
|
|
74
|
+
|
|
75
|
+
## Training Mode: Teaching While You Work
|
|
76
|
+
|
|
77
|
+
This is what makes CloudStream Claude Tools fundamentally different from vanilla Claude Code.
|
|
78
|
+
|
|
79
|
+
| Vanilla Claude | CloudStream Claude Tools |
|
|
80
|
+
|----------------|------------------------|
|
|
81
|
+
| Reactive: you ask, it does | Proactive: it teaches while you work |
|
|
82
|
+
| No guidance on approach | Suggests optimal workflows |
|
|
83
|
+
| Each session starts fresh | Context and knowledge persist |
|
|
84
|
+
| You must know best practices | Best practices are built-in |
|
|
85
|
+
|
|
86
|
+
### How Training Mode Works
|
|
87
|
+
|
|
88
|
+
When you type a request, the system:
|
|
89
|
+
1. **Analyzes your intent** through keyword detection
|
|
90
|
+
- "Add a feature" → feature workflow
|
|
91
|
+
- "Fix this bug" → bug fix workflow
|
|
92
|
+
- "Refactor the code" → refactor workflow
|
|
93
|
+
2. **Suggests the optimal command sequence**
|
|
94
|
+
3. **Explains WHY** this order matters
|
|
95
|
+
4. **Lets you proceed, modify, or skip**
|
|
96
|
+
|
|
97
|
+
Example:
|
|
98
|
+
```
|
|
99
|
+
You: "Add a login feature"
|
|
100
|
+
|
|
101
|
+
[Training Mode] Intent detected: NEW FEATURE + SECURITY-SENSITIVE
|
|
102
|
+
|
|
103
|
+
Suggested workflow:
|
|
104
|
+
/plan "Add login feature"
|
|
105
|
+
/tdd "Login component"
|
|
106
|
+
/code-review (with security focus)
|
|
107
|
+
/verify
|
|
108
|
+
|
|
109
|
+
Rationale: Plan prevents scope creep. TDD ensures testability.
|
|
110
|
+
Security review catches auth vulnerabilities before production.
|
|
111
|
+
|
|
112
|
+
Ready to proceed? (yes/modify/skip)
|
|
113
|
+
```
|
|
114
|
+
|
|
115
|
+
Over time, you internalize these patterns. Training mode makes them muscle memory.
|
|
116
|
+
|
|
117
|
+
## What Makes This Different
|
|
118
|
+
|
|
119
|
+
Think of the difference this way:
|
|
120
|
+
|
|
121
|
+
**Without this system:**
|
|
122
|
+
- You code first, plan later (maybe)
|
|
123
|
+
- Tests are an afterthought
|
|
124
|
+
- Security issues found in production
|
|
125
|
+
- Each project reinvents patterns
|
|
126
|
+
- Knowledge lives in developers' heads
|
|
127
|
+
|
|
128
|
+
**With this system:**
|
|
129
|
+
- Plan → Code → Review → Verify (every time)
|
|
130
|
+
- Tests drive development
|
|
131
|
+
- Security reviewed before merge
|
|
132
|
+
- Patterns extracted and reused
|
|
133
|
+
- Knowledge persists in the system
|
|
134
|
+
|
|
135
|
+
The goal isn't to slow you down - it's to make the right way the easy way.
|
|
136
|
+
|
|
137
|
+
## Exercise
|
|
138
|
+
|
|
139
|
+
### Exercise 0.1: Understand Your Session Context
|
|
140
|
+
|
|
141
|
+
When Claude Code starts, notice what context is restored:
|
|
142
|
+
- Previous session state?
|
|
143
|
+
- Which client/project?
|
|
144
|
+
- Compliance mode?
|
|
145
|
+
- Tutorial progress?
|
|
146
|
+
|
|
147
|
+
**Observation**: The system already knows context you'd normally have to re-establish.
|
|
148
|
+
|
|
149
|
+
### Exercise 0.2: Observe Training Mode
|
|
150
|
+
|
|
151
|
+
Try typing a request and observe the suggestion:
|
|
152
|
+
|
|
153
|
+
```
|
|
154
|
+
Add validation to the user form
|
|
155
|
+
```
|
|
156
|
+
|
|
157
|
+
Notice:
|
|
158
|
+
- Does it suggest a workflow?
|
|
159
|
+
- Does it explain why?
|
|
160
|
+
- Can you modify or skip?
|
|
161
|
+
|
|
162
|
+
### Exercise 0.3: Preview the Core Loop
|
|
163
|
+
|
|
164
|
+
These are the commands you'll master in upcoming lessons:
|
|
165
|
+
|
|
166
|
+
| Command | Purpose | Lesson |
|
|
167
|
+
|---------|---------|--------|
|
|
168
|
+
| `/verify` | Validate project state | 1 |
|
|
169
|
+
| `/plan` | Design implementation | 3 |
|
|
170
|
+
| `/tdd` | Test-driven development | 3 |
|
|
171
|
+
| `/code-review` | Quality check | 3 |
|
|
172
|
+
| `/checkpoint` | Create safe restore point | 3 |
|
|
173
|
+
|
|
174
|
+
You don't need to memorize them now - just know they exist and work together.
|
|
175
|
+
|
|
176
|
+
## Verification
|
|
177
|
+
|
|
178
|
+
You've understood this lesson if you can answer:
|
|
179
|
+
|
|
180
|
+
- [ ] Why does planning come before coding?
|
|
181
|
+
- [ ] What happens automatically when a session starts?
|
|
182
|
+
- [ ] What is the "aha moment" about knowledge compounding?
|
|
183
|
+
- [ ] How does training mode help you learn optimal patterns?
|
|
184
|
+
|
|
185
|
+
## Key Takeaway
|
|
186
|
+
|
|
187
|
+
This system is designed to make the right way the easy way. It teaches while you work, enforces quality automatically, and compounds your expertise across projects.
|
|
188
|
+
|
|
189
|
+
**The goal: Build muscle memory for Golden Standard quality.**
|
|
190
|
+
|
|
191
|
+
## Next Steps
|
|
192
|
+
|
|
193
|
+
In Lesson 1, you'll learn the core architecture (Commands → Agents → Rules → Skills) and run your first command.
|
|
194
|
+
|
|
195
|
+
---
|
|
196
|
+
|
|
197
|
+
**Concepts learned**: Daily workflow, core loop (plan/tdd/review/verify), training mode, knowledge compounding
|
|
198
|
+
**Key insight**: The system teaches while you work - it's proactive, not just reactive
|
|
@@ -0,0 +1,81 @@
|
|
|
1
|
+
# Lesson 1: Core Concepts
|
|
2
|
+
|
|
3
|
+
Welcome to the CloudStream Claude Tools tutorial. This lesson introduces the fundamental mental model.
|
|
4
|
+
|
|
5
|
+
> **Prerequisite**: If you haven't read [Lesson 0: Philosophy & Workflow](00-philosophy-and-workflow.md), start there to understand the "why" before the "what".
|
|
6
|
+
|
|
7
|
+
## The Golden Standard
|
|
8
|
+
|
|
9
|
+
Before diving into commands, understand the quality bar: **top 1% enterprise professional quality**. This isn't aspirational - it's the baseline. Everything you produce should be:
|
|
10
|
+
- Production-ready and bulletproof
|
|
11
|
+
- 80%+ test coverage (TDD workflow)
|
|
12
|
+
- Security-reviewed (OWASP Top 10 awareness)
|
|
13
|
+
- Handoff-ready documentation
|
|
14
|
+
|
|
15
|
+
The system enforces this through rules, hooks, and guided workflows.
|
|
16
|
+
|
|
17
|
+
## Overview
|
|
18
|
+
|
|
19
|
+
The CloudStream Claude Tools system is built around a simple hierarchy:
|
|
20
|
+
|
|
21
|
+
**Commands** → **Agents** → **Rules** → **Skills**
|
|
22
|
+
|
|
23
|
+
- **Commands** are what you type (e.g., `/verify`, `/tdd`, `/plan`)
|
|
24
|
+
- **Agents** are specialized AI personas that execute commands
|
|
25
|
+
- **Rules** define behavior constraints and patterns
|
|
26
|
+
- **Skills** provide reusable knowledge and templates
|
|
27
|
+
|
|
28
|
+
Think of it like a restaurant:
|
|
29
|
+
- Commands = your order ("I'll have the steak")
|
|
30
|
+
- Agents = the chef who prepares it (knows techniques)
|
|
31
|
+
- Rules = the recipe (constraints and steps)
|
|
32
|
+
- Skills = cooking techniques the chef knows
|
|
33
|
+
|
|
34
|
+
## Why This Matters
|
|
35
|
+
|
|
36
|
+
This architecture means:
|
|
37
|
+
1. **Consistency**: Same command always triggers the same workflow
|
|
38
|
+
2. **Expertise**: Agents have deep domain knowledge built-in
|
|
39
|
+
3. **Customization**: Rules can be adjusted per-project
|
|
40
|
+
4. **Extensibility**: New skills can be added without breaking existing ones
|
|
41
|
+
|
|
42
|
+
You don't need to memorize all agents or rules. Just learn the commands, and the system handles the rest.
|
|
43
|
+
|
|
44
|
+
## Exercise
|
|
45
|
+
|
|
46
|
+
Let's run your first command. The `/verify` command is the most important - it validates your entire project.
|
|
47
|
+
|
|
48
|
+
**Step 1**: Navigate to a project directory (or the tutorial-test folder)
|
|
49
|
+
|
|
50
|
+
**Step 2**: Run the verify command:
|
|
51
|
+
```
|
|
52
|
+
/verify
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
**Step 3**: Watch what happens:
|
|
56
|
+
1. Build check runs
|
|
57
|
+
2. Tests execute
|
|
58
|
+
3. Lint validates code style
|
|
59
|
+
4. Type check verifies TypeScript
|
|
60
|
+
|
|
61
|
+
## Verification
|
|
62
|
+
|
|
63
|
+
You've completed this exercise successfully if:
|
|
64
|
+
- [ ] You saw output from multiple verification steps
|
|
65
|
+
- [ ] Each step showed a pass/fail status
|
|
66
|
+
- [ ] The command finished with an overall status
|
|
67
|
+
|
|
68
|
+
If `/verify` found issues, that's okay! The point is to see the multi-step workflow in action.
|
|
69
|
+
|
|
70
|
+
## Key Takeaway
|
|
71
|
+
|
|
72
|
+
The `/verify` command is your safety net. Run it before every commit to catch issues early.
|
|
73
|
+
|
|
74
|
+
## Next Steps
|
|
75
|
+
|
|
76
|
+
In Lesson 2, you'll learn about Training Mode - how the system suggests optimal workflows based on your intent.
|
|
77
|
+
|
|
78
|
+
---
|
|
79
|
+
|
|
80
|
+
**Command learned**: `/verify` - runs build, tests, lint, and type checks
|
|
81
|
+
**Progress**: 2 of 15 lessons complete
|