telo3-ai 5.0.7 → 6.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.
Files changed (47) hide show
  1. package/README.md +32 -791
  2. package/SKILL.md +36 -657
  3. package/bootstrap/TELO3.md +17 -0
  4. package/cli.js +223 -42
  5. package/hooks/inject-contract.mjs +23 -0
  6. package/hooks/session-start.example.json +15 -0
  7. package/index.js +48 -14
  8. package/package.json +32 -69
  9. package/references/accessibility-quality.md +92 -272
  10. package/references/ai-behavior.md +70 -332
  11. package/references/anti-slop.md +71 -0
  12. package/references/document-specification.md +110 -419
  13. package/references/legal-compliance.md +90 -395
  14. package/references/performance-quality.md +100 -351
  15. package/references/privacy-compliance.md +88 -464
  16. package/references/project-audit.md +79 -440
  17. package/references/security-quality.md +68 -220
  18. package/references/seo-quality.md +83 -339
  19. package/references/smart-skill-delegation.md +73 -419
  20. package/references/token-optimization.md +83 -450
  21. package/references/ui-quality.md +106 -481
  22. package/references/workflow.md +91 -447
  23. package/scripts/postinstall.mjs +27 -0
  24. package/src/activate.js +159 -0
  25. package/src/context.js +72 -0
  26. package/src/find-context.js +41 -0
  27. package/src/init.js +38 -0
  28. package/src/install.js +128 -0
  29. package/src/paths.js +20 -0
  30. package/src/status.js +30 -0
  31. package/src/tokens.js +10 -0
  32. package/src/validate.js +220 -0
  33. package/src/version.js +12 -0
  34. package/templates/architecture.md +17 -398
  35. package/templates/design.md +22 -631
  36. package/templates/memory.md +13 -351
  37. package/templates/prd.md +15 -295
  38. package/templates/rules.md +20 -600
  39. package/templates/tasks.md +10 -210
  40. package/AI-CONTEXT.md +0 -272
  41. package/ONBOARDING-SKILL.md +0 -738
  42. package/SKILL-METADATA.json +0 -237
  43. package/scripts/init-project-context.sh +0 -139
  44. package/scripts/validate-project-context.sh +0 -164
  45. package/skills/telo3/SKILL.md +0 -315
  46. package/skills/telo3-context/SKILL.md +0 -272
  47. package/skills/telo3-onboarding/SKILL.md +0 -738
@@ -1,315 +0,0 @@
1
- ---
2
- name: telo3
3
- version: 5.0.5
4
- description: AI development framework with project-context system, quality frameworks, and systematic engineering practices
5
- author: Jeet (@jeet1511)
6
- license: MIT
7
- repository: https://github.com/Jeet1511/telo3
8
- ---
9
-
10
- # Telo3 — AI Development Skill
11
-
12
- **Version:** 5.0.5
13
- **Purpose:** Make AI coding agents understand, build, maintain, audit, secure, optimize, and document software projects systematically instead of "vibe coding."
14
- **Created by:** [Jeet (@Jeet1511)](https://github.com/Jeet1511)
15
- **Repository:** https://github.com/Jeet1511/telo3
16
-
17
- ---
18
-
19
- ## Core Principle
20
-
21
- **Understand the project BEFORE making meaningful changes.**
22
-
23
- This skill system provides AI agents with persistent project memory, engineering rules, quality standards, and governance frameworks to prevent:
24
-
25
- - AI hallucination
26
- - Vibe coding and architectural drift
27
- - Inconsistent UI and random technology choices
28
- - Accidental breaking changes
29
- - Security, privacy, and compliance oversights
30
- - Forgotten decisions and stale context
31
- - Unnecessary rewrites and duplicated features
32
-
33
- ---
34
-
35
- ## When to Activate
36
-
37
- Activate this skill when:
38
-
39
- - Starting work on a new project
40
- - Onboarding to an existing project
41
- - Auditing project quality
42
- - Synchronizing documentation with implementation
43
- - The project contains `project-context/` or similar context files (any location works)
44
-
45
- ## Quick Start (30 seconds)
46
-
47
- **Read in this order:**
48
-
49
- 1. `AI-CONTEXT.md` — 30-second overview (you're reading it now)
50
- 2. `project-context/prd.md` — What & why
51
- 3. `project-context/architecture.md` — How it's built
52
- 4. `project-context/memory.md` — Recent context
53
-
54
- Then proceed with coding systematically.
55
-
56
- ---
57
-
58
- ## The 6-Document Context System
59
-
60
- | Document | Purpose | When to Read | When to Update |
61
- |----------|---------|--------------|----------------|
62
- | **prd.md** | WHAT & WHY — Requirements, vision, users | Always first | When requirements change |
63
- | **architecture.md** | HOW it's built — Tech stack, structure | Before changing structure | When architecture changes |
64
- | **rules.md** | HOW to code — Standards, security, testing | Before coding | When standards evolve |
65
- | **design.md** | WHAT it looks like — UI/UX, brand, components | Before UI work | When design system changes |
66
- | **tasks.md** | WHAT to do — Current sprint, backlog, done | Daily | When tasks change |
67
- | **memory.md** | CURRENT STATE — Recent work, decisions, continuity | Every session | After significant changes |
68
-
69
- **Location:** `project-context/` or `docs/project-context/` or project root (flexible)
70
-
71
- ---
72
-
73
- ## Quality Frameworks (11 Dimensions)
74
-
75
- Before implementing features, check relevant frameworks:
76
-
77
- | Framework | What It Covers | Reference File |
78
- |-----------|----------------|----------------|
79
- | **Security** | OWASP, auth, validation, secrets | `references/security-quality.md` |
80
- | **Privacy** | GDPR, COPPA, data collection, tracking | `references/privacy-compliance.md` |
81
- | **Legal** | CAN-SPAM, DMCA, age restrictions, terms | `references/legal-compliance.md` |
82
- | **Accessibility** | WCAG 2.1 AA, screen readers, keyboard nav | `references/accessibility-quality.md` |
83
- | **SEO** | Meta tags, semantic markup, sitemaps, Core Web Vitals | `references/seo-quality.md` |
84
- | **Performance** | LCP, INP, CLS, image optimization | `references/performance-quality.md` |
85
- | **UI Quality** | Anti-vibe-coding, design consistency | `references/ui-quality.md` |
86
- | **Token Efficiency** | Selective loading, caveman mode | `references/token-optimization.md` |
87
- | **Smart Delegation** | MCP integration, skill discovery | `references/smart-skill-delegation.md` |
88
- | **Documentation** | Systematic specifications | `references/document-specification.md` |
89
- | **Workflow** | AI behavior patterns | `references/workflow.md` |
90
-
91
- ---
92
-
93
- ## Token Optimization (80% Savings)
94
-
95
- ### Selective Context Loading
96
-
97
- **Don't read everything.** Load documents based on task:
98
-
99
- | Task Type | Read These |
100
- |-----------|------------|
101
- | **New feature** | prd.md, architecture.md, rules.md, tasks.md |
102
- | **Bug fix** | memory.md, architecture.md, rules.md |
103
- | **UI change** | design.md, rules.md, ui-quality.md |
104
- | **Security audit** | security-quality.md, privacy-compliance.md, legal-compliance.md |
105
- | **Onboarding** | AI-CONTEXT.md → prd.md → architecture.md |
106
-
107
- ### Caveman Mode (Ultra-Concise Communication)
108
-
109
- **Status updates:** `✅ Task done` not "I have successfully completed..."
110
- **Questions:** `DB choice: Postgres vs MongoDB?` not verbose explanations
111
- **Changes:** Update `memory.md` silently, announce only major changes
112
-
113
- **Token savings: 80%**
114
-
115
- ---
116
-
117
- ## Smart Skill Delegation
118
-
119
- **Before implementing, check:**
120
- - Does skill exist for this? (check your AI's skills directory)
121
- - Is there MCP tool? (figma, context7, stripe, etc.)
122
- - Would sub-agent do better? (if your AI supports delegation)
123
-
124
- **Common delegations:**
125
- - UI/Design → figma skill
126
- - Payments → stripe MCP
127
- - Auth → authentication skills
128
- - API docs → openapi tools
129
- - Testing → testing frameworks
130
-
131
- See `references/smart-skill-delegation.md` for complete guide.
132
-
133
- ---
134
-
135
- ## Anti-Vibe-Coding Framework
136
-
137
- **What is vibe coding?**
138
- Generic AI aesthetics: purple/black themes, excessive gradients, arbitrary shadows, decorative-only UI, fake statistics, random tech choices.
139
-
140
- **Telo3 prevents this:**
141
-
142
- ❌ **Don't:**
143
- - Use generic "AI aesthetics" (purple/black, harsh gradients)
144
- - Make arbitrary design choices
145
- - Ignore existing design system
146
- - Create fake data/testimonials
147
- - Add features not in prd.md
148
- - Change architecture without updating docs
149
-
150
- ✅ **Do:**
151
- - Follow design.md system
152
- - Reuse existing components
153
- - Match brand guidelines
154
- - Use real data or clearly labeled placeholders
155
- - Check prd.md before adding features
156
- - Update architecture.md when structure changes
157
-
158
- See `references/ui-quality.md` for complete guidelines.
159
-
160
- ---
161
-
162
- ## Workflow Patterns
163
-
164
- ### 1. Session Start
165
-
166
- ```
167
- 1. Read AI-CONTEXT.md (this file)
168
- 2. Read project-context/memory.md (recent context)
169
- 3. Read project-context/prd.md (current goals)
170
- 4. Review project-context/tasks.md (current work)
171
- 5. Proceed with development
172
- ```
173
-
174
- ### 2. Before Coding
175
-
176
- ```
177
- 1. Check project-context/rules.md (standards)
178
- 2. Check project-context/architecture.md (patterns)
179
- 3. Check project-context/design.md (if UI work)
180
- 4. Check relevant quality frameworks
181
- 5. Code following established patterns
182
- ```
183
-
184
- ### 3. After Significant Changes
185
-
186
- ```
187
- 1. Update project-context/memory.md (decisions made)
188
- 2. Update project-context/architecture.md (if structure changed)
189
- 3. Update project-context/tasks.md (mark tasks done)
190
- 4. Run validation (if available)
191
- ```
192
-
193
- ### 4. Quality Checks
194
-
195
- **Before marking work complete:**
196
-
197
- - ✅ Follows rules.md standards
198
- - ✅ Matches architecture.md patterns
199
- - ✅ Follows design.md (if UI)
200
- - ✅ Security framework checked
201
- - ✅ Accessibility verified (if public-facing)
202
- - ✅ Performance acceptable
203
- - ✅ Documentation updated
204
-
205
- ---
206
-
207
- ## Installation & Setup
208
-
209
- ### For Developers
210
-
211
- **Install Telo3:**
212
- ```bash
213
- # Via npm
214
- npm install -g telo3-ai
215
-
216
- # Via skillpm
217
- npx skillpm install telo3-ai
218
-
219
- # Via git
220
- git clone https://github.com/Jeet1511/telo3.git ~/telo3
221
- ```
222
-
223
- **Initialize project context:**
224
- ```bash
225
- cd your-project
226
- telo3 init
227
- # Or: ~/telo3/scripts/init-project-context.sh
228
- ```
229
-
230
- **Activate with AI:**
231
- ```
232
- Use Telo3 from ~/telo3/ - Read AI-CONTEXT.md first
233
- ```
234
-
235
- ### For AI Agents
236
-
237
- **Auto-detection files:**
238
- - `.cursorrules` — Cursor IDE
239
- - `.windsurfrules` — Windsurf IDE
240
- - `skill.json` — Universal skill manifest
241
- - `.github/skill-registry.json` — Platform registry
242
-
243
- **Manual activation:**
244
- ```
245
- Use Telo3 systematic engineering framework.
246
- Read ~/telo3/AI-CONTEXT.md for quick start.
247
- Follow project-context/ documents before making changes.
248
- ```
249
-
250
- ---
251
-
252
- ## Repository Structure
253
-
254
- ```
255
- telo3/
256
- ├── skills/ # skillpm-compatible skills
257
- │ ├── telo3/ # Main framework skill
258
- │ ├── telo3-onboarding/ # Smart onboarding
259
- │ └── telo3-quick-reference/ # Quick reference
260
- ├── templates/ # 6-document templates
261
- │ ├── prd.md
262
- │ ├── architecture.md
263
- │ ├── rules.md
264
- │ ├── design.md
265
- │ ├── tasks.md
266
- │ └── memory.md
267
- ├── references/ # Quality frameworks
268
- │ ├── security-quality.md
269
- │ ├── privacy-compliance.md
270
- │ ├── legal-compliance.md
271
- │ ├── accessibility-quality.md
272
- │ ├── seo-quality.md
273
- │ ├── performance-quality.md
274
- │ ├── ui-quality.md
275
- │ ├── token-optimization.md
276
- │ ├── smart-skill-delegation.md
277
- │ ├── document-specification.md
278
- │ ├── workflow.md
279
- │ ├── ai-behavior.md
280
- │ └── project-audit.md
281
- ├── scripts/
282
- │ ├── init-project-context.sh
283
- │ └── validate-project-context.sh
284
- ├── examples/
285
- │ └── example-project/ # Complete example
286
- ├── SKILL.md # This file
287
- ├── AI-CONTEXT.md # Quick reference
288
- ├── ONBOARDING-SKILL.md # Smart onboarding system
289
- └── README.md # Full documentation
290
- ```
291
-
292
- ---
293
-
294
- ## Links
295
-
296
- - **GitHub:** https://github.com/Jeet1511/telo3
297
- - **npm:** https://www.npmjs.com/package/telo3-ai
298
- - **skillpm:** Auto-indexed from npm
299
- - **Author:** [Jeet (@jeet1511)](https://github.com/jeet1511)
300
- - **License:** MIT
301
-
302
- ---
303
-
304
- ## Support & Contributing
305
-
306
- - **Issues:** https://github.com/Jeet1511/telo3/issues
307
- - **Discussions:** https://github.com/Jeet1511/telo3/discussions
308
- - **Contributing:** See CONTRIBUTING.md
309
- - **Changelog:** See CHANGELOG.md
310
-
311
- ---
312
-
313
- **Version:** 5.0.5
314
- **Created by:** [Jeet (@jeet1511)](https://github.com/jeet1511)
315
- **License:** MIT
@@ -1,272 +0,0 @@
1
- ---
2
- name: telo3-quick-reference
3
- version: 5.0.4
4
- description: 30-second quick reference guide for AI assistants
5
- author: Jeet (@jeet1511)
6
- license: MIT
7
- repository: https://github.com/Jeet1511/telo3
8
- ---
9
-
10
- # AI Context — Quick Reference
11
-
12
- > **Ultra-concise project context for AI agents. Read this FIRST (30 seconds).**
13
-
14
- ---
15
-
16
- ## What This Is
17
-
18
- **Project Context System** = 6 documents + quality frameworks for systematic AI coding.
19
-
20
- Prevents: vibe coding, architectural drift, forgotten decisions, security mistakes.
21
-
22
- ---
23
-
24
- ## Core Documents (Read Selectively)
25
-
26
- | File | When to Read | Time |
27
- |------|--------------|------|
28
- | **memory.md** | ALWAYS (current state) | 30s |
29
- | **prd.md** | Changing requirements | 2min |
30
- | **architecture.md** | Adding features, structure changes | 3min |
31
- | **rules.md** | Unsure about standards | 2min |
32
- | **design.md** | Building UI | 2min |
33
- | **tasks.md** | Planning work | 1min |
34
-
35
- **Default:** Read memory.md only. Load others if relevant.
36
-
37
- ---
38
-
39
- ## Quick Decision Framework
40
-
41
- ```
42
- Tiny task (< 5min)?
43
- → Read affected file only → Code → Update memory.md
44
-
45
- Medium task (5-15min)?
46
- → Read memory.md + relevant doc → Code → Update 2 docs
47
-
48
- Large task (15min+)?
49
- → Read context subset → Plan → Code → Update all affected
50
- ```
51
-
52
- ---
53
-
54
- ## Critical Rules
55
-
56
- ### Security (Non-Negotiable)
57
- - Validate ALL user input
58
- - Check authorization on EVERY request
59
- - Never commit secrets
60
- - Hash passwords (bcrypt/argon2)
61
- - Filter queries by teamId/userId (if multi-tenant)
62
-
63
- ### Privacy (Required)
64
- - Document data collection
65
- - Self-host fonts (no Google Fonts by default)
66
- - No invasive tracking without disclosure
67
- - Support data deletion
68
-
69
- ### Legal (Awareness)
70
- - Age restrictions if children can use service
71
- - Unsubscribe for marketing emails
72
- - Clear subscription terms
73
- - DMCA agent for user content (U.S.)
74
- - **This is engineering guidance, not legal advice**
75
-
76
- ### Quality (Standards)
77
- - Follow existing patterns (inspect before creating)
78
- - Reuse components (don't duplicate)
79
- - Accessible by default (semantic HTML, ARIA, contrast)
80
- - Responsive (mobile-first)
81
-
82
- ---
83
-
84
- ## Token Optimization
85
-
86
- ### Read Minimum
87
- - memory.md (always)
88
- - Affected files only
89
- - Skip unrelated code
90
-
91
- ### Skip Unnecessary
92
- - Don't test if not requested
93
- - Don't verify unchanged code
94
- - Don't inspect unrelated files
95
- - Don't re-read files from this conversation
96
-
97
- ### Communicate Concisely
98
- **Normal mode:** Brief, clear updates
99
- **Caveman mode:** Ultra-short, no fluff
100
-
101
- ---
102
-
103
- ## Smart Delegation
104
-
105
- **Before implementing, check:**
106
- - Does skill exist for this? (check your AI's skills directory)
107
- - Is there MCP tool? (figma, context7, stripe, etc.)
108
- - Would sub-agent do better? (if your AI supports delegation)
109
-
110
- **Use specialized tools for specialized tasks.**
111
-
112
- ---
113
-
114
- ## Update Pattern
115
-
116
- **After EVERY meaningful change:**
117
-
118
- ✅ Update **memory.md** (current state, decisions)
119
- ✅ Update **tasks.md** (mark complete, add new)
120
- ✅ Update other docs ONLY if they changed
121
-
122
- ❌ Don't update unrelated docs
123
- ❌ Don't duplicate info across docs
124
- ❌ Don't turn memory.md into conversation log
125
-
126
- ---
127
-
128
- ## Quality Checks (Mental)
129
-
130
- Before marking complete:
131
- - [ ] Follows existing patterns?
132
- - [ ] Security considered?
133
- - [ ] Accessible (if UI)?
134
- - [ ] Documentation updated?
135
- - [ ] No secrets committed?
136
-
137
- ---
138
-
139
- ## Caveman Mode
140
-
141
- **User says:** "caveman mode" or "be concise"
142
-
143
- **You respond:**
144
- ```
145
- Caveman mode ON.
146
- Short responses.
147
- Ready.
148
- ```
149
-
150
- **Format:**
151
- - Short sentences
152
- - No fluff
153
- - Facts only
154
- - Action → Result → Done
155
-
156
- ---
157
-
158
- ## Response Templates
159
-
160
- ### Standard Update
161
- ```
162
- Task: [X]
163
-
164
- Changed:
165
- - file.ts (added Y)
166
- - file2.ts (updated Z)
167
-
168
- Updated:
169
- - memory.md
170
- - tasks.md
171
-
172
- Done.
173
- ```
174
-
175
- ### Caveman Update
176
- ```
177
- Done.
178
-
179
- Changed:
180
- - file.ts (Y)
181
- - file2.ts (Z)
182
-
183
- Docs current.
184
- ```
185
-
186
- ### Bug Fix
187
- ```
188
- Fixed [issue].
189
-
190
- Root cause: [X]
191
- Changed: [file:line]
192
- Verified: Works now.
193
- ```
194
-
195
- ---
196
-
197
- ## When to Ask User
198
-
199
- **Ask when:**
200
- - Requirements unclear
201
- - Multiple valid approaches
202
- - Breaking change needed
203
- - Security/privacy decision
204
- - Scope change
205
-
206
- **Don't ask when:**
207
- - Obvious implementation
208
- - Following existing pattern
209
- - Standard practice
210
- - Documented in context
211
-
212
- ---
213
-
214
- ## Common Patterns (Auto-Apply)
215
-
216
- | User Request | Auto Action |
217
- |--------------|-------------|
218
- | "Fix typo" | Fix → No test → Update memory.md |
219
- | "Change color" | Check design.md → Update → Done |
220
- | "Add form field" | Add with validation → Test if critical |
221
- | "Update docs" | Update → No code verification |
222
- | "Refactor" | Read code → Plan → Confirm → Refactor |
223
-
224
- ---
225
-
226
- ## Reference Docs (Load as Needed)
227
-
228
- **Quality frameworks in `references/`:**
229
- - `ui-quality.md` — Anti-vibe-coding
230
- - `seo-quality.md` — SEO audit
231
- - `accessibility-quality.md` — WCAG standards
232
- - `performance-quality.md` — Core Web Vitals
233
- - `security-quality.md` — Security audit
234
- - `privacy-compliance.md` — Privacy guidelines
235
- - `legal-compliance.md` — Compliance awareness
236
- - `token-optimization.md` — Efficiency rules
237
- - `smart-skill-delegation.md` — Use other tools
238
-
239
- **Load only when doing that type of work.**
240
-
241
- ---
242
-
243
- ## Skill Location
244
-
245
- This skill: Anywhere you cloned Telo3 (universal)
246
-
247
- Main instruction: `SKILL.md`
248
- Templates: `templates/`
249
- References: `references/`
250
- Scripts: `scripts/`
251
-
252
- ---
253
-
254
- ## Summary (10 seconds)
255
-
256
- 1. **Read memory.md first** (30s)
257
- 2. **Load relevant context only**
258
- 3. **Follow existing patterns**
259
- 4. **Code with security/privacy/quality**
260
- 5. **Update memory.md + tasks.md**
261
- 6. **Communicate concisely**
262
- 7. **Use specialized tools when better**
263
-
264
- **Goal:** Systematic engineering. Minimal tokens. Maximum quality.
265
-
266
- ---
267
-
268
- **Now check memory.md for current project state.**
269
-
270
- ---
271
-
272
- **Telo3 by [Jeet](https://github.com/Jeet1511)** | [Full Docs](https://github.com/Jeet1511/telo3) | [Contribute](https://github.com/Jeet1511/telo3/blob/main/CONTRIBUTING.md)