telo3-ai 5.0.7 → 6.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.
Files changed (46) hide show
  1. package/README.md +35 -787
  2. package/SKILL.md +36 -657
  3. package/bootstrap/TELO3.md +17 -0
  4. package/cli.js +221 -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 +30 -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/src/activate.js +159 -0
  24. package/src/context.js +72 -0
  25. package/src/find-context.js +41 -0
  26. package/src/init.js +38 -0
  27. package/src/install.js +128 -0
  28. package/src/paths.js +20 -0
  29. package/src/status.js +30 -0
  30. package/src/tokens.js +10 -0
  31. package/src/validate.js +220 -0
  32. package/src/version.js +12 -0
  33. package/templates/architecture.md +17 -398
  34. package/templates/design.md +22 -631
  35. package/templates/memory.md +13 -351
  36. package/templates/prd.md +15 -295
  37. package/templates/rules.md +20 -600
  38. package/templates/tasks.md +10 -210
  39. package/AI-CONTEXT.md +0 -272
  40. package/ONBOARDING-SKILL.md +0 -738
  41. package/SKILL-METADATA.json +0 -237
  42. package/scripts/init-project-context.sh +0 -139
  43. package/scripts/validate-project-context.sh +0 -164
  44. package/skills/telo3/SKILL.md +0 -315
  45. package/skills/telo3-context/SKILL.md +0 -272
  46. package/skills/telo3-onboarding/SKILL.md +0 -738
package/README.md CHANGED
@@ -1,818 +1,66 @@
1
1
  # Telo3
2
2
 
3
- **Telo3 is an AI development framework and project-context system for coding agents. Telo3 provides persistent memory, quality frameworks, and systematic engineering practices that transform AI coding assistants (Claude, ChatGPT, GitHub Copilot, Cursor) into reliable development partners.**
3
+ A chat-first skill for less AI slop, less wasted context, and continuity between coding sessions. Install in your project, say **telo3** once, then work normally. No mandatory CLI use after installation.
4
4
 
5
- [![MIT License](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/licenses/MIT)
6
- [![GitHub stars](https://img.shields.io/github/stars/jeet1511/telo3?style=social)](https://github.com/jeet1511/telo3/stargazers)
7
- [![GitHub forks](https://img.shields.io/github/forks/jeet1511/telo3?style=social)](https://github.com/jeet1511/telo3/network/members)
8
- [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/jeet1511/telo3/pulls)
9
- [![Author](https://img.shields.io/badge/Author-Jeet-blue?style=flat&logo=github)](https://github.com/jeet1511)
5
+ ## Install
10
6
 
11
- > **Created by [Jeet (@jeet1511)](https://github.com/jeet1511)** · [Repository](https://github.com/jeet1511/telo3) · [Issues](https://github.com/jeet1511/telo3/issues) · [Contributing](CONTRIBUTING.md)
12
-
13
- ---
14
-
15
- ## What is Telo3?
16
-
17
- Telo3 is a comprehensive AI development framework that provides project-context management, quality assurance frameworks, and systematic engineering workflows for AI coding agents. The Telo3 system prevents AI hallucination, architectural drift, and inconsistent code quality through a 6-document context architecture and 11 integrated quality frameworks.
18
-
19
- ### Why Telo3?
20
-
21
- Traditional AI coding assistants suffer from context loss, inconsistent quality, and "vibe coding" (generic, aesthetically-driven code without systematic engineering). Telo3 solves these problems through:
22
-
23
- **Problems Telo3 Prevents:**
24
-
25
- - ❌ **AI Vibe Coding** — Generic aesthetics without engineering discipline
26
- - ❌ **Context Loss** — Forgotten decisions and repeated explanations
27
- - ❌ **Token Inefficiency** — Wasteful token usage and slow iteration
28
- - ❌ **Security Vulnerabilities** — Unvalidated input and exposed credentials
29
- - ❌ **Privacy Violations** — Undocumented tracking and compliance gaps
30
- - ❌ **Architectural Drift** — Inconsistent patterns and random technology choices
31
- - ❌ **Design Inconsistency** — Copy-paste interfaces without design systems
32
- - ❌ **Quality Gaps** — Missing accessibility, SEO, and performance standards
33
-
34
- **How Telo3 Solves These:**
35
-
36
- **How Telo3 Solves These:**
37
-
38
- - ✅ **6-Document Project Context** — prd.md, architecture.md, rules.md, design.md, tasks.md, memory.md provide persistent AI memory
39
- - ✅ **11 Quality Frameworks** — Security, privacy, accessibility (WCAG), SEO, performance (Core Web Vitals), legal compliance (GDPR, COPPA, CAN-SPAM, DMCA)
40
- - ✅ **Token Optimization** — 80% reduction through selective context loading and "caveman mode" communication
41
- - ✅ **Smart Delegation** — Automatic detection and use of specialized skills and MCP servers
42
- - ✅ **Anti-Vibe-Coding Framework** — Systematic design system enforcement
43
- - ✅ **Framework Agnostic** — Works with React, Next.js, Vue, Python, Go, Rust, and any technology stack
44
- - ✅ **Smart Onboarding** — AI-driven project discovery and automated setup for empty projects
45
-
46
- ---
47
-
48
- ## Telo3 Architecture
49
-
50
- ## Telo3 Architecture
51
-
52
- The Telo3 system consists of three core layers:
53
-
54
- ### 1. Project Context Layer (6-Document System)
55
-
56
- Telo3 maintains project state through six interconnected markdown documents:
57
-
58
- | Document | Purpose | Telo3 Function |
59
- |----------|---------|----------------|
60
- | **prd.md** | Product requirements | What the project does and why |
61
- | **architecture.md** | Technical architecture | System structure, technology choices, patterns |
62
- | **rules.md** | Coding standards | Language-specific conventions, best practices |
63
- | **design.md** | Design system | UI/UX standards, component library, brand guidelines |
64
- | **tasks.md** | Implementation roadmap | Current sprint, backlog, completed work |
65
- | **memory.md** | Decision log | Recent changes, active context, session continuity |
66
-
67
- ### 2. Quality Framework Layer (11 Dimensions)
68
-
69
- Telo3 quality frameworks ensure production-ready code:
70
-
71
- | Framework | Standards | Telo3 Reference |
72
- |-----------|-----------|-----------------|
73
- | **Security** | OWASP, input validation, authentication | [security-quality.md](references/security-quality.md) |
74
- | **Privacy** | GDPR, COPPA, data protection | [privacy-compliance.md](references/privacy-compliance.md) |
75
- | **Legal** | CAN-SPAM, DMCA, terms compliance | [legal-compliance.md](references/legal-compliance.md) |
76
- | **Accessibility** | WCAG 2.1 AA, keyboard navigation, screen readers | [accessibility-quality.md](references/accessibility-quality.md) |
77
- | **SEO** | Meta tags, semantic HTML, Core Web Vitals | [seo-quality.md](references/seo-quality.md) |
78
- | **Performance** | LCP, INP, CLS optimization | [performance-quality.md](references/performance-quality.md) |
79
- | **UI Quality** | Design system consistency, anti-vibe-coding | [ui-quality.md](references/ui-quality.md) |
80
- | **Token Efficiency** | Selective loading, caveman mode | [token-optimization.md](references/token-optimization.md) |
81
- | **Smart Delegation** | MCP integration, skill discovery | [smart-skill-delegation.md](references/smart-skill-delegation.md) |
82
- | **Documentation** | Systematic specifications | [document-specification.md](references/document-specification.md) |
83
- | **Workflow** | AI behavior patterns | [workflow.md](references/workflow.md) |
84
-
85
- ### 3. Intelligence Layer (Smart Systems)
86
-
87
- - **Smart Onboarding** — Automated project discovery and planning ([ONBOARDING-SKILL.md](ONBOARDING-SKILL.md))
88
- - **Context Intelligence** — Selective document loading based on task
89
- - **Skill Delegation** — Automatic detection of specialized tools
90
- - **Token Optimization** — 80% reduction through intelligent caching
91
-
92
- ---
93
-
94
- ## Features
95
-
96
- ## Features
97
-
98
- ### Core Telo3 Capabilities
99
-
100
- - **Persistent Project Memory** — Six markdown documents (prd, architecture, rules, design, tasks, memory) maintain complete project context across AI sessions
101
- - **Smart Onboarding** — Automated project discovery through conversational AI for empty codebases ([Quick Start Guide](QUICK-START-ONBOARDING.md))
102
- - **Token Optimization** — 80% reduction through selective context loading and caveman mode communication
103
- - **Quality Frameworks** — 11 production-ready frameworks covering security, privacy, accessibility, SEO, performance
104
- - **Smart Skill Delegation** — Automatic detection and integration of specialized MCP servers and AI skills
105
- - **Framework Agnostic** — Compatible with React, Vue, Next.js, Python, Go, Rust, and any technology stack
106
- - **Universal AI Compatibility** — Works with Claude, ChatGPT, GitHub Copilot, Cursor, Kiro, and any AI coding assistant
107
-
108
- ### Telo3 Quality Dimensions
109
-
110
- Telo3 enforces production standards across 11 quality dimensions:
111
-
112
- 1. **Security** — OWASP standards, input validation, authentication patterns
113
- 2. **Privacy** — GDPR, COPPA, CCPA compliance guidance
114
- 3. **Legal** — CAN-SPAM, DMCA, terms of service frameworks
115
- 4. **Accessibility** — WCAG 2.1 Level AA compliance
116
- 5. **SEO** — Semantic HTML, meta tags, Core Web Vitals
117
- 6. **Performance** — LCP, INP, CLS optimization strategies
118
- 7. **UI Quality** — Design system consistency, anti-vibe-coding principles
119
- 8. **Token Efficiency** — Context caching and selective loading
120
- 9. **Smart Delegation** — MCP and skill integration intelligence
121
- 10. **Documentation** — Systematic specification standards
122
- 11. **Workflow** — AI behavior and decision patterns
123
-
124
- ### Efficiency Modes
125
-
126
- Telo3 supports multiple communication modes optimized for different use cases:
127
-
128
- | Mode | Description | Token Savings | Use Case |
129
- |------|-------------|---------------|----------|
130
- | **Normal** | Clear, concise documentation | 50% | Standard development |
131
- | **Caveman** | Ultra-compressed communication | 80% | Rapid iteration |
132
- | **Selective** | Context-aware document loading | Varies | Large projects |
133
- | **Smart Delegation** | Automatic tool selection | Varies | Specialized tasks |
134
-
135
- ---
136
-
137
- ## Installation
138
-
139
- Telo3 is available via npm, skillpm, and GitHub.
140
-
141
- ### Install via npm
142
-
143
- ```bash
144
- # Install globally (recommended)
145
- npm install -g telo3-ai
146
-
147
- # Or install in your project
148
- npm install telo3-ai
149
-
150
- # Or use npx (no installation needed)
151
- npx telo3-ai init
152
- ```
153
-
154
- **Package:** https://www.npmjs.com/package/telo3-ai
155
-
156
- ### Install via skillpm
157
-
158
- ```bash
159
- # Install as AI skill
160
- npx skillpm install telo3-ai
161
-
162
- # List installed skills
163
- npx skillpm list
164
- ```
165
-
166
- **Registry:** https://skillpm.dev
167
-
168
- ### Or Clone from GitHub
7
+ Requires Node.js 20+ for the installer; chat activation uses the AI's file tools, not Node.
169
8
 
170
9
  ```bash
171
- # Clone Telo3 to your home directory
172
- git clone https://github.com/Jeet1511/telo3.git ~/telo3
173
-
174
- # Or clone into your project directory
175
- git clone https://github.com/Jeet1511/telo3.git ./telo3
10
+ npx telo3-ai@6.1.0 install
176
11
  ```
177
12
 
178
- ### Or Add as Git Submodule
179
-
180
- ```bash
181
- # Add Telo3 to an existing project
182
- cd your-project
183
- git submodule add https://github.com/Jeet1511/telo3.git telo3
184
- ```
13
+ This copies the complete skill into your project, independent of npm's temporary cache. It detects existing Qoder, Claude, Gemini or Cursor project folders; otherwise uses the shared `.agents/skills/telo3` directory.
185
14
 
186
- ---
15
+ For a specific host:
187
16
 
188
- ## Usage
189
-
190
- ### Initialize Telo3 Project Context
191
-
192
- **If installed via npm:**
193
17
  ```bash
194
- cd your-project
195
- telo3 init
196
- ```
197
-
198
- **If cloned from GitHub:**
199
- ```bash
200
- cd your-project
201
- ~/telo3/scripts/init-project-context.sh
202
- ```
203
-
204
- **Manual setup:**
205
- ```bash
206
- # Copy Telo3 templates to your project
207
- cp -r ~/telo3/templates/* ./project-context/
208
- ```
209
-
210
- ### Activate Telo3 with Your AI
211
-
212
- **For new/empty projects:**
213
- ```
214
- Use Telo3 onboarding - this is a new project
215
- ```
216
-
217
- **For existing projects:**
218
-
219
- **For existing projects:**
220
-
221
- **Kiro IDE:**
222
- ```
223
- Use Telo3 from ~/telo3/ - Read AI-CONTEXT.md first
224
- ```
225
-
226
- **Cursor:**
227
- ```
228
- @telo3/AI-CONTEXT.md Use Telo3 systematic approach
229
- ```
230
-
231
- **GitHub Copilot:**
232
- ```
233
- #file:telo3/AI-CONTEXT.md Follow Telo3 project context system
234
- ```
235
-
236
- **Claude / ChatGPT:**
237
- ```
238
- Use Telo3 framework from ~/telo3/ - Read AI-CONTEXT.md for quick reference
239
- ```
240
-
241
- ---
242
-
243
- ## Telo3 Skills
244
-
245
- Telo3 provides specialized skills for different development scenarios:
246
-
247
- - **[SKILL.md](SKILL.md)** — Complete Telo3 system documentation and AI instructions
248
- - **[ONBOARDING-SKILL.md](ONBOARDING-SKILL.md)** — Smart project discovery and automated setup for empty projects
249
- - **[AI-CONTEXT.md](AI-CONTEXT.md)** — 30-second quick reference for AI assistants
250
-
251
- ## Telo3 Project Context
252
-
253
- The Telo3 project-context system consists of six core documents that maintain persistent state:
254
-
255
- 1. **[prd.md](templates/prd.md)** — Product requirements and project goals
256
- 2. **[architecture.md](templates/architecture.md)** — System architecture and technical decisions
257
- 3. **[rules.md](templates/rules.md)** — Coding standards and best practices
258
- 4. **[design.md](templates/design.md)** — Design system and UI/UX guidelines
259
- 5. **[tasks.md](templates/tasks.md)** — Implementation roadmap and task tracking
260
- 6. **[memory.md](templates/memory.md)** — Recent decisions and active context
261
-
262
- ## Supported AI Coding Tools
263
-
264
- Telo3 works with any AI coding assistant, including:
265
-
266
- - **Claude** (Anthropic) — Excellent systematic reasoning
267
- - **ChatGPT** (OpenAI) — Fast prototyping and code generation
268
- - **GitHub Copilot** — IDE-integrated suggestions
269
- - **Cursor** — AI-first code editor
270
- - **Kiro** — AI development environment
271
- - Any other AI assistant that can read markdown documentation
272
-
273
- ## Documentation
274
-
275
- ### Core Documentation
276
- - **[README.md](README.md)** — This file, Telo3 overview
277
- - **[SKILL.md](SKILL.md)** — Complete Telo3 instructions for AI
278
- - **[AI-CONTEXT.md](AI-CONTEXT.md)** — Quick reference guide
279
- - **[ONBOARDING-SKILL.md](ONBOARDING-SKILL.md)** — Smart onboarding system
280
- - **[QUICK-START-ONBOARDING.md](QUICK-START-ONBOARDING.md)** — Onboarding quick start
281
-
282
- ### Quality Framework References
283
- - [Token Optimization](references/token-optimization.md) — 80% token savings through selective loading
284
- - [Smart Skill Delegation](references/smart-skill-delegation.md) — Automatic MCP and skill integration
285
- - [UI Quality](references/ui-quality.md) — Anti-vibe-coding design principles
286
- - [Security](references/security-quality.md) — OWASP standards and secure coding
287
- - [Privacy](references/privacy-compliance.md) — GDPR, COPPA, CCPA guidance
288
- - [Legal](references/legal-compliance.md) — CAN-SPAM, DMCA, compliance
289
- - [SEO](references/seo-quality.md) — Semantic HTML, Core Web Vitals
290
- - [Accessibility](references/accessibility-quality.md) — WCAG 2.1 AA standards
291
- - [Performance](references/performance-quality.md) — LCP, INP, CLS optimization
292
- - [Document Specification](references/document-specification.md) — Documentation standards
293
- - [Workflow](references/workflow.md) — AI behavior patterns
294
- - [AI Behavior](references/ai-behavior.md) — Decision-making frameworks
295
- - [Project Audit](references/project-audit.md) — Quality assessment checklist
296
-
297
- ---
298
-
299
- ## Author
300
-
301
- **Telo3** is created and maintained by **[Jeet (@jeet1511)](https://github.com/jeet1511)**.
302
-
303
- - GitHub: [@jeet1511](https://github.com/jeet1511)
304
- - Repository: [github.com/Jeet1511/telo3](https://github.com/Jeet1511/telo3)
305
- - Issues: [github.com/Jeet1511/telo3/issues](https://github.com/Jeet1511/telo3/issues)
306
-
307
- ---
308
-
309
- ## License
310
-
311
- Telo3 is open source software licensed under the **[MIT License](LICENSE)**.
312
-
313
- You are free to use, modify, and distribute Telo3 for any purpose, including commercial projects.
314
-
315
- ---
316
- | **design.md** | HOW it looks - Visual language, components | When design patterns change |
317
- | **tasks.md** | WHAT remains - Implementation backlog | Weekly or after work |
318
- | **memory.md** | CURRENT STATE - Recent work, decisions | After important changes |
319
-
320
- ### Why This Works
321
-
322
- **Before Telo3:**
323
- - AI forgets project decisions
324
- - Repeats same questions
325
- - Ignores established patterns
326
- - Makes random choices
327
- - Wasts tokens reading everything
328
-
329
- **With Telo3:**
330
- - Persistent project memory
331
- - Understands requirements
332
- - Follows established patterns
333
- - Makes informed decisions
334
- - Efficient token usage
335
-
336
- ---
337
-
338
- ## 🎨 Anti-Vibe-Coding System
339
-
340
- Telo3 prevents generic AI aesthetics:
341
-
342
- ### What It Catches
343
-
344
- ❌ Harsh/arbitrary gradients
345
- ❌ Generic purple/black "AI" palettes
346
- ❌ Excessive shadows and effects
347
- ❌ Inconsistent design
348
- ❌ Generic SaaS layouts
349
- ❌ Decorative UI without purpose
350
- ❌ Copy-paste components
351
- ❌ Fake statistics/testimonials
352
-
353
- ### What It Enforces
354
-
355
- ✅ Follow actual design system
356
- ✅ Reuse existing components
357
- ✅ Consistent visual language
358
- ✅ Purpose-driven UI
359
- ✅ Brand-appropriate aesthetics
360
-
361
- ---
362
-
363
- ## 🔒 Security & Privacy Built-In
364
-
365
- ### Security Checks
366
-
367
- - ✅ Input validation (all user input)
368
- - ✅ Authorization (every API endpoint)
369
- - ✅ Secret protection (never committed)
370
- - ✅ SQL injection prevention
371
- - ✅ XSS prevention
372
- - ✅ CSRF protection
373
- - ✅ Security headers
374
-
375
- ### Privacy Safeguards
376
-
377
- - ✅ Data minimization
378
- - ✅ Third-party audit
379
- - ✅ Cookie transparency
380
- - ✅ Self-hosted fonts (no Google Fonts by default)
381
- - ✅ Session replay safeguards
382
- - ✅ Children's privacy (COPPA awareness)
383
- - ✅ Data deletion support
384
-
385
- ### Legal Compliance Awareness
386
-
387
- > **Important:** Telo3 provides engineering guidance, not legal advice.
388
-
389
- - ✅ Age restrictions (COPPA for U.S.)
390
- - ✅ Marketing emails (CAN-SPAM, GDPR)
391
- - ✅ Subscriptions (disclosure requirements)
392
- - ✅ User content (DMCA considerations)
393
- - ✅ Recommends legal counsel verification
394
-
395
- ---
396
-
397
- ## 🚄 Token Optimization
398
-
399
- ### How Telo3 Saves 80% Tokens
400
-
401
- **Traditional AI:**
402
- 1. Reads entire codebase (2000 tokens)
403
- 2. Reads all documentation (1500 tokens)
404
- 3. Runs unnecessary tests (500 tokens)
405
- 4. Verbose explanations (1000 tokens)
406
- **Total:** ~5000 tokens per task
407
-
408
- **With Telo3:**
409
- 1. Reads memory.md only (100 tokens)
410
- 2. Reads affected file (200 tokens)
411
- 3. Skips unnecessary tests (0 tokens)
412
- 4. Caveman mode response (50 tokens)
413
- **Total:** ~350 tokens per task
414
-
415
- **Savings:** 93% on this example!
416
-
417
- ### Caveman Mode
418
-
419
- ```
420
- User: "Use caveman mode"
421
- AI: "Caveman mode ON. Short responses. Ready."
422
-
423
- User: "Add login button"
424
- AI: "Done.
425
-
426
- Changed:
427
- - LoginButton.tsx (new)
428
- - auth.ts (imported)
429
-
430
- Follows design.md button styles.
431
- Works."
432
- ```
433
-
434
- ---
435
-
436
- ## 🔧 Smart Skill Delegation
437
-
438
- Telo3 automatically checks for better tools:
439
-
440
- ### Before Implementing
441
-
442
- **Smart AI behavior:**
443
- - Checks for Figma power (design implementation)
444
- - Checks for context7 MCP (library docs)
445
- - Checks for specialized skills
446
- - Recommends MCP configuration if beneficial
447
- - Uses best tool for each job
448
-
449
- **Example:**
18
+ npx telo3-ai@6.1.0 install --agent qoder
19
+ # alternatives: claude, cursor, gemini, copilot, codex, agents
450
20
  ```
451
- Task: Implement Figma design
452
-
453
- Telo3: "Figma power available. Using for accurate extraction.
454
- Faster + more accurate than manual. Proceeding..."
455
- ```
456
-
457
- ---
458
-
459
- ## 📦 What's Included
460
-
461
- ```
462
- telo3/
463
- ├── AI-CONTEXT.md # 🔥 READ THIS FIRST
464
- ├── SKILL.md # Complete AI instructions
465
- ├── README.md # This file
466
- ├── SKILL-METADATA.json # AI discovery metadata
467
- ├── LICENSE # MIT License
468
- ├── CHANGELOG.md # Version history
469
- │
470
- ├── templates/ (6 files) # Core document templates
471
- │ ├── prd.md
472
- │ ├── architecture.md
473
- │ ├── rules.md
474
- │ ├── design.md
475
- │ ├── tasks.md
476
- │ └── memory.md
477
- │
478
- ├── references/ (13 files) # Quality frameworks
479
- │ ├── token-optimization.md # 🔥 80% savings
480
- │ ├── smart-skill-delegation.md # 🔥 Use better tools
481
- │ ├── ui-quality.md # Anti-vibe-coding
482
- │ ├── seo-quality.md # SEO framework
483
- │ ├── accessibility-quality.md # WCAG compliance
484
- │ ├── performance-quality.md # Core Web Vitals
485
- │ ├── security-quality.md # Security audit
486
- │ ├── privacy-compliance.md # Privacy guidelines
487
- │ ├── legal-compliance.md # Legal awareness
488
- │ ├── document-specification.md
489
- │ ├── workflow.md
490
- │ ├── ai-behavior.md
491
- │ └── project-audit.md
492
- │
493
- ├── examples/example-project/ (6 files) # Complete example
494
- │
495
- └── scripts/ (2 files) # Automation
496
- ├── init-project-context.sh
497
- └── validate-project-context.sh
498
- ```
499
-
500
- **Total:** 31 files, ~280KB of systematic engineering knowledge
501
-
502
- ---
503
-
504
- ## 🌟 Real-World Benefits
505
-
506
- ### For AI Agents
507
- - ✅ Persistent memory across sessions
508
- - ✅ Clear engineering standards
509
- - ✅ Decision-making framework
510
- - ✅ Quality guardrails
511
- - ✅ Token efficiency
512
-
513
- ### For Developers
514
- - ✅ Consistent AI behavior
515
- - ✅ Documented decisions
516
- - ✅ Quality assurance
517
- - ✅ Faster onboarding
518
- - ✅ Reduced drift
519
-
520
- ### For Projects
521
- - ✅ Design consistency
522
- - ✅ Security by design
523
- - ✅ Accessibility compliance
524
- - ✅ Performance optimization
525
- - ✅ Legal awareness
526
-
527
- ---
528
-
529
- ## 🎯 Use Cases
530
-
531
- ### Perfect For
532
-
533
- | Project Type | Why Telo3 Helps |
534
- |--------------|-----------------|
535
- | **Startups** | Systematic from day 1, scales properly |
536
- | **SaaS Products** | Security, privacy, compliance built-in |
537
- | **E-commerce** | Payment security, subscriptions, SEO |
538
- | **Portfolios** | SEO, accessibility, design consistency |
539
- | **Enterprise** | Documentation, architecture, quality |
540
- | **Open Source** | Clear contribution guidelines, standards |
541
-
542
- ### Works With
543
-
544
- **ANY AI coding assistant:**
545
- - ✅ **Kiro IDE**
546
- - ✅ **Cursor**
547
- - ✅ **GitHub Copilot** (Chat & Workspace)
548
- - ✅ **Claude** (Desktop, API, Chat)
549
- - ✅ **ChatGPT** (Plus, API)
550
- - ✅ **Gemini** (Code Assist, Chat)
551
- - ✅ **Codeium**
552
- - ✅ **Tabnine**
553
- - ✅ **Amazon CodeWhisperer**
554
- - ✅ **VS Code with any AI extension**
555
- - ✅ **JetBrains with AI Assistant**
556
- - ✅ **Any IDE + Any AI**
557
-
558
- **How it works universally:**
559
- 1. Clone Telo3 to any folder
560
- 2. Initialize project context anywhere
561
- 3. Reference files from your AI tool
562
- 4. AI follows systematic approach
563
-
564
- **No platform lock-in. Works everywhere.**
565
-
566
- ### Framework Support
567
-
568
- - ✅ React, Next.js, Vue, Svelte, Angular
569
- - ✅ Node.js, Python, Go, Rust, PHP
570
- - ✅ Any tech stack (framework-agnostic)
571
-
572
- ---
573
-
574
- ## 📖 Documentation
575
-
576
- ### Quick References
577
- - [AI-CONTEXT.md](AI-CONTEXT.md) - 30-second quick start
578
- - [SKILL.md](SKILL.md) - Complete AI instructions
579
- - [CHANGELOG.md](CHANGELOG.md) - Version history
580
-
581
- ### Quality Frameworks
582
- - [Token Optimization](references/token-optimization.md) - Save 80% tokens
583
- - [Smart Delegation](references/smart-skill-delegation.md) - Use better tools
584
- - [UI Quality](references/ui-quality.md) - Anti-vibe-coding
585
- - [Security](references/security-quality.md) - Security audit
586
- - [Privacy](references/privacy-compliance.md) - Privacy guidelines
587
- - [Legal](references/legal-compliance.md) - Compliance awareness
588
- - [SEO](references/seo-quality.md) - SEO optimization
589
- - [Accessibility](references/accessibility-quality.md) - WCAG standards
590
- - [Performance](references/performance-quality.md) - Core Web Vitals
591
-
592
- ### Full Documentation
593
- - [Document Specification](references/document-specification.md)
594
- - [AI Workflow](references/workflow.md)
595
- - [AI Behavior](references/ai-behavior.md)
596
- - [Project Audit](references/project-audit.md)
597
-
598
- ---
599
21
 
600
- ## 🤝 Contributing
22
+ Then type **telo3** in your AI chat. Refresh the host's skill list if it caches discovery. The AI installs a small project instruction block using its file tools, preserves existing instructions, and confirms once. Future sessions resume from project instructions and the short memory summary.
601
23
 
602
- Contributions welcome! Telo3 is open source and community-driven.
24
+ For manual/no-terminal installation, copy this package into the appropriate project's skill directory as `telo3/`, with `SKILL.md`, references, templates and runtime assets intact. Then say **telo3**. Plain web chat without project-file access cannot persist activation by itself.
603
25
 
604
- ### How to Contribute
26
+ Optional direct activation: `npx telo3-ai@6.1.0 activate`. This also creates a durable project skill first.
605
27
 
606
- 1. Fork the repository
607
- 2. Create feature branch (`git checkout -b feature/amazing`)
608
- 3. Commit changes (`git commit -m 'Add amazing feature'`)
609
- 4. Push to branch (`git push origin feature/amazing`)
610
- 5. Open Pull Request
28
+ ## Small core, on-demand depth
611
29
 
612
- ### Areas for Contribution
30
+ One compact contract in `AGENTS.md`; other host files contain small pointers, not duplicate full instructions. Domain references load only when needed. The skill is opt-in, not a prompt that hijacks every unrelated project.
613
31
 
614
- - Additional quality frameworks
615
- - Language-specific templates
616
- - Framework-specific examples
617
- - Translation (i18n)
618
- - Documentation improvements
619
- - Bug fixes
32
+ Six context documents have separate roles: requirements (`prd.md`), structure (`architecture.md`), engineering (`rules.md`), UI/UX (`design.md`), work (`tasks.md`), handoff (`memory.md`). Reuse existing docs; create only missing context appropriate to substantial work. Memory is a rolling summary, not a transcript or personal memory store.
620
33
 
621
- ---
34
+ Keep security/privacy, purposeful design, accessibility and performance checks relevant to the actual change. The 14 references retain detailed guidance without loading every audit every turn. Host permissions and current user scope remain authoritative; the skill cannot override them or guarantee model compliance.
622
35
 
623
- ## 📜 License
36
+ ## Optional commands
624
37
 
625
- MIT License - see [LICENSE](LICENSE) file.
38
+ | Command | Result |
39
+ |---|---|
40
+ | `install [dir] --agent <host>` | Durable skill installation; preserves user edits |
41
+ | `activate [dir] [--all]` | Persistent core + host pointers; repeat-safe |
42
+ | `deactivate [dir]` | Remove only Telo3 instruction blocks; keep custom content |
43
+ | `init [dir] --context-dir <relative-path>` | Six skeletons; never overwrite existing docs |
44
+ | `validate [dir] [--json] [--strict]` | Sections, placeholders, likely secrets and bounded stale scan |
45
+ | `status [dir]` | Context health |
46
+ | `context <task> [dir] --measure` | Character-based estimate of context-loading reduction |
47
+ | `version` | Package version |
626
48
 
627
- Copyright (c) 2024 **[Jeet](https://github.com/jeet1511)**
49
+ Token comparison uses selected docs + task references versus **all six docs + the same references**. It is not an actual model/API token counter. Missing selected docs are reported. Detected credentials are redacted from context output; this is heuristic protection, not complete data-loss prevention.
628
50
 
629
- ---
51
+ Installation refuses unmanaged directories or modified installer-owned files. Updates are staged with rollback; backups survive if recovery itself fails. Do not edit skill files concurrently during an update.
630
52
 
631
- ## 👨‍💻 Author
53
+ ## Optional Claude Code hook
632
54
 
633
- **Jeet**
634
- GitHub: [@jeet1511](https://github.com/jeet1511)
635
- Created: December 2024
55
+ `hooks/session-start.example.json` shows opt-in registration. Adjust the command to the installed skill's location. The hook returns only the core from an already-activated project's `AGENTS.md`; it does not silently activate unrelated projects or load all memory. No hooks/settings are installed without user authorization. Host project instructions remain the primary persistence mechanism.
636
56
 
637
- ---
638
-
639
- ## 🌟 Show Your Support
640
-
641
- If Telo3 helped you, please:
642
-
643
- ⭐ **Star this repo** on GitHub
644
- 🍴 **Fork** and contribute
645
- 📢 **Share** with your team
646
- 💬 **Report issues** or suggest features
647
- ☕ **[Buy me a coffee](https://buymeacoffee.com/jeet1511)**
648
-
649
- ---
650
-
651
- ## 📊 Stats & Metrics
652
-
653
- - **Token Savings:** 80% average
654
- - **Speed Increase:** 5x faster tasks
655
- - **Quality Dimensions:** 11 frameworks
656
- - **Supported Platforms:** 7+ AI tools
657
- - **Framework Support:** All major frameworks
658
- - **License:** MIT (free forever)
659
- - **Files:** 31 comprehensive files
660
- - **Community:** Growing daily
661
-
662
- ---
663
-
664
- ## 🔮 Roadmap
665
-
666
- ### v1.1 (Coming Soon)
667
- - [ ] Visual documentation generator
668
- - [ ] Integration with more MCP servers
669
- - [ ] Multi-language support
670
- - [ ] Video tutorials
671
- - [ ] Community skill registry
672
-
673
- ### v1.2 (Future)
674
- - [ ] Auto-audit scheduling
675
- - [ ] AI-powered context optimization
676
- - [ ] Team collaboration features
677
- - [ ] Cloud sync option
678
-
679
- ---
680
-
681
- ## 💬 Community
682
-
683
- - **Discord:** [Join our community](https://discord.gg/telo3)
684
- - **GitHub Discussions:** [Ask questions](https://github.com/jeet1511/telo3/discussions)
685
- - **Issues:** [Report bugs](https://github.com/jeet1511/telo3/issues)
686
- - **Twitter:** [@jeet1511](https://twitter.com/jeet1511)
687
-
688
- ---
689
-
690
- ## 🏆 Why Telo3 is Different
691
-
692
- ### vs Traditional Prompt Engineering
693
- - ❌ Prompts: Lost after session, inconsistent
694
- - ✅ Telo3: Persistent memory, systematic
695
-
696
- ### vs Generic AI Coding
697
- - ❌ Generic: Vibe coding, random decisions
698
- - ✅ Telo3: Follows system, informed decisions
699
-
700
- ### vs Manual Documentation
701
- - ❌ Manual: Gets stale, ignored by AI
702
- - ✅ Telo3: Always current, AI understands
703
-
704
- ### vs Other Skills
705
- - ❌ Others: Single-purpose, limited scope
706
- - ✅ Telo3: Comprehensive, 11 quality dimensions
707
-
708
- ---
709
-
710
- ## 🎬 Quick Demo
57
+ ## Release verification (source repository)
711
58
 
712
59
  ```bash
713
- # 1. Clone Telo3
714
- git clone https://github.com/jeet1511/telo3.git ~/telo3
715
-
716
- # 2. Initialize your project
717
- cd my-project
718
- ~/telo3/scripts/init-project-context.sh
719
-
720
- # 3. Start your AI coding session
721
- kiro
722
-
723
- # 4. Tell AI
724
- "Use Telo3. Read AI-CONTEXT.md. Enable caveman mode."
725
-
726
- # 5. Watch the magic ✨
727
- # AI now codes systematically with 80% fewer tokens!
60
+ npm test
61
+ npm run verify:release
728
62
  ```
729
63
 
730
- ---
731
-
732
- ## 🙏 Acknowledgments
733
-
734
- Built with inspiration from:
735
- - AI coding community
736
- - Open source movement
737
- - Systematic engineering practices
738
- - Token efficiency research
739
- - Quality-first development
740
-
741
- Special thanks to all contributors and early adopters!
742
-
743
- ---
744
-
745
- ## 📞 Support & Contact
746
-
747
- - **GitHub Issues:** [Report bugs](https://github.com/jeet1511/telo3/issues)
748
- - **GitHub Discussions:** [Ask questions](https://github.com/jeet1511/telo3/discussions)
749
- - **Email:** [Contact form](https://github.com/jeet1511)
750
- - **Sponsor:** [Support development](https://github.com/sponsors/jeet1511)
751
-
752
- ---
753
-
754
- <div align="center">
755
-
756
- ### 🚀 Transform Your AI Coding Today
757
-
758
- **Telo3: From Vibe Coding to Systematic Engineering**
759
-
760
- Made with ❤️ by [Jeet](https://github.com/jeet1511)
761
-
762
- [⭐ Star on GitHub](https://github.com/jeet1511/telo3) | [📖 Read Docs](https://github.com/jeet1511/telo3/blob/main/SKILL.md) | [🤝 Contribute](https://github.com/jeet1511/telo3/blob/main/CONTRIBUTING.md)
763
-
764
- </div>
765
-
766
- ---
767
-
768
- **Keywords for SEO:** AI coding, AI agent, systematic engineering, project context, AI memory, token optimization, caveman mode, anti-vibe-coding, security framework, privacy compliance, legal awareness, accessibility WCAG, SEO optimization, performance audit, design system, Kiro skill, Cursor extension, Claude integration, ChatGPT plugin, GitHub Copilot, smart delegation, MCP integration, framework-agnostic, production-ready, open-source skill, developer productivity, code quality, AI best practices, Jeet, jeet1511
769
-
770
-
771
- ---
772
-
773
- <details>
774
- <summary>📊 Project Statistics & Information</summary>
775
-
776
- <br/>
777
-
778
- ![GitHub stars](https://img.shields.io/github/stars/jeet1511/telo3?style=social&label=Star%20this%20AI%20coding%20framework)
779
- ![GitHub forks](https://img.shields.io/github/forks/jeet1511/telo3?style=social&label=Fork%20for%20systematic%20development)
780
- ![GitHub watchers](https://img.shields.io/github/watchers/jeet1511/telo3?style=social)
781
- ![GitHub contributors](https://img.shields.io/github/contributors/jeet1511/telo3)
782
- ![GitHub last commit](https://img.shields.io/github/last-commit/jeet1511/telo3)
783
- ![GitHub repo size](https://img.shields.io/github/repo-size/jeet1511/telo3)
784
- ![Lines of code](https://img.shields.io/tokei/lines/github/jeet1511/telo3)
785
- ![GitHub language count](https://img.shields.io/github/languages/count/jeet1511/telo3)
786
-
787
- ### Common Search Terms Leading to Telo3
788
-
789
- This project helps developers searching for: AI coding assistant frameworks, Claude development tools, GPT-4 project context management, GitHub Copilot productivity enhancement, Cursor AI configuration rules, systematic software engineering approaches, automated project documentation systems, code quality assurance frameworks for AI agents, security compliance in AI-generated code, accessibility standards for software development, performance optimization techniques, SEO best practices, token efficiency in AI communication, empty project setup automation, intelligent onboarding systems, technology stack recommendation engines, smart skill delegation patterns, MCP server integration guides, anti-vibe-coding methodologies, hallucination prevention in AI coding, and production-ready development templates.
790
-
791
- ### Supported Technologies
792
-
793
- **AI Assistants:** Claude (Anthropic), GPT-4 (OpenAI), ChatGPT, GitHub Copilot, Cursor, Kiro IDE, Windsurf, Cody, Tabnine, Amazon CodeWhisperer
794
-
795
- **Programming Languages:** JavaScript, TypeScript, Python, Go, Rust, Java, C#, PHP, Ruby, Swift, Kotlin, C++, Scala, Elixir, Haskell
796
-
797
- **Frameworks:** React, Vue, Angular, Svelte, Next.js, Nuxt, Remix, Astro, SolidJS, Qwik, Express, Fastify, NestJS, Django, Flask, FastAPI, Rails, Laravel, Spring Boot, ASP.NET
798
-
799
- **Development Environments:** VS Code, Visual Studio, IntelliJ IDEA, WebStorm, PyCharm, GoLand, RustRover, Fleet, Zed, Neovim
800
-
801
- ### Quality Standards Implemented
802
-
803
- Telo3 enforces industry-leading quality standards including WCAG 2.1 Level AA accessibility compliance, OWASP security best practices, Core Web Vitals performance optimization, GDPR privacy compliance, COPPA child safety requirements, CAN-SPAM email regulations, DMCA copyright compliance, semantic HTML5 standards, responsive design principles, progressive enhancement methodology, and systematic software engineering practices.
804
-
805
- ### Use Cases
806
-
807
- - **Startup MVPs:** Rapid prototyping with production-quality foundations
808
- - **Enterprise Applications:** Systematic development with audit trails
809
- - **Open Source Projects:** Consistent quality across contributors
810
- - **Learning Projects:** Best practices built-in from day one
811
- - **Client Work:** Professional standards, documented decisions
812
- - **Team Collaboration:** Shared context, reduced onboarding
813
- - **Solo Development:** Persistent memory across sessions
814
- - **Migration Projects:** Document existing systems systematically
815
- - **API Development:** Consistent patterns and security
816
- - **Full-Stack Applications:** Coordinated frontend/backend development
64
+ The second command packs locally, checks the allowlist, installs the archive offline, and tests the installed CLI, durable skills, hooks, links, idempotency and token baseline. `prepublishOnly` runs both checks. It never publishes or queries credentials.
817
65
 
818
- </details>
66
+ MIT © Jeet ([@jeet1511](https://github.com/jeet1511)).