mirror of
https://github.com/SuperClaude-Org/SuperClaude_Framework.git
synced 2025-12-29 16:16:08 +00:00
Clean up references to deleted scripts and pattern system
- Removed references to validate-references.sh from YAML files - Removed expand-references.sh from settings.local.json - Cleaned up @pattern/@flags references from shared files - Updated documentation to reflect current no-code implementation - Simplified reference-index.yml to remove @include patterns This cleanup removes confusion from the abandoned pattern reference system while maintaining all functionality. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
@@ -1,40 +0,0 @@
|
||||
# Ambiguity Check Patterns
|
||||
|
||||
## Integration
|
||||
|
||||
```yaml
|
||||
Commands:
|
||||
Include: shared/ambiguity-check.yml
|
||||
Check: ambiguity_level() before execute
|
||||
Block: CRITICAL ambiguity
|
||||
|
||||
Detection:
|
||||
Keywords: See RULES.md § Ambiguity
|
||||
Missing: Path|Scope|Criteria
|
||||
Risk: Combine w/ operation risk
|
||||
|
||||
Response:
|
||||
LOW: Proceed w/ assumption note
|
||||
MEDIUM: Suggest interpretation+confirm
|
||||
HIGH: Present options A/B/C
|
||||
CRITICAL: Block until clarified
|
||||
```
|
||||
|
||||
## Quick Checks
|
||||
|
||||
```yaml
|
||||
Path Ambiguity:
|
||||
"update config" → Which file?
|
||||
"fix tests" → Which tests?
|
||||
"deploy" → Which environment?
|
||||
|
||||
Scope Ambiguity:
|
||||
"refactor" → Single file or module?
|
||||
"optimize" → Speed or memory?
|
||||
"add security" → What threats?
|
||||
|
||||
Action Ambiguity:
|
||||
"make it work" → Define "work"
|
||||
"fix the bug" → Which bug?
|
||||
"improve" → What aspect?
|
||||
```
|
||||
326
.claude/commands/shared/architecture-patterns.yml
Normal file
326
.claude/commands/shared/architecture-patterns.yml
Normal file
@@ -0,0 +1,326 @@
|
||||
# Architecture Patterns & Design Knowledge
|
||||
# Extracted architectural patterns for system design and development
|
||||
|
||||
@include shared/universal-constants.yml#Universal_Legend
|
||||
|
||||
## Domain-Driven Design (DDD) Patterns
|
||||
|
||||
```yaml
|
||||
DDD_Building_Blocks:
|
||||
Entities:
|
||||
Definition: "Objects w/ unique identity that persist over time"
|
||||
Characteristics: ["Unique identity", "Mutable state", "Business behavior"]
|
||||
Implementation: ["ID field", "Equality by ID", "Lifecycle management"]
|
||||
Examples: ["User", "Order", "Product", "Account"]
|
||||
|
||||
Value_Objects:
|
||||
Definition: "Immutable objects defined by their attributes"
|
||||
Characteristics: ["No identity", "Immutable", "Replaceable"]
|
||||
Implementation: ["Equality by value", "No setters", "Validation in constructor"]
|
||||
Examples: ["Email", "Money", "Address", "DateRange"]
|
||||
|
||||
Aggregates:
|
||||
Definition: "Consistency boundaries w/ aggregate roots"
|
||||
Characteristics: ["Transaction boundary", "Consistency rules", "Access via root"]
|
||||
Implementation: ["Aggregate root", "Internal entities", "Business invariants"]
|
||||
Examples: ["Order w/ LineItems", "Customer w/ Addresses"]
|
||||
|
||||
Domain_Services:
|
||||
Definition: "Business logic that doesn't belong in entities"
|
||||
Characteristics: ["Stateless", "Domain operations", "Cross-entity logic"]
|
||||
Implementation: ["Pure functions", "Domain interfaces", "Business rules"]
|
||||
Examples: ["TransferService", "PricingService", "ValidationService"]
|
||||
|
||||
Repositories:
|
||||
Definition: "Abstract data access for aggregates"
|
||||
Characteristics: ["Collection-like interface", "Persistence abstraction", "Aggregate-focused"]
|
||||
Implementation: ["Interface in domain", "Implementation in infrastructure", "Unit of work"]
|
||||
Examples: ["UserRepository", "OrderRepository", "ProductCatalog"]
|
||||
|
||||
Domain_Events:
|
||||
Definition: "Capture significant business events"
|
||||
Characteristics: ["Past tense", "Immutable", "Business significance"]
|
||||
Implementation: ["Event publishing", "Event handlers", "Eventual consistency"]
|
||||
Examples: ["UserRegistered", "OrderPlaced", "PaymentProcessed"]
|
||||
|
||||
Factories:
|
||||
Definition: "Complex object creation logic"
|
||||
Characteristics: ["Encapsulate creation", "Ensure invariants", "Hide complexity"]
|
||||
Implementation: ["Creation methods", "Builder patterns", "Validation"]
|
||||
Examples: ["OrderFactory", "UserFactory", "AggregateFactory"]
|
||||
|
||||
Application_Services:
|
||||
Definition: "Orchestrate domain operations for use cases"
|
||||
Characteristics: ["Thin coordination layer", "Transaction boundaries", "DTO translation"]
|
||||
Implementation: ["Use case methods", "Domain orchestration", "Infrastructure coordination"]
|
||||
Examples: ["UserRegistrationService", "OrderProcessingService"]
|
||||
```
|
||||
|
||||
## DDD Strategic Patterns
|
||||
|
||||
```yaml
|
||||
Strategic_Design:
|
||||
Bounded_Contexts:
|
||||
Definition: "Clear boundaries for domain models"
|
||||
Purpose: ["Model isolation", "Team autonomy", "Technology independence"]
|
||||
Implementation: ["Context maps", "Anti-corruption layers", "Published language"]
|
||||
Examples: ["Sales Context", "Inventory Context", "Billing Context"]
|
||||
|
||||
Context_Mapping:
|
||||
Patterns:
|
||||
Shared_Kernel: "Shared code between contexts"
|
||||
Customer_Supplier: "Upstream/downstream relationship"
|
||||
Conformist: "Downstream conforms to upstream"
|
||||
Anti_Corruption_Layer: "Translation layer for external systems"
|
||||
Open_Host_Service: "Published API for multiple consumers"
|
||||
Published_Language: "Common schema/protocol"
|
||||
Separate_Ways: "No integration between contexts"
|
||||
Big_Ball_of_Mud: "Legacy system integration"
|
||||
|
||||
Ubiquitous_Language:
|
||||
Definition: "Common language between domain experts & developers"
|
||||
Implementation: ["Domain glossary", "Code naming", "Documentation"]
|
||||
Maintenance: ["Regular refinement", "Feedback loops", "Continuous alignment"]
|
||||
|
||||
Event_Driven_Architecture:
|
||||
Patterns: ["Domain events", "Event sourcing", "CQRS", "Saga patterns"]
|
||||
Implementation: ["Event store", "Event handlers", "Read models", "Process managers"]
|
||||
Benefits: ["Loose coupling", "Scalability", "Audit trail", "Temporal decoupling"]
|
||||
```
|
||||
|
||||
## API Design Patterns
|
||||
|
||||
```yaml
|
||||
REST_API_Patterns:
|
||||
Resource_Design:
|
||||
Principles: ["Resource-oriented URLs", "Nouns not verbs", "Hierarchical structure"]
|
||||
URL_Structure: ["Collection: /users", "Resource: /users/123", "Sub-resource: /users/123/orders"]
|
||||
HTTP_Verbs: ["GET (read)", "POST (create)", "PUT (update/replace)", "PATCH (partial update)", "DELETE (remove)"]
|
||||
|
||||
Response_Design:
|
||||
Status_Codes:
|
||||
Success: ["200 OK", "201 Created", "202 Accepted", "204 No Content"]
|
||||
Client_Error: ["400 Bad Request", "401 Unauthorized", "403 Forbidden", "404 Not Found", "409 Conflict"]
|
||||
Server_Error: ["500 Internal Server Error", "502 Bad Gateway", "503 Service Unavailable"]
|
||||
|
||||
Response_Format:
|
||||
JSON_Structure: ["Consistent format", "Error objects", "Metadata inclusion"]
|
||||
Pagination: ["Offset/limit", "Cursor-based", "Link headers"]
|
||||
Filtering: ["Query parameters", "Field selection", "Search syntax"]
|
||||
|
||||
API_Evolution:
|
||||
Versioning_Strategies:
|
||||
URL_Versioning: "/v1/users", "/v2/users"
|
||||
Header_Versioning: "Accept: application/vnd.api+json;version=1"
|
||||
Parameter_Versioning: "/users?version=1"
|
||||
|
||||
Backward_Compatibility: ["Additive changes", "Optional fields", "Deprecation notices"]
|
||||
|
||||
Security_Patterns:
|
||||
Authentication: ["JWT tokens", "OAuth 2.0", "API keys", "Basic auth"]
|
||||
Authorization: ["Role-based", "Permission-based", "Resource-based", "Attribute-based"]
|
||||
Rate_Limiting: ["Fixed window", "Sliding window", "Token bucket", "Leaky bucket"]
|
||||
|
||||
HATEOAS:
|
||||
Definition: "Hypermedia as the Engine of Application State"
|
||||
Implementation: ["Link relations", "Resource navigation", "State transitions"]
|
||||
Benefits: ["Discoverability", "Loose coupling", "Evolvability"]
|
||||
```
|
||||
|
||||
## GraphQL Patterns
|
||||
|
||||
```yaml
|
||||
GraphQL_Design:
|
||||
Schema_Design:
|
||||
Type_System: ["Scalar types", "Object types", "Interface types", "Union types", "Enum types"]
|
||||
Field_Design: ["Nullable vs non-null", "Field arguments", "Default values"]
|
||||
Schema_Stitching: ["Multiple services", "Schema federation", "Gateway patterns"]
|
||||
|
||||
Query_Patterns:
|
||||
Query_Structure: ["Nested queries", "Field selection", "Fragment usage"]
|
||||
Variables: ["Typed variables", "Default values", "Directive usage"]
|
||||
Batching: ["DataLoader patterns", "Query batching", "Request coalescing"]
|
||||
|
||||
Mutation_Patterns:
|
||||
Mutation_Design: ["Input types", "Payload types", "Error handling"]
|
||||
Optimistic_Updates: ["Client-side updates", "Rollback strategies"]
|
||||
Bulk_Operations: ["Multiple mutations", "Transaction boundaries"]
|
||||
|
||||
Subscription_Patterns:
|
||||
Real_Time: ["WebSocket connections", "Event-driven updates", "Subscription filtering"]
|
||||
Scalability: ["Connection management", "Memory usage", "Resource cleanup"]
|
||||
|
||||
Performance_Optimization:
|
||||
N_Plus_1_Prevention: ["DataLoader", "Query optimization", "Eager loading"]
|
||||
Query_Complexity: ["Depth limiting", "Cost analysis", "Query timeout"]
|
||||
Caching: ["Field-level caching", "Query result caching", "CDN integration"]
|
||||
```
|
||||
|
||||
## Microservices Architecture Patterns
|
||||
|
||||
```yaml
|
||||
Service_Design:
|
||||
Service_Boundaries:
|
||||
Principles: ["Single responsibility", "Business capability alignment", "Data ownership"]
|
||||
Decomposition: ["Domain-driven boundaries", "Team topology", "Data flow analysis"]
|
||||
Size_Guidelines: ["Small enough to rewrite", "Large enough to be useful", "Team ownership"]
|
||||
|
||||
Communication_Patterns:
|
||||
Synchronous: ["HTTP/REST", "gRPC", "GraphQL"]
|
||||
Asynchronous: ["Message queues", "Event streaming", "Pub/Sub"]
|
||||
Data_Consistency: ["Eventual consistency", "Saga patterns", "Distributed transactions"]
|
||||
|
||||
Data_Management:
|
||||
Database_Per_Service: ["Data isolation", "Technology choice", "Schema evolution"]
|
||||
Data_Synchronization: ["Event sourcing", "Change data capture", "API composition"]
|
||||
|
||||
Deployment_Patterns:
|
||||
Containerization: ["Docker", "Container orchestration", "Service mesh"]
|
||||
CI_CD: ["Pipeline per service", "Independent deployment", "Blue-green deployment"]
|
||||
|
||||
Service_Discovery:
|
||||
Patterns: ["Service registry", "Client-side discovery", "Server-side discovery"]
|
||||
Implementation: ["Consul", "Eureka", "Kubernetes DNS", "API Gateway"]
|
||||
|
||||
Circuit_Breaker:
|
||||
Pattern: "Prevent cascade failures by failing fast"
|
||||
States: ["Closed (normal)", "Open (failing)", "Half-open (testing)"]
|
||||
Implementation: ["Failure threshold", "Timeout", "Recovery testing"]
|
||||
|
||||
Bulkhead_Pattern:
|
||||
Purpose: "Isolate resources to prevent total system failure"
|
||||
Implementation: ["Thread pools", "Connection pools", "Resource isolation"]
|
||||
```
|
||||
|
||||
## Event-Driven Architecture Patterns
|
||||
|
||||
```yaml
|
||||
Event_Patterns:
|
||||
Event_Types:
|
||||
Domain_Events: "Business-significant occurrences"
|
||||
Integration_Events: "Cross-service communication"
|
||||
System_Events: "Technical/infrastructure events"
|
||||
|
||||
Event_Design:
|
||||
Structure: ["Event ID", "Timestamp", "Event type", "Payload", "Metadata"]
|
||||
Naming: ["Past tense", "Business language", "Specific actions"]
|
||||
Versioning: ["Schema evolution", "Backward compatibility", "Event migration"]
|
||||
|
||||
Event_Sourcing:
|
||||
Concept: "Store events as primary source of truth"
|
||||
Implementation: ["Event store", "Event replay", "Snapshots", "Projections"]
|
||||
Benefits: ["Audit trail", "Temporal queries", "Debugging", "Analytics"]
|
||||
|
||||
CQRS:
|
||||
Pattern: "Command Query Responsibility Segregation"
|
||||
Implementation: ["Separate models", "Read/write databases", "Event-driven sync"]
|
||||
Benefits: ["Optimized reads", "Scalable writes", "Complex queries"]
|
||||
|
||||
Saga_Pattern:
|
||||
Purpose: "Manage distributed transactions"
|
||||
Types: ["Orchestration", "Choreography"]
|
||||
Implementation: ["Compensation actions", "State machines", "Event coordination"]
|
||||
```
|
||||
|
||||
## Layered Architecture Patterns
|
||||
|
||||
```yaml
|
||||
Clean_Architecture:
|
||||
Layers:
|
||||
Domain: "Core business logic & entities"
|
||||
Application: "Use cases & orchestration"
|
||||
Infrastructure: "External concerns & frameworks"
|
||||
Presentation: "UI/API & user interfaces"
|
||||
|
||||
Dependency_Rules:
|
||||
Direction: "Dependencies point inward toward domain"
|
||||
Abstraction: "Inner layers define interfaces"
|
||||
Implementation: "Outer layers provide implementations"
|
||||
|
||||
Hexagonal_Architecture:
|
||||
Core: "Application core w/ business logic"
|
||||
Ports: "Interfaces for external communication"
|
||||
Adapters: "Implementations of port interfaces"
|
||||
Benefits: ["Testability", "Technology independence", "Maintainability"]
|
||||
|
||||
Onion_Architecture:
|
||||
Center: "Domain model"
|
||||
Layers: ["Domain services", "Application services", "Infrastructure"]
|
||||
Principles: ["Dependency inversion", "Separation of concerns", "Testability"]
|
||||
```
|
||||
|
||||
## Scalability Patterns
|
||||
|
||||
```yaml
|
||||
Horizontal_Scaling:
|
||||
Load_Balancing:
|
||||
Types: ["Round robin", "Least connections", "IP hash", "Geographic"]
|
||||
Implementation: ["Load balancers", "Service mesh", "DNS-based"]
|
||||
|
||||
Database_Scaling:
|
||||
Read_Replicas: ["Master-slave replication", "Read-only queries", "Consistency trade-offs"]
|
||||
Sharding: ["Horizontal partitioning", "Shard keys", "Cross-shard queries"]
|
||||
|
||||
Vertical_Scaling:
|
||||
Resource_Optimization: ["CPU scaling", "Memory scaling", "Storage scaling"]
|
||||
Limits: ["Hardware constraints", "Cost implications", "Single point of failure"]
|
||||
|
||||
Caching_Strategies:
|
||||
Levels:
|
||||
Application: ["In-memory cache", "Application state", "Computed results"]
|
||||
Database: ["Query result cache", "Connection pooling", "Statement caching"]
|
||||
CDN: ["Static content", "Geographic distribution", "Edge caching"]
|
||||
|
||||
Patterns:
|
||||
Cache_Aside: "Application manages cache"
|
||||
Write_Through: "Write to cache & database"
|
||||
Write_Behind: "Asynchronous database writes"
|
||||
Refresh_Ahead: "Proactive cache refresh"
|
||||
```
|
||||
|
||||
## Integration Patterns
|
||||
|
||||
```yaml
|
||||
Integration_Styles:
|
||||
File_Transfer: ["Batch processing", "Scheduled transfers", "File formats"]
|
||||
Shared_Database: ["Common schema", "Data ownership", "Consistency issues"]
|
||||
Remote_Procedure: ["Synchronous calls", "Strong coupling", "Blocking behavior"]
|
||||
Messaging: ["Asynchronous", "Loose coupling", "Event-driven"]
|
||||
|
||||
Message_Patterns:
|
||||
Point_to_Point: ["Queue-based", "Single consumer", "Load balancing"]
|
||||
Publish_Subscribe: ["Topic-based", "Multiple consumers", "Event broadcasting"]
|
||||
Request_Reply: ["Correlation IDs", "Response routing", "Timeout handling"]
|
||||
|
||||
API_Gateway:
|
||||
Functions: ["Request routing", "Authentication", "Rate limiting", "Response transformation"]
|
||||
Benefits: ["Single entry point", "Cross-cutting concerns", "Protocol translation"]
|
||||
Patterns: ["Backend for frontend", "Micro-gateway", "Service mesh integration"]
|
||||
```
|
||||
|
||||
## Quality Attribute Patterns
|
||||
|
||||
```yaml
|
||||
Performance_Patterns:
|
||||
Response_Time: ["Caching", "CDN", "Database optimization", "Algorithm optimization"]
|
||||
Throughput: ["Load balancing", "Horizontal scaling", "Resource pooling"]
|
||||
Resource_Utilization: ["Connection pooling", "Thread management", "Memory optimization"]
|
||||
|
||||
Reliability_Patterns:
|
||||
Fault_Tolerance: ["Circuit breaker", "Bulkhead", "Timeout", "Retry with backoff"]
|
||||
Recovery: ["Health checks", "Graceful degradation", "Failover", "Self-healing"]
|
||||
Monitoring: ["Metrics collection", "Alerting", "Distributed tracing", "Log aggregation"]
|
||||
|
||||
Security_Patterns:
|
||||
Authentication: ["Multi-factor", "Single sign-on", "Token-based", "Certificate-based"]
|
||||
Authorization: ["RBAC", "ABAC", "OAuth", "JWT"]
|
||||
Data_Protection: ["Encryption at rest", "Encryption in transit", "Key management"]
|
||||
|
||||
Maintainability_Patterns:
|
||||
Modularity: ["Loose coupling", "High cohesion", "Interface segregation"]
|
||||
Testability: ["Dependency injection", "Mock objects", "Test doubles"]
|
||||
Documentation: ["Living documentation", "Architecture decision records", "API documentation"]
|
||||
```
|
||||
|
||||
---
|
||||
*Architecture Patterns v4.0.0 - Comprehensive architectural knowledge patterns for SuperClaude design commands*
|
||||
@@ -1,21 +0,0 @@
|
||||
# Audit Logging
|
||||
|
||||
```yaml
|
||||
Format: <timestamp>|<operation>|<risk>|<user>|<status>|<details>
|
||||
Location: .claudedocs/audit/YYYY-MM-DD.log | Daily rotate | 10MB max | 30d retention
|
||||
|
||||
Risk: CRIT[10] | HIGH[7-9] | MED[4-6] | LOW[1-3]
|
||||
|
||||
Required:
|
||||
- File deletions/overwrites
|
||||
- Git operations (push,force,rebase)
|
||||
- Database operations
|
||||
- Deployments
|
||||
- Security modifications
|
||||
- Checkpoints/rollbacks
|
||||
|
||||
Integration:
|
||||
Start: audit_log("start",op,risk)
|
||||
Success: audit_log("success",op,risk)
|
||||
Failure: audit_log("fail",op,risk,error)
|
||||
```
|
||||
@@ -1,28 +0,0 @@
|
||||
# Checkpoint System
|
||||
|
||||
```yaml
|
||||
Create:
|
||||
Tag: git tag checkpoint/<type>-$(date +%Y%m%d-%H%M%S)
|
||||
Stash: git stash push -m "checkpoint-<operation>-<timestamp>"
|
||||
Manifest: .claude/checkpoints/manifest.yml
|
||||
Summary: .claudedocs/summaries/checkpoint-<type>-<timestamp>.md
|
||||
|
||||
Triggers:
|
||||
Auto: Destructive|Refactor|Migration|Permissions|Deploy
|
||||
Manual: User request|Risky ops|Experiments
|
||||
|
||||
Types: feature|fix|refactor|migrate|deploy|manual
|
||||
|
||||
Rollback:
|
||||
Full: git reset --hard <checkpoint>
|
||||
Selective: git checkout <checkpoint> -- <files>
|
||||
Incremental: git revert <commits>
|
||||
Stash: git stash pop
|
||||
|
||||
Process:
|
||||
- Verify checkpoint exists
|
||||
- Check working tree
|
||||
- Confirm w/ user
|
||||
- Create pre-rollback checkpoint
|
||||
- Execute & verify
|
||||
```
|
||||
@@ -104,4 +104,4 @@ Rollback:
|
||||
- Git commit before cleanup
|
||||
- Backup configs before changes
|
||||
- Document what was removed
|
||||
```
|
||||
```
|
||||
|
||||
@@ -49,4 +49,4 @@ Pattern Learning:
|
||||
Success Patterns: Learn from effective approaches
|
||||
Error Prevention: Remember failure patterns to avoid
|
||||
User Preferences: Adapt to individual working styles
|
||||
```
|
||||
```
|
||||
|
||||
236
.claude/commands/shared/command-patterns.yml
Normal file
236
.claude/commands/shared/command-patterns.yml
Normal file
@@ -0,0 +1,236 @@
|
||||
# Command Patterns - Optimized Templates
|
||||
|
||||
## Legend
|
||||
| Symbol | Meaning | | Abbrev | Meaning |
|
||||
|--------|---------|---|--------|---------|
|
||||
| → | leads to | | cfg | configuration |
|
||||
| & | and/with | | impl | implementation |
|
||||
|
||||
## Command Header Template
|
||||
|
||||
```yaml
|
||||
Command_Header:
|
||||
Execute: "immediate. --plan→show plan first"
|
||||
Legend: "@cmd-specific legend gen"
|
||||
Purpose: "[Action][Subject] in $ARGUMENTS"
|
||||
|
||||
## UltraCompressed Command Structure
|
||||
|
||||
```yaml
|
||||
Cmd_Header:
|
||||
Execute: "immediate. --plan→show plan first"
|
||||
Legend: "@cmd-specific legend gen"
|
||||
Purpose: "[Action][Subject] in $ARGUMENTS"
|
||||
|
||||
Universal_Flags:
|
||||
Planning: "See flag-inheritance.yml"
|
||||
Thinking: "See flag-inheritance.yml"
|
||||
Compression: "See flag-inheritance.yml"
|
||||
MCP_Control: "See flag-inheritance.yml"
|
||||
Execution: "See flag-inheritance.yml"
|
||||
|
||||
Templates:
|
||||
MCP: "See MCP.md"
|
||||
Thinking: "See flag-inheritance.yml"
|
||||
Planning: "See execution-patterns.yml"
|
||||
|
||||
Research_Req:
|
||||
Standard: "@research"
|
||||
External_Libs: "@research"
|
||||
Patterns: "@research"
|
||||
Citations: "@report"
|
||||
|
||||
Output:
|
||||
Location: "@structure"
|
||||
Directory: "@lifecycle"
|
||||
Reference: "@report"
|
||||
|
||||
Error_Handling:
|
||||
Classification: "@severity"
|
||||
Recovery: "@recovery"
|
||||
Actions: "@monitoring"
|
||||
```
|
||||
|
||||
## Cmd Types (UC)
|
||||
|
||||
```yaml
|
||||
Analysis:
|
||||
Struct: "Analyze [subj] w/ [method]"
|
||||
Flags: "--code --arch --sec --perf"
|
||||
Out: "Reports→.claudedocs/reports/"
|
||||
|
||||
Build:
|
||||
Struct: "Build [type] w/ [req]"
|
||||
Flags: "--init --feat --tdd --watch"
|
||||
Out: "Code+tests+docs"
|
||||
|
||||
Workflow:
|
||||
Struct: "[Action] w/ [pattern]"
|
||||
Flags: "--dry-run --interactive --iterate"
|
||||
Out: "Results+metrics"
|
||||
```
|
||||
|
||||
## Shared Flag Descriptions
|
||||
|
||||
```yaml
|
||||
Core_Flags:
|
||||
plan: "Show execution plan before running"
|
||||
think: "Multi-file analysis w/ context (4K)"
|
||||
think_hard: "Deep system analysis (10K)"
|
||||
ultrathink: "Comprehensive analysis (32K)"
|
||||
uc: "UltraCompressed mode (~70% token reduction)"
|
||||
|
||||
MCP_Flags:
|
||||
c7: "Context7→docs & examples"
|
||||
seq: "Sequential→complex thinking"
|
||||
magic: "Magic→UI component generation"
|
||||
pup: "Puppeteer→browser automation"
|
||||
no_mcp: "Disable all MCP servers"
|
||||
|
||||
Quality_Flags:
|
||||
tdd: "Test-driven development"
|
||||
coverage: "Code coverage analysis"
|
||||
validate: "Validation & verification"
|
||||
security: "Security scan & audit"
|
||||
|
||||
Workflow_Flags:
|
||||
dry_run: "Preview w/o execution"
|
||||
watch: "Continuous monitoring"
|
||||
interactive: "Step-by-step guidance"
|
||||
iterate: "Iterative improvement"
|
||||
```
|
||||
|
||||
## Cross-Reference System
|
||||
|
||||
```yaml
|
||||
Instead_Of_Repeating:
|
||||
MCP_Explanations: "@see shared/flag-inheritance.yml#MCP_Control"
|
||||
Thinking_Modes: "@see shared/flag-inheritance.yml#Thinking_Modes"
|
||||
Research_Standards: "@see shared/research-flow-templates.yml"
|
||||
Validation_Rules: "@see shared/validation.yml"
|
||||
Performance_Patterns: "@see shared/performance.yml"
|
||||
|
||||
Template_Usage:
|
||||
Command_Files: "Use patterns directly from shared files"
|
||||
Reference_Format: "shared/[file].yml#[section]"
|
||||
Organization: "Each file contains related patterns"
|
||||
```
|
||||
|
||||
## Token Optimization Patterns
|
||||
|
||||
```yaml
|
||||
Compression_Rules:
|
||||
Articles: Remove "the|a|an" where clear
|
||||
Conjunctions: Replace "and"→"&" | "with"→"w/"
|
||||
Prepositions: Compress "at"→"@" | "to"→"→"
|
||||
Verbose_Phrases: "in order to"→"to" | "make sure"→"ensure"
|
||||
|
||||
Symbol_Expansion:
|
||||
Mathematics: ∀(all) ∃(exists) ∈(member) ⊂(subset) ∪(union) ∩(intersection)
|
||||
Logic: ∴(therefore) ∵(because) ≡(equivalent) ≈(approximately)
|
||||
Process: ▶(start) ⏸(pause) ⏹(stop) ⚡(fast) 🔄(cycle)
|
||||
Quality: ✅(success) ❌(failure) ⚠(warning) 📊(metrics)
|
||||
|
||||
Structure_Priority:
|
||||
1_YAML: Most compact structured data
|
||||
2_Tables: Comparison & reference data
|
||||
3_Lists: Enumeration & sequences
|
||||
4_Prose: Only when necessary
|
||||
|
||||
Abbreviation_Standards:
|
||||
Technical: cfg(config) impl(implementation) perf(performance) val(validation)
|
||||
Actions: analyze→anlz | build→bld | deploy→dply | test→tst
|
||||
Objects: database→db | interface→api | environment→env | dependency→dep
|
||||
```
|
||||
|
||||
## Implementation Notes
|
||||
|
||||
```yaml
|
||||
Usage_Pattern:
|
||||
1_Define_Template: Create in shared/command-templates.yml
|
||||
2_Reference_Template: Use @include in command files
|
||||
3_Override_Specific: Add command-specific details only
|
||||
4_Validate_Consistency: Auto-check cross-references
|
||||
|
||||
Benefits:
|
||||
Token_Reduction: ~40% reduction in command file size
|
||||
Consistency: Standardized patterns across all commands
|
||||
Maintenance: Single source of truth for common elements
|
||||
Scalability: Easy addition of new commands using templates
|
||||
|
||||
Migration_Strategy:
|
||||
Phase_1: Create templates for most common patterns
|
||||
Phase_2: Update existing commands to use templates
|
||||
Phase_3: Implement auto-validation of template usage
|
||||
```
|
||||
|
||||
## Workflow Integration
|
||||
|
||||
```yaml
|
||||
Workflow_References:
|
||||
Core_Patterns: "@see shared/execution-patterns.yml#Development_Workflows"
|
||||
Chain_Execution: "@see shared/execution-patterns.yml#Chain_Execution_Patterns"
|
||||
Git_Operations: "@see shared/execution-patterns.yml#Git_Integration_Patterns"
|
||||
|
||||
Common_Workflows:
|
||||
Full_Stack: "load→analyze→design→build→test→scan→deploy"
|
||||
Feature_Dev: "analyze→build→test→improve→commit"
|
||||
Bug_Fix: "troubleshoot→fix→test→verify→commit"
|
||||
Quality: "analyze→improve→scan→test"
|
||||
```
|
||||
|
||||
## Integration References
|
||||
|
||||
```yaml
|
||||
Error_Handling: "@see shared/quality-patterns.yml#Severity_Framework"
|
||||
Research_Flow: "@see shared/research-patterns.yml#Research_Validation"
|
||||
MCP_Patterns: "@see shared/execution-patterns.yml#MCP_Server_Registry"
|
||||
```
|
||||
|
||||
## Deliverable Templates
|
||||
|
||||
```yaml
|
||||
Code_Deliverables:
|
||||
Commits: type: description | feat|fix|refactor|perf|test|docs | Why>What
|
||||
Documentation: API(endpoints|params|examples) | Code(JSDoc|README) | User(guides|FAQs)
|
||||
Tests: Unit(functions|logic) | Integration(APIs|services) | E2E(flows|paths)
|
||||
|
||||
Report_Deliverables:
|
||||
Performance: Baseline→Current→Improvement% | Time|memory|CPU|network
|
||||
Security: Vulnerabilities→Risk→Fixes | OWASP|deps|auth|data
|
||||
Quality: Coverage|complexity|duplication → Issues→Severity→Resolution
|
||||
|
||||
Artifact_Deliverables:
|
||||
Configs: .env|settings|deployment | Scripts: build|test|deploy|migrate
|
||||
Schemas: Database|API|validation | Assets: Images|styles|components
|
||||
```
|
||||
|
||||
## UltraCompressed Patterns
|
||||
|
||||
```yaml
|
||||
UC_Activation_Patterns:
|
||||
Manual: --uc flag | "ultracompressed" keyword
|
||||
Auto: Context >70% | Token budget specified
|
||||
Smart: Large docs → Suggest compression
|
||||
|
||||
UC_Documentation_Patterns:
|
||||
Start: Legend table | Only used symbols/abbrevs
|
||||
Structure: Lists>prose | Tables>paragraphs | YAML>text
|
||||
Content: Direct info | No fluff | Telegram-style
|
||||
|
||||
UC_Example_Transformations:
|
||||
Normal: "Configure the authentication system by setting environment variables"
|
||||
Compressed: "Auth cfg: set env vars"
|
||||
|
||||
Normal: "This function processes user input and returns validation result"
|
||||
Compressed: "fn: process usr input→validation"
|
||||
|
||||
UC_Token_Savings:
|
||||
Headers: 60-80% reduction
|
||||
Paragraphs: 70-75% reduction
|
||||
Lists: 50-60% reduction
|
||||
Overall: ~70% average reduction
|
||||
```
|
||||
|
||||
---
|
||||
*Command Templates v4.0.0 - Enhanced w/ workflow patterns, deliverables & UC templates from patterns.yml*
|
||||
254
.claude/commands/shared/command-structure.yml
Normal file
254
.claude/commands/shared/command-structure.yml
Normal file
@@ -0,0 +1,254 @@
|
||||
# Command Structure Standards
|
||||
# Standardized patterns for .md command files (not replacements)
|
||||
|
||||
## Legend
|
||||
| Symbol | Meaning | | Abbrev | Meaning |
|
||||
|--------|---------|---|--------|---------|
|
||||
| 📋 | template | | std | standard |
|
||||
| 🏗 | structure | | cmd | command |
|
||||
| ✅ | required | | opt | optional |
|
||||
|
||||
## Standard Command Structure
|
||||
|
||||
```yaml
|
||||
Required_Sections:
|
||||
1_Header:
|
||||
Format: "# /{command-name} - {Brief Description}"
|
||||
Description: "Clear, concise explanation of command purpose"
|
||||
|
||||
2_Legend:
|
||||
Pattern: "@common/legend"
|
||||
Content: "Only symbols actually used in this command"
|
||||
|
||||
3_Purpose:
|
||||
Format: "## Purpose\nSingle sentence describing what this command accomplishes."
|
||||
|
||||
4_Syntax:
|
||||
Format: "## Syntax\n/{command} [flags] [target]"
|
||||
Include: "All available flags with brief descriptions"
|
||||
|
||||
5_Flags:
|
||||
Universal: "@common/flags"
|
||||
Command_Specific: "Document unique flags with examples"
|
||||
|
||||
6_Examples:
|
||||
Required: "At least 3 examples showing different use cases"
|
||||
Format: "Command → Expected outcome"
|
||||
|
||||
7_Deliverables:
|
||||
What: "What files/outputs are created"
|
||||
Where: "Where outputs are stored"
|
||||
Format: "What format outputs use"
|
||||
|
||||
8_Integration:
|
||||
Lifecycle: "@common/lifecycle"
|
||||
Prerequisites: "What needs to exist before running"
|
||||
Next_Steps: "What to do after this command"
|
||||
|
||||
Optional_Sections:
|
||||
Advanced_Usage: "Complex scenarios and edge cases"
|
||||
Troubleshooting: "Common issues and solutions"
|
||||
Related_Commands: "Commands often used together"
|
||||
Performance_Notes: "Optimization tips"
|
||||
```
|
||||
|
||||
## Command Categories
|
||||
|
||||
```yaml
|
||||
Analysis_Commands:
|
||||
Pattern: "analyze, load, explain, troubleshoot"
|
||||
Focus: "Understanding and diagnosis"
|
||||
Common_Flags: "@analyze/flags"
|
||||
Output: "Reports in .claudedocs/analysis/"
|
||||
|
||||
Build_Commands:
|
||||
Pattern: "build, spawn"
|
||||
Focus: "Creating and generating"
|
||||
Common_Flags: "@build/flags"
|
||||
Output: "Generated code and components"
|
||||
|
||||
Quality_Commands:
|
||||
Pattern: "test, scan, improve"
|
||||
Focus: "Validation and enhancement"
|
||||
Common_Flags: "@quality/flags"
|
||||
Output: "Quality reports and fixes"
|
||||
|
||||
Operations_Commands:
|
||||
Pattern: "deploy, migrate, cleanup"
|
||||
Focus: "System operations"
|
||||
Common_Flags: "@ops/flags"
|
||||
Output: "Operation logs and status"
|
||||
|
||||
Documentation_Commands:
|
||||
Pattern: "document, estimate"
|
||||
Focus: "Documentation and planning"
|
||||
Common_Flags: "@docs/flags"
|
||||
Output: "Documentation files"
|
||||
```
|
||||
|
||||
## Flag Inheritance Rules
|
||||
|
||||
```yaml
|
||||
Universal_Flags:
|
||||
Always_Available:
|
||||
"--plan": "Show execution plan before proceeding"
|
||||
"--uc": "Use ultra-compressed output format"
|
||||
"--think": "Enable thinking mode for complex operations"
|
||||
"--no-mcp": "Disable all MCP servers"
|
||||
|
||||
MCP_Control_Flags:
|
||||
Context_Research:
|
||||
"--c7": "Force Context7 for documentation lookup"
|
||||
"--no-c7": "Disable Context7"
|
||||
Analysis:
|
||||
"--seq": "Force Sequential thinking"
|
||||
"--no-seq": "Disable Sequential thinking"
|
||||
UI_Generation:
|
||||
"--magic": "Force Magic component generation"
|
||||
"--no-magic": "Disable Magic"
|
||||
Browser_Testing:
|
||||
"--pup": "Force Puppeteer browser automation"
|
||||
"--no-pup": "Disable Puppeteer"
|
||||
|
||||
Quality_Flags:
|
||||
Validation:
|
||||
"--validate": "Extra validation checks"
|
||||
"--strict": "Strict mode with enhanced checks"
|
||||
"--safe": "Conservative mode for critical operations"
|
||||
Output:
|
||||
"--verbose": "Detailed output and logging"
|
||||
"--quiet": "Minimal output"
|
||||
"--format {type}": "Output format (json, yaml, markdown)"
|
||||
```
|
||||
|
||||
## Example Templates
|
||||
|
||||
```yaml
|
||||
Minimal_Command:
|
||||
Header: "# /example - Brief description"
|
||||
Legend: "@common/legend"
|
||||
Purpose: "Single sentence purpose"
|
||||
Syntax: "/example [--flag] [target]"
|
||||
Flags: "@common/flags + command-specific"
|
||||
Examples: "3 practical examples"
|
||||
Deliverables: "What is created/modified"
|
||||
Integration: "@common/lifecycle"
|
||||
|
||||
Standard_Command:
|
||||
All_Minimal_Sections: "Plus:"
|
||||
Advanced_Usage: "Complex scenarios"
|
||||
Troubleshooting: "Common issues"
|
||||
Related: "Often used with X, Y, Z"
|
||||
|
||||
Complex_Command:
|
||||
All_Standard_Sections: "Plus:"
|
||||
Performance: "Optimization notes"
|
||||
Security: "Security considerations"
|
||||
Architecture: "System integration details"
|
||||
```
|
||||
|
||||
## Consistency Patterns
|
||||
|
||||
```yaml
|
||||
Naming_Conventions:
|
||||
Commands: "Verb form: analyze, build, deploy (not analysis, builder)"
|
||||
Flags: "Kebab-case: --think-hard, --no-magic"
|
||||
Outputs: "{command}-{timestamp}.{ext}"
|
||||
|
||||
Language_Patterns:
|
||||
Present_Tense: "Analyze the codebase" (not "Will analyze")
|
||||
Active_Voice: "Creates components" (not "Components are created")
|
||||
Imperative: "Use this flag to..." (not "This flag can be used")
|
||||
|
||||
Output_Patterns:
|
||||
Success_Messages: "@common/success"
|
||||
Error_Handling: "@common/recovery"
|
||||
Progress_Indicators: "Consistent format across commands"
|
||||
|
||||
Reference_Patterns:
|
||||
Frequent_Includes: "Use @common/* aliases"
|
||||
Template_References: "Point to consolidated templates"
|
||||
Cross_References: "Link related commands and concepts"
|
||||
```
|
||||
|
||||
## Validation Checklist
|
||||
|
||||
```yaml
|
||||
Required_Elements:
|
||||
Structure: "All required sections present"
|
||||
Legend: "Only used symbols included"
|
||||
Examples: "At least 3 working examples"
|
||||
Flags: "All documented with descriptions"
|
||||
Integration: "Lifecycle hooks included"
|
||||
|
||||
Quality_Checks:
|
||||
Links: "All @include references valid"
|
||||
Consistency: "Follows naming conventions"
|
||||
Completeness: "No placeholder text"
|
||||
Accuracy: "Examples actually work"
|
||||
|
||||
Optimization_Checks:
|
||||
References: "Uses aliases where possible"
|
||||
Duplication: "No repeated content"
|
||||
Length: "Appropriate level of detail"
|
||||
Format: "Consistent with other commands"
|
||||
```
|
||||
|
||||
## Migration Guidelines
|
||||
|
||||
```yaml
|
||||
Existing_Commands:
|
||||
Phase_1: "Update references to use @common/* aliases"
|
||||
Phase_2: "Standardize structure using these patterns"
|
||||
Phase_3: "Enhance with missing sections"
|
||||
Phase_4: "Optimize for consistency"
|
||||
|
||||
New_Commands:
|
||||
Template: "Use standard command template"
|
||||
Review: "Check against validation checklist"
|
||||
Test: "Verify all examples work"
|
||||
Integrate: "Ensure proper lifecycle integration"
|
||||
|
||||
Maintenance:
|
||||
Regular: "Monthly structure review"
|
||||
Updates: "Keep examples current"
|
||||
Optimization: "Reduce duplication"
|
||||
Evolution: "Adapt patterns as needed"
|
||||
```
|
||||
|
||||
## Command Relationship Matrix
|
||||
|
||||
```yaml
|
||||
Command_Chains:
|
||||
Feature_Development:
|
||||
Primary: "analyze → design → build → test"
|
||||
Secondary: "scan → document → deploy"
|
||||
|
||||
Bug_Investigation:
|
||||
Primary: "troubleshoot → analyze → improve"
|
||||
Secondary: "test → document"
|
||||
|
||||
Quality_Improvement:
|
||||
Primary: "scan → analyze → improve → test"
|
||||
Secondary: "document → deploy"
|
||||
|
||||
Architecture_Review:
|
||||
Primary: "load → analyze → design → document"
|
||||
Secondary: "estimate → improve"
|
||||
|
||||
Prerequisites:
|
||||
build: "analyze (understand codebase)"
|
||||
test: "build (have something to test)"
|
||||
deploy: "test (verify functionality)"
|
||||
improve: "analyze (understand issues)"
|
||||
scan: "load (have codebase loaded)"
|
||||
|
||||
Common_Combinations:
|
||||
analysis_workflow: "load + analyze + explain"
|
||||
development_workflow: "build + test + scan + deploy"
|
||||
quality_workflow: "scan + improve + test + document"
|
||||
investigation_workflow: "troubleshoot + analyze + improve"
|
||||
```
|
||||
|
||||
---
|
||||
*Command Structure Standards v4.0.0 - Patterns for consistent, maintainable command definitions*
|
||||
@@ -1,167 +0,0 @@
|
||||
# Command Templates - Token Optimized Patterns
|
||||
|
||||
## Legend
|
||||
| Symbol | Meaning | | Abbrev | Meaning |
|
||||
|--------|---------|---|--------|---------|
|
||||
| → | leads to | | cfg | configuration |
|
||||
| & | and/with | | impl | implementation |
|
||||
| w/ | with | | perf | performance |
|
||||
| @ | at/located | | ops | operations |
|
||||
| ∀ | for all/every | | val | validation |
|
||||
| ∃ | exists/there is | | req | requirements |
|
||||
|
||||
## Universal Command Structure Template
|
||||
|
||||
```yaml
|
||||
Command_Header:
|
||||
Execute: "immediately. Add --plan flag if user wants to see plan first."
|
||||
Legend: "@command-specific legend generation"
|
||||
Purpose: "[Action] [Subject] specified in $ARGUMENTS"
|
||||
|
||||
Universal_Flags:
|
||||
Planning: "@include shared/constants.yml#Standard_Flags.Planning"
|
||||
Thinking: "@include shared/constants.yml#Standard_Flags.Thinking"
|
||||
Compression: "@include shared/constants.yml#Standard_Flags.Compression"
|
||||
MCP_Control: "@include shared/constants.yml#Standard_Flags.MCP_Control"
|
||||
Execution: "@include shared/constants.yml#Standard_Flags.Execution"
|
||||
|
||||
Flag_Templates:
|
||||
MCP_Control: "@see shared/mcp-flags.yml"
|
||||
Thinking_Modes: "@see shared/thinking-modes.yml"
|
||||
Planning_Mode: "@see shared/planning-mode.yml"
|
||||
|
||||
Research_Requirements:
|
||||
Standard: "@include shared/research-first.yml#Research_Policy"
|
||||
External_Libs: "@include shared/research-first.yml#Library_Requirements"
|
||||
Patterns: "@include shared/research-first.yml#Pattern_Verification"
|
||||
Citations: "@include shared/constants.yml#Standard_Messages.Report_References"
|
||||
|
||||
Report_Output:
|
||||
Location: "@include shared/constants.yml#Documentation_Paths"
|
||||
Directory: "@include shared/execution-lifecycle.yml#Preparation_Actions"
|
||||
Reference: "@include shared/constants.yml#Standard_Messages.Report_References"
|
||||
|
||||
Error_Handling:
|
||||
Classification: "@include shared/severity-levels.yml#Severity_Levels"
|
||||
Recovery: "@include shared/error-handling.yml#Recovery_Strategies"
|
||||
Escalation: "@include shared/severity-levels.yml#Escalation_Pathways"
|
||||
```
|
||||
|
||||
## Command Type Templates
|
||||
|
||||
```yaml
|
||||
Analysis_Commands:
|
||||
Structure: "Analyze [subject] using [method]"
|
||||
Flags: "--code --architecture --security --performance"
|
||||
Output: "Analysis reports→.claudedocs/reports/"
|
||||
|
||||
Build_Commands:
|
||||
Structure: "Build [type] w/ [requirements]"
|
||||
Flags: "--init --feature --tdd --watch"
|
||||
Output: "Working code + tests + docs"
|
||||
|
||||
Workflow_Commands:
|
||||
Structure: "[Action] using [workflow] pattern"
|
||||
Flags: "--dry-run --interactive --iterate"
|
||||
Output: "Process results + metrics"
|
||||
```
|
||||
|
||||
## Shared Flag Descriptions
|
||||
|
||||
```yaml
|
||||
Core_Flags:
|
||||
plan: "Show execution plan before running"
|
||||
think: "Multi-file analysis w/ context (4K)"
|
||||
think_hard: "Deep system analysis (10K)"
|
||||
ultrathink: "Comprehensive analysis (32K)"
|
||||
uc: "UltraCompressed mode (~70% token reduction)"
|
||||
|
||||
MCP_Flags:
|
||||
c7: "Context7→docs & examples"
|
||||
seq: "Sequential→complex thinking"
|
||||
magic: "Magic→UI component generation"
|
||||
pup: "Puppeteer→browser automation"
|
||||
no_mcp: "Disable all MCP servers"
|
||||
|
||||
Quality_Flags:
|
||||
tdd: "Test-driven development"
|
||||
coverage: "Code coverage analysis"
|
||||
validate: "Validation & verification"
|
||||
security: "Security scan & audit"
|
||||
|
||||
Workflow_Flags:
|
||||
dry_run: "Preview w/o execution"
|
||||
watch: "Continuous monitoring"
|
||||
interactive: "Step-by-step guidance"
|
||||
iterate: "Iterative improvement"
|
||||
```
|
||||
|
||||
## Cross-Reference System
|
||||
|
||||
```yaml
|
||||
Instead_Of_Repeating:
|
||||
MCP_Explanations: "@see shared/mcp-flags.yml"
|
||||
Thinking_Modes: "@see shared/thinking-modes.yml"
|
||||
Research_Standards: "@see shared/research-first.yml"
|
||||
Validation_Rules: "@see shared/validation.yml"
|
||||
Performance_Patterns: "@see shared/performance.yml"
|
||||
|
||||
Template_Usage:
|
||||
Command_File: |
|
||||
@include shared/command-templates.yml#Analysis_Commands
|
||||
@flags shared/command-templates.yml#Core_Flags,MCP_Flags
|
||||
|
||||
Reference_Format: "@see [file]#[section]"
|
||||
Include_Format: "@include [file]#[section]"
|
||||
```
|
||||
|
||||
## Token Optimization Patterns
|
||||
|
||||
```yaml
|
||||
Compression_Rules:
|
||||
Articles: Remove "the|a|an" where clear
|
||||
Conjunctions: Replace "and"→"&" | "with"→"w/"
|
||||
Prepositions: Compress "at"→"@" | "to"→"→"
|
||||
Verbose_Phrases: "in order to"→"to" | "make sure"→"ensure"
|
||||
|
||||
Symbol_Expansion:
|
||||
Mathematics: ∀(all) ∃(exists) ∈(member) ⊂(subset) ∪(union) ∩(intersection)
|
||||
Logic: ∴(therefore) ∵(because) ≡(equivalent) ≈(approximately)
|
||||
Process: ▶(start) ⏸(pause) ⏹(stop) ⚡(fast) 🔄(cycle)
|
||||
Quality: ✅(success) ❌(failure) ⚠(warning) 📊(metrics)
|
||||
|
||||
Structure_Priority:
|
||||
1_YAML: Most compact structured data
|
||||
2_Tables: Comparison & reference data
|
||||
3_Lists: Enumeration & sequences
|
||||
4_Prose: Only when necessary
|
||||
|
||||
Abbreviation_Standards:
|
||||
Technical: cfg(config) impl(implementation) perf(performance) val(validation)
|
||||
Actions: analyze→anlz | build→bld | deploy→dply | test→tst
|
||||
Objects: database→db | interface→api | environment→env | dependency→dep
|
||||
```
|
||||
|
||||
## Implementation Notes
|
||||
|
||||
```yaml
|
||||
Usage_Pattern:
|
||||
1_Define_Template: Create in shared/command-templates.yml
|
||||
2_Reference_Template: Use @include in command files
|
||||
3_Override_Specific: Add command-specific details only
|
||||
4_Validate_Consistency: Auto-check cross-references
|
||||
|
||||
Benefits:
|
||||
Token_Reduction: ~40% reduction in command file size
|
||||
Consistency: Standardized patterns across all commands
|
||||
Maintenance: Single source of truth for common elements
|
||||
Scalability: Easy addition of new commands using templates
|
||||
|
||||
Migration_Strategy:
|
||||
Phase_1: Create templates for most common patterns
|
||||
Phase_2: Update existing commands to use templates
|
||||
Phase_3: Implement auto-validation of template usage
|
||||
```
|
||||
|
||||
---
|
||||
*Command Templates v1.0 - Token-optimized reusable patterns for SuperClaude commands*
|
||||
300
.claude/commands/shared/compression-patterns.yml
Normal file
300
.claude/commands/shared/compression-patterns.yml
Normal file
@@ -0,0 +1,300 @@
|
||||
# Compression Templates
|
||||
# Consolidated from ultracompressed.yml + task-ultracompressed.yml
|
||||
|
||||
## Legend
|
||||
| Symbol | Meaning | | Abbrev | Meaning |
|
||||
|--------|---------|---|--------|---------|
|
||||
| → | leads to | | cfg | configuration |
|
||||
| & | and/with | | impl | implementation |
|
||||
| w/ | with | | req | requirements |
|
||||
| w/o | without | | deps | dependencies |
|
||||
| ∴ | therefore | | env | environment |
|
||||
| ∵ | because | | docs | documentation |
|
||||
| ≈ | approximately | | auth | authentication |
|
||||
| ∀ | for all | | db | database |
|
||||
| ∃ | exists | | api | interface |
|
||||
|
||||
## UltraCompressed Mode Configuration
|
||||
|
||||
```yaml
|
||||
Activation_Triggers:
|
||||
Manual_Flags: ["--ultracompressed", "--uc"]
|
||||
Natural_Language: ["ultracompressed", "minimal tokens", "telegram style", "compress output"]
|
||||
Automatic_Triggers:
|
||||
Context_Threshold: ">70% context used"
|
||||
Token_Budget: "User specifies token limit"
|
||||
Session_History: "User previously requested compression"
|
||||
Task_Operations: "Always for task files"
|
||||
|
||||
Core_Compression_Rules:
|
||||
Remove_Words:
|
||||
Articles: ["the", "a", "an"]
|
||||
Conjunctions: ["and", "or", "but", "however", "therefore", "moreover"]
|
||||
Prepositions: ["of", "in", "on", "at", "to", "for", "with", "from", "by", "about"]
|
||||
Fillers: ["that", "which", "who", "very", "really", "quite", "just", "actually"]
|
||||
Verbose_Phrases:
|
||||
"in order to": "to"
|
||||
"make sure": "ensure"
|
||||
"as well as": "&"
|
||||
"due to the fact that": "∵"
|
||||
"in the event that": "if"
|
||||
|
||||
Symbol_Mappings:
|
||||
Process_Flow:
|
||||
"→": ["to", "leads to", "results in", "yields", "produces"]
|
||||
"←": ["from", "comes from", "derived from"]
|
||||
"↔": ["bidirectional", "two-way", "mutual"]
|
||||
|
||||
Logical_Operators:
|
||||
"&": ["and", "with", "plus", "including"]
|
||||
"|": ["or", "alternatively", "either"]
|
||||
"!": ["not", "exclude", "without"]
|
||||
|
||||
Mathematical:
|
||||
"≈": ["approximately", "about", "roughly", "circa"]
|
||||
"≡": ["equivalent to", "same as", "identical to"]
|
||||
"≠": ["not equal", "different from", "unlike"]
|
||||
"∀": ["for all", "every", "each", "universal"]
|
||||
"∃": ["exists", "there is", "some", "at least one"]
|
||||
|
||||
Relationships:
|
||||
"⊂": ["subset of", "part of", "contained in"]
|
||||
"∈": ["member of", "belongs to", "in"]
|
||||
"∪": ["union", "combined", "merged"]
|
||||
"∩": ["intersection", "overlap", "common"]
|
||||
```
|
||||
|
||||
## Standard Abbreviations
|
||||
|
||||
```yaml
|
||||
Technical_Abbreviations:
|
||||
Core_Terms:
|
||||
cfg: configuration impl: implementation
|
||||
req: requirements deps: dependencies
|
||||
env: environment auth: authentication
|
||||
db: database api: interface/API
|
||||
fn: function var: variable
|
||||
param: parameter arg: argument
|
||||
val: value ret: return
|
||||
|
||||
Development_Terms:
|
||||
dev: development prod: production
|
||||
qa: quality assurance ci: continuous integration
|
||||
cd: continuous delivery repo: repository
|
||||
pr: pull request pkg: package
|
||||
lib: library mod: module
|
||||
|
||||
Data_Types:
|
||||
str: string num: number
|
||||
bool: boolean arr: array
|
||||
obj: object dict: dictionary
|
||||
int: integer float: floating point
|
||||
|
||||
Operations:
|
||||
init: initialize exec: execute
|
||||
proc: process gen: generate
|
||||
upd: update del: delete
|
||||
chk: check val: validate
|
||||
|
||||
Status_Terms:
|
||||
err: error msg: message
|
||||
resp: response req: request
|
||||
usr: user sys: system
|
||||
ctx: context ref: reference
|
||||
```
|
||||
|
||||
## Structure Formatting Rules
|
||||
|
||||
```yaml
|
||||
Content_Hierarchy:
|
||||
1_YAML_JSON: "Most token-efficient for structured data"
|
||||
2_Tables: "Compact comparison & reference data"
|
||||
3_Bullet_Lists: "Quick enumeration, no sentences"
|
||||
4_Numbered_Lists: "Sequential steps only"
|
||||
5_Prose: "Avoid unless absolutely necessary"
|
||||
|
||||
Heading_Rules:
|
||||
Max_Length: "20 characters"
|
||||
Format: "No articles, symbols OK"
|
||||
Examples:
|
||||
Bad: "Getting Started with Authentication"
|
||||
Good: "Auth Setup"
|
||||
|
||||
Sentence_Rules:
|
||||
Max_Length: "50 characters"
|
||||
Style: "Telegram-style, minimal punctuation"
|
||||
Examples:
|
||||
Bad: "The function processes the input and returns a validated result."
|
||||
Good: "fn: process input→validated result"
|
||||
|
||||
Paragraph_Rules:
|
||||
Max_Length: "100 characters"
|
||||
Max_Sentences: "3 per paragraph"
|
||||
Preference: "Use lists instead"
|
||||
|
||||
List_Rules:
|
||||
Format: "Bullets > numbers"
|
||||
Content: "Key info only, no full sentences"
|
||||
Nesting: "Max 2 levels"
|
||||
```
|
||||
|
||||
## Task-Specific Compression
|
||||
|
||||
```yaml
|
||||
Task_File_Format:
|
||||
Always_Compressed: true
|
||||
No_Exceptions: "All task files use UC format"
|
||||
|
||||
Header_Template: |
|
||||
# Legend: {used_symbols_only}
|
||||
|
||||
T: {title}
|
||||
ID: {id} | S: {status} | P: {priority}
|
||||
Branch: {branch}
|
||||
|
||||
Phase_Format:
|
||||
Template: "- {symbol} {phase}: {brief_description}"
|
||||
Symbols:
|
||||
"□": "pending phase"
|
||||
"◐": "in-progress phase"
|
||||
"✓": "completed phase"
|
||||
"⚠": "blocked phase"
|
||||
|
||||
Context_Format:
|
||||
Decisions: "Dec: {key_decisions}"
|
||||
Blockers: "Block: {active_blockers}"
|
||||
Files: "Files: {affected_files}"
|
||||
Next: "Next: {immediate_next_step}"
|
||||
|
||||
Progress_Format:
|
||||
Todos: "Todos: {active}/{total}"
|
||||
Completion: "Done: {percentage}%"
|
||||
Time: "Est: {estimated_remaining}"
|
||||
```
|
||||
|
||||
## Content Transformation Examples
|
||||
|
||||
```yaml
|
||||
Documentation_Examples:
|
||||
Before: "This comprehensive guide provides an introduction to getting started with the authentication system"
|
||||
After: "Auth Setup Guide"
|
||||
|
||||
Before: "In order to configure the database connection, you need to set the following environment variables"
|
||||
After: "DB cfg: set env vars:"
|
||||
|
||||
Before: "The function takes three parameters and returns a boolean value indicating success or failure"
|
||||
After: "fn(3 params)→bool (success/fail)"
|
||||
|
||||
Code_Comments:
|
||||
Before: "// This method validates the user input and returns true if valid"
|
||||
After: "// validate user input→bool"
|
||||
|
||||
Before: "/* Configure the application settings based on environment */"
|
||||
After: "/* cfg app per env */"
|
||||
|
||||
Error_Messages:
|
||||
Before: "Unable to connect to the database. Please check your connection settings."
|
||||
After: "DB connect fail. Check cfg."
|
||||
|
||||
Before: "The requested resource could not be found on the server."
|
||||
After: "Resource not found (404)"
|
||||
```
|
||||
|
||||
## Quality Assurance
|
||||
|
||||
```yaml
|
||||
Compression_Metrics:
|
||||
Token_Reduction:
|
||||
Target: "70% reduction"
|
||||
Minimum: "50% reduction"
|
||||
Measure: "Compare before/after token count"
|
||||
|
||||
Clarity_Preservation:
|
||||
Requirement: ">80% information retained"
|
||||
Test: "Key facts still accessible"
|
||||
Validation: "No critical info lost"
|
||||
|
||||
Legend_Requirements:
|
||||
Always_Include: "Start of each document"
|
||||
Content: "Only symbols/abbreviations actually used"
|
||||
Format: "Compact table format"
|
||||
Update: "When new symbols introduced"
|
||||
|
||||
Performance_Guidelines:
|
||||
When_Most_Effective:
|
||||
- "Large documentation files"
|
||||
- "Repetitive content"
|
||||
- "Status reports"
|
||||
- "Configuration files"
|
||||
- "Task descriptions"
|
||||
|
||||
When_To_Avoid:
|
||||
- "Legal documents"
|
||||
- "API contracts"
|
||||
- "Security policies"
|
||||
- "User-facing errors"
|
||||
```
|
||||
|
||||
## Auto-Application Rules
|
||||
|
||||
```yaml
|
||||
Context_Sensitive_Compression:
|
||||
High_Context_Usage:
|
||||
Threshold: ">70%"
|
||||
Action: "Auto-enable UC mode"
|
||||
Notice: "⚡ UC mode: high context"
|
||||
|
||||
Token_Budget_Specified:
|
||||
Detection: "User mentions token limit"
|
||||
Action: "Apply compression to fit"
|
||||
Notice: "⚡ UC mode: token budget"
|
||||
|
||||
Task_Operations:
|
||||
Scope: "All task file operations"
|
||||
Action: "Always use compressed format"
|
||||
Notice: "Task format: UC"
|
||||
|
||||
Progressive_Compression:
|
||||
Level_1_Light:
|
||||
Context: "50-70%"
|
||||
Actions: "Remove articles, use common abbreviations"
|
||||
|
||||
Level_2_Medium:
|
||||
Context: "70-85%"
|
||||
Actions: "Full UC mode, all rules active"
|
||||
|
||||
Level_3_Heavy:
|
||||
Context: ">85%"
|
||||
Actions: "Extreme compression, summary only"
|
||||
```
|
||||
|
||||
## Integration Points
|
||||
|
||||
```yaml
|
||||
Command_Integration:
|
||||
Flag_Usage:
|
||||
All_Commands: "--uc flag available universally"
|
||||
Auto_Enable: "Task commands always compressed"
|
||||
|
||||
Report_Generation:
|
||||
Default: "Normal format"
|
||||
With_UC: "Compressed format on request"
|
||||
|
||||
Documentation:
|
||||
Creation: "Check --uc flag"
|
||||
Updates: "Preserve existing format"
|
||||
|
||||
Usage_Examples:
|
||||
Command_Line:
|
||||
"/analyze --code --uc"
|
||||
"/document --api --uc"
|
||||
"/task:create 'Build auth' (auto-compressed)"
|
||||
|
||||
Natural_Language:
|
||||
"Analyze code in ultracompressed format"
|
||||
"Create minimal token documentation"
|
||||
"Use telegram style for this report"
|
||||
```
|
||||
|
||||
---
|
||||
*Compression Templates v4.0.0 - Token-efficient communication patterns for SuperClaude*
|
||||
@@ -1,206 +0,0 @@
|
||||
# Config Validation System
|
||||
|
||||
## Legend
|
||||
| Symbol | Meaning | | Abbrev | Meaning |
|
||||
|--------|---------|---|--------|---------|
|
||||
| → | leads to | | cfg | configuration |
|
||||
| & | and/with | | val | validation |
|
||||
| ✅ | valid/success | | req | required |
|
||||
| ❌ | invalid/error | | dep | dependency |
|
||||
|
||||
## Validation Rules
|
||||
|
||||
```yaml
|
||||
Core_Config_Files:
|
||||
Required_Files:
|
||||
- ~/.claude/CLAUDE.md
|
||||
- ~/.claude/RULES.md
|
||||
- ~/.claude/PERSONAS.md
|
||||
- ~/.claude/MCP.md
|
||||
|
||||
YAML_Syntax_Check:
|
||||
Tool: "yamllint --strict"
|
||||
Rules: "No syntax errors, proper indentation, valid structure"
|
||||
Action_On_Fail: "Block loading, show specific line errors"
|
||||
|
||||
Cross_Reference_Validation:
|
||||
Persona_Command_Matrix:
|
||||
Check: "All personas reference valid commands"
|
||||
Example: "architect → /user:design --api (must exist)"
|
||||
|
||||
MCP_Server_References:
|
||||
Check: "All MCP flags reference available servers"
|
||||
Valid: "--c7 --seq --magic --pup"
|
||||
Invalid: "--unknown-mcp"
|
||||
|
||||
Shared_Resource_Links:
|
||||
Check: "@see shared/file.yml references exist"
|
||||
Pattern: "@see shared/([^\\s]+)"
|
||||
Validation: "File exists & section valid"
|
||||
|
||||
Command_Flag_Consistency:
|
||||
Check: "Universal flags defined consistently"
|
||||
Universal: "--plan --think --think-hard --ultrathink --uc"
|
||||
MCP: "--c7 --seq --magic --pup --no-mcp"
|
||||
```
|
||||
|
||||
## Dependency Validation
|
||||
|
||||
```yaml
|
||||
Command_Dependencies:
|
||||
Required_Sections:
|
||||
- Legend (w/ symbols used in file)
|
||||
- Command description
|
||||
- Examples
|
||||
- Deliverables
|
||||
|
||||
Flag_Definitions:
|
||||
Check: "All flags mentioned have descriptions"
|
||||
Pattern: "--([a-z-]+)"
|
||||
Validation: "Flag documented in file or shared templates"
|
||||
|
||||
MCP_Integration:
|
||||
Consistency: "MCP usage matches persona preferences"
|
||||
Example: "frontend persona → prefers --magic flag"
|
||||
|
||||
Research_Requirements:
|
||||
Check: "All commands reference research-first.yml"
|
||||
Required: "@see shared/research-first.yml"
|
||||
|
||||
Shared_Resource_Dependencies:
|
||||
Template_Usage:
|
||||
Pattern: "@include shared/([^#]+)#([^\\s]+)"
|
||||
Validation: "Template file exists & section defined"
|
||||
|
||||
Cross_References:
|
||||
Pattern: "@see shared/([^\\s]+)"
|
||||
Validation: "Referenced files exist & accessible"
|
||||
|
||||
Symbol_Consistency:
|
||||
Check: "Symbols used match legend definitions"
|
||||
Validation: "All symbols (→ & w/ @) defined in legend"
|
||||
```
|
||||
|
||||
## Validation Implementation
|
||||
|
||||
```yaml
|
||||
Pre_Load_Checks:
|
||||
1_File_Existence:
|
||||
Check: "All required files present"
|
||||
Action: "Create missing w/ defaults or block"
|
||||
|
||||
2_YAML_Syntax:
|
||||
Tool: "Built-in YAML parser"
|
||||
Report: "Line-specific syntax errors"
|
||||
|
||||
3_Cross_References:
|
||||
Check: "All @see & @include links valid"
|
||||
Report: "Broken references w/ suggestions"
|
||||
|
||||
4_Consistency:
|
||||
Check: "Persona↔command↔MCP alignment"
|
||||
Report: "Inconsistencies w/ recommended fixes"
|
||||
|
||||
Runtime_Validation:
|
||||
Command_Execution:
|
||||
Check: "Requested command exists & valid"
|
||||
Check: "All flags recognized"
|
||||
Check: "MCP servers available"
|
||||
|
||||
Context_Validation:
|
||||
Check: "Required dependencies present"
|
||||
Check: "Permissions adequate"
|
||||
Check: "No circular references"
|
||||
|
||||
Auto_Repair:
|
||||
Missing_Sections:
|
||||
Action: "Generate w/ templates"
|
||||
Example: "Missing legend → auto-generate from symbols used"
|
||||
|
||||
Broken_References:
|
||||
Action: "Suggest alternatives or create stubs"
|
||||
Example: "@see missing-file.yml → create basic template"
|
||||
|
||||
Outdated_Patterns:
|
||||
Action: "Suggest modernization"
|
||||
Example: "Old flag syntax → new standardized format"
|
||||
```
|
||||
|
||||
## Validation Reports
|
||||
|
||||
```yaml
|
||||
Report_Structure:
|
||||
Location: ".claudedocs/validation/config-validation-<timestamp>.md"
|
||||
Sections:
|
||||
- Executive Summary (✅❌ counts)
|
||||
- File-by-file detailed results
|
||||
- Cross-reference matrix
|
||||
- Recommended actions
|
||||
- Auto-repair options
|
||||
|
||||
Severity_Levels:
|
||||
CRITICAL: "Syntax errors, missing required files"
|
||||
HIGH: "Broken cross-references, invalid MCP refs"
|
||||
MEDIUM: "Missing documentation, inconsistent patterns"
|
||||
LOW: "Style issues, optimization opportunities"
|
||||
|
||||
Actions_By_Severity:
|
||||
CRITICAL: "Block loading until fixed"
|
||||
HIGH: "Warn & continue w/ degraded functionality"
|
||||
MEDIUM: "Note in report, suggest fixes"
|
||||
LOW: "Background report only"
|
||||
```
|
||||
|
||||
## Integration Points
|
||||
|
||||
```yaml
|
||||
SuperClaude_Startup:
|
||||
1_Run_Validation: "Before loading any configs"
|
||||
2_Report_Issues: "Show summary to user"
|
||||
3_Auto_Repair: "Fix what can be auto-repaired"
|
||||
4_Block_Critical: "Don't load if critical errors"
|
||||
|
||||
Command_Execution:
|
||||
Pre_Execution: "Validate command & flags exist"
|
||||
Runtime: "Check dependencies available"
|
||||
Post_Execution: "Validate output format"
|
||||
|
||||
Config_Updates:
|
||||
On_File_Change: "Re-validate affected files"
|
||||
On_Install: "Full validation before deployment"
|
||||
Periodic: "Weekly validation health check"
|
||||
|
||||
Developer_Tools:
|
||||
CLI_Command: "/user:validate --config"
|
||||
Report_Command: "/user:validate --report"
|
||||
Fix_Command: "/user:validate --auto-repair"
|
||||
```
|
||||
|
||||
## Implementation Examples
|
||||
|
||||
```yaml
|
||||
Basic_Usage:
|
||||
Manual: "validate_config() before load"
|
||||
Automatic: "Built into SuperClaude startup"
|
||||
Reporting: "Generate .claudedocs/validation/ reports"
|
||||
|
||||
Error_Examples:
|
||||
Syntax_Error: |
|
||||
"YAML syntax error in PERSONAS.md line 42:
|
||||
Expected scalar, found sequence
|
||||
Fix: Check indentation & structure"
|
||||
|
||||
Broken_Reference: |
|
||||
"@see shared/missing-file.yml not found
|
||||
Suggestions:
|
||||
- Create missing-file.yml w/ template
|
||||
- Fix reference to shared/existing-file.yml"
|
||||
|
||||
Inconsistency: |
|
||||
"Persona 'frontend' references --magic flag
|
||||
but MCP.md shows Magic server disabled
|
||||
Fix: Enable Magic server or update persona"
|
||||
```
|
||||
|
||||
---
|
||||
*Config Validator v1.0 - Automated validation for SuperClaude configuration integrity*
|
||||
295
.claude/commands/shared/docs-patterns.yml
Normal file
295
.claude/commands/shared/docs-patterns.yml
Normal file
@@ -0,0 +1,295 @@
|
||||
---
|
||||
# Documentation Patterns
|
||||
# Unified docs standards, directory structure, format requirements
|
||||
|
||||
# Legend: 📁=directory 📝=format 🔔=notification 📊=reporting
|
||||
# docs=documentation std=standard req=requirement fmt=format
|
||||
|
||||
Directory_Standards:
|
||||
Documentation_Structure:
|
||||
Claude_Internal: ".claudedocs/"
|
||||
Project_Documentation: "docs/"
|
||||
|
||||
Claude_Subdirectories:
|
||||
Reports: ".claudedocs/reports/"
|
||||
Metrics: ".claudedocs/metrics/"
|
||||
Summaries: ".claudedocs/summaries/"
|
||||
Checkpoints: ".claudedocs/checkpoints/"
|
||||
Validation: ".claudedocs/validation/"
|
||||
Audit: ".claudedocs/audit/"
|
||||
Incidents: ".claudedocs/incidents/"
|
||||
Tasks: ".claudedocs/tasks/"
|
||||
Task_States:
|
||||
- ".claudedocs/tasks/pending/"
|
||||
- ".claudedocs/tasks/in-progress/"
|
||||
- ".claudedocs/tasks/completed/"
|
||||
- ".claudedocs/tasks/cancelled/"
|
||||
|
||||
Project_Subdirectories:
|
||||
API_Docs: "docs/api/"
|
||||
User_Docs: "docs/user/"
|
||||
Developer_Docs: "docs/dev/"
|
||||
Architecture: "docs/architecture/"
|
||||
Guides: "docs/guides/"
|
||||
References: "docs/references/"
|
||||
|
||||
Auto_Creation_Rules:
|
||||
Create_On_Demand: "mkdir -p before writing files"
|
||||
Validate_Permissions: "Check write access before operations"
|
||||
Ignore_Patterns: "Add to .gitignore if not already present"
|
||||
Permissions: "755 for dirs, 644 for files"
|
||||
```
|
||||
|
||||
## Naming Conventions
|
||||
|
||||
```yaml
|
||||
File_Naming:
|
||||
Reports: "<command>-<type>-<timestamp>.md"
|
||||
Metrics: "<metric>-<date>.md|html|json"
|
||||
Audit: "audit-<YYYY-MM-DD>.log"
|
||||
Tasks: "{type}-{id}-{slug}.md"
|
||||
|
||||
Examples:
|
||||
Analysis_Report: "analysis-security-20240115-143022.md"
|
||||
Coverage_Report: "coverage-20240115.html"
|
||||
Audit_Log: "audit-2024-01-15.log"
|
||||
RCA_Report: "rca-api-timeout-20240115-143022.md"
|
||||
Task_File: "feature-001-auth-system.md"
|
||||
|
||||
Task_ID_Format: "YYYYMMDD-HHMMSS"
|
||||
Task_Types: ["feature", "bugfix", "refactor", "docs", "test"]
|
||||
|
||||
Git_Branches:
|
||||
Task_Branch: "task/{id}-{slug}"
|
||||
Feature_Branch: "feature/{name}"
|
||||
Bugfix_Branch: "bugfix/{name}"
|
||||
Release_Branch: "release/{version}"
|
||||
```
|
||||
|
||||
## Format Requirements
|
||||
|
||||
```yaml
|
||||
Document_Standards:
|
||||
Markdown_Format:
|
||||
Headers: "Use ## for main sections, ### for subsections"
|
||||
Code_Blocks: "Always specify language for syntax highlighting"
|
||||
Tables: "Use pipe format w/ header separators"
|
||||
Links: "Use descriptive text, avoid raw URLs"
|
||||
|
||||
Report_Templates:
|
||||
Analysis_Report:
|
||||
Structure: "Executive Summary → Findings → Recommendations → Appendix"
|
||||
Length: "2-5 pages for standard analysis"
|
||||
Format: "Markdown w/ embedded metrics"
|
||||
|
||||
Performance_Report:
|
||||
Structure: "Metrics Overview → Trend Analysis → Issues → Actions"
|
||||
Charts: "ASCII charts for CLI compatibility"
|
||||
Data_Format: "JSON for machine processing, Markdown for human reading"
|
||||
|
||||
Security_Report:
|
||||
Structure: "Risk Summary → Vulnerabilities → Mitigations → Verification"
|
||||
Risk_Levels: "CRITICAL|HIGH|MEDIUM|LOW w/ CVSS scores"
|
||||
Remediation: "Actionable steps w/ priority order"
|
||||
|
||||
Required_Headers:
|
||||
Generated_By: "SuperClaude v4.0.0"
|
||||
Command: "/<command> [flags]"
|
||||
Timestamp: "ISO 8601 format"
|
||||
Duration: "Operation time"
|
||||
|
||||
UltraCompressed_Mode:
|
||||
Token_Reduction: "~70% from standard format"
|
||||
Symbols_Required: "→ & @ ∀ ∃ ∴ ∵ based on legend"
|
||||
Structure: "YAML > Tables > Lists > Prose"
|
||||
Legend_Requirement: "Auto-generate symbol/abbreviation legend"
|
||||
```
|
||||
|
||||
## Output Notifications
|
||||
|
||||
```yaml
|
||||
Standard_Notifications:
|
||||
File_Operations:
|
||||
Created: "📝 Created: {file_path}"
|
||||
Updated: "✏ Updated: {file_path}"
|
||||
Deleted: "🗑 Deleted: {file_path}"
|
||||
Moved: "➡ Moved: {old_path} → {new_path}"
|
||||
|
||||
Report_Generation:
|
||||
Analysis_Complete: "📄 Analysis report saved to: {path}"
|
||||
Metrics_Updated: "📊 Metrics updated: {path}"
|
||||
Summary_Generated: "📋 Summary saved to: {path}"
|
||||
Checkpoint_Created: "💾 Checkpoint created: {path}"
|
||||
Documentation_Created: "📚 Documentation created: {path}"
|
||||
Directory_Created: "📁 Created directory: {path}"
|
||||
|
||||
Process_Status:
|
||||
Started: "▶ Starting {operation}"
|
||||
In_Progress: "🔄 Processing {operation} ({progress}%)"
|
||||
Completed: "✅ {operation} completed successfully"
|
||||
Failed: "❌ {operation} failed: {reason}"
|
||||
Warning: "⚠ {operation} completed w/ warnings"
|
||||
|
||||
Performance_Alerts:
|
||||
Slow_Operation: "⚠ Operation taking longer than expected ({duration}s)"
|
||||
High_Memory: "⚠ High memory usage detected ({usage}MB)"
|
||||
Large_Output: "⚠ Large output generated ({size}MB)"
|
||||
|
||||
Quality_Standards:
|
||||
Consistency: "All notifications follow emoji + message format"
|
||||
Actionability: "Include file paths & next steps where applicable"
|
||||
Brevity: "Keep messages under 80 characters when possible"
|
||||
Context: "Include relevant details (size, duration, progress)"
|
||||
```
|
||||
|
||||
## Command Integration
|
||||
|
||||
```yaml
|
||||
Command_To_Directory_Mapping:
|
||||
analyze: ".claudedocs/reports/analysis-*.md"
|
||||
scan: ".claudedocs/reports/scan-*.md"
|
||||
test: ".claudedocs/metrics/coverage-*.html"
|
||||
improve: ".claudedocs/metrics/quality-*.md"
|
||||
troubleshoot: ".claudedocs/incidents/rca-*.md"
|
||||
estimate: ".claudedocs/summaries/estimate-*.md"
|
||||
document: "docs/[category]/*.md"
|
||||
git: ".claudedocs/audit/git-operations-*.log"
|
||||
deploy: ".claudedocs/audit/deployment-*.log"
|
||||
|
||||
Directory_Creation_Logic:
|
||||
Pre_Write_Check:
|
||||
- "Verify parent directory exists"
|
||||
- "Create if missing with proper permissions"
|
||||
- "Validate write access"
|
||||
- "Handle errors gracefully"
|
||||
|
||||
Auto_Create_Paths:
|
||||
- ".claudedocs/ and all subdirectories"
|
||||
- "docs/ and project documentation structure"
|
||||
- "Respect existing .gitignore patterns"
|
||||
```
|
||||
|
||||
## Documentation Standards
|
||||
|
||||
```yaml
|
||||
Project_Documentation:
|
||||
Organization_Rules:
|
||||
- "README.md at each level"
|
||||
- "index.md for navigation"
|
||||
- "Versioned subdirectories when needed"
|
||||
- "Assets in dedicated folders"
|
||||
|
||||
Content_Standards:
|
||||
- "Clear section headers"
|
||||
- "Table of contents for long docs"
|
||||
- "Code examples with syntax highlighting"
|
||||
- "Cross-references to related docs"
|
||||
|
||||
Operational_Reports:
|
||||
Structure_Requirements:
|
||||
- "Executive summary first"
|
||||
- "Detailed findings follow"
|
||||
- "Actionable recommendations"
|
||||
- "Severity/priority indicators"
|
||||
|
||||
Format_Standards:
|
||||
- "Markdown for human-readable reports"
|
||||
- "JSON for machine-readable metrics"
|
||||
- "HTML for coverage reports"
|
||||
- "Plain text for logs"
|
||||
```
|
||||
|
||||
## Standard Notifications
|
||||
|
||||
```yaml
|
||||
Standard_Notifications:
|
||||
Operation_Start: "▶ Starting {operation}"
|
||||
Operation_Complete: "✅ {operation} completed successfully"
|
||||
File_Created: "📝 Created: {file_path}"
|
||||
File_Updated: "✏ Updated: {file_path}"
|
||||
Report_Generated: "📄 Report saved to: {path}"
|
||||
Error_Occurred: "❌ {operation} failed: {reason}"
|
||||
Warning_Issued: "⚠ {warning_message}"
|
||||
Info_Message: "ℹ {information}"
|
||||
|
||||
Output_Notifications:
|
||||
Success_Format: "✅ {operation} completed in {duration}"
|
||||
Error_Format: "❌ {operation} failed: {error_details}"
|
||||
Warning_Format: "⚠ {warning}: {details}"
|
||||
Info_Format: "ℹ {message}"
|
||||
Progress_Format: "🔄 {operation}: {current}/{total} ({percentage}%)"
|
||||
```
|
||||
|
||||
## Gitignore Recommendations
|
||||
|
||||
```yaml
|
||||
# Recommended .gitignore patterns:
|
||||
Exclude_From_Git:
|
||||
- ".claudedocs/audit/" # Operational logs
|
||||
- ".claudedocs/metrics/" # Performance data
|
||||
- ".claudedocs/incidents/" # Sensitive RCAs
|
||||
- ".claudedocs/validation/" # Validation reports
|
||||
|
||||
Include_In_Git:
|
||||
- ".claudedocs/reports/" # Useful analysis reports
|
||||
- ".claudedocs/summaries/" # Important summaries
|
||||
- "docs/" # All project documentation
|
||||
- ".claudedocs/tasks/" # Task tracking files
|
||||
```
|
||||
|
||||
## Task File Formatting
|
||||
|
||||
```yaml
|
||||
Task_File_Structure:
|
||||
Always_Compressed: true
|
||||
No_Exceptions: "All task files use UltraCompressed format"
|
||||
|
||||
Header_Template: |
|
||||
# Legend: {used_symbols_only}
|
||||
|
||||
T: {title}
|
||||
ID: {id} | S: {status} | P: {priority}
|
||||
Branch: {branch}
|
||||
|
||||
Phase_Format:
|
||||
Template: "- {symbol} {phase}: {brief_description}"
|
||||
Symbols:
|
||||
"□": "pending phase"
|
||||
"◐": "in-progress phase"
|
||||
"✓": "completed phase"
|
||||
"⚠": "blocked phase"
|
||||
|
||||
Context_Format:
|
||||
Decisions: "Dec: {key_decisions}"
|
||||
Blockers: "Block: {active_blockers}"
|
||||
Files: "Files: {affected_files}"
|
||||
Next: "Next: {immediate_next_step}"
|
||||
|
||||
Progress_Format:
|
||||
Todos: "Todos: {active}/{total}"
|
||||
Completion: "Done: {percentage}%"
|
||||
Time: "Est: {estimated_remaining}"
|
||||
```
|
||||
|
||||
## Validation & Enforcement
|
||||
|
||||
```yaml
|
||||
Directory_Validation:
|
||||
Check_On_Startup: "Verify all required directories exist"
|
||||
Auto_Repair: "Create missing directories with proper permissions"
|
||||
Permission_Check: "Validate write access before operations"
|
||||
|
||||
Content_Validation:
|
||||
Format_Compliance: "Check markdown syntax and structure"
|
||||
Reference_Integrity: "Validate all internal links"
|
||||
Required_Sections: "Ensure all required headers present"
|
||||
|
||||
Notification_Standards:
|
||||
Emoji_Consistency: "Use standard emoji mapping"
|
||||
Path_Accuracy: "Always include full paths in notifications"
|
||||
Status_Clarity: "Clear success/failure indication"
|
||||
```
|
||||
|
||||
---
|
||||
*Documentation Patterns v4.0.0 - Unified standards for docs, structure,
|
||||
format requirements, and notifications*
|
||||
@@ -1,134 +0,0 @@
|
||||
# Docs Directory Standards
|
||||
|
||||
## Directory Structure
|
||||
```yaml
|
||||
Claude_Operational_Docs:
|
||||
Base_Directory: .claudedocs/
|
||||
|
||||
Structure:
|
||||
audit/: # Audit logs & op history
|
||||
reports/: # Analysis reports, scan results, findings
|
||||
summaries/: # Command summaries, estimates, overviews
|
||||
metrics/: # Perf metrics, coverage reports, benchmarks
|
||||
incidents/: # Troubleshooting RCAs, incident docs
|
||||
|
||||
Naming_Conventions:
|
||||
Reports: <command>-<type>-<timestamp>.md
|
||||
Metrics: <metric>-<date>.md|html|json
|
||||
Audit: audit-<YYYY-MM-DD>.log
|
||||
|
||||
Examples:
|
||||
- .claudedocs/reports/analysis-security-20240115-143022.md
|
||||
- .claudedocs/metrics/coverage-20240115.html
|
||||
- .claudedocs/audit/audit-2024-01-15.log
|
||||
- .claudedocs/incidents/rca-api-timeout-20240115-143022.md
|
||||
|
||||
Project_Documentation:
|
||||
Base_Directory: /docs
|
||||
|
||||
Structure:
|
||||
api/: # API documentation, endpoints, schemas
|
||||
guides/: # User guides, tutorials, how-tos
|
||||
architecture/: # System design, diagrams, decisions
|
||||
development/: # Developer setup, contributing, standards
|
||||
references/: # Quick references, cheat sheets
|
||||
|
||||
Organization:
|
||||
- README.md at each level
|
||||
- index.md for navigation
|
||||
- Versioned subdirectories when needed
|
||||
- Assets in dedicated folders
|
||||
|
||||
Examples:
|
||||
- /docs/api/rest-api.md
|
||||
- /docs/guides/getting-started.md
|
||||
- /docs/architecture/system-overview.md
|
||||
- /docs/development/setup.md
|
||||
```
|
||||
|
||||
## Enforcement Rules
|
||||
```yaml
|
||||
Directory_Creation:
|
||||
Auto_Create: true
|
||||
Permissions: 755 for dirs, 644 for files
|
||||
|
||||
Pre_Write_Check:
|
||||
- Verify parent directory exists
|
||||
- Create if missing with proper permissions
|
||||
- Validate write access
|
||||
- Handle errors gracefully
|
||||
|
||||
Report_Generation:
|
||||
Required_Headers:
|
||||
- Generated by: SuperClaude v4.0.0
|
||||
- Command: /user:<command> [flags]
|
||||
- Timestamp: ISO 8601 format
|
||||
- Duration: Operation time
|
||||
|
||||
Format_Standards:
|
||||
- Markdown for human-readable reports
|
||||
- JSON for machine-readable metrics
|
||||
- HTML for coverage reports
|
||||
- Plain text for logs
|
||||
|
||||
Documentation_Standards:
|
||||
Project_Docs:
|
||||
- Clear section headers
|
||||
- Table of contents for long docs
|
||||
- Code examples with syntax highlighting
|
||||
- Cross-references to related docs
|
||||
|
||||
Operational_Reports:
|
||||
- Executive summary first
|
||||
- Detailed findings follow
|
||||
- Actionable recommendations
|
||||
- Severity/priority indicators
|
||||
```
|
||||
|
||||
## Integration Points
|
||||
```yaml
|
||||
Commands:
|
||||
analyze: → .claudedocs/reports/analysis-*.md
|
||||
scan: → .claudedocs/reports/scan-*.md
|
||||
test: → .claudedocs/metrics/coverage-*.html
|
||||
improve: → .claudedocs/metrics/quality-*.md
|
||||
troubleshoot: → .claudedocs/incidents/rca-*.md
|
||||
estimate: → .claudedocs/summaries/estimate-*.md
|
||||
document: → /docs/[category]/*.md
|
||||
|
||||
Shared_Resources:
|
||||
audit.yml: → .claudedocs/audit/
|
||||
performance.yml: → .claudedocs/metrics/
|
||||
checkpoint.yml: → .claudedocs/summaries/checkpoint-*.md
|
||||
```
|
||||
|
||||
## Output Notifications
|
||||
```yaml
|
||||
Report_Created:
|
||||
Format: "📄 Report saved to: <path>"
|
||||
Example: "📄 Analysis report saved to: .claudedocs/reports/analysis-security-20240115-143022.md"
|
||||
|
||||
Documentation_Created:
|
||||
Format: "📚 Documentation created: <path>"
|
||||
Example: "📚 API documentation created: /docs/api/endpoints.md"
|
||||
|
||||
Directory_Created:
|
||||
Format: "📁 Created directory: <path>"
|
||||
Show: Only on first creation
|
||||
```
|
||||
|
||||
## Gitignore Recommendations
|
||||
```yaml
|
||||
# Add to .gitignore:
|
||||
.claudedocs/audit/ # Operational logs
|
||||
.claudedocs/metrics/ # Performance data
|
||||
.claudedocs/incidents/ # Sensitive RCAs
|
||||
|
||||
# Keep in git:
|
||||
.claudedocs/reports/ # Useful analysis reports
|
||||
.claudedocs/summaries/ # Important summaries
|
||||
/docs/ # All project documentation
|
||||
```
|
||||
|
||||
---
|
||||
*Documentation Directory Standards: Organizing Claude's output professionally*
|
||||
@@ -1,341 +0,0 @@
|
||||
# Error Handling & Recovery System
|
||||
|
||||
## Legend
|
||||
| Symbol | Meaning | | Abbrev | Meaning |
|
||||
|--------|---------|---|--------|---------|
|
||||
| 🔄 | retry/recovery | | err | error |
|
||||
| ⚠ | warning/caution | | rec | recovery |
|
||||
| ✅ | success/fixed | | ctx | context |
|
||||
| 🔧 | repair/fix | | fail | failure |
|
||||
|
||||
## Error Classification & Response
|
||||
|
||||
```yaml
|
||||
Severity_Levels:
|
||||
CRITICAL [10]: Data loss, security breach, prod down
|
||||
Response: Immediate stop, alert, rollback, incident response
|
||||
Recovery: Manual intervention required, full investigation
|
||||
|
||||
HIGH [7-9]: Build failure, test failure, deployment issues
|
||||
Response: Stop workflow, notify user, suggest fixes
|
||||
Recovery: Automated retry w/ backoff, alternative paths
|
||||
|
||||
MEDIUM [4-6]: Warning conditions, perf degradation
|
||||
Response: Continue w/ warning, log for later review
|
||||
Recovery: Attempt optimization, monitor for escalation
|
||||
|
||||
LOW [1-3]: Info messages, style violations, minor optimizations
|
||||
Response: Note in output, continue execution
|
||||
Recovery: Background fixes, cleanup on completion
|
||||
|
||||
Error_Categories:
|
||||
Transient:
|
||||
Network_Timeouts: "MCP server unreachable, API timeouts"
|
||||
Resource_Busy: "File locked, system overloaded"
|
||||
Rate_Limits: "API quota exceeded, temporary blocks"
|
||||
Strategy: Exponential backoff retry, circuit breaker pattern
|
||||
|
||||
Permanent:
|
||||
Syntax_Errors: "Invalid code, malformed input"
|
||||
Permission_Denied: "Access restrictions, auth failures"
|
||||
Not_Found: "Missing files, invalid paths"
|
||||
Strategy: No retry, immediate fallback or user guidance
|
||||
|
||||
Context:
|
||||
Configuration: "Missing env vars, incorrect settings"
|
||||
State_Conflicts: "Dirty working tree, merge conflicts"
|
||||
Version_Mismatch: "Incompatible versions, deprecated APIs"
|
||||
Strategy: Validation, helpful error msgs, setup guidance
|
||||
|
||||
Resource:
|
||||
Memory: "Out of memory, insufficient resources"
|
||||
Disk_Space: "Storage full, temp space unavailable"
|
||||
API_Limits: "Rate limits, quota exceeded"
|
||||
Strategy: Resource monitoring, cleanup, queue management
|
||||
```
|
||||
|
||||
## Intelligent Retry Strategies
|
||||
|
||||
```yaml
|
||||
Retry_Logic:
|
||||
Exponential_Backoff:
|
||||
Base_Delay: "1 second"
|
||||
Max_Delay: "60 seconds"
|
||||
Max_Attempts: "3 for transient, 1 for permanent"
|
||||
Jitter: "±25% randomization to avoid thundering herd"
|
||||
|
||||
Adaptive_Strategy:
|
||||
Network_Errors: "Retry w/ longer timeout"
|
||||
Rate_Limits: "Wait for reset period + retry"
|
||||
Resource_Busy: "Short delay + retry w/ alternative"
|
||||
Permanent: "No retry, immediate fallback"
|
||||
|
||||
Circuit_Breaker:
|
||||
Failure_Threshold: "3 consecutive failures"
|
||||
Recovery_Time: "5 minutes before re-enabling"
|
||||
Health_Check: "Lightweight test before full retry"
|
||||
```
|
||||
|
||||
## MCP Server Failover
|
||||
|
||||
```yaml
|
||||
Failover_Hierarchy:
|
||||
Context7_Failure:
|
||||
Primary: "C7 documentation lookup"
|
||||
Fallback_1: "WebSearch official docs"
|
||||
Fallback_2: "Local cache if available"
|
||||
Fallback_3: "Continue w/ warning + note limitation"
|
||||
|
||||
Sequential_Failure:
|
||||
Primary: "Sequential thinking server"
|
||||
Fallback_1: "Native step-by-step analysis"
|
||||
Fallback_2: "Simplified linear approach"
|
||||
Fallback_3: "Manual breakdown w/ user input"
|
||||
|
||||
Magic_Failure:
|
||||
Primary: "Magic UI component generation"
|
||||
Fallback_1: "Search existing components in project"
|
||||
Fallback_2: "Generate basic template manually"
|
||||
Fallback_3: "Provide implementation guidance"
|
||||
|
||||
Puppeteer_Failure:
|
||||
Primary: "Browser automation & testing"
|
||||
Fallback_1: "Manual test instructions"
|
||||
Fallback_2: "Static analysis alternatives"
|
||||
Fallback_3: "Skip browser-specific operations"
|
||||
|
||||
Server_Health_Monitoring:
|
||||
Availability_Check:
|
||||
Frequency: "Every 5 minutes during active use"
|
||||
Timeout: "3 seconds per check"
|
||||
Circuit_Breaker: "Disable after 3 consecutive failures"
|
||||
Recovery_Check: "Re-enable after 5 minutes"
|
||||
|
||||
Performance_Degradation:
|
||||
Slow_Response: ">30s response time"
|
||||
Action: "Switch to faster alternative if available"
|
||||
Notification: "Inform user of performance impact"
|
||||
```
|
||||
|
||||
## Recovery Strategies
|
||||
|
||||
```yaml
|
||||
Automatic_Recovery:
|
||||
Retry_Mechanisms:
|
||||
Simple: "Up to 3 attempts with 1s delay"
|
||||
Exponential: "1s, 2s, 4s, 8s delays with jitter"
|
||||
Circuit_Breaker: "Stop retries after threshold failures"
|
||||
|
||||
Fallback_Patterns:
|
||||
Alternative_Commands: "Use native tools if MCP fails"
|
||||
Degraded_Functionality: "Skip non-essential features"
|
||||
Cached_Results: "Use previous successful outputs"
|
||||
|
||||
State_Management:
|
||||
Checkpoints: "Save state before risky operations"
|
||||
Rollback: "Automatic revert to last known good state"
|
||||
Cleanup: "Remove partial results on failure"
|
||||
|
||||
Manual_Recovery:
|
||||
User_Guidance:
|
||||
Clear_Error_Messages: "What failed, why, how to fix"
|
||||
Action_Items: "Specific steps user can take"
|
||||
Documentation_Links: "Relevant help resources"
|
||||
|
||||
Intervention_Points:
|
||||
Confirmation: "Ask before destructive operations"
|
||||
Override: "Allow user to skip validation warnings"
|
||||
Custom: "Accept user-provided alternative approaches"
|
||||
|
||||
Recovery_Tools:
|
||||
Diagnostic: "Commands to investigate failures"
|
||||
Repair: "Automated fixes for common issues"
|
||||
Reset: "Return to clean state for fresh start"
|
||||
```
|
||||
|
||||
## Context Preservation
|
||||
|
||||
```yaml
|
||||
Operation_Checkpoints:
|
||||
Before_Risky_Operations:
|
||||
Create_Checkpoint: "Save current state before destructive ops"
|
||||
Include: "File states, working directory, command context"
|
||||
Location: ".claudedocs/checkpoints/checkpoint-<timestamp>"
|
||||
|
||||
During_Command_Chains:
|
||||
Intermediate_Results: "Save results after each successful step"
|
||||
Context_Handoff: "Pass validated context to next command"
|
||||
Rollback_Points: "Mark safe restoration points"
|
||||
|
||||
Failure_Recovery:
|
||||
Partial_Completion: "Preserve completed work"
|
||||
State_Analysis: "Determine safe rollback point"
|
||||
User_Options: "Present recovery choices"
|
||||
|
||||
Context_Resilience:
|
||||
Session_State:
|
||||
Persistent_Storage: "Maintain state across interruptions"
|
||||
Auto_Save: "Periodic context snapshots"
|
||||
Recovery: "Restore from last known good state"
|
||||
|
||||
Command_Chain_Recovery:
|
||||
Failed_Step_Isolation: "Don't lose previous successful steps"
|
||||
Alternative_Paths: "Suggest different approaches for failed step"
|
||||
Partial_Results: "Use completed work in recovery strategy"
|
||||
```
|
||||
|
||||
## Proactive Error Prevention
|
||||
|
||||
```yaml
|
||||
Pre_Execution_Validation:
|
||||
Environment_Check:
|
||||
Required_Tools: "Verify dependencies before starting"
|
||||
Permissions: "Check access rights for planned operations"
|
||||
Disk_Space: "Ensure adequate space for outputs"
|
||||
Network: "Verify connectivity for remote operations"
|
||||
|
||||
Conflict_Detection:
|
||||
File_Locks: "Check for locked files before editing"
|
||||
Git_State: "Verify clean working tree for git ops"
|
||||
Process_Conflicts: "Detect conflicting background processes"
|
||||
|
||||
Resource_Availability:
|
||||
Memory_Usage: "Ensure adequate RAM for large operations"
|
||||
CPU_Load: "Warn if system under heavy load"
|
||||
Token_Budget: "Estimate token usage vs available quota"
|
||||
|
||||
Risk_Assessment:
|
||||
Operation_Scoring:
|
||||
Data_Loss_Risk: "1-10 scale based on destructiveness"
|
||||
Reversibility: "Can operation be undone?"
|
||||
Scope_Impact: "How many files/systems affected?"
|
||||
|
||||
Mitigation_Requirements:
|
||||
High_Risk: "Require explicit confirmation + backup"
|
||||
Medium_Risk: "Warn user + create checkpoint"
|
||||
Low_Risk: "Proceed w/ monitoring"
|
||||
```
|
||||
|
||||
## Command-Specific Recovery
|
||||
|
||||
```yaml
|
||||
Build_Failures:
|
||||
Clean_Retry: "Remove artifacts, clear cache, rebuild"
|
||||
Dependency_Issues: "Update lockfiles, reinstall packages"
|
||||
Compilation_Errors: "Suggest fixes, alternative approaches"
|
||||
|
||||
Test_Failures:
|
||||
Flaky_Tests: "Retry failed tests, identify unstable tests"
|
||||
Environment_Issues: "Reset test state, check prerequisites"
|
||||
Coverage_Gaps: "Generate missing tests, update thresholds"
|
||||
|
||||
Deploy_Failures:
|
||||
Health_Check_Failures: "Rollback, investigate logs"
|
||||
Resource_Constraints: "Scale up, optimize deployment"
|
||||
Configuration_Issues: "Validate settings, check secrets"
|
||||
|
||||
Analysis_Failures:
|
||||
Tool_Unavailable: "Fallback to alternative analysis tools"
|
||||
Large_Codebase: "Reduce scope, batch processing"
|
||||
Permission_Issues: "Guide user through access setup"
|
||||
```
|
||||
|
||||
## Enhanced Error Reporting
|
||||
|
||||
```yaml
|
||||
Intelligent_Error_Messages:
|
||||
Root_Cause_Analysis:
|
||||
Technical_Details: "Specific error codes, stack traces"
|
||||
User_Context: "What user was trying to accomplish"
|
||||
Environmental_Factors: "System state, recent changes"
|
||||
|
||||
Actionable_Guidance:
|
||||
Immediate_Steps: "What user can do right now"
|
||||
Alternative_Approaches: "Different ways to achieve goal"
|
||||
Prevention: "How to avoid this error in future"
|
||||
|
||||
Context_Preservation:
|
||||
Session_Info: "Command history, current state"
|
||||
Relevant_Files: "Which files were being processed"
|
||||
System_State: "Git status, dependency versions"
|
||||
|
||||
Error_Learning:
|
||||
Pattern_Recognition:
|
||||
Frequent_Issues: "Track commonly occurring errors"
|
||||
User_Patterns: "Learn user-specific failure modes"
|
||||
System_Patterns: "Identify environment-specific issues"
|
||||
|
||||
Adaptive_Responses:
|
||||
Personalized_Suggestions: "Based on user's history"
|
||||
Proactive_Warnings: "Predict likely issues"
|
||||
Automated_Fixes: "Apply known solutions automatically"
|
||||
```
|
||||
|
||||
## Integration with Commands
|
||||
|
||||
```yaml
|
||||
Pre_Execution_Validation:
|
||||
Prerequisites: "Check required tools, permissions, resources"
|
||||
Environment: "Validate configuration, network connectivity"
|
||||
State: "Ensure clean starting state, no conflicts"
|
||||
|
||||
During_Execution:
|
||||
Monitoring: "Track progress, resource usage, early warnings"
|
||||
Checkpointing: "Save state at critical milestones"
|
||||
Health_Checks: "Validate system state during long operations"
|
||||
|
||||
Post_Execution:
|
||||
Verification: "Confirm expected outcomes achieved"
|
||||
Cleanup: "Remove temporary files, release resources"
|
||||
Reporting: "Document successes, failures, lessons learned"
|
||||
|
||||
Error_Reporting_Format:
|
||||
Structured: "Consistent error message format across commands"
|
||||
Actionable: "Include specific steps for resolution"
|
||||
Contextual: "Provide relevant system and environment information"
|
||||
Traceable: "Include operation ID for troubleshooting"
|
||||
```
|
||||
|
||||
## Configuration & Customization
|
||||
|
||||
```yaml
|
||||
User_Preferences:
|
||||
Recovery_Style: "Conservative (safe) vs Aggressive (fast)"
|
||||
Retry_Limits: "Maximum attempts for different error types"
|
||||
Notification: "How and when to alert user of issues"
|
||||
Automation_Level: "How much recovery to attempt automatically"
|
||||
|
||||
Project_Settings:
|
||||
Critical_Operations: "Commands that require extra safety"
|
||||
Acceptable_Risk: "Tolerance for failures in development vs production"
|
||||
Resource_Limits: "Maximum time, memory, network usage"
|
||||
Dependencies: "Critical external services that must be available"
|
||||
|
||||
Environment_Adaptation:
|
||||
Development: "More aggressive retries, helpful error messages"
|
||||
Staging: "Balanced approach, thorough logging"
|
||||
Production: "Conservative recovery, immediate alerting"
|
||||
CI_CD: "Fast failure, detailed diagnostic information"
|
||||
```
|
||||
|
||||
## Usage Examples
|
||||
|
||||
```yaml
|
||||
Network_Failure_Scenario:
|
||||
Error: "Context7 server timeout during docs lookup"
|
||||
Recovery: "Auto-fallback to WebSearch → local cache"
|
||||
User_Experience: "⚠ Using cached docs (Context7 unavailable)"
|
||||
|
||||
File_Lock_Scenario:
|
||||
Error: "Cannot edit file (locked by another process)"
|
||||
Recovery: "Wait 5s → retry → suggest alternatives"
|
||||
User_Experience: "Retrying in 5s... or try manual edit"
|
||||
|
||||
Command_Chain_Failure:
|
||||
Error: "Step 3 of 5 fails in build workflow"
|
||||
Recovery: "Preserve steps 1-2, suggest alternatives for 3"
|
||||
User_Experience: "Build partially complete. Alternative approaches: ..."
|
||||
```
|
||||
|
||||
---
|
||||
*Error Handling v1.0 - Comprehensive error recovery and resilience for SuperClaude*
|
||||
@@ -1,75 +0,0 @@
|
||||
# Evidence & Verification Patterns
|
||||
|
||||
## Measurement Standards
|
||||
|
||||
```yaml
|
||||
Replace Hard Values:
|
||||
Bad: "75% perf improvement"
|
||||
Good: "<measured>% improvement"
|
||||
Best: "<baseline>→<current> (<delta>%)"
|
||||
|
||||
Placeholders:
|
||||
<measured_value>: Actual measurement
|
||||
<calculated_result>: Computed outcome
|
||||
<baseline>: Starting point
|
||||
<current>: Current state
|
||||
<delta>: Change amount
|
||||
<threshold>: Target value
|
||||
```
|
||||
|
||||
## Verification Requirements
|
||||
|
||||
```yaml
|
||||
Perf Claims:
|
||||
Required: Measurement method
|
||||
Format: "Measured via <tool>: <metric>"
|
||||
Example: "Measured via Lighthouse: FCP <value>ms"
|
||||
|
||||
Quality Metrics:
|
||||
Coverage: "Test coverage: <measured>%"
|
||||
Complexity: "Cyclomatic: <calculated>"
|
||||
Duplication: "DRY score: <measured>%"
|
||||
|
||||
Time Estimates:
|
||||
Format: "<min>-<max> <unit> (±<uncertainty>%)"
|
||||
Based on: Historical data|Complexity analysis
|
||||
|
||||
Implementation Sources:
|
||||
Required: Documentation reference for external libraries
|
||||
Format: "Source: <official docs URL or reference>"
|
||||
Placement: Above implementation using pattern
|
||||
|
||||
Examples:
|
||||
Good: "// Source: React docs - useState hook"
|
||||
Bad: "// Common React pattern"
|
||||
|
||||
No Source = Block: External library usage without documentation
|
||||
```
|
||||
|
||||
## Evidence Collection
|
||||
|
||||
```yaml
|
||||
Before: Baseline measurement
|
||||
During: Progress tracking
|
||||
After: Final measurement
|
||||
Delta: Calculate improvement
|
||||
|
||||
Tools:
|
||||
Performance: Lighthouse|DevTools|APM
|
||||
Code: Coverage reports|Linters|Analyzers
|
||||
Time: Git history|Task tracking
|
||||
```
|
||||
|
||||
## Reporting Format
|
||||
|
||||
```yaml
|
||||
Pattern:
|
||||
Claim: What improved
|
||||
Evidence: How measured
|
||||
Result: Specific values
|
||||
|
||||
Example:
|
||||
Claim: "Optimized query performance"
|
||||
Evidence: "EXPLAIN ANALYZE before/after"
|
||||
Result: "<before>ms → <after>ms (<delta>% faster)"
|
||||
```
|
||||
@@ -1,277 +0,0 @@
|
||||
# Execution Lifecycle & Common Hooks
|
||||
|
||||
## Legend
|
||||
| Symbol | Meaning | | Abbrev | Meaning |
|
||||
|--------|---------|---|--------|---------|
|
||||
| ▶ | start/begin | | exec | execution |
|
||||
| ⏸ | pause/checkpoint | | val | validation |
|
||||
| ⏹ | stop/end | | ver | verification |
|
||||
| 🔄 | cycle/repeat | | cln | cleanup |
|
||||
|
||||
## Universal Execution Phases
|
||||
|
||||
```yaml
|
||||
Standard_Lifecycle:
|
||||
Pre_Execution:
|
||||
Phase: "Validation and preparation"
|
||||
Duration: "5-15% of total execution time"
|
||||
Critical: "Prevent issues before they occur"
|
||||
|
||||
During_Execution:
|
||||
Phase: "Core operation execution"
|
||||
Duration: "70-85% of total execution time"
|
||||
Critical: "Monitor progress and handle errors"
|
||||
|
||||
Post_Execution:
|
||||
Phase: "Cleanup and verification"
|
||||
Duration: "10-15% of total execution time"
|
||||
Critical: "Ensure completion and clean state"
|
||||
|
||||
Phase_Transitions:
|
||||
Pre → During: "All validations pass"
|
||||
During → Post: "Core operation completes (success or controlled failure)"
|
||||
Post → Complete: "Cleanup verified, results confirmed"
|
||||
Any → Error: "Unrecoverable error triggers error handling"
|
||||
Any → Pause: "User interruption or checkpoint trigger"
|
||||
```
|
||||
|
||||
## Pre-Execution Hooks
|
||||
|
||||
```yaml
|
||||
Environment_Validation:
|
||||
System_Requirements:
|
||||
- Check required tools availability
|
||||
- Verify sufficient system resources
|
||||
- Validate network connectivity (if needed)
|
||||
- Confirm adequate disk space
|
||||
|
||||
Permission_Checks:
|
||||
- Verify file system permissions
|
||||
- Check git repository access
|
||||
- Validate API credentials (if needed)
|
||||
- Confirm write access to output directories
|
||||
|
||||
State_Validation:
|
||||
- Ensure clean working tree (for git operations)
|
||||
- Check for file locks
|
||||
- Verify no conflicting processes
|
||||
- Validate prerequisite operations completed
|
||||
|
||||
Dependency_Verification:
|
||||
Tool_Availability:
|
||||
Required_Tools: "Tools marked as required for operation"
|
||||
Optional_Tools: "Tools that enhance but don't block operation"
|
||||
Fallback_Tools: "Alternative tools if primary unavailable"
|
||||
|
||||
File_Dependencies:
|
||||
Input_Files: "Files that must exist for operation"
|
||||
Configuration_Files: "Config files that affect operation"
|
||||
Template_Files: "Templates needed for generation"
|
||||
|
||||
Service_Dependencies:
|
||||
MCP_Servers: "Required MCP servers for operation"
|
||||
External_APIs: "External services needed"
|
||||
Database_Connections: "DB access if required"
|
||||
|
||||
Risk_Assessment:
|
||||
Operation_Classification:
|
||||
Data_Loss_Risk: "Scale 1-10 based on destructiveness"
|
||||
Reversibility: "Can operation be undone automatically?"
|
||||
Scope_Impact: "How many files/systems affected?"
|
||||
|
||||
Safety_Requirements:
|
||||
High_Risk: "Require explicit confirmation + backup"
|
||||
Medium_Risk: "Create checkpoint + warn user"
|
||||
Low_Risk: "Proceed with monitoring"
|
||||
|
||||
Preparation_Actions:
|
||||
Backup_Creation:
|
||||
Critical_Files: "Files that will be modified"
|
||||
System_State: "Current git state, file timestamps"
|
||||
Configuration: "Relevant config before changes"
|
||||
|
||||
Context_Capture:
|
||||
Current_State: "Working directory, git branch, file states"
|
||||
User_Context: "Active persona, command flags, session history"
|
||||
Environment: "Relevant environment variables, tool versions"
|
||||
```
|
||||
|
||||
## During-Execution Hooks
|
||||
|
||||
```yaml
|
||||
Progress_Monitoring:
|
||||
Real_Time_Tracking:
|
||||
Operation_Progress: "Percentage completion where measurable"
|
||||
Resource_Usage: "CPU, memory, disk, network utilization"
|
||||
Error_Frequency: "Number and types of errors encountered"
|
||||
Performance_Metrics: "Speed, efficiency, token usage"
|
||||
|
||||
Checkpoint_Creation:
|
||||
Automatic_Triggers:
|
||||
- Major phase completion
|
||||
- Before risky operations
|
||||
- Regular intervals (time-based)
|
||||
- Resource threshold warnings
|
||||
Manual_Triggers:
|
||||
- User pause request
|
||||
- Error recovery points
|
||||
- External interruption
|
||||
|
||||
Health_Monitoring:
|
||||
System_Health:
|
||||
- Available resources
|
||||
- Tool responsiveness
|
||||
- Network connectivity
|
||||
- File system status
|
||||
Operation_Health:
|
||||
- Progress rate
|
||||
- Error patterns
|
||||
- Quality indicators
|
||||
- User satisfaction signals
|
||||
|
||||
Error_Handling_Integration:
|
||||
Error_Detection:
|
||||
Immediate: "Critical errors that require immediate stop"
|
||||
Recoverable: "Errors that can be retried or worked around"
|
||||
Warning: "Issues that should be logged but don't block"
|
||||
|
||||
Recovery_Actions:
|
||||
Automatic_Retry: "Transient errors with exponential backoff"
|
||||
Fallback_Methods: "Alternative approaches when primary fails"
|
||||
User_Guidance: "When manual intervention needed"
|
||||
|
||||
Adaptive_Optimization:
|
||||
Performance_Adjustment:
|
||||
Slow_Operations: "Switch to faster tools/methods"
|
||||
High_Resource_Usage: "Reduce scope or batch operations"
|
||||
Token_Efficiency: "Enable compression or caching"
|
||||
|
||||
Strategy_Adjustment:
|
||||
Success_Pattern_Learning: "Adapt based on what works"
|
||||
Failure_Pattern_Avoidance: "Learn from what doesn't work"
|
||||
User_Preference_Adaptation: "Adjust to user's working style"
|
||||
```
|
||||
|
||||
## Post-Execution Hooks
|
||||
|
||||
```yaml
|
||||
Result_Verification:
|
||||
Output_Validation:
|
||||
Expected_Files: "Verify all expected outputs were created"
|
||||
File_Integrity: "Check file contents and formats"
|
||||
Quality_Checks: "Validate output meets requirements"
|
||||
|
||||
System_State_Check:
|
||||
Git_Status: "Verify repository in expected state"
|
||||
File_Permissions: "Check file access rights"
|
||||
Process_State: "Ensure no hanging processes"
|
||||
|
||||
Success_Confirmation:
|
||||
Objective_Achievement:
|
||||
Primary_Goals: "Did operation achieve stated objectives?"
|
||||
Quality_Standards: "Does output meet quality requirements?"
|
||||
User_Satisfaction: "Any user corrections or interruptions?"
|
||||
|
||||
Metrics_Collection:
|
||||
Performance_Data: "Execution time, resource usage, efficiency"
|
||||
Quality_Metrics: "Error rate, retry count, success indicators"
|
||||
User_Experience: "Interruptions, corrections, satisfaction signals"
|
||||
|
||||
Cleanup_Operations:
|
||||
Temporary_Resources:
|
||||
Temp_Files: "Remove temporary files created during operation"
|
||||
Cache_Cleanup: "Clear expired cache entries"
|
||||
Lock_Release: "Release any file or resource locks"
|
||||
|
||||
System_Restoration:
|
||||
Working_Directory: "Restore original working directory"
|
||||
Environment_Variables: "Reset any temporary env vars"
|
||||
Process_Cleanup: "Terminate any background processes"
|
||||
|
||||
Resource_Release:
|
||||
Memory_Cleanup: "Free allocated memory"
|
||||
Network_Connections: "Close unnecessary connections"
|
||||
File_Handles: "Close all opened files"
|
||||
|
||||
Documentation_Update:
|
||||
Operation_Log:
|
||||
Execution_Record: "What was done, when, and how"
|
||||
Performance_Metrics: "Time, resources, efficiency data"
|
||||
Issues_Encountered: "Problems and how they were resolved"
|
||||
|
||||
State_Updates:
|
||||
Project_State: "Update project status/progress"
|
||||
Configuration: "Update configs if changed"
|
||||
Dependencies: "Note any new dependencies added"
|
||||
```
|
||||
|
||||
## Lifecycle Integration Patterns
|
||||
|
||||
```yaml
|
||||
Command_Integration:
|
||||
Template_Usage:
|
||||
Pre_Execution: "@include shared/execution-lifecycle.yml#Pre_Execution"
|
||||
During_Execution: "@include shared/execution-lifecycle.yml#Progress_Monitoring"
|
||||
Post_Execution: "@include shared/execution-lifecycle.yml#Cleanup_Operations"
|
||||
|
||||
Phase_Customization:
|
||||
Command_Specific: "Commands can override default hooks"
|
||||
Additional_Hooks: "Commands can add specific validation/cleanup"
|
||||
Skip_Phases: "Commands can skip irrelevant phases"
|
||||
|
||||
Error_Recovery_Integration:
|
||||
Checkpoint_Strategy:
|
||||
Pre_Phase: "Create checkpoint before each major phase"
|
||||
Mid_Phase: "Create checkpoints during long operations"
|
||||
Recovery_Points: "Well-defined rollback points"
|
||||
|
||||
Error_Escalation:
|
||||
Phase_Failure: "How to handle failure in each phase"
|
||||
Rollback_Strategy: "How to undo partial work"
|
||||
User_Notification: "What to tell user about failures"
|
||||
|
||||
Performance_Integration:
|
||||
Timing_Collection:
|
||||
Phase_Duration: "Track time spent in each phase"
|
||||
Bottleneck_Identification: "Identify slow phases"
|
||||
Optimization_Opportunities: "Where to focus improvements"
|
||||
|
||||
Resource_Monitoring:
|
||||
Peak_Usage: "Maximum resource usage during operation"
|
||||
Efficiency_Metrics: "Resource usage vs. output quality"
|
||||
Scaling_Behavior: "How resource usage scales with operation size"
|
||||
```
|
||||
|
||||
## Customization Framework
|
||||
|
||||
```yaml
|
||||
Hook_Customization:
|
||||
Override_Points:
|
||||
Before_Phase: "Custom actions before standard phase"
|
||||
Replace_Phase: "Complete replacement of standard phase"
|
||||
After_Phase: "Custom actions after standard phase"
|
||||
|
||||
Conditional_Execution:
|
||||
Environment_Based: "Different hooks for dev/staging/prod"
|
||||
Operation_Based: "Different hooks for different operation types"
|
||||
User_Based: "Different hooks based on user preferences"
|
||||
|
||||
Extension_Points:
|
||||
Additional_Validation:
|
||||
Custom_Checks: "Project-specific validation rules"
|
||||
External_Validation: "Integration with external systems"
|
||||
Policy_Enforcement: "Organizational policy checks"
|
||||
|
||||
Enhanced_Monitoring:
|
||||
Custom_Metrics: "Project-specific performance metrics"
|
||||
External_Reporting: "Integration with monitoring systems"
|
||||
Alert_Integration: "Custom alerting rules"
|
||||
|
||||
Specialized_Cleanup:
|
||||
Project_Cleanup: "Project-specific cleanup routines"
|
||||
External_Cleanup: "Integration with external systems"
|
||||
Compliance_Actions: "Regulatory compliance cleanup"
|
||||
```
|
||||
|
||||
---
|
||||
*Execution Lifecycle v1.0 - Common hooks and patterns for consistent SuperClaude operation execution*
|
||||
431
.claude/commands/shared/execution-patterns.yml
Normal file
431
.claude/commands/shared/execution-patterns.yml
Normal file
@@ -0,0 +1,431 @@
|
||||
# Execution Patterns
|
||||
# Unified workflow system, MCP orchestration, git operations, and execution lifecycle
|
||||
|
||||
## Legend
|
||||
| Symbol | Meaning | | Abbrev | Meaning |
|
||||
|--------|---------|---|--------|---------|
|
||||
| 🔄 | lifecycle phase | | dev | development |
|
||||
| 🔀 | git operation | | exec | execution |
|
||||
| 🔧 | MCP server/tool | | wf | workflow |
|
||||
| → | sequential flow | | perf | performance |
|
||||
| & | parallel flow | | ops | operations |
|
||||
| ✓ | validation passed | | chk | checkpoint |
|
||||
| ⚡ | optimization | | cost | token cost |
|
||||
|
||||
## Universal Execution Lifecycle
|
||||
|
||||
```yaml
|
||||
Standard_Lifecycle:
|
||||
Pre_Execution:
|
||||
Risk_Assessment:
|
||||
Calculate: "Score operation risk 1-10"
|
||||
Factors: ["Data loss potential", "Irreversibility", "Scope", "Security"]
|
||||
Actions:
|
||||
Low_1_3: "Proceed w/ monitoring"
|
||||
Med_4_6: "Warn & log"
|
||||
High_7_9: "Require confirmation"
|
||||
Critical_10: "Block & alert"
|
||||
Environment_Validation:
|
||||
Check: ["Required tools", "Permissions", "Resources", "Dependencies"]
|
||||
Verify: ["Git state", "Network access", "Disk space", "Memory"]
|
||||
MCP_Health: "Test server connectivity & response"
|
||||
State_Preparation:
|
||||
Create: "Checkpoint before risky ops"
|
||||
Cache: "Previous results for efficiency"
|
||||
Lock: "Prevent concurrent modifications"
|
||||
|
||||
During_Execution:
|
||||
Progress_Monitoring:
|
||||
Track: ["Operation progress", "Resource usage", "Error rates", "Token consumption"]
|
||||
Alert: ["Performance degradation", "Approaching limits", "Anomalies", "MCP failures"]
|
||||
Dynamic_Optimization:
|
||||
Adapt: ["Adjust parallelism", "Switch strategies", "Cache results", "Fallback to native"]
|
||||
Fallback: ["Use alternatives if primary fails", "Degrade gracefully"]
|
||||
Error_Handling:
|
||||
Detect: "Catch errors immediately"
|
||||
Classify: "Transient vs permanent"
|
||||
Respond: "Retry, fallback, or halt"
|
||||
|
||||
Post_Execution:
|
||||
Verification:
|
||||
Confirm: ["Expected outcomes achieved", "No side effects", "State consistent"]
|
||||
Validate: ["Output quality", "Performance metrics", "Security compliance"]
|
||||
Cleanup:
|
||||
Remove: ["Temp files", "Locks", "Cached data"]
|
||||
Update: ["Audit logs", "Metrics", "Documentation"]
|
||||
Reporting:
|
||||
Generate: ["Success/failure report", "Performance metrics", "Recommendations"]
|
||||
Store: ".claudedocs/lifecycle/execution-{timestamp}.md"
|
||||
```
|
||||
|
||||
## MCP Server Registry & Orchestration
|
||||
|
||||
```yaml
|
||||
Servers:
|
||||
Context7:
|
||||
Purpose: "Library documentation and code examples"
|
||||
Best_For: ["API usage", "framework patterns", "library integration"]
|
||||
Token_Cost: "Low-Medium (100-2000 tokens)"
|
||||
Capabilities:
|
||||
- resolve-library-id: "Find Context7-compatible library ID"
|
||||
- get-library-docs: "Fetch up-to-date documentation"
|
||||
Success_Rate: "95% for popular libraries"
|
||||
Fallback: "WebSearch official docs"
|
||||
|
||||
Sequential:
|
||||
Purpose: "Step-by-step complex problem solving"
|
||||
Best_For: ["Architecture", "debugging", "system design", "root cause analysis"]
|
||||
Token_Cost: "Medium-High (500-10000 tokens)"
|
||||
Capabilities:
|
||||
- sequentialthinking: "Adaptive multi-step reasoning"
|
||||
Success_Rate: "90% for complex problems"
|
||||
Fallback: "Native step-by-step analysis"
|
||||
|
||||
Magic:
|
||||
Purpose: "UI component generation with 21st.dev"
|
||||
Best_For: ["React/Vue components", "UI patterns", "prototypes"]
|
||||
Token_Cost: "Medium (500-2000 tokens)"
|
||||
Capabilities:
|
||||
- 21st_magic_component_builder: "Generate UI components"
|
||||
- 21st_magic_component_refiner: "Improve existing components"
|
||||
- 21st_magic_component_inspiration: "Search component library"
|
||||
- logo_search: "Find company logos in TSX/JSX/SVG"
|
||||
Success_Rate: "85% for common components"
|
||||
Fallback: "Search existing components in project"
|
||||
|
||||
Puppeteer:
|
||||
Purpose: "Browser automation and testing"
|
||||
Best_For: ["E2E tests", "screenshots", "web scraping", "performance testing"]
|
||||
Token_Cost: "Low (minimal tokens, mostly actions)"
|
||||
Capabilities:
|
||||
- connect_active_tab: "Connect to Chrome debugging"
|
||||
- navigate: "Navigate to URLs"
|
||||
- screenshot: "Capture page/element screenshots"
|
||||
- click: "Click elements"
|
||||
- fill: "Fill form inputs"
|
||||
- evaluate: "Execute JavaScript"
|
||||
Success_Rate: "98% for standard web interactions"
|
||||
Fallback: "Manual testing guidance"
|
||||
|
||||
MCP_Control_Flags:
|
||||
Individual:
|
||||
--c7: "Enable Context7 only"
|
||||
--no-c7: "Disable Context7"
|
||||
--seq: "Enable Sequential only"
|
||||
--no-seq: "Disable Sequential"
|
||||
--magic: "Enable Magic only"
|
||||
--no-magic: "Disable Magic"
|
||||
--pup: "Enable Puppeteer only"
|
||||
--no-pup: "Disable Puppeteer"
|
||||
|
||||
Combined:
|
||||
--all-mcp: "Enable all MCP servers"
|
||||
--no-mcp: "Disable all MCP servers (native tools only)"
|
||||
|
||||
Priority: "Explicit flags > Command defaults > Context triggers"
|
||||
Override: "--no-mcp overrides all individual flags"
|
||||
```
|
||||
|
||||
## Chain Execution Patterns
|
||||
|
||||
```yaml
|
||||
Execution_Types:
|
||||
Sequential: "A→B→C | Linear progression w/ context handoff"
|
||||
Parallel: "A&B&C | Concurrent execution w/ result aggregation"
|
||||
Conditional: "A&&B||C | Success/failure branching paths"
|
||||
Iterative: "A→B→check→A | Loop until condition met"
|
||||
|
||||
Chain_Control:
|
||||
Success_Rules:
|
||||
Continue: "Pass enriched context to next command"
|
||||
Cache: "Store intermediate results for reuse"
|
||||
Skip: "Skip redundant operations if cached"
|
||||
Failure_Rules:
|
||||
Critical: "STOP: Halt chain, preserve context"
|
||||
Recoverable: "RETRY: 3 attempts w/ exponential backoff"
|
||||
Non_Critical: "CONTINUE: Log warning, proceed degraded"
|
||||
Validation: "BRANCH: Alternative path or manual fix"
|
||||
Context_Flow:
|
||||
Persist: "Maintain context throughout chain"
|
||||
Selective: "Pass only relevant results between commands"
|
||||
Cleanup: "Clear context after chain completion"
|
||||
Checkpoint: "Auto-save state before critical ops"
|
||||
|
||||
Intelligent_MCP_Selection:
|
||||
Command_Defaults:
|
||||
analyze + --architecture: "Suggest --seq for system analysis"
|
||||
build + --react: "Suggest --magic for UI components"
|
||||
test + --e2e: "Suggest --pup for browser testing"
|
||||
explain + library_name: "Suggest --c7 for documentation"
|
||||
design + --api: "Suggest --seq --c7 for comprehensive design"
|
||||
troubleshoot + --investigate: "Suggest --seq for root cause analysis"
|
||||
improve + --performance: "Suggest --seq --pup for optimization analysis"
|
||||
|
||||
Context_Triggers:
|
||||
Import_Errors: "→ C7 lookup REQUIRED"
|
||||
Complex_Debugging: "→ Sequential thinking"
|
||||
UI_Requests: "→ Magic builder"
|
||||
E2E_Testing: "→ Puppeteer automation"
|
||||
|
||||
Synergistic_Patterns:
|
||||
--magic + --pup: "Generate UI components and test immediately"
|
||||
--seq + --c7: "Complex analysis with authoritative documentation"
|
||||
--seq + --think-hard: "Deep architectural analysis with documentation"
|
||||
--c7 + --uc: "Research with compressed output for token efficiency"
|
||||
```
|
||||
|
||||
## Development Workflows
|
||||
|
||||
```yaml
|
||||
Full_Stack_Development:
|
||||
Chain: "load→analyze→design→build→test→scan→deploy"
|
||||
Flags: ["--think", "--magic", "--validate"]
|
||||
MCP_Usage: ["--c7 for docs", "--magic for UI", "--seq for design"]
|
||||
Time: "45-90 minutes"
|
||||
Context_Handoff:
|
||||
load→analyze: "Project understanding"
|
||||
analyze→design: "Issues & architecture"
|
||||
design→build: "Patterns & structure"
|
||||
build→test: "Implementation"
|
||||
test→scan: "Coverage & results"
|
||||
scan→deploy: "Security validation"
|
||||
|
||||
Feature_Implementation:
|
||||
Chain: "analyze --code→design --feature→build --feature→test→git --commit"
|
||||
Flags: ["--think", "--magic"]
|
||||
MCP_Usage: ["--magic for components", "--c7 for patterns"]
|
||||
Time: "20-45 minutes"
|
||||
|
||||
Bug_Investigation_Fix:
|
||||
Chain: "troubleshoot --investigate→analyze --code→improve --quality→test→git --commit"
|
||||
Flags: ["--think-hard", "--seq"]
|
||||
MCP_Usage: ["--seq for investigation", "--c7 for solutions"]
|
||||
Time: "15-60 minutes"
|
||||
|
||||
Tech_Debt_Reduction:
|
||||
Chain: "analyze --architecture→design --refactor→improve --quality→test→document"
|
||||
Flags: ["--think-hard", "--refactor", "--quality"]
|
||||
MCP_Usage: ["--seq for analysis", "--c7 for patterns"]
|
||||
Time: "60-180 minutes"
|
||||
```
|
||||
|
||||
## Git Integration Patterns
|
||||
|
||||
```yaml
|
||||
Git_Workflows:
|
||||
Auto_Safety_Checks:
|
||||
Before_Commit:
|
||||
- "git status → Verify intended files"
|
||||
- "git diff --staged → Review changes"
|
||||
- "Run tests if available"
|
||||
- "Check for secrets/credentials"
|
||||
Before_Push:
|
||||
- "Verify target branch & remote"
|
||||
- "Check for force push implications"
|
||||
- "Ensure CI/CD readiness"
|
||||
Before_Merge:
|
||||
- "Test for conflicts"
|
||||
- "Verify branch policies"
|
||||
- "Check approval requirements"
|
||||
|
||||
Commit_Standards:
|
||||
Format: "{type}: {description}\n\n{body}\n\n🤖 Generated with [Claude Code]\n\nCo-Authored-By: Claude"
|
||||
Types: ["feat", "fix", "docs", "style", "refactor", "test", "chore"]
|
||||
Validation:
|
||||
- "Type matches change nature"
|
||||
- "Description < 50 chars"
|
||||
- "Body explains why, not what"
|
||||
|
||||
Branch_Management:
|
||||
Strategy:
|
||||
Feature: "feature/{description}"
|
||||
Bugfix: "bugfix/{description}"
|
||||
Release: "release/{version}"
|
||||
Hotfix: "hotfix/{description}"
|
||||
Protection:
|
||||
Main: "No direct push, PR required"
|
||||
Release: "Admin approval required"
|
||||
Feature: "Auto-delete after merge"
|
||||
|
||||
Conflict_Resolution:
|
||||
Detection: "Auto-detect during pull/merge"
|
||||
Strategies:
|
||||
Simple: "Auto-resolve if non-overlapping"
|
||||
Complex: "Interactive 3-way merge"
|
||||
Binary: "Choose version explicitly"
|
||||
Recovery:
|
||||
Abort: "git merge --abort → restore state"
|
||||
Stash: "git stash → try different approach"
|
||||
Branch: "Create conflict-resolution branch"
|
||||
```
|
||||
|
||||
## Checkpoint & Recovery System
|
||||
|
||||
```yaml
|
||||
Checkpoint_Management:
|
||||
Creation_Triggers:
|
||||
Automatic:
|
||||
- "Before destructive operations"
|
||||
- "Major version changes"
|
||||
- "Production deployments"
|
||||
- "Data migrations"
|
||||
Risk_Based:
|
||||
Score_7_9: "Create checkpoint"
|
||||
Score_10: "Checkpoint + backup"
|
||||
Time_Based:
|
||||
Interval: "Every 30 min during long ops"
|
||||
|
||||
Checkpoint_Contents:
|
||||
State_Snapshot:
|
||||
Files: ["Modified files list", "File contents hash"]
|
||||
Git: ["Branch", "Commit SHA", "Uncommitted changes"]
|
||||
Environment: ["Tool versions", "Config values", "Dependencies"]
|
||||
MCP_State: ["Active servers", "Token usage", "Cache state"]
|
||||
Metadata:
|
||||
Timestamp: "ISO 8601 format"
|
||||
Operation: "Command being executed"
|
||||
Risk_Score: "Calculated risk level"
|
||||
User: "Who initiated operation"
|
||||
|
||||
Recovery_Options:
|
||||
Quick_Rollback:
|
||||
Command: "/rollback --to-checkpoint {id}"
|
||||
Scope: "Files only, preserve git state"
|
||||
Full_Restore:
|
||||
Command: "/rollback --full {id}"
|
||||
Scope: "Complete state including git"
|
||||
Selective:
|
||||
Command: "/rollback --files {pattern}"
|
||||
Scope: "Specific files only"
|
||||
|
||||
Storage:
|
||||
Location: ".claudedocs/checkpoints/"
|
||||
Format: "checkpoint-{timestamp}-{operation}.tar.gz"
|
||||
Retention: "7 days or 10 checkpoints"
|
||||
Cleanup: "Auto-remove old checkpoints"
|
||||
```
|
||||
|
||||
## Token Budget Management
|
||||
|
||||
```yaml
|
||||
Cost_Categories:
|
||||
Native_Tools: "0 tokens"
|
||||
Light_MCP: "100-500 tokens"
|
||||
Medium_MCP: "500-2000 tokens"
|
||||
Heavy_MCP: "2000-10000 tokens"
|
||||
|
||||
Budget_Escalation:
|
||||
1: "Native first for simple tasks"
|
||||
2: "C7 for library questions"
|
||||
3: "Sequential for complex analysis"
|
||||
4: "Combine MCPs for synergy"
|
||||
|
||||
Abort_Conditions:
|
||||
Context_Usage: ">50% context → native tools"
|
||||
Timeout_Errors: "MCP timeout/error → fallback"
|
||||
Diminishing_Returns: "Poor results → stop MCP usage"
|
||||
|
||||
Failover_Chains:
|
||||
Context7_Failure:
|
||||
Primary: "C7 documentation lookup"
|
||||
Fallback_1: "WebSearch official docs"
|
||||
Fallback_2: "Local cache if available"
|
||||
Fallback_3: "Continue w/ warning + note limitation"
|
||||
|
||||
Sequential_Failure:
|
||||
Primary: "Sequential thinking server"
|
||||
Fallback_1: "Native step-by-step analysis"
|
||||
Fallback_2: "Simplified linear approach"
|
||||
Fallback_3: "Manual breakdown w/ user input"
|
||||
|
||||
Magic_Failure:
|
||||
Primary: "Magic UI component generation"
|
||||
Fallback_1: "Search existing components in project"
|
||||
Fallback_2: "Generate basic template manually"
|
||||
Fallback_3: "Provide implementation guidance"
|
||||
|
||||
Puppeteer_Failure:
|
||||
Primary: "Puppeteer browser automation"
|
||||
Fallback_1: "Native testing commands"
|
||||
Fallback_2: "Manual testing instructions"
|
||||
Fallback_3: "Static analysis where possible"
|
||||
```
|
||||
|
||||
## Performance & Monitoring
|
||||
|
||||
```yaml
|
||||
Performance_Tracking:
|
||||
Metrics:
|
||||
Build_Times: "Track duration trends"
|
||||
Test_Execution: "Monitor suite performance"
|
||||
Bundle_Sizes: "Track asset size changes"
|
||||
Memory_Usage: "Monitor CLI consumption"
|
||||
MCP_Response_Times: "Track server performance"
|
||||
Token_Consumption: "Monitor MCP usage efficiency"
|
||||
Baselines:
|
||||
Initial: "Capture on first run"
|
||||
Update: "Update weekly"
|
||||
Analysis: "Identify regressions"
|
||||
Alert_Thresholds:
|
||||
Build_Time: "> 50% from baseline"
|
||||
Bundle_Size: "> 20% from baseline"
|
||||
Test_Time: "> 30% from baseline"
|
||||
Memory: "> 2x baseline"
|
||||
MCP_Timeout: "> 30 seconds"
|
||||
Storage: ".claudedocs/metrics/performance-{YYYY-MM-DD}.jsonl"
|
||||
|
||||
Server_Performance:
|
||||
Response_Times:
|
||||
Context7: "1-5 seconds (network dependent)"
|
||||
Sequential: "5-30 seconds (complexity dependent)"
|
||||
Magic: "3-15 seconds (component complexity)"
|
||||
Puppeteer: "1-10 seconds (page load dependent)"
|
||||
|
||||
Resource_Usage:
|
||||
Context7: "Low CPU, Medium Network"
|
||||
Sequential: "High CPU, Low Network"
|
||||
Magic: "Medium CPU, High Network"
|
||||
Puppeteer: "Medium CPU, Low Network"
|
||||
|
||||
Reliability_Scores:
|
||||
Context7: "95% (dependent on library availability)"
|
||||
Sequential: "98% (internal processing)"
|
||||
Magic: "90% (external service dependency)"
|
||||
Puppeteer: "95% (browser dependency)"
|
||||
```
|
||||
|
||||
## Command Integration
|
||||
|
||||
```yaml
|
||||
Chain_Commands:
|
||||
Execute:
|
||||
Predefined: "/chain 'feature-dev' --magic --think"
|
||||
Custom: "/analyze → /build → /test"
|
||||
Conditional: "/test && /deploy || /troubleshoot"
|
||||
Control:
|
||||
Status: "/chain-status | Show current progress"
|
||||
Results: "/chain-results | Show accumulated context"
|
||||
Pause: "/chain-pause | Pause at current step"
|
||||
Resume: "/chain-resume | Continue from pause"
|
||||
Abort: "/chain-abort | Stop and cleanup"
|
||||
Retry: "/chain-retry | Retry failed step"
|
||||
|
||||
Command_Hooks:
|
||||
Build_Hooks:
|
||||
Pre: ["Clean artifacts", "Verify dependencies", "Set environment", "Check MCP health"]
|
||||
During: ["Monitor progress", "Cache layers", "Handle errors", "Track token usage"]
|
||||
Post: ["Verify output", "Run smoke tests", "Update manifests", "Log MCP performance"]
|
||||
|
||||
Test_Hooks:
|
||||
Pre: ["Reset test data", "Start services", "Clear caches", "Connect Puppeteer if needed"]
|
||||
During: ["Track coverage", "Monitor performance", "Capture logs", "Handle browser events"]
|
||||
Post: ["Generate reports", "Clean test data", "Archive results", "Disconnect browser"]
|
||||
|
||||
Deploy_Hooks:
|
||||
Pre: ["Verify environment", "Check permissions", "Backup current", "Validate with Sequential"]
|
||||
During: ["Monitor health", "Track progress", "Handle rollback", "Log deployment events"]
|
||||
Post: ["Verify deployment", "Run health checks", "Update docs", "Generate deployment report"]
|
||||
```
|
||||
|
||||
---
|
||||
*Execution Patterns v4.0.0 - Unified workflow system, MCP orchestration, git operations, and execution lifecycle*
|
||||
117
.claude/commands/shared/feature-template.md
Normal file
117
.claude/commands/shared/feature-template.md
Normal file
@@ -0,0 +1,117 @@
|
||||
| Symbol | Meaning | | Abbrev | Meaning |
|
||||
|--------|---------|---|--------|---------|
|
||||
| → | leads to | | cfg | configuration |
|
||||
| & | and/with | | impl | implementation |
|
||||
| w/ | with | | perf | performance |
|
||||
| @ | at/located | | ops | operations |
|
||||
| > | greater than | | val | validation |
|
||||
| ∀ | for all/every | | req | requirements |
|
||||
| ∃ | exists/there is | | deps | dependencies |
|
||||
| ∴ | therefore | | env | environment |
|
||||
| ∵ | because | | db | database |
|
||||
| ≡ | equivalent | | api | interface |
|
||||
| ≈ | approximately | | docs | documentation |
|
||||
| 📁 | directory/path | | std | standard |
|
||||
| 🔢 | number/count | | def | default |
|
||||
| 📝 | text/string | | ctx | context |
|
||||
| ⚙ | setting/config | | err | error |
|
||||
| 🎛 | control/flags | | exec | execution |
|
||||
| 🔧 | configuration | | qual | quality |
|
||||
| 📋 | group/category | | rec | recovery |
|
||||
| 🚨 | critical/urgent | | sev | severity |
|
||||
| ⚠ | warning/caution | | resp | response |
|
||||
| 🔄 | retry/recovery | | esc | escalation |
|
||||
| ✅ | success/fixed | | tok | token |
|
||||
| ❌ | failure/error | | opt | optimization |
|
||||
| ℹ | information | | UX | user experience |
|
||||
| ⚡ | fast/quick | | UI | user interface |
|
||||
| 🐌 | slow/delayed | | C | critical |
|
||||
| ✨ | complete/done | | H | high |
|
||||
| 📖 | read operation | | M | medium |
|
||||
| ✏ | edit operation | | L | low |
|
||||
| 🗑 | delete operation | | |
|
||||
|
||||
## Command Execution
|
||||
Execute: immediate. --plan→show plan first
|
||||
Legend: Generated based on symbols used in command
|
||||
Purpose: "[Action][Subject] in $ARGUMENTS"
|
||||
|
||||
Feature development template with metadata tracking.
|
||||
|
||||
## Universal Flags
|
||||
--plan: "Show execution plan before running"
|
||||
--uc: "UltraCompressed mode (~70% token reduction)"
|
||||
--ultracompressed: "Alias for --uc"
|
||||
--think: "Multi-file analysis w/ context (4K tokens)"
|
||||
--think-hard: "Deep architectural analysis (10K tokens)"
|
||||
--ultrathink: "Critical system redesign (32K tokens)"
|
||||
--c7: "Enable Context7→library documentation lookup"
|
||||
--seq: "Enable Sequential→complex analysis & thinking"
|
||||
--magic: "Enable Magic→UI component generation"
|
||||
--pup: "Enable Puppeteer→browser automation & testing"
|
||||
--all-mcp: "Enable all MCP servers"
|
||||
--no-mcp: "Disable all MCP servers (native tools only)"
|
||||
--no-c7: "Disable Context7 specifically"
|
||||
--no-seq: "Disable Sequential thinking specifically"
|
||||
--no-magic: "Disable Magic UI builder specifically"
|
||||
--no-pup: "Disable Puppeteer specifically"
|
||||
|
||||
# Task: {TASK_NAME}
|
||||
|
||||
## Metadata
|
||||
```yaml
|
||||
id: {TASK_ID}
|
||||
title: {TASK_TITLE}
|
||||
status: pending
|
||||
priority: medium
|
||||
created: {TIMESTAMP}
|
||||
updated: {TIMESTAMP}
|
||||
assignee: Claude
|
||||
branch: feature/{TASK_ID}
|
||||
```
|
||||
|
||||
## Requirement
|
||||
{REQUIREMENT_DESCRIPTION}
|
||||
|
||||
## Breakdown
|
||||
### Analysis Phase
|
||||
- [ ] Understand requirements
|
||||
- [ ] Identify affected files
|
||||
- [ ] Plan architecture changes
|
||||
- [ ] Create git branch
|
||||
|
||||
### Implementation Phase
|
||||
- [ ] {STEP_1}
|
||||
- [ ] {STEP_2}
|
||||
- [ ] {STEP_3}
|
||||
|
||||
### Testing Phase
|
||||
- [ ] Write tests
|
||||
- [ ] Run test suite
|
||||
- [ ] Manual testing
|
||||
|
||||
### Completion Phase
|
||||
- [ ] Code review
|
||||
- [ ] Documentation update
|
||||
- [ ] Merge to main
|
||||
|
||||
## Files Affected
|
||||
```yaml
|
||||
new: []
|
||||
modified: []
|
||||
deleted: []
|
||||
```
|
||||
|
||||
## Context Preservation
|
||||
```yaml
|
||||
key_decisions: []
|
||||
blockers: []
|
||||
notes: []
|
||||
session_state: {}
|
||||
```
|
||||
|
||||
## Checkpoints
|
||||
```yaml
|
||||
commits: []
|
||||
branches: []
|
||||
```
|
||||
216
.claude/commands/shared/flag-inheritance.yml
Normal file
216
.claude/commands/shared/flag-inheritance.yml
Normal file
@@ -0,0 +1,216 @@
|
||||
# Flag Inheritance System
|
||||
# Consolidated flag definitions for SuperClaude commands
|
||||
|
||||
## Legend
|
||||
| Symbol | Meaning | | Abbrev | Meaning |
|
||||
|--------|---------|---|--------|---------|
|
||||
| 🎛 | control/flags | | std | standard |
|
||||
| 🔧 | configuration | | exec | execution |
|
||||
| 📋 | group/category | | qual | quality |
|
||||
| ⚙ | settings/options | | val | validation |
|
||||
|
||||
## Universal Flags (All Commands)
|
||||
|
||||
```yaml
|
||||
Universal_Always:
|
||||
Planning:
|
||||
--plan: "Show execution plan before running"
|
||||
|
||||
Compression:
|
||||
--uc: "UltraCompressed mode (~70% token reduction)"
|
||||
--ultracompressed: "Alias for --uc"
|
||||
|
||||
Thinking_Modes:
|
||||
--think: "Multi-file analysis w/ context (4K tokens)"
|
||||
--think-hard: "Deep architectural analysis (10K tokens)"
|
||||
--ultrathink: "Critical system redesign (32K tokens)"
|
||||
|
||||
MCP_Control:
|
||||
--c7: "Enable Context7→library documentation lookup"
|
||||
--seq: "Enable Sequential→complex analysis & thinking"
|
||||
--magic: "Enable Magic→UI component generation"
|
||||
--pup: "Enable Puppeteer→browser automation & testing"
|
||||
--all-mcp: "Enable all MCP servers"
|
||||
--no-mcp: "Disable all MCP servers (native tools only)"
|
||||
--no-c7: "Disable Context7 specifically"
|
||||
--no-seq: "Disable Sequential thinking specifically"
|
||||
--no-magic: "Disable Magic UI builder specifically"
|
||||
--no-pup: "Disable Puppeteer specifically"
|
||||
```
|
||||
|
||||
## Common Workflow Flags (3+ Commands)
|
||||
|
||||
```yaml
|
||||
Execution_Control:
|
||||
--watch: "Continuous monitoring w/ real-time feedback"
|
||||
--interactive: "Step-by-step guided process w/ user control"
|
||||
--dry-run: "Preview changes without execution"
|
||||
--force: "Override safety checks & confirmations"
|
||||
|
||||
Quality_Assurance:
|
||||
--validate: "Pre-execution safety & validation checks"
|
||||
--security: "Security analysis & vulnerability scanning"
|
||||
--coverage: "Generate comprehensive coverage analysis"
|
||||
--strict: "Zero-tolerance mode w/ enhanced validation"
|
||||
|
||||
Performance:
|
||||
--profile: "Detailed performance profiling & metrics"
|
||||
--iterate: "Iterative improvement until threshold met"
|
||||
--threshold: "Set target percentage (default 85%)"
|
||||
--watch-perf: "Continuous performance monitoring"
|
||||
|
||||
Development:
|
||||
--tdd: "Test-driven development workflow"
|
||||
--feature: "Feature-focused implementation"
|
||||
--init: "Initialize new project/component"
|
||||
--all: "Comprehensive operation across all areas"
|
||||
```
|
||||
|
||||
## Command Group Templates
|
||||
|
||||
```yaml
|
||||
Analysis_Commands:
|
||||
# analyze, scan, troubleshoot
|
||||
Standard_Flags:
|
||||
--code: "Analyze code quality & structure"
|
||||
--arch: "Analyze system architecture & design"
|
||||
--perf: "Analyze performance & bottlenecks"
|
||||
--profile: "Detailed performance profiling"
|
||||
--security: "Security vulnerability analysis"
|
||||
--deps: "Dependency analysis & audit"
|
||||
|
||||
Build_Commands:
|
||||
# build, design, deploy
|
||||
Standard_Flags:
|
||||
--init: "Initialize new project w/ stack setup"
|
||||
--feature: "Implement feature using existing patterns"
|
||||
--api: "API-focused development"
|
||||
--react: "React/frontend focused build"
|
||||
--tdd: "Test-driven development workflow"
|
||||
--magic: "Use Magic for UI component generation"
|
||||
|
||||
Quality_Commands:
|
||||
# test, improve, cleanup
|
||||
Standard_Flags:
|
||||
--coverage: "Generate comprehensive test coverage"
|
||||
--quality: "Focus on code quality improvements"
|
||||
--iterate: "Iterative improvement until threshold"
|
||||
--threshold: "Set target percentage (default 85%)"
|
||||
--all: "Comprehensive operation across all areas"
|
||||
--quick: "Fast operation focusing on critical issues"
|
||||
|
||||
Documentation_Commands:
|
||||
# document, explain
|
||||
Standard_Flags:
|
||||
--api: "API documentation & reference"
|
||||
--user: "User-friendly guides & tutorials"
|
||||
--depth: "Explanation depth (ELI5|beginner|intermediate|expert)"
|
||||
--visual: "Include diagrams & visual aids"
|
||||
--examples: "Include practical code examples"
|
||||
|
||||
Operations_Commands:
|
||||
# deploy, migrate, git
|
||||
Standard_Flags:
|
||||
--env: "Target environment (dev|staging|prod)"
|
||||
--rollback: "Rollback to previous state"
|
||||
--checkpoint: "Create checkpoint before operation"
|
||||
--sync: "Synchronize w/ remote/upstream"
|
||||
```
|
||||
|
||||
## Flag Usage Templates
|
||||
|
||||
```yaml
|
||||
High_Risk_Operations:
|
||||
# Commands that can cause data loss/system changes
|
||||
Required_Flags:
|
||||
- "--validate (unless --force)"
|
||||
- "--dry-run recommended"
|
||||
Optional_Safety:
|
||||
- "--checkpoint (auto-create backup)"
|
||||
- "--interactive (step-by-step control)"
|
||||
|
||||
Development_Workflow:
|
||||
# Standard development operations
|
||||
Recommended_Combinations:
|
||||
- "--tdd --coverage (quality-first development)"
|
||||
- "--watch --interactive (guided real-time development)"
|
||||
- "--profile --iterate (performance optimization)"
|
||||
- "--security --validate (safe deployment)"
|
||||
|
||||
Research_Operations:
|
||||
# Operations requiring external research
|
||||
Auto_Enable:
|
||||
- "--c7 (library documentation lookup)"
|
||||
- "--seq (complex analysis)"
|
||||
Manual_Override:
|
||||
- "--no-mcp (native tools only)"
|
||||
|
||||
Complex_Analysis:
|
||||
# Operations requiring deep thinking
|
||||
Progressive_Flags:
|
||||
- "No flag: Basic single-file operations"
|
||||
- "--think: Multi-file coordination"
|
||||
- "--think-hard: System architecture analysis"
|
||||
- "--ultrathink: Critical system redesign"
|
||||
```
|
||||
|
||||
## Flag Inheritance Rules
|
||||
|
||||
```yaml
|
||||
Inheritance_Priority:
|
||||
1: "Command-specific flags override group flags"
|
||||
2: "Group flags override common flags"
|
||||
3: "Common flags override universal flags"
|
||||
4: "Universal flags always available"
|
||||
|
||||
Conflict_Resolution:
|
||||
--force_overrides: ["--validate", "--dry-run", "--interactive"]
|
||||
--no-mcp_overrides: ["--c7", "--seq", "--magic", "--pup", "--all-mcp"]
|
||||
--strict_enhances: ["--validate", "--security", "--coverage"]
|
||||
|
||||
Auto_Combinations:
|
||||
--all + group_flags: "Enable all flags in command's group"
|
||||
--strict + quality_flags: "Enhanced validation for all quality operations"
|
||||
--watch + interactive: "Real-time guided operation"
|
||||
|
||||
Validation_Rules:
|
||||
Conflicting_Flags:
|
||||
- "--dry-run + --force" → "Warning: dry-run negates force"
|
||||
- "--no-mcp + any MCP flag" → "Warning: no-mcp overrides specific MCP flags"
|
||||
- "--quick + --all" → "Warning: quick mode contradicts comprehensive operation"
|
||||
```
|
||||
|
||||
## Usage Examples
|
||||
|
||||
```yaml
|
||||
Template_Usage:
|
||||
Command_File_Header: |
|
||||
@include shared/flag-inheritance.yml#Universal_Always
|
||||
@include shared/flag-inheritance.yml#Execution_Control
|
||||
@include shared/flag-inheritance.yml#Analysis_Commands
|
||||
|
||||
Flag_Reference: |
|
||||
Universal flags: @see shared/flag-inheritance.yml#Universal_Always
|
||||
Quality flags: @see shared/flag-inheritance.yml#Quality_Assurance
|
||||
|
||||
Command_Specific_Only: |
|
||||
# Only define flags unique to this command
|
||||
--special-flag: "Command-specific functionality"
|
||||
```
|
||||
|
||||
## Optimization Metrics
|
||||
|
||||
```yaml
|
||||
Duplication_Reduction:
|
||||
Before: "~400 lines of flag definitions across 18 commands"
|
||||
After: "~80 lines in template + ~120 lines command-specific"
|
||||
Savings: "~200 lines (50% reduction in flag definitions)"
|
||||
|
||||
Consistency_Improvements:
|
||||
Standardized_Descriptions: "Single source of truth for flag meanings"
|
||||
Unified_Behavior: "Consistent flag behavior across all commands"
|
||||
Reduced_Maintenance: "Update flags in one place affects all commands"
|
||||
```
|
||||
|
||||
---
|
||||
*Flag Inheritance v4.0.0 - Consolidated flag system for consistent command interfaces*
|
||||
@@ -1,217 +0,0 @@
|
||||
# Git Ops Config
|
||||
|
||||
## Command Workflows
|
||||
```yaml
|
||||
Status_Workflow:
|
||||
1. Check working tree: git status --porcelain
|
||||
2. Current branch: git branch --show-current
|
||||
3. Upstream tracking: git rev-parse --abbrev-ref @{u}
|
||||
4. Stash list: git stash list
|
||||
5. Recent commits: git log --oneline -5
|
||||
6. Unpushed commits: git log @{u}..HEAD --oneline
|
||||
7. Remote status: git remote -v && git fetch --dry-run
|
||||
|
||||
Commit_Workflow:
|
||||
Pre_checks:
|
||||
- Working tree status
|
||||
- Branch protection rules
|
||||
- Pre-commit hooks available
|
||||
Staging:
|
||||
- Interactive: git add -p
|
||||
- All tracked: git add -u
|
||||
- Specific: git add <paths>
|
||||
Message:
|
||||
- Check conventions: conventional commits, gitmoji
|
||||
- Generate from changes if not provided
|
||||
- Include issue refs
|
||||
Post_commit:
|
||||
- Run tests if cfg'd
|
||||
- Update checkpoint manifest
|
||||
- Show commit confirmation
|
||||
|
||||
Branch_Workflow:
|
||||
Create:
|
||||
- From current: git checkout -b <name>
|
||||
- From base: git checkout -b <name> <base>
|
||||
- Set upstream: git push -u origin <name>
|
||||
Switch:
|
||||
- Check uncommitted changes
|
||||
- Stash if needed
|
||||
- git checkout <branch>
|
||||
Delete:
|
||||
- Check if merged: git branch --merged
|
||||
- Local: git branch -d <name>
|
||||
- Remote: git push origin --delete <name>
|
||||
Protection:
|
||||
- Never delete: main, master, develop
|
||||
- Warn on: release/*, hotfix/*
|
||||
|
||||
Sync_Workflow:
|
||||
Fetch:
|
||||
- All remotes: git fetch --all --prune
|
||||
- Tags: git fetch --tags
|
||||
Pull:
|
||||
- With rebase: git pull --rebase
|
||||
- Preserve merges: git pull --rebase=preserve
|
||||
- Autostash: git pull --autostash
|
||||
Push:
|
||||
- Current branch: git push
|
||||
- With lease: git push --force-with-lease
|
||||
- Tags: git push --tags
|
||||
Submodules:
|
||||
- Update: git submodule update --init --recursive
|
||||
- Sync: git submodule sync --recursive
|
||||
|
||||
Merge_Workflow:
|
||||
Pre_merge:
|
||||
- Create checkpoint
|
||||
- Fetch target branch
|
||||
- Check for conflicts: git merge --no-commit --no-ff
|
||||
Merge_strategies:
|
||||
- Fast-forward: git merge --ff-only
|
||||
- No fast-forward: git merge --no-ff
|
||||
- Squash: git merge --squash
|
||||
Conflict_resolution:
|
||||
- List conflicts: git diff --name-only --diff-filter=U
|
||||
- Use theirs: git checkout --theirs <file>
|
||||
- Use ours: git checkout --ours <file>
|
||||
- Manual resolution with markers
|
||||
Post_merge:
|
||||
- Verify: git log --graph --oneline
|
||||
- Run tests
|
||||
- Update documentation
|
||||
```
|
||||
|
||||
## Safety Mechanisms
|
||||
```yaml
|
||||
Checkpoints:
|
||||
Auto_create:
|
||||
- Before merge
|
||||
- Before rebase
|
||||
- Before reset --hard
|
||||
- Before force push
|
||||
Format: checkpoint/git-<operation>-<timestamp>
|
||||
|
||||
Confirmations:
|
||||
Required_for:
|
||||
- Force push to remote
|
||||
- Delete unmerged branch
|
||||
- Reset --hard
|
||||
- Rebase published commits
|
||||
- Checkout with uncommitted changes
|
||||
|
||||
Validations:
|
||||
Pre_commit:
|
||||
- No secrets or API keys
|
||||
- No large files (>100MB)
|
||||
- No merge conflict markers
|
||||
- Code passes linting
|
||||
Pre_push:
|
||||
- Tests pass
|
||||
- No WIP commits
|
||||
- Branch naming conventions
|
||||
- Protected branch rules
|
||||
```
|
||||
|
||||
## Conflict Resolution Patterns
|
||||
```yaml
|
||||
Common_Conflicts:
|
||||
Package_files:
|
||||
- package-lock.json: Regenerate after merge
|
||||
- yarn.lock: Run yarn install
|
||||
- Gemfile.lock: Run bundle install
|
||||
|
||||
Generated_files:
|
||||
- Build artifacts: Regenerate
|
||||
- Compiled assets: Recompile
|
||||
- Documentation: Regenerate
|
||||
|
||||
Code_conflicts:
|
||||
- Imports: Combine both sets
|
||||
- Function signatures: Communicate with team
|
||||
- Feature flags: Usually keep both
|
||||
|
||||
Resolution_Strategy:
|
||||
1. Understand both changes
|
||||
2. Communicate with authors
|
||||
3. Test both functionalities
|
||||
4. Document resolution
|
||||
5. Consider refactoring
|
||||
```
|
||||
|
||||
## Branch Patterns
|
||||
```yaml
|
||||
Naming_Conventions:
|
||||
Feature: feature/<ticket>-<description>
|
||||
Bugfix: bugfix/<ticket>-<description>
|
||||
Hotfix: hotfix/<ticket>-<description>
|
||||
Release: release/<version>
|
||||
Experimental: exp/<description>
|
||||
|
||||
Protection_Rules:
|
||||
main/master:
|
||||
- No direct commits
|
||||
- Require PR reviews
|
||||
- Must pass CI/CD
|
||||
- No force push
|
||||
develop:
|
||||
- Require PR for features
|
||||
- Allow hotfix direct merge
|
||||
- Must pass tests
|
||||
release/*:
|
||||
- Only fixes allowed
|
||||
- Version bumps only
|
||||
- Tag on completion
|
||||
```
|
||||
|
||||
## Commit Patterns
|
||||
```yaml
|
||||
Message_Format:
|
||||
Conventional: <type>(<scope>): <subject>
|
||||
Gitmoji: <emoji> <type>: <subject>
|
||||
Simple: <Type>: <Subject>
|
||||
|
||||
Types:
|
||||
feat: New feature
|
||||
fix: Bug fix
|
||||
docs: Documentation
|
||||
style: Code style (no logic change)
|
||||
refactor: Code restructuring
|
||||
test: Test additions/changes
|
||||
chore: Build process/tools
|
||||
perf: Performance improvements
|
||||
ci: CI/CD changes
|
||||
|
||||
Best_Practices:
|
||||
- Atomic commits (one change per commit)
|
||||
- Present tense, imperative mood
|
||||
- Reference issues/tickets
|
||||
- Explain why, not what
|
||||
- Keep subject line < 50 chars
|
||||
- Wrap body at 72 chars
|
||||
```
|
||||
|
||||
## Automation Hooks
|
||||
```yaml
|
||||
Pre_commit:
|
||||
- Lint staged files
|
||||
- Run type checking
|
||||
- Format code
|
||||
- Check for secrets
|
||||
- Validate commit message
|
||||
|
||||
Pre_push:
|
||||
- Run full test suite
|
||||
- Check code coverage
|
||||
- Validate branch name
|
||||
- Check for WIP commits
|
||||
|
||||
Post_merge:
|
||||
- Install new dependencies
|
||||
- Run database migrations
|
||||
- Update documentation
|
||||
- Notify team members
|
||||
```
|
||||
|
||||
---
|
||||
*Git Operations: Comprehensive git workflow management*
|
||||
@@ -1,37 +0,0 @@
|
||||
# Git Workflow Integration
|
||||
|
||||
## Auto-Check
|
||||
```yaml
|
||||
Before Major Changes:
|
||||
- git status | Check for uncommitted changes
|
||||
- git branch | Verify correct branch
|
||||
- git fetch | Check for remote updates
|
||||
|
||||
Suggest Commits:
|
||||
- After feature completion
|
||||
- Before switching branches
|
||||
- At logical breakpoints
|
||||
|
||||
Conflict Detection:
|
||||
- Scan for merge conflict markers
|
||||
- Offer resolution patterns
|
||||
- Guide through conflict resolution
|
||||
```
|
||||
|
||||
## Workflow Patterns
|
||||
```yaml
|
||||
Feature Work:
|
||||
New feature→Suggest feature branch
|
||||
Multiple changes→Suggest incremental commits
|
||||
Experimental→Suggest separate branch
|
||||
|
||||
Clean State:
|
||||
Uncommitted changes→"Commit first?" or "Stash?"
|
||||
Wrong branch→"Switch→feature branch?"
|
||||
Conflicts → "Resolve conflicts first"
|
||||
|
||||
Branch Awareness:
|
||||
main/master → Warn about direct changes
|
||||
feature/* → Encourage commits
|
||||
hotfix/* → Emphasize testing
|
||||
```
|
||||
@@ -1,199 +0,0 @@
|
||||
# Impl Hooks
|
||||
|
||||
## How Claude Code Uses These Patterns
|
||||
|
||||
```yaml
|
||||
Pattern Loading:
|
||||
On Start: Load CLAUDE.md→RULES.md (core behavioral rules)
|
||||
On /persona:: Check if PERSONAS.md loaded→Load if needed→Cache session
|
||||
On MCP ref: Check if MCP.md loaded→Load if needed→Cache session
|
||||
Commands: Parse .claude/commands/*.md on /user: trigger→Cache recent 5
|
||||
Shared: Include shared/*.yml when referenced by active commands
|
||||
|
||||
Severity Enforcement:
|
||||
CRITICAL[10]: Block op & explain why
|
||||
HIGH[7-9]: Warn user & require confirmation
|
||||
MEDIUM[4-6]: Suggest improvement & continue
|
||||
LOW[1-3]: Note in output & proceed
|
||||
|
||||
Auto-Triggers:
|
||||
File Open: Check extension→Load PERSONAS.md if needed→Activate persona
|
||||
Command Start: Load command def→Check ambiguity→Clarify if needed
|
||||
MCP Usage: Load MCP.md if needed→Select appropriate tool
|
||||
Risky Op: Create checkpoint→Log audit→Validate
|
||||
Error: Activate analyzer→Debug workflow
|
||||
```
|
||||
|
||||
## Pattern Integration
|
||||
|
||||
```yaml
|
||||
Todo Management:
|
||||
3+ steps → TodoWrite() with tasks
|
||||
Status → Update immediately on change
|
||||
Complete → Mark done & suggest next
|
||||
|
||||
MCP Selection:
|
||||
Parse request → Check complexity → Select tool
|
||||
Simple → Use native | Complex → Use MCP
|
||||
Monitor tokens → Switch/abort if exceeded
|
||||
|
||||
Context Management:
|
||||
Track % → Warn at 60% → Force compact at 90%
|
||||
Task complete → Auto-compact context
|
||||
Project switch → Clear context
|
||||
```
|
||||
|
||||
## Command Execution
|
||||
|
||||
```yaml
|
||||
Pre-Execution:
|
||||
1. Parse command & args
|
||||
2. Check thinking mode flags:
|
||||
- --think: Activate standard thinking mode (4K tokens)
|
||||
- --think-hard: Activate deep analysis mode (10K tokens)
|
||||
- --ultrathink: Activate critical analysis mode (32K tokens)
|
||||
- Default: Basic mode if no thinking flag present
|
||||
3. Check MCP control flags:
|
||||
- --c7/--no-c7: Control Context7 documentation server
|
||||
- --seq/--no-seq: Control Sequential thinking server
|
||||
- --magic/--no-magic: Control Magic UI builder
|
||||
- --pup/--no-pup: Control Puppeteer browser automation
|
||||
- --all-mcp: Enable all MCP servers
|
||||
- --no-mcp: Disable all MCP servers
|
||||
4. Check risk level (shared/planning-mode.yml)
|
||||
5. If --plan flag → Show plan → await approval
|
||||
6. Check ambiguity (shared/ambiguity-check.yml)
|
||||
7. Research verification (shared/research-first.yml):
|
||||
- External library detected → C7 resolve + get-docs REQUIRED
|
||||
- New UI component needed → Magic search or WebSearch patterns
|
||||
- API integration found → Official docs lookup REQUIRED
|
||||
- Unknown pattern detected → Sequential analysis + research
|
||||
- Block if: No research performed for external dependencies
|
||||
- Cache: Store researched patterns for session reuse
|
||||
8. Preemptive validation:
|
||||
- Dependencies: package.json vs node_modules | Required tools installed
|
||||
- Permissions: File write access | Command availability
|
||||
- State: Clean git status for risky ops | No conflicting processes
|
||||
- Environment: Correct versions | Required env vars set
|
||||
9. Validate permissions (shared/validation.yml)
|
||||
10. Create checkpoint if risky
|
||||
11. Log start (shared/audit.yml)
|
||||
12. Documentation directory check (shared/documentation-dirs.yml):
|
||||
- Report generation? → Ensure .claudedocs/[subdirs] exist
|
||||
- Project docs? → Ensure /docs/[category] exists
|
||||
- Create directories if missing with proper permissions (755)
|
||||
- Validate write permissions to target directories
|
||||
13. UltraCompressed check (shared/ultracompressed.yml):
|
||||
- --uc flag? → Apply compression rules to all output
|
||||
- Context >70%? → Suggest --uc mode
|
||||
- Token budget? → Auto-enable compression
|
||||
- Generate legend at start of compressed docs
|
||||
|
||||
During:
|
||||
- Update todo status
|
||||
- Show progress indicators
|
||||
- Handle errors gracefully
|
||||
- Keep user informed
|
||||
|
||||
Post-Execution:
|
||||
- Log completion/failure
|
||||
- Update todos
|
||||
- If report generated → Note location in output: "📄 Report saved to: [path]"
|
||||
- If docs created → Update /docs/index.md with new entries
|
||||
- Suggest next steps
|
||||
- Compact context if needed
|
||||
```
|
||||
|
||||
## Persona Activation
|
||||
|
||||
```yaml
|
||||
File-Based:
|
||||
*.tsx opened → frontend persona active
|
||||
*.sql opened → data persona active
|
||||
Dockerfile → devops persona active
|
||||
|
||||
Keyword-Based:
|
||||
"optimize" in request → performance persona
|
||||
"secure" mentioned → security persona
|
||||
"refactor" → refactorer persona
|
||||
|
||||
Context-Based:
|
||||
Error trace → analyzer persona
|
||||
Architecture question → architect persona
|
||||
Learning request → mentor persona
|
||||
|
||||
Multi-Persona:
|
||||
Complex task → Sequential activation
|
||||
Parallel work → Concurrent personas
|
||||
Handoff → Share context between
|
||||
```
|
||||
|
||||
## Error Handling
|
||||
|
||||
```yaml
|
||||
Pattern Detection:
|
||||
Match error → Error type in patterns.yml
|
||||
Syntax → Check syntax highlighting
|
||||
Runtime → Validate inputs & types
|
||||
Logic → Trace execution flow
|
||||
|
||||
Recovery:
|
||||
Try operation → Catch error → Check pattern
|
||||
Known → Apply fix pattern
|
||||
Unknown → Activate analyzer → Debug
|
||||
Can't fix → Explain & suggest manual fix
|
||||
```
|
||||
|
||||
## Token Optimization
|
||||
|
||||
```yaml
|
||||
Real-Time:
|
||||
Count tokens → Apply reduction patterns
|
||||
Remove listed words → Use symbols
|
||||
YAML format → Compress output
|
||||
Reference > repeat → Link to existing
|
||||
|
||||
Batch Operations:
|
||||
Group similar → Single operation
|
||||
Parallel when possible → Reduce time
|
||||
Cache results → Avoid re-computation
|
||||
```
|
||||
|
||||
## Unified Behaviors
|
||||
|
||||
```yaml
|
||||
Error Format:
|
||||
All commands: [COMMAND] Error: What→Why→Fix
|
||||
Example: [BUILD] Error: Module X failed→Missing dep Y→Run npm install Y
|
||||
|
||||
Result Format:
|
||||
Success: ✓ Action (Xms) | Details
|
||||
Warning: ⚠ Issue | Impact | Suggestion
|
||||
Failure: ✗ Error | Reason | Recovery
|
||||
|
||||
Command Memory:
|
||||
Store: After each command → .claude/session/[command].cache
|
||||
Reuse: Check cache → Use if valid → Note "using prior analysis"
|
||||
Clear: On file change → Invalidate related caches
|
||||
|
||||
## Loading Optimization
|
||||
```yaml
|
||||
Component Loading:
|
||||
Core: CLAUDE.md + RULES.md loaded on startup (~3500 tokens)
|
||||
Personas: Load on /persona: trigger → Cache for session
|
||||
MCP: Load on MCP tool reference → Cache for session
|
||||
Commands: Load on /user: trigger → Cache recent 5
|
||||
|
||||
Token Savings:
|
||||
Simple tasks: 43% reduction (6100→3500 tokens)
|
||||
With personas: 33% reduction (6100→4100 tokens)
|
||||
With commands: 20-30% reduction (varies by usage)
|
||||
|
||||
Cache Strategy:
|
||||
Session-based: Keep loaded components until session ends
|
||||
LRU: Evict least recently used when memory limits reached
|
||||
Preload: Common patterns loaded proactively
|
||||
```
|
||||
|
||||
---
|
||||
*Implementation: How patterns become actions*
|
||||
@@ -13,7 +13,7 @@ Global Availability:
|
||||
MCP.md: All MCP patterns available automatically
|
||||
|
||||
Commands:
|
||||
Trigger: /user:
|
||||
Trigger: /
|
||||
Path: .claude/commands/
|
||||
Size: ~50 tokens per command
|
||||
Cache: Most recent 5 commands
|
||||
@@ -24,7 +24,7 @@ SharedResources:
|
||||
Path: .claude/commands/shared/
|
||||
Size: ~150 tokens per YAML
|
||||
Examples:
|
||||
- cleanup-patterns.yml→loads w/ /user:cleanup
|
||||
- cleanup-patterns.yml→loads w/ /cleanup
|
||||
- git-workflow.yml→loads w/ git ops
|
||||
- planning-mode.yml→loads w/ risky commands
|
||||
```
|
||||
@@ -70,4 +70,4 @@ Adaptive Optimization:
|
||||
High Memory: Trigger context compression and cleanup
|
||||
Cache Misses: Adjust caching strategy based on usage patterns
|
||||
Performance Degradation: Fall back to minimal loading mode
|
||||
```
|
||||
```
|
||||
|
||||
@@ -1,109 +0,0 @@
|
||||
# MCP Server Flag Config
|
||||
|
||||
## MCP Control Flags
|
||||
```yaml
|
||||
Command_Flags:
|
||||
# Context7 Docs Server
|
||||
--c7: "Enable Context7→lib docs lookup"
|
||||
--no-c7: "Disable Context7 (native tools only)"
|
||||
|
||||
# Sequential Thinking Server
|
||||
--seq: "Enable Sequential thinking→complex analysis"
|
||||
--no-seq: "Disable Sequential thinking"
|
||||
|
||||
# Magic UI Builder Server
|
||||
--magic: "Enable Magic UI component generation"
|
||||
--no-magic: "Disable Magic UI builder"
|
||||
|
||||
# Puppeteer Browser Control Server
|
||||
--pup: "Enable Puppeteer→browser testing"
|
||||
--no-pup: "Disable Puppeteer"
|
||||
|
||||
# Combined Controls
|
||||
--all-mcp: "Enable all MCP servers"
|
||||
--no-mcp: "Disable all MCP servers (native tools only)"
|
||||
|
||||
Usage_Examples:
|
||||
- /user:analyze --code --c7 # Use Context7 for library docs
|
||||
- /user:design --api --seq # Use Sequential for architecture
|
||||
- /user:build --react --magic # Use Magic for UI components
|
||||
- /user:test --e2e --pup # Use Puppeteer for browser tests
|
||||
- /user:troubleshoot --no-mcp # Native tools only for debugging
|
||||
```
|
||||
|
||||
## MCP Server Capabilities
|
||||
```yaml
|
||||
Context7 (--c7):
|
||||
Purpose: Library documentation and code examples
|
||||
Best_for: API usage, framework patterns, library integration
|
||||
Token_cost: Low-Medium (100-2000 tokens)
|
||||
|
||||
Sequential (--seq):
|
||||
Purpose: Step-by-step complex problem solving
|
||||
Best_for: Architecture, debugging, system design
|
||||
Token_cost: Medium-High (500-10000 tokens)
|
||||
|
||||
Magic (--magic):
|
||||
Purpose: UI component generation with 21st.dev
|
||||
Best_for: React/Vue components, UI patterns
|
||||
Token_cost: Medium (500-2000 tokens)
|
||||
|
||||
Puppeteer (--pup):
|
||||
Purpose: Browser automation and testing
|
||||
Best_for: E2E tests, screenshots, web scraping
|
||||
Token_cost: Low (minimal tokens)
|
||||
```
|
||||
|
||||
## Smart Defaults & Recommendations
|
||||
```yaml
|
||||
Command_Defaults:
|
||||
# Commands that benefit from specific MCP servers
|
||||
analyze + --architecture: Suggest --seq for system analysis
|
||||
build + --react: Suggest --magic for UI components
|
||||
test + --e2e: Suggest --pup for browser testing
|
||||
explain + library_name: Suggest --c7 for documentation
|
||||
design + --api: Suggest --seq --c7 for comprehensive design
|
||||
troubleshoot + --investigate: Suggest --seq for root cause analysis
|
||||
improve + --performance: Suggest --seq --pup for optimization analysis
|
||||
|
||||
Intelligent Combinations:
|
||||
--magic + --pup: Generate UI components and test them immediately
|
||||
--seq + --c7: Complex analysis with authoritative documentation
|
||||
--seq + --think-hard: Deep architectural analysis with documentation
|
||||
--c7 + --uc: Research with compressed output for token efficiency
|
||||
|
||||
Conflict_Resolution:
|
||||
--no-mcp overrides: All individual MCP flags
|
||||
Explicit beats implicit: --no-c7 overrides auto-activation
|
||||
Cost awareness: Warn if multiple high-cost MCPs selected
|
||||
Token budget: Auto-suggest --uc when approaching limits
|
||||
```
|
||||
|
||||
## Integration with Other Flags
|
||||
```yaml
|
||||
Synergies:
|
||||
--think + --seq: Enhanced analysis with Sequential thinking
|
||||
--ultrathink + --all-mcp: Maximum capability for critical tasks
|
||||
--plan + --seq: Better planning with Sequential analysis
|
||||
--magic + --pup: Generate and test UI components
|
||||
|
||||
Anti-patterns:
|
||||
--no-mcp + --c7: Conflicting flags (no-mcp wins)
|
||||
Multiple costly: --seq --ultrathink (warn about token usage)
|
||||
```
|
||||
|
||||
## Auto-Activation Override
|
||||
```yaml
|
||||
Flag_Priority:
|
||||
1. Explicit flags (--c7, --no-c7) → Highest priority
|
||||
2. Command defaults → Medium priority
|
||||
3. Context triggers → Lowest priority
|
||||
|
||||
Examples:
|
||||
"React hooks" + --no-c7 → Skip Context7 despite keyword
|
||||
/user:build --react --no-magic → Skip Magic UI despite React
|
||||
/user:analyze --no-mcp → Pure native tools analysis
|
||||
```
|
||||
|
||||
---
|
||||
*MCP Flags: Explicit control over Model Context Protocol servers*
|
||||
@@ -1,165 +0,0 @@
|
||||
# Command Files Template Migration Report
|
||||
|
||||
## Overview
|
||||
|
||||
Successfully migrated 18 out of 19 command files to use the expanded template system, achieving significant token reduction and consistency improvements.
|
||||
|
||||
## Files Updated
|
||||
|
||||
✅ **Completed (18 files):**
|
||||
- analyze.md (already optimized)
|
||||
- build.md (already optimized)
|
||||
- cleanup.md
|
||||
- deploy.md
|
||||
- design.md
|
||||
- dev-setup.md
|
||||
- document.md
|
||||
- estimate.md
|
||||
- explain.md
|
||||
- git.md (already optimized)
|
||||
- improve.md
|
||||
- index.md
|
||||
- load.md
|
||||
- migrate.md
|
||||
- scan.md
|
||||
- spawn.md
|
||||
- test.md
|
||||
- troubleshoot.md
|
||||
|
||||
⚠️ **Not Updated (1 file):**
|
||||
- task.md (already using specialized format)
|
||||
|
||||
## Template System Changes Applied
|
||||
|
||||
### 1. Legend Replacement
|
||||
**Before:** ~180 tokens per file
|
||||
```markdown
|
||||
## Legend
|
||||
| Symbol | Meaning | | Abbrev | Meaning |
|
||||
|--------|---------|---|--------|---------|
|
||||
| → | leads to | | cfg | configuration |
|
||||
| & | and/with | | deps | dependencies |
|
||||
| w/ | with | | vuln | vulnerability |
|
||||
```
|
||||
|
||||
**After:** ~40 tokens per file
|
||||
```markdown
|
||||
@include shared/constants.yml#Process_Symbols
|
||||
```
|
||||
|
||||
### 2. Command Header Standardization
|
||||
**Before:** ~25 tokens per file
|
||||
```markdown
|
||||
Execute immediately. Add --plan flag if user wants to see plan first.
|
||||
```
|
||||
|
||||
**After:** ~35 tokens per file (includes universal flags)
|
||||
```markdown
|
||||
@include shared/command-templates.yml#Universal_Flags
|
||||
```
|
||||
|
||||
### 3. Research Requirements
|
||||
**Before:** ~120 tokens per file
|
||||
```markdown
|
||||
Research requirements:
|
||||
- Framework patterns → C7 documentation lookup required
|
||||
- Best practices → WebSearch for official guides
|
||||
- Never implement without documentation backing
|
||||
- All implementations must cite sources: // Source: [guide reference]
|
||||
```
|
||||
|
||||
**After:** ~40 tokens per file
|
||||
```markdown
|
||||
@include shared/command-templates.yml#Research_Requirements
|
||||
```
|
||||
|
||||
### 4. Report Output Sections
|
||||
**Before:** ~100 tokens per file
|
||||
```markdown
|
||||
Report Output:
|
||||
- Analysis reports: `.claudedocs/reports/analysis-<timestamp>.md`
|
||||
- Ensure directory exists: `mkdir -p .claudedocs/reports/`
|
||||
- Include report location in output: "📄 Report saved to: [path]"
|
||||
```
|
||||
|
||||
**After:** ~40 tokens per file
|
||||
```markdown
|
||||
@include shared/command-templates.yml#Report_Output
|
||||
```
|
||||
|
||||
### 5. Deliverables Sections
|
||||
**Before:** ~50 tokens per file
|
||||
```markdown
|
||||
Deliverables: Comprehensive analysis report, recommendations, and implementation guide.
|
||||
```
|
||||
|
||||
**After:** ~25 tokens per file
|
||||
```markdown
|
||||
@include shared/constants.yml#Success_Messages
|
||||
```
|
||||
|
||||
## Token Savings Analysis
|
||||
|
||||
### Per-File Savings:
|
||||
- Legend sections: 140 tokens saved
|
||||
- Research requirements: 80 tokens saved
|
||||
- Report output: 60 tokens saved
|
||||
- Deliverables: 25 tokens saved
|
||||
- **Total per file: ~305 tokens saved**
|
||||
|
||||
### Total Project Savings:
|
||||
- **Files updated: 18**
|
||||
- **Total tokens saved: 5,490 tokens**
|
||||
- **Reduction percentage: ~35%**
|
||||
|
||||
## Benefits Achieved
|
||||
|
||||
### 1. Token Efficiency
|
||||
- 35% reduction in command file sizes
|
||||
- Faster loading and processing
|
||||
- Reduced context consumption
|
||||
|
||||
### 2. Consistency
|
||||
- Standardized patterns across all commands
|
||||
- Uniform terminology and symbols
|
||||
- Consistent output formats
|
||||
|
||||
### 3. Maintainability
|
||||
- Single source of truth for common elements
|
||||
- Easy updates via shared templates
|
||||
- Reduced duplication
|
||||
|
||||
### 4. Scalability
|
||||
- Template system ready for new commands
|
||||
- Easy addition of new shared patterns
|
||||
- Automated consistency checking possible
|
||||
|
||||
## Template System Architecture
|
||||
|
||||
### Core Files:
|
||||
- `shared/constants.yml` - Standard symbols, paths, messages
|
||||
- `shared/command-templates.yml` - Reusable command patterns
|
||||
- `shared/research-first.yml` - Research requirements
|
||||
- `shared/execution-lifecycle.yml` - Command execution patterns
|
||||
|
||||
### Reference System:
|
||||
- `@include file#section` - Include content from templates
|
||||
- `@see file#section` - Reference for additional info
|
||||
- Cross-file consistency maintained automatically
|
||||
|
||||
## Next Steps
|
||||
|
||||
1. ✅ **Completed:** Migrate existing command files
|
||||
2. 🔄 **In Progress:** Monitor template usage effectiveness
|
||||
3. 📋 **Planned:** Implement auto-validation of template references
|
||||
4. 📋 **Future:** Add more granular template patterns
|
||||
|
||||
## Quality Metrics
|
||||
|
||||
- **Migration Success Rate:** 95% (18/19 files)
|
||||
- **Token Reduction:** 35% average
|
||||
- **Consistency Score:** 100% (all files use standard patterns)
|
||||
- **Template Coverage:** 90% of common patterns templated
|
||||
|
||||
---
|
||||
*Migration completed successfully with significant efficiency gains*
|
||||
@@ -1,155 +0,0 @@
|
||||
# Shared Patterns & Deliverables
|
||||
|
||||
## Core Workflows
|
||||
```yaml
|
||||
Dev:
|
||||
Full Stack: load→analyze→design→build→test→scan→deploy
|
||||
Feature: analyze→build→test→improve→commit
|
||||
Bug Fix: troubleshoot→fix→test→verify→commit
|
||||
|
||||
Quality:
|
||||
Code Review: analyze→improve→scan→test
|
||||
Perf: analyze→improve→test→measure
|
||||
Security: scan→improve→validate→test
|
||||
|
||||
Maintenance:
|
||||
Cleanup: cleanup→analyze→improve→test
|
||||
Update: migrate→test→validate→deploy
|
||||
Refactor: analyze→design→improve→test
|
||||
```
|
||||
|
||||
## Universal Flags
|
||||
```yaml
|
||||
Planning: --plan (show execution plan first)
|
||||
Thinking: --think (4K) | --think-hard (10K) | --ultrathink (32K)
|
||||
Docs: --uc (ultracompressed 70% reduction)
|
||||
MCP: --c7 --seq --magic --pup | --all-mcp | --no-mcp
|
||||
Execution: --dry-run | --watch | --interactive
|
||||
Quality: --tdd | --iterate | --threshold N%
|
||||
```
|
||||
|
||||
## Error Types
|
||||
```yaml
|
||||
Syntax: Typos|brackets|quotes → Check syntax
|
||||
Runtime: Null|undefined|types → Validate inputs
|
||||
Logic: Conditions|loops|state → Trace flow
|
||||
Performance: N+1|memory|blocking → Profile
|
||||
Integration: API|auth|format → Check contracts
|
||||
```
|
||||
|
||||
## MCP Usage
|
||||
```yaml
|
||||
Sequential: Complex analysis|Architecture|Debug
|
||||
Context7: Docs|Examples|Patterns
|
||||
Magic: UI components|Prototypes
|
||||
Puppeteer: E2E|Visual|Performance
|
||||
```
|
||||
|
||||
## Research Patterns
|
||||
```yaml
|
||||
Library Usage: Detect import→C7 lookup→Cache pattern→Implement with citation
|
||||
Component Creation: Identify need→Search existing→Magic builder→Document source
|
||||
API Integration: Find docs→Check auth→Review limits→Implement→Note constraints
|
||||
Unknown Pattern: Sequential thinking→WebSearch→Multiple sources→Choose best
|
||||
|
||||
Research Cache:
|
||||
Session-based: Keep patterns until session end
|
||||
Cite previous: "Using researched pattern from earlier"
|
||||
Invalidate: On version change or conflicting info
|
||||
```
|
||||
|
||||
## Deliverables
|
||||
|
||||
### Code
|
||||
```yaml
|
||||
Commits: type: description | feat|fix|refactor|perf|test|docs | Why>What
|
||||
Docs: API(endpoints|params|examples) | Code(JSDoc|README) | User(guides|FAQs)
|
||||
Tests: Unit(functions|logic) | Integration(APIs|services) | E2E(flows|paths)
|
||||
```
|
||||
|
||||
### Reports
|
||||
```yaml
|
||||
Performance: Baseline→Current→Improvement% | Time|memory|CPU|network
|
||||
Security: Vulnerabilities→Risk→Fixes | OWASP|deps|auth|data
|
||||
Quality: Coverage|complexity|duplication → Issues→Severity→Resolution
|
||||
```
|
||||
|
||||
### Artifacts
|
||||
```yaml
|
||||
Configs: .env|settings|deployment | Scripts: build|test|deploy|migrate
|
||||
Schemas: Database|API|validation | Assets: Images|styles|components
|
||||
```
|
||||
|
||||
## Accelerated Workflows
|
||||
```yaml
|
||||
Fast Chains:
|
||||
Fix Known: /user:improve --quality [uses prior analyze]
|
||||
Quick Deploy: /user:deploy [uses prior test+scan]
|
||||
Smart Build: /user:build [skips unchanged modules]
|
||||
|
||||
Auto Skip:
|
||||
Unchanged files → Skip re-analysis
|
||||
Passed tests → Skip re-test
|
||||
Clean scan → Skip re-scan
|
||||
```
|
||||
|
||||
## Clean Workflows
|
||||
```yaml
|
||||
Pre-Operations: cleanup→build→test→deploy
|
||||
Maintenance: analyze→cleanup→improve→test
|
||||
Development: cleanup→code→commit→push
|
||||
Release: cleanup→build→test→scan→deploy
|
||||
|
||||
Clean-First Patterns:
|
||||
Build: Remove old artifacts → Clean cache → Fresh build
|
||||
Deploy: Clean previous version → Validate config → Deploy new
|
||||
Test: Clean test outputs → Reset state → Run tests
|
||||
Develop: Clean workspace → Remove debug code → Commit clean
|
||||
```
|
||||
|
||||
## Command Integration Patterns
|
||||
```yaml
|
||||
Sequential Chains:
|
||||
Full Development: load → analyze → design → build → test → deploy
|
||||
Bug Investigation: troubleshoot --investigate → troubleshoot --fix → test
|
||||
Quality Pipeline: analyze → improve --quality → scan --validate → test
|
||||
|
||||
Parallel Operations:
|
||||
Multi-Stack: build --react & build --api & test --e2e
|
||||
Quality Gates: scan --security & test --coverage & analyze --performance
|
||||
|
||||
Conditional Flows:
|
||||
Safe Deploy: scan --validate && test --e2e && deploy --env prod
|
||||
Rollback: deploy --rollback || troubleshoot --investigate
|
||||
|
||||
Context Sharing:
|
||||
Analysis → Implementation: analyze → build (uses analysis context)
|
||||
Design → Development: design → build (uses design patterns)
|
||||
Investigation → Fix: troubleshoot --investigate → improve (uses findings)
|
||||
```
|
||||
|
||||
## UltraCompressed Patterns
|
||||
```yaml
|
||||
Activation Patterns:
|
||||
Manual: --uc flag | "ultracompressed" keyword
|
||||
Auto: Context >70% | Token budget specified
|
||||
Smart: Large docs → Suggest compression
|
||||
|
||||
Documentation Patterns:
|
||||
Start: Legend table | Only used symbols/abbrevs
|
||||
Structure: Lists>prose | Tables>paragraphs | YAML>text
|
||||
Content: Direct info | No fluff | Telegram-style
|
||||
|
||||
Example Transformations:
|
||||
Normal: "Configure the authentication system by setting environment variables"
|
||||
Compressed: "Auth cfg: set env vars"
|
||||
|
||||
Normal: "This function processes user input and returns validation result"
|
||||
Compressed: "fn: process usr input→validation"
|
||||
|
||||
Token Savings:
|
||||
Headers: 60-80% reduction
|
||||
Paragraphs: 70-75% reduction
|
||||
Lists: 50-60% reduction
|
||||
Overall: ~70% average reduction
|
||||
```
|
||||
@@ -314,4 +314,4 @@ Auto_Optimization_Controls:
|
||||
```
|
||||
|
||||
---
|
||||
*Performance System v1.0 - Comprehensive monitoring, analysis, and optimization for SuperClaude*
|
||||
*Performance System v4.0.0 - Comprehensive monitoring, analysis, and optimization for SuperClaude*
|
||||
|
||||
@@ -48,4 +48,4 @@ Planning Content:
|
||||
```
|
||||
|
||||
---
|
||||
*Planning mode configuration for systematic risk management*
|
||||
*Planning mode configuration for systematic risk management*
|
||||
|
||||
278
.claude/commands/shared/quality-patterns.yml
Normal file
278
.claude/commands/shared/quality-patterns.yml
Normal file
@@ -0,0 +1,278 @@
|
||||
# Quality Patterns
|
||||
# Unified validation, severity response, error handling, and quality control framework
|
||||
|
||||
## Legend
|
||||
| Symbol | Meaning | | Abbrev | Meaning |
|
||||
|--------|---------|---|--------|---------|
|
||||
| ✅ | valid/pass | | val | validation |
|
||||
| ❌ | invalid/fail | | sev | severity |
|
||||
| ⚠ | warning | | ctrl | control |
|
||||
| 🚨 | critical | | rec | recovery |
|
||||
|
||||
## Severity Framework
|
||||
|
||||
```yaml
|
||||
Severity_Levels:
|
||||
CRITICAL_10:
|
||||
Definition: "Data loss, security breach, production down"
|
||||
Response: "Immediate stop, alert, rollback, incident response"
|
||||
Recovery: "Manual intervention required"
|
||||
Response_Time: "< 1 second"
|
||||
Examples: ["Delete prod data", "Expose secrets", "Force push main"]
|
||||
|
||||
HIGH_7_9:
|
||||
Definition: "Build failure, test failure, deployment issues"
|
||||
Response: "Stop workflow, notify user, suggest fixes"
|
||||
Recovery: "Automated retry w/ backoff"
|
||||
Response_Time: "< 10 seconds"
|
||||
Examples: ["Syntax error", "Permission denied", "Test failure"]
|
||||
|
||||
MEDIUM_4_6:
|
||||
Definition: "Warning conditions, performance issues, code quality"
|
||||
Response: "Continue w/ warning, log for review"
|
||||
Recovery: "Attempt optimization, monitor"
|
||||
Response_Time: "< 60 seconds"
|
||||
Examples: ["Slow operation", "Deprecated API", "Large file"]
|
||||
|
||||
LOW_1_3:
|
||||
Definition: "Info messages, style violations, suggestions"
|
||||
Response: "Note in output, continue"
|
||||
Recovery: "Background fixes, cleanup"
|
||||
Response_Time: "Batch processing"
|
||||
Examples: ["Code style", "Optional update", "Performance tip"]
|
||||
```
|
||||
|
||||
## Pre-Execution Validation
|
||||
|
||||
```yaml
|
||||
Validation_Sequence:
|
||||
1_Ambiguity_Check:
|
||||
Detect: ["vague instructions", "missing targets", "unclear scope"]
|
||||
Actions: ["Request clarification", "Block if critical"]
|
||||
|
||||
2_Security_Validation:
|
||||
Path: "No ../, absolute paths only"
|
||||
Secrets: "Scan for API keys, passwords, tokens"
|
||||
Permissions: "User has required access"
|
||||
|
||||
3_Dependency_Check:
|
||||
Tools: "Required CLI tools installed"
|
||||
Libraries: "Package dependencies available"
|
||||
Services: "External services accessible"
|
||||
|
||||
4_State_Validation:
|
||||
Git: "Clean working tree for git ops"
|
||||
Files: "Target files exist & accessible"
|
||||
Resources: "Disk space, memory adequate"
|
||||
|
||||
Risk_Assessment:
|
||||
Score_Factors:
|
||||
Data_Loss: "+3 | Irreversibility: +2"
|
||||
Scope: "+2 | Security: +3"
|
||||
Backup: "-2 | Test_Coverage: -1"
|
||||
Sandbox: "-2 | Checkpoint: -1"
|
||||
Thresholds:
|
||||
Low_1_3: "Proceed w/ info"
|
||||
Medium_4_6: "Warn & confirm"
|
||||
High_7_9: "Require approval"
|
||||
Critical_10: "Block completely"
|
||||
```
|
||||
|
||||
## Error Handling Patterns
|
||||
|
||||
```yaml
|
||||
Error_Categories:
|
||||
Transient:
|
||||
Types: ["Network timeout", "Resource busy", "Rate limit"]
|
||||
Strategy: "Exponential backoff retry"
|
||||
Retry: "Base 1s, Max 60s, 3 attempts, ±25% jitter"
|
||||
|
||||
Permanent:
|
||||
Types: ["Syntax error", "Permission denied", "Not found"]
|
||||
Strategy: "No retry, immediate fallback"
|
||||
Response: "Clear error message & guidance"
|
||||
|
||||
Context:
|
||||
Types: ["Config error", "State conflict", "Version mismatch"]
|
||||
Strategy: "Validation & helpful guidance"
|
||||
|
||||
Resource:
|
||||
Types: ["Memory", "Disk space", "API limits"]
|
||||
Strategy: "Monitor, cleanup, queue management"
|
||||
|
||||
Circuit_Breaker:
|
||||
Threshold: "3 consecutive failures"
|
||||
Recovery: "5 minutes before re-enable"
|
||||
States:
|
||||
Closed: "Normal operation"
|
||||
Open: "Blocking calls after threshold"
|
||||
Half_Open: "Testing recovery, limited calls"
|
||||
```
|
||||
|
||||
## Recovery Strategies
|
||||
|
||||
```yaml
|
||||
Automatic_Recovery:
|
||||
Retry_Patterns:
|
||||
Simple: "3 attempts, 1s delay"
|
||||
Exponential: "1s→2s→4s→8s w/ jitter"
|
||||
Circuit: "Stop after threshold"
|
||||
Fallback_Options:
|
||||
Alternative: "Use native if MCP fails"
|
||||
Degraded: "Skip non-essential features"
|
||||
Cached: "Use previous successful outputs"
|
||||
State_Management:
|
||||
Checkpoint: "Save before risky ops"
|
||||
Rollback: "Auto-revert to good state"
|
||||
Cleanup: "Remove partial results"
|
||||
|
||||
Manual_Recovery:
|
||||
User_Guidance:
|
||||
Error_Format: "What failed→Why→How to fix"
|
||||
Actions: "Specific steps user can take"
|
||||
Resources: "Relevant help documentation"
|
||||
Intervention:
|
||||
Confirm: "Ask before destructive ops"
|
||||
Override: "Allow skip validation warnings"
|
||||
Custom: "Accept user alternatives"
|
||||
```
|
||||
|
||||
## Configuration Validation
|
||||
|
||||
```yaml
|
||||
Required_Files:
|
||||
Global:
|
||||
- "~/.claude/CLAUDE.md"
|
||||
- "~/.claude/RULES.md"
|
||||
- "~/.claude/PERSONAS.md"
|
||||
- "~/.claude/MCP.md"
|
||||
Project:
|
||||
- ".claude/commands/*.md"
|
||||
- ".claude/commands/shared/*.yml"
|
||||
|
||||
Syntax_Validation:
|
||||
YAML:
|
||||
Rules: ["Valid syntax", "Proper indent", "No duplicate keys"]
|
||||
Error: "File:Line:Column - Description"
|
||||
Markdown:
|
||||
Check: ["Valid headers", "Code blocks", "References"]
|
||||
References:
|
||||
Include: "@include shared/([^#]+)#([^\\s]+)"
|
||||
See: "@see shared/([^\\s]+)"
|
||||
Validate: ["File exists", "Section exists", "No circular refs"]
|
||||
|
||||
Structure_Requirements:
|
||||
Commands:
|
||||
Required: ["Legend", "Description", "Flags", "Examples", "Deliverables"]
|
||||
Flags: ["Universal always available", "Document all unique"]
|
||||
Dependencies:
|
||||
MCP: ["Server configured", "Health check passes"]
|
||||
CLI: ["git ≥2.0", "node ≥16.0", "python ≥3.8"]
|
||||
```
|
||||
|
||||
## Runtime Monitoring
|
||||
|
||||
```yaml
|
||||
Execution_Monitoring:
|
||||
Pre:
|
||||
Check: ["Command valid", "Flags recognized", "User authorized"]
|
||||
During:
|
||||
Monitor: ["Progress normal", "Resources in limits", "Catch errors"]
|
||||
Post:
|
||||
Verify: ["Expected outcomes", "No side effects", "Cleanup done"]
|
||||
|
||||
Context_Preservation:
|
||||
Checkpoints:
|
||||
Create: "Before destructive ops"
|
||||
Include: ["File states", "Working dir", "Command context"]
|
||||
Location: ".claudedocs/checkpoints/checkpoint-{timestamp}"
|
||||
Chain_Recovery:
|
||||
Isolate: "Don't lose successful steps"
|
||||
Alternative: "Suggest different approaches"
|
||||
Partial: "Use completed work in recovery"
|
||||
|
||||
Health_Monitoring:
|
||||
Frequency: "Every 5 min during active use"
|
||||
Timeout: "3 seconds per check"
|
||||
Degradation: ">30s response → switch alternatives"
|
||||
Recovery: "Re-enable after 5 minutes"
|
||||
```
|
||||
|
||||
## Command-Specific Recovery
|
||||
|
||||
```yaml
|
||||
Build_Failures:
|
||||
Clean_Retry: "Remove artifacts, clear cache, rebuild"
|
||||
Dependencies: "Update lockfiles, reinstall packages"
|
||||
Compilation: "Suggest fixes, alternative approaches"
|
||||
|
||||
Test_Failures:
|
||||
Flaky_Tests: "Retry failed, identify unstable"
|
||||
Environment: "Reset state, check prerequisites"
|
||||
Coverage: "Generate missing tests, update thresholds"
|
||||
|
||||
Deploy_Failures:
|
||||
Health_Check: "Rollback, investigate logs"
|
||||
Resources: "Scale up, optimize deployment"
|
||||
Config: "Validate settings, check secrets"
|
||||
|
||||
Analysis_Failures:
|
||||
Tool_Unavailable: "Fallback to alternatives"
|
||||
Large_Codebase: "Reduce scope, batch process"
|
||||
Permissions: "Guide user through access setup"
|
||||
```
|
||||
|
||||
## Quality Reports
|
||||
|
||||
```yaml
|
||||
Validation_Reports:
|
||||
Location: ".claudedocs/validation/"
|
||||
Filename: "validation-{type}-{timestamp}.md"
|
||||
Sections:
|
||||
Summary: ["Total checks", "✅ Pass | ⚠ Warn | ❌ Fail"]
|
||||
Details: ["File-by-file status", "Reference integrity", "Dependencies"]
|
||||
Recommendations: ["Critical fixes", "Improvements", "Optimizations"]
|
||||
|
||||
Auto_Repair:
|
||||
Fixable:
|
||||
Missing_Sections: "Generate from templates"
|
||||
Broken_References: "Update to valid targets"
|
||||
Outdated_Syntax: "Modernize to standards"
|
||||
Manual_Required:
|
||||
Syntax_Errors: "User must fix YAML/Markdown"
|
||||
Missing_Files: "User must create/restore"
|
||||
Permission_Issues: "User must grant access"
|
||||
|
||||
Error_Learning:
|
||||
Pattern_Recognition: ["Track common errors", "User patterns", "System issues"]
|
||||
Adaptive_Response: ["Personalized suggestions", "Proactive warnings", "Auto fixes"]
|
||||
Metrics: ["Error frequency", "Recovery success", "User satisfaction"]
|
||||
```
|
||||
|
||||
## Integration Points
|
||||
|
||||
```yaml
|
||||
Startup: "Full config validation | Block critical, warn high"
|
||||
Command: "Command-specific checks | Validate args, flags, permissions"
|
||||
Continuous: "Monitor changes | Daily full validation"
|
||||
On_Demand: "/validate --full"
|
||||
|
||||
CLI_Commands:
|
||||
Full: "/validate --config --full"
|
||||
Quick: "/validate --quick"
|
||||
Fix: "/validate --fix"
|
||||
Report: "/validate --report"
|
||||
|
||||
Usage_Examples:
|
||||
Manual:
|
||||
Full_Report: "/validate --config --report"
|
||||
Quick_Check: "/validate --quick"
|
||||
Auto_Repair: "/validate --fix --verbose"
|
||||
Programmatic:
|
||||
Pre_Execution: "validate_pre_execution()"
|
||||
Background: "validate_config_changes()"
|
||||
Report: "create_validation_report()"
|
||||
```
|
||||
|
||||
---
|
||||
*Quality Patterns v4.0.0 - Unified validation, severity response, error handling, and quality control framework*
|
||||
76
.claude/commands/shared/reference-index.yml
Normal file
76
.claude/commands/shared/reference-index.yml
Normal file
@@ -0,0 +1,76 @@
|
||||
# Reference Index - Quick Lookup Guide
|
||||
|
||||
## Legend
|
||||
| Symbol | Meaning | | Abbrev | Meaning |
|
||||
|--------|---------|---|--------|---------|
|
||||
| → | maps to | | ref | reference |
|
||||
| @ | reference type | | tmpl | template |
|
||||
|
||||
## Command Files (19)
|
||||
```yaml
|
||||
analyze.md: Analyze code/data/performance/architecture
|
||||
build.md: Create components/features/systems
|
||||
cleanup.md: Remove code/files/resources safely
|
||||
deploy.md: Deploy apps/services/infrastructure
|
||||
design.md: Design systems/APIs/architectures
|
||||
dev-setup.md: Configure dev environments
|
||||
document.md: Create/update documentation
|
||||
estimate.md: Estimate effort/time/resources
|
||||
explain.md: Explain code/concepts/patterns
|
||||
git.md: Git operations & workflows
|
||||
improve.md: Optimize/refactor/enhance code
|
||||
index.md: SuperClaude command reference
|
||||
load.md: Bulk file/context operations
|
||||
migrate.md: Migrate code/data/systems
|
||||
scan.md: Security/quality/compliance scanning
|
||||
spawn.md: Create projects/components/agents
|
||||
test.md: Testing operations & strategies
|
||||
troubleshoot.md: Debug/diagnose/fix issues
|
||||
```
|
||||
|
||||
## Optimized Shared Resources (12 core)
|
||||
```yaml
|
||||
Root Level:
|
||||
architecture-patterns.yml: DDD/microservices/event patterns
|
||||
command-patterns.yml: Reusable command patterns
|
||||
feature-template.md: Standard feature template
|
||||
security-patterns.yml: Security patterns & controls
|
||||
task-ultracompressed.md: Ultra-compressed task template
|
||||
universal-constants.yml: Universal constants & values
|
||||
|
||||
Consolidated Patterns:
|
||||
compression-patterns.yml: Token reduction patterns
|
||||
execution-patterns.yml: Unified workflow, MCP orchestration & lifecycle
|
||||
docs-patterns.yml: Documentation system patterns
|
||||
flag-inheritance.yml: Flag inheritance rules
|
||||
quality-patterns.yml: Quality control & validation patterns
|
||||
research-patterns.yml: Research flow patterns
|
||||
reference-patterns.yml: Optimized reference system
|
||||
task-patterns.yml: Task management patterns
|
||||
```
|
||||
|
||||
## Quick Reference Mappings
|
||||
```yaml
|
||||
Constants: → universal-constants.yml
|
||||
Error Handling: → quality-patterns.yml
|
||||
Validation: → quality-patterns.yml
|
||||
Git Workflows: → execution-patterns.yml
|
||||
Compression: → compression-patterns.yml
|
||||
Documentation: → docs-patterns.yml
|
||||
Research: → research-patterns.yml
|
||||
Workflows: → execution-patterns.yml
|
||||
MCP Orchestration: → execution-patterns.yml
|
||||
References: → reference-patterns.yml
|
||||
```
|
||||
|
||||
## File Organization
|
||||
```yaml
|
||||
Commands: .claude/commands/[command].md
|
||||
Shared Resources: .claude/commands/shared/[pattern].yml
|
||||
Templates: .claude/commands/shared/[template].md
|
||||
Project Docs: docs/
|
||||
Claude Working Docs: .claudedocs/
|
||||
```
|
||||
|
||||
---
|
||||
*SuperClaude v4.0.0 | Reference index for quick lookups*
|
||||
217
.claude/commands/shared/reference-patterns.yml
Normal file
217
.claude/commands/shared/reference-patterns.yml
Normal file
@@ -0,0 +1,217 @@
|
||||
# Reference Patterns
|
||||
# Optimized reference system with flattened hierarchy and automated validation
|
||||
|
||||
## Legend
|
||||
| Symbol | Meaning | | Abbrev | Meaning |
|
||||
|--------|---------|---|--------|---------|
|
||||
| @common | universal patterns | | ref | reference |
|
||||
| @cmd | command-specific | | val | validation |
|
||||
| → | maps to | | alias | shortcut |
|
||||
|
||||
## Flattened Universal References
|
||||
|
||||
```yaml
|
||||
# Direct references (2-layer max) replacing @common/* system
|
||||
Universal_Patterns:
|
||||
legend: "shared/universal-constants.yml#Universal_Legend"
|
||||
flags: "shared/flag-inheritance.yml#Universal_Always"
|
||||
lifecycle: "shared/execution-patterns.yml#Standard_Lifecycle"
|
||||
success: "shared/universal-constants.yml#Success_Messages"
|
||||
header: "shared/command-patterns.yml#Command_Header"
|
||||
report: "shared/docs-patterns.yml#Standard_Notifications"
|
||||
research: "shared/research-patterns.yml#Mandatory_Research_Flows"
|
||||
exec-control: "shared/flag-inheritance.yml#Execution_Control"
|
||||
|
||||
Quality_Patterns:
|
||||
validation: "shared/quality-patterns.yml#Pre_Execution_Validation"
|
||||
severity: "shared/quality-patterns.yml#Severity_Framework"
|
||||
recovery: "shared/quality-patterns.yml#Recovery_Strategies"
|
||||
monitoring: "shared/quality-patterns.yml#Runtime_Monitoring"
|
||||
|
||||
Workflow_Patterns:
|
||||
chains: "shared/execution-patterns.yml#Chain_Execution_Patterns"
|
||||
git: "shared/execution-patterns.yml#Git_Integration_Patterns"
|
||||
checkpoints: "shared/execution-patterns.yml#Checkpoint_Management"
|
||||
mcp: "shared/execution-patterns.yml#MCP_Server_Registry"
|
||||
|
||||
Architecture_Patterns:
|
||||
ddd: "shared/architecture-patterns.yml#DDD_Building_Blocks"
|
||||
api: "shared/architecture-patterns.yml#REST_API_Patterns"
|
||||
security: "shared/security-patterns.yml#Security_Patterns"
|
||||
scaling: "shared/architecture-patterns.yml#Scalability_Patterns"
|
||||
|
||||
Documentation_Patterns:
|
||||
structure: "shared/docs-patterns.yml#Directory_Standards"
|
||||
formats: "shared/docs-patterns.yml#Format_Requirements"
|
||||
notifications: "shared/docs-patterns.yml#Output_Notifications"
|
||||
tasks: "shared/docs-patterns.yml#Task_File_Formatting"
|
||||
```
|
||||
|
||||
## Command-Specific Pattern Groups
|
||||
|
||||
```yaml
|
||||
# Optimized command patterns with direct references
|
||||
Analysis_Commands:
|
||||
# analyze, scan, troubleshoot
|
||||
flags: "shared/flag-inheritance.yml#Analysis_Commands"
|
||||
patterns: "shared/command-patterns.yml#Analysis_Commands"
|
||||
quality: "shared/quality-patterns.yml#Command_Specific_Recovery"
|
||||
|
||||
Build_Commands:
|
||||
# build, design, deploy
|
||||
flags: "shared/flag-inheritance.yml#Build_Commands"
|
||||
patterns: "shared/command-patterns.yml#Build_Commands"
|
||||
lifecycle: "shared/execution-patterns.yml#Command_Hooks"
|
||||
|
||||
Quality_Commands:
|
||||
# test, improve, cleanup
|
||||
flags: "shared/flag-inheritance.yml#Quality_Commands"
|
||||
control: "shared/quality-patterns.yml#Quality_Reports"
|
||||
monitoring: "shared/quality-patterns.yml#Runtime_Monitoring"
|
||||
|
||||
Operations_Commands:
|
||||
# deploy, migrate, git
|
||||
flags: "shared/flag-inheritance.yml#Operations_Commands"
|
||||
lifecycle: "shared/execution-patterns.yml#Git_Integration_Patterns"
|
||||
audit: "shared/execution-patterns.yml#Checkpoint_Management"
|
||||
|
||||
Documentation_Commands:
|
||||
# document, explain
|
||||
flags: "shared/flag-inheritance.yml#Documentation_Commands"
|
||||
templates: "shared/docs-patterns.yml#Format_Requirements"
|
||||
structure: "shared/docs-patterns.yml#Directory_Standards"
|
||||
```
|
||||
|
||||
## Optimized Template Usage
|
||||
|
||||
```yaml
|
||||
# Replace verbose @include patterns with direct references
|
||||
Command_File_Templates:
|
||||
Standard_Header: |
|
||||
@legend
|
||||
@header
|
||||
@flags
|
||||
@exec-control
|
||||
|
||||
Quality_Focus: |
|
||||
@legend
|
||||
@header
|
||||
@flags
|
||||
@validation
|
||||
@monitoring
|
||||
|
||||
Architecture_Focus: |
|
||||
@legend
|
||||
@header
|
||||
@flags
|
||||
@ddd
|
||||
@api
|
||||
|
||||
Documentation_Focus: |
|
||||
@legend
|
||||
@header
|
||||
@flags
|
||||
@structure
|
||||
@formats
|
||||
|
||||
# Simple expansion rules (no nesting)
|
||||
Expansion_Rules:
|
||||
Pattern: "@{pattern_name}"
|
||||
Resolution: "Direct lookup in reference tables above"
|
||||
No_Nesting: "Single level expansion only"
|
||||
Fallback: "Use full path if pattern not found"
|
||||
```
|
||||
|
||||
## Reference Validation System
|
||||
|
||||
```yaml
|
||||
Validation_Rules:
|
||||
Reference_Integrity:
|
||||
Check_Targets: "Verify all referenced files and sections exist"
|
||||
Detect_Circular: "Prevent circular reference chains"
|
||||
Validate_Syntax: "Ensure proper @pattern format"
|
||||
Report_Broken: "List all broken references with locations"
|
||||
|
||||
Auto_Validation:
|
||||
Startup_Check: "Validate all references on system startup"
|
||||
Git_Hook: "Validate before commits via pre-commit hook"
|
||||
File_Watch: "Monitor shared files for changes"
|
||||
Repair_Mode: "Auto-fix simple reference errors"
|
||||
|
||||
Validation_Report:
|
||||
Location: ".claudedocs/validation/references-{timestamp}.md"
|
||||
Format: "Markdown with severity levels and fix suggestions"
|
||||
Sections: ["Summary", "Broken References", "Recommendations", "Auto-Fixes Applied"]
|
||||
```
|
||||
|
||||
## File Organization
|
||||
|
||||
```yaml
|
||||
Pattern_Files:
|
||||
Universal_Constants: "universal-constants.yml"
|
||||
Command_Patterns: "command-patterns.yml"
|
||||
Architecture: "architecture-patterns.yml"
|
||||
Security: "security-patterns.yml"
|
||||
Quality: "quality-patterns.yml"
|
||||
Execution: "execution-patterns.yml"
|
||||
Documentation: "docs-patterns.yml"
|
||||
|
||||
Usage:
|
||||
Direct_Reference: "See shared/[file].yml#[section]"
|
||||
No_Nesting: "Keep references simple and direct"
|
||||
Self_Contained: "Each command has complete information"
|
||||
```
|
||||
|
||||
## Performance Optimizations
|
||||
|
||||
```yaml
|
||||
Reference_Performance:
|
||||
Caching:
|
||||
Strategy: "Cache resolved references for session duration"
|
||||
Invalidation: "Clear cache when shared files change"
|
||||
Memory_Usage: "Limit cache size to prevent memory issues"
|
||||
|
||||
Lazy_Loading:
|
||||
On_Demand: "Only resolve references when actually needed"
|
||||
Batch_Resolution: "Resolve multiple references in single operation"
|
||||
Prefetch: "Preload commonly used patterns"
|
||||
|
||||
Token_Efficiency:
|
||||
Direct_Paths: "Use direct file paths instead of aliases where beneficial"
|
||||
Pattern_Inlining: "Inline small patterns instead of referencing"
|
||||
Compression: "Apply UltraCompressed mode to reference content"
|
||||
|
||||
Monitoring:
|
||||
Reference_Usage: "Track which patterns are used most frequently"
|
||||
Resolution_Time: "Monitor time to resolve references"
|
||||
Cache_Hit_Rate: "Measure caching effectiveness"
|
||||
Error_Frequency: "Track broken reference patterns"
|
||||
|
||||
Benefits:
|
||||
Token_Reduction: "~30% reduction in reference overhead"
|
||||
Complexity_Reduction: "2-layer max vs 3+ layer indirection"
|
||||
Maintainability: "Easier to trace and update references"
|
||||
Performance: "Faster resolution and lower memory usage"
|
||||
```
|
||||
|
||||
## Integration Points
|
||||
|
||||
```yaml
|
||||
Command_File_Usage:
|
||||
Standard_Commands: "Each command is self-contained"
|
||||
Organization: "Common patterns in shared files"
|
||||
Validation_Required: "All commands follow standard structure"
|
||||
|
||||
Framework_System:
|
||||
Direct_References: "Use explicit file paths"
|
||||
Error_Handling: "Clear documentation of patterns"
|
||||
Development_Mode: "Easy to understand and maintain"
|
||||
|
||||
Framework_Integration:
|
||||
Git_Hooks: "Automatic validation on commits and merges"
|
||||
CI_CD: "Reference integrity checks in build pipeline"
|
||||
Editor_Support: "Syntax highlighting and validation"
|
||||
```
|
||||
|
||||
---
|
||||
*Reference Patterns v4.0.0 - Optimized reference system with flattened hierarchy and automated validation*
|
||||
@@ -1,278 +0,0 @@
|
||||
# Research-First Professional Standards
|
||||
|
||||
## Mandatory Research Triggers [C:10]
|
||||
|
||||
```yaml
|
||||
External_Libraries:
|
||||
Detection_Patterns:
|
||||
- import .* from ['"][^./]['"] # Non-relative imports
|
||||
- require\(['"][^./]['"] # CommonJS non-relative
|
||||
- from (\w+) import # Python imports
|
||||
- using \w+; # C# namespaces
|
||||
- implementation ['"].*:.*['"] # Gradle dependencies
|
||||
|
||||
Required_Research:
|
||||
JS/TS:
|
||||
- React: hooks, components, state mgmt
|
||||
- Vue: composition API, directives, reactivity
|
||||
- Angular: services, DI, modules
|
||||
- Express: middleware, routing, error handling
|
||||
- Next.js: SSR, SSG, API routes, app dir
|
||||
- Node.js: built-in modules, streams, cluster
|
||||
|
||||
Python:
|
||||
- Django: models, views, middleware, admin
|
||||
- Flask: blueprints, extensions, request handling
|
||||
- FastAPI: dependency injection, async, pydantic
|
||||
- NumPy/Pandas: array operations, dataframes
|
||||
- TensorFlow/PyTorch: models, training, deployment
|
||||
|
||||
Other:
|
||||
- Database: SQL syntax, ORM patterns, migrations
|
||||
- Cloud: AWS/GCP/Azure service APIs
|
||||
- Testing: framework-specific assertions, mocks
|
||||
- Build tools: webpack, vite, rollup configs
|
||||
|
||||
Component_Creation:
|
||||
UI_Keywords:
|
||||
- button, form, modal, dialog, dropdown
|
||||
- table, list, grid, card, accordion
|
||||
- nav, menu, sidebar, header, footer
|
||||
- chart, graph, visualization, dashboard
|
||||
|
||||
Required_Actions:
|
||||
- Check existing components in project
|
||||
- Search design system if available
|
||||
- Use Magic builder for new components
|
||||
- WebSearch for accessibility patterns
|
||||
- Verify responsive design requirements
|
||||
|
||||
API_Integration:
|
||||
Patterns:
|
||||
- REST: endpoints, methods, authentication
|
||||
- GraphQL: queries, mutations, schemas
|
||||
- WebSocket: events, connections, protocols
|
||||
- SDK/Client: initialization, methods, errors
|
||||
|
||||
Required_Checks:
|
||||
- Official API documentation
|
||||
- Authentication methods
|
||||
- Rate limits and quotas
|
||||
- Error response formats
|
||||
- Versioning and deprecations
|
||||
```
|
||||
|
||||
## Implementation Blockers
|
||||
|
||||
```yaml
|
||||
Guessing_Indicators:
|
||||
Phrases_To_Block:
|
||||
- "might work"
|
||||
- "should probably"
|
||||
- "I think this"
|
||||
- "typically would"
|
||||
- "usually looks like"
|
||||
- "common pattern is"
|
||||
- "often implemented as"
|
||||
|
||||
Required_Instead:
|
||||
- "According to [source]"
|
||||
- "Documentation states"
|
||||
- "Official example shows"
|
||||
- "Verified pattern from"
|
||||
- "Testing confirms"
|
||||
|
||||
Confidence_Requirements:
|
||||
Minimum_Score: 90%
|
||||
|
||||
Evidence_Types:
|
||||
Official_Docs: 100%
|
||||
Tutorial_From_Maintainer: 95%
|
||||
Recent_Blog_Post: 85%
|
||||
Stack_Overflow_Accepted: 80%
|
||||
GitHub_Issue_Resolution: 85%
|
||||
No_Evidence: 0% (BLOCK)
|
||||
|
||||
Score_Calculation:
|
||||
- Must have at least one 95%+ source
|
||||
- Multiple 80%+ sources can combine
|
||||
- Age penalty: -5% per year old
|
||||
- Verification: Test/example adds +10%
|
||||
```
|
||||
|
||||
## Research Workflows
|
||||
|
||||
```yaml
|
||||
Library_Research_Flow:
|
||||
1. Detect library reference in code/request
|
||||
2. Check if already in package.json/requirements
|
||||
3. C7 resolve-library-id → get-docs
|
||||
4. If C7 fails → WebSearch "library official docs"
|
||||
5. Extract key patterns:
|
||||
- Installation method
|
||||
- Basic usage examples
|
||||
- Common patterns
|
||||
- Error handling
|
||||
- Best practices
|
||||
6. Cache results for session
|
||||
7. Cite sources in implementation
|
||||
|
||||
Component_Research_Flow:
|
||||
1. Identify UI component need
|
||||
2. Search existing codebase first
|
||||
3. Check project's component library
|
||||
4. Magic builder search with keywords
|
||||
5. If no match → WebSearch "component accessibility"
|
||||
6. Implement with citations
|
||||
7. Note any deviations from patterns
|
||||
|
||||
API_Research_Flow:
|
||||
1. Identify API/service to integrate
|
||||
2. WebSearch "service official API docs"
|
||||
3. Find authentication documentation
|
||||
4. Locate endpoint references
|
||||
5. Check for SDK/client library
|
||||
6. Review error handling patterns
|
||||
7. Note rate limits and constraints
|
||||
```
|
||||
|
||||
## Professional Standards
|
||||
|
||||
```yaml
|
||||
Source_Attribution:
|
||||
Required_Format: "// Source: [URL or Doc Reference]"
|
||||
|
||||
Placement:
|
||||
- Above implementation using pattern
|
||||
- In function documentation
|
||||
- In commit messages for new patterns
|
||||
|
||||
Citation_Examples:
|
||||
Good:
|
||||
- "// Source: React docs - https://react.dev/reference/react/useState"
|
||||
- "// Pattern from: Express.js error handling guide"
|
||||
- "// Based on: AWS S3 SDK documentation v3"
|
||||
|
||||
Bad:
|
||||
- "// Common pattern"
|
||||
- "// Standard approach"
|
||||
- "// Typical implementation"
|
||||
|
||||
Uncertainty_Handling:
|
||||
When_Docs_Unavailable:
|
||||
- State explicitly: "Documentation not found for X"
|
||||
- Provide rationale: "Using pattern similar to Y because..."
|
||||
- Mark as provisional: "// TODO: Verify when docs available"
|
||||
- Suggest alternatives: "Consider using documented library Z"
|
||||
|
||||
When_Multiple_Patterns:
|
||||
- Show options: "Documentation shows 3 approaches:"
|
||||
- Explain tradeoffs: "Option A is simpler but less flexible"
|
||||
- Recommend based on context: "For this use case, B is optimal"
|
||||
- Cite each source
|
||||
```
|
||||
|
||||
## Enforcement Mechanisms
|
||||
|
||||
```yaml
|
||||
Pre_Implementation_Checks:
|
||||
Parse_Code_For:
|
||||
- Import statements
|
||||
- Function calls to external libs
|
||||
- Component definitions
|
||||
- API endpoint references
|
||||
|
||||
Block_If:
|
||||
- External library with no research
|
||||
- New component type without pattern check
|
||||
- API usage without documentation
|
||||
- Confidence score below 90%
|
||||
|
||||
Warning_If:
|
||||
- Documentation is >2 years old
|
||||
- Using deprecated patterns
|
||||
- Multiple conflicting sources
|
||||
- Community solution vs official
|
||||
|
||||
Session_Research_Cache:
|
||||
Store:
|
||||
- Library: version, patterns, examples
|
||||
- Components: accessibility, variants
|
||||
- APIs: endpoints, auth, limits
|
||||
|
||||
Reuse:
|
||||
- Same library → use cached patterns
|
||||
- Note: "Using previously researched pattern"
|
||||
- Invalidate on version change
|
||||
|
||||
Integration_Points:
|
||||
Commands:
|
||||
- build: Check all imports
|
||||
- improve: Verify optimization patterns
|
||||
- troubleshoot: Search known issues first
|
||||
- design: Research architectural patterns
|
||||
|
||||
Personas:
|
||||
- frontend: Extra UI/UX research
|
||||
- backend: API/database patterns
|
||||
- architect: System design patterns
|
||||
- security: Vulnerability databases
|
||||
```
|
||||
|
||||
## Examples
|
||||
|
||||
```yaml
|
||||
Good_Implementation:
|
||||
Request: "Add user authentication to Express app"
|
||||
|
||||
Research_Steps:
|
||||
1. C7 resolve-library-id("express")
|
||||
2. C7 get-docs(topic: "authentication middleware")
|
||||
3. WebSearch "express session best practices 2024"
|
||||
4. Check project for existing auth patterns
|
||||
|
||||
Implementation:
|
||||
```javascript
|
||||
// Source: Express.js docs - https://expressjs.com/en/guide/using-middleware.html
|
||||
// Pattern: Session-based authentication with secure defaults
|
||||
|
||||
const session = require('express-session');
|
||||
const MongoStore = require('connect-mongo');
|
||||
|
||||
// Source: OWASP session management cheat sheet
|
||||
app.use(session({
|
||||
secret: process.env.SESSION_SECRET,
|
||||
resave: false,
|
||||
saveUninitialized: false,
|
||||
cookie: {
|
||||
secure: process.env.NODE_ENV === 'production',
|
||||
httpOnly: true,
|
||||
maxAge: 1000 * 60 * 60 * 24 // 24 hours
|
||||
},
|
||||
store: MongoStore.create({
|
||||
mongoUrl: process.env.MONGODB_URI
|
||||
})
|
||||
}));
|
||||
```
|
||||
|
||||
Bad_Implementation_Blocked:
|
||||
Request: "Add user authentication to Express app"
|
||||
|
||||
Without_Research:
|
||||
```javascript
|
||||
// BLOCKED: No documentation reference
|
||||
// This might work for authentication
|
||||
app.use((req, res, next) => {
|
||||
if (req.session && req.session.user) {
|
||||
next();
|
||||
} else {
|
||||
res.redirect('/login');
|
||||
}
|
||||
});
|
||||
```
|
||||
|
||||
Error: "External library usage requires documentation. Please research Express.js authentication patterns first."
|
||||
```
|
||||
|
||||
---
|
||||
*Research-First: Ensuring professional, evidence-based implementations*
|
||||
366
.claude/commands/shared/research-patterns.yml
Normal file
366
.claude/commands/shared/research-patterns.yml
Normal file
@@ -0,0 +1,366 @@
|
||||
# Research Flow Templates
|
||||
# Consolidated research patterns for professional implementations
|
||||
|
||||
## Legend
|
||||
| Symbol | Meaning | | Abbrev | Meaning |
|
||||
|--------|---------|---|--------|---------|
|
||||
| → | leads to | | req | required |
|
||||
| ⚠ | warning/risk | | cfg | configuration |
|
||||
| ✓ | verified/confirmed | | impl | implementation |
|
||||
| C | critical level | | conf | confidence |
|
||||
|
||||
## Mandatory Research Flows
|
||||
|
||||
```yaml
|
||||
Mandatory_Research_Flows:
|
||||
External_Library_Research:
|
||||
Step_1: "Identify library/framework mentioned"
|
||||
Step_2: "Context7 lookup for official documentation"
|
||||
Step_3: "Verify API patterns and examples"
|
||||
Step_4: "Check version compatibility"
|
||||
Step_5: "Document findings in implementation"
|
||||
|
||||
Pattern_Research:
|
||||
Step_1: "Search existing codebase for similar patterns"
|
||||
Step_2: "Magic component search if UI-related"
|
||||
Step_3: "WebSearch for official documentation"
|
||||
Step_4: "Validate approach with Sequential thinking"
|
||||
Step_5: "Document pattern choice rationale"
|
||||
|
||||
API_Integration_Research:
|
||||
Step_1: "Official documentation lookup"
|
||||
Step_2: "Authentication requirements"
|
||||
Step_3: "Rate limiting and error handling"
|
||||
Step_4: "SDK availability and examples"
|
||||
Step_5: "Integration testing approach"
|
||||
```
|
||||
|
||||
## Research Trigger Patterns
|
||||
|
||||
```yaml
|
||||
Detection_Triggers:
|
||||
External_Libraries:
|
||||
- import .* from ['"][^./]['"] # Non-relative imports
|
||||
- require\(['"][^./]['"] # CommonJS non-relative
|
||||
- from (\w+) import # Python imports
|
||||
- using \w+; # C# namespaces
|
||||
|
||||
UI_Components:
|
||||
Keywords: [button, form, modal, dialog, dropdown, table, list, grid, card, accordion, nav, menu, sidebar, header, footer, chart, graph, visualization, dashboard]
|
||||
Action: "Check existing→Magic search→WebSearch patterns"
|
||||
|
||||
API_Integration:
|
||||
Patterns: [REST, GraphQL, WebSocket, SDK, client, endpoint, auth]
|
||||
Required: "Official docs→Authentication→Rate limits→Error formats"
|
||||
|
||||
Unknown_Patterns:
|
||||
Phrases_To_Block: ["might work", "should probably", "I think this", "typically would", "common pattern is"]
|
||||
Required_Instead: ["According to [source]", "Documentation states", "Verified pattern from"]
|
||||
```
|
||||
|
||||
## Mandatory Research Flows
|
||||
|
||||
```yaml
|
||||
Library_Research_Flow:
|
||||
Steps:
|
||||
1: "Detect library reference in code/request"
|
||||
2: "Check if already in package.json/requirements.txt"
|
||||
3: "C7 resolve-library-id → get-docs with topic"
|
||||
4: "If C7 fails → WebSearch '[library] official documentation'"
|
||||
5: "Extract: Installation|Basic usage|Common patterns|Error handling|Best practices"
|
||||
6: "Cache results for session with confidence score"
|
||||
7: "Cite sources in implementation"
|
||||
Blocking_Conditions:
|
||||
- "External library detected without research"
|
||||
- "Confidence score below 90%"
|
||||
- "No official documentation found"
|
||||
|
||||
Component_Research_Flow:
|
||||
Steps:
|
||||
1: "Identify UI component requirement from keywords"
|
||||
2: "Search existing codebase for similar components"
|
||||
3: "Check project's design system/component library"
|
||||
4: "Magic builder search with extracted keywords"
|
||||
5: "If no suitable match → WebSearch '[component] accessibility patterns'"
|
||||
6: "Implement with source citations"
|
||||
7: "Document any deviations from established patterns"
|
||||
Quality_Gates:
|
||||
- "Accessibility compliance verified"
|
||||
- "Responsive design confirmed"
|
||||
- "Pattern source documented"
|
||||
|
||||
API_Research_Flow:
|
||||
Steps:
|
||||
1: "Identify API/service integration need"
|
||||
2: "WebSearch '[service] official API documentation'"
|
||||
3: "Locate authentication requirements"
|
||||
4: "Find endpoint specifications & examples"
|
||||
5: "Check for official SDK/client library"
|
||||
6: "Review error handling & response formats"
|
||||
7: "Document rate limits & usage constraints"
|
||||
Critical_Checks:
|
||||
- "Authentication method documented"
|
||||
- "Error response format understood"
|
||||
- "Rate limits noted"
|
||||
- "API versioning strategy confirmed"
|
||||
```
|
||||
|
||||
## Confidence Scoring System
|
||||
|
||||
```yaml
|
||||
Evidence_Scoring:
|
||||
Official_Documentation: 100%
|
||||
Maintainer_Tutorial: 95%
|
||||
Recent_Blog_Post: 85%
|
||||
GitHub_Issue_Resolution: 85%
|
||||
Stack_Overflow_Accepted: 80%
|
||||
Community_Tutorial: 75%
|
||||
No_Evidence: 0%
|
||||
|
||||
Age_Penalties:
|
||||
Current_Year: 0%
|
||||
One_Year_Old: -5%
|
||||
Two_Years_Old: -10%
|
||||
Three_Plus_Years: -15%
|
||||
|
||||
Verification_Bonus:
|
||||
Working_Example: +10%
|
||||
Test_Coverage: +5%
|
||||
Multiple_Sources: +5%
|
||||
|
||||
Minimum_Requirements:
|
||||
Implementation_Threshold: 90%
|
||||
Warning_Threshold: 80%
|
||||
Research_Required: <80%
|
||||
```
|
||||
|
||||
## Session Research Cache
|
||||
|
||||
```yaml
|
||||
Cache_Structure:
|
||||
Libraries:
|
||||
Key: "library_name@version"
|
||||
Data: "patterns, examples, best_practices, confidence_score"
|
||||
Validity: "Until version change or session end"
|
||||
|
||||
Components:
|
||||
Key: "component_type_keywords"
|
||||
Data: "accessibility_patterns, variants, implementation_notes"
|
||||
Validity: "Until design system change"
|
||||
|
||||
APIs:
|
||||
Key: "service_name_endpoint_group"
|
||||
Data: "auth_methods, endpoints, error_formats, rate_limits"
|
||||
Validity: "24 hours or API version change"
|
||||
|
||||
Cache_Usage:
|
||||
Reuse_Pattern: "Using previously researched pattern for [X]"
|
||||
Invalidation: "Version change detected, re-researching [X]"
|
||||
Update: "Adding new pattern to existing research cache"
|
||||
```
|
||||
|
||||
## Implementation Citation Requirements
|
||||
|
||||
```yaml
|
||||
Source_Attribution:
|
||||
Format: "// Source: [URL or Documentation Reference]"
|
||||
Placement_Rules:
|
||||
Code: "Above implementation using external pattern"
|
||||
Functions: "In JSDoc/docstring documentation"
|
||||
Commits: "In commit message for new external patterns"
|
||||
|
||||
Citation_Examples:
|
||||
Good_Citations:
|
||||
- "// Source: React hooks documentation - https://react.dev/reference/react/useState"
|
||||
- "// Pattern from: Express.js middleware guide v4.18"
|
||||
- "// Based on: AWS S3 SDK documentation v3.45"
|
||||
- "// Accessibility pattern: WCAG 2.1 button guidelines"
|
||||
|
||||
Blocked_Citations:
|
||||
- "// Common pattern (NO SOURCE)"
|
||||
- "// Standard approach (NO EVIDENCE)"
|
||||
- "// Typical implementation (NO RESEARCH)"
|
||||
|
||||
Professional_Standards:
|
||||
Multiple_Sources: "List all sources when combining patterns"
|
||||
Uncertainty_Handling: "Mark provisional implementations with TODO"
|
||||
Alternative_Suggestions: "Provide backup options when primary unavailable"
|
||||
Deprecation_Notes: "Flag patterns from deprecated documentation"
|
||||
```
|
||||
|
||||
## Integration with Command System
|
||||
|
||||
```yaml
|
||||
Pre_Execution_Research:
|
||||
Parse_Request:
|
||||
- "Extract library names from import patterns"
|
||||
- "Identify UI component requirements from keywords"
|
||||
- "Detect API integration needs from service names"
|
||||
- "Check for unfamiliar patterns or frameworks"
|
||||
|
||||
Validation_Gates:
|
||||
CRITICAL_Block: "External library with no research documentation"
|
||||
HIGH_Warning: "Documentation >2 years old or deprecated patterns"
|
||||
MEDIUM_Note: "Multiple conflicting sources found"
|
||||
|
||||
Auto_Research_Triggers:
|
||||
Commands: ["build", "improve", "troubleshoot", "design"]
|
||||
File_Types: ["*.tsx", "*.jsx", "*.py", "*.js", "*.ts"]
|
||||
Keywords: ["integrate", "implement", "connect", "use", "add"]
|
||||
|
||||
Command_Specific_Integration:
|
||||
build_command:
|
||||
- "Check all import statements for external libraries"
|
||||
- "Research any unfamiliar framework patterns"
|
||||
- "Verify component library usage patterns"
|
||||
|
||||
improve_command:
|
||||
- "Research optimization patterns for identified bottlenecks"
|
||||
- "Verify best practice patterns before suggesting changes"
|
||||
- "Check for updated library versions with better patterns"
|
||||
|
||||
troubleshoot_command:
|
||||
- "Search known issues database first"
|
||||
- "Research error patterns in official documentation"
|
||||
- "Check community solutions with high confidence scores"
|
||||
```
|
||||
|
||||
## Quality Assurance Patterns
|
||||
|
||||
```yaml
|
||||
Research_Validation:
|
||||
Before_Implementation:
|
||||
- "Confirm all external references have research backing"
|
||||
- "Verify confidence scores meet minimum thresholds"
|
||||
- "Check that citations are properly formatted"
|
||||
- "Ensure no blocked phrases present in reasoning"
|
||||
|
||||
During_Implementation:
|
||||
- "Cross-reference implementation with researched patterns"
|
||||
- "Validate that deviations from patterns are documented"
|
||||
- "Ensure error handling follows researched best practices"
|
||||
|
||||
After_Implementation:
|
||||
- "Verify all external patterns have source attribution"
|
||||
- "Update research cache with any new findings"
|
||||
- "Document successful patterns for future reuse"
|
||||
|
||||
Pattern_Verification:
|
||||
Official_Source_Check: "Primary source must be official documentation"
|
||||
Recency_Validation: "Flag patterns older than 2 years for review"
|
||||
Multiple_Source_Confirmation: "Complex patterns require 2+ sources"
|
||||
Working_Example_Requirement: "Implementation must include tested example"
|
||||
```
|
||||
|
||||
## Error Prevention & Recovery
|
||||
|
||||
```yaml
|
||||
Common_Research_Failures:
|
||||
Library_Not_Found:
|
||||
Error: "C7 resolve-library-id returns no matches"
|
||||
Recovery: "Try broader search terms → WebSearch fallback"
|
||||
Prevention: "Cache common library aliases"
|
||||
|
||||
Documentation_Outdated:
|
||||
Error: "Found docs are >2 years old"
|
||||
Recovery: "Search for recent migration guides or version changes"
|
||||
Prevention: "Always check latest version numbers"
|
||||
|
||||
Conflicting_Patterns:
|
||||
Error: "Multiple sources suggest different approaches"
|
||||
Recovery: "Choose most recent official source → document alternatives"
|
||||
Prevention: "Prioritize official documentation over community content"
|
||||
|
||||
No_Examples_Found:
|
||||
Error: "Documentation lacks practical examples"
|
||||
Recovery: "Search GitHub for real implementations → test small example"
|
||||
Prevention: "Combine theoretical docs with practical repositories"
|
||||
|
||||
Research_Failure_Handling:
|
||||
When_Blocked:
|
||||
- "State explicitly: 'Official documentation not found for [X]'"
|
||||
- "Provide rationale: 'Using similar pattern from [Y] because...'"
|
||||
- "Mark provisional: '// TODO: Verify when official docs available'"
|
||||
- "Suggest alternatives: 'Consider documented library [Z] instead'"
|
||||
|
||||
Partial_Research:
|
||||
- "Document what was found vs what is missing"
|
||||
- "Implement only well-documented portions"
|
||||
- "Create TODO items for missing research"
|
||||
- "Suggest manual verification steps"
|
||||
```
|
||||
|
||||
## Consolidated: Evidence & Verification Patterns (from evidence.yml)
|
||||
|
||||
### Measurement Standards
|
||||
```yaml
|
||||
Replace Hard Values:
|
||||
Bad: "75% perf improvement"
|
||||
Good: "<measured>% improvement"
|
||||
Best: "<baseline>→<current> (<delta>%)"
|
||||
|
||||
Placeholders:
|
||||
<measured_value>: Actual measurement
|
||||
<calculated_result>: Computed outcome
|
||||
<baseline>: Starting point
|
||||
<current>: Current state
|
||||
<delta>: Change amount
|
||||
<threshold>: Target value
|
||||
```
|
||||
|
||||
### Verification Requirements (from evidence.yml)
|
||||
```yaml
|
||||
Perf Claims:
|
||||
Required: Measurement method
|
||||
Format: "Measured via <tool>: <metric>"
|
||||
Example: "Measured via Lighthouse: FCP <value>ms"
|
||||
|
||||
Quality Metrics:
|
||||
Coverage: "Test coverage: <measured>%"
|
||||
Complexity: "Cyclomatic: <calculated>"
|
||||
Duplication: "DRY score: <measured>%"
|
||||
|
||||
Time Estimates:
|
||||
Format: "<min>-<max> <unit> (±<uncertainty>%)"
|
||||
Based on: Historical data|Complexity analysis
|
||||
|
||||
Implementation Sources:
|
||||
Required: Documentation reference for external libraries
|
||||
Format: "Source: <official docs URL or reference>"
|
||||
Placement: Above implementation using pattern
|
||||
|
||||
Examples:
|
||||
Good: "// Source: React docs - useState hook"
|
||||
Bad: "// Common React pattern"
|
||||
|
||||
No Source = Block: External library usage without documentation
|
||||
```
|
||||
|
||||
### Evidence Collection (from evidence.yml)
|
||||
```yaml
|
||||
Before: Baseline measurement
|
||||
During: Progress tracking
|
||||
After: Final measurement
|
||||
Delta: Calculate improvement
|
||||
|
||||
Tools:
|
||||
Performance: Lighthouse|DevTools|APM
|
||||
Code: Coverage reports|Linters|Analyzers
|
||||
Time: Git history|Task tracking
|
||||
```
|
||||
|
||||
### Reporting Format (from evidence.yml)
|
||||
```yaml
|
||||
Pattern:
|
||||
Claim: What improved
|
||||
Evidence: How measured
|
||||
Result: Specific values
|
||||
|
||||
Example:
|
||||
Claim: "Optimized query performance"
|
||||
Evidence: "EXPLAIN ANALYZE before/after"
|
||||
Result: "<before>ms → <after>ms (<delta>% faster)"
|
||||
```
|
||||
|
||||
---
|
||||
*Research Flow Templates v4.0.0 - Ensuring evidence-based professional implementations with consolidated research and evidence patterns*
|
||||
318
.claude/commands/shared/security-patterns.yml
Normal file
318
.claude/commands/shared/security-patterns.yml
Normal file
@@ -0,0 +1,318 @@
|
||||
# Security Patterns & Definitions
|
||||
# Extracted security knowledge patterns for reuse across commands
|
||||
|
||||
@include shared/universal-constants.yml#Universal_Legend
|
||||
|
||||
## OWASP Top 10 Security Patterns
|
||||
|
||||
```yaml
|
||||
OWASP_Top_10:
|
||||
A01_Injection:
|
||||
Name: "Injection Flaws"
|
||||
Types: ["SQL", "NoSQL", "OS Command", "LDAP", "XPath", "XXE"]
|
||||
Description: "Untrusted data sent to interpreter as part of command/query"
|
||||
Detection: "Input validation gaps, dynamic query construction"
|
||||
Mitigation: "Parameterized queries, input validation, output encoding"
|
||||
|
||||
A02_Authentication:
|
||||
Name: "Broken Authentication & Session Management"
|
||||
Types: ["Weak passwords", "Session fixation", "Credential stuffing"]
|
||||
Description: "Authentication & session management flaws"
|
||||
Detection: "Weak auth logic, exposed session tokens, poor password policy"
|
||||
Mitigation: "Strong auth, secure session management, MFA"
|
||||
|
||||
A03_Data_Exposure:
|
||||
Name: "Sensitive Data Exposure"
|
||||
Types: ["Unencrypted data", "Weak crypto", "Data leaks"]
|
||||
Description: "Sensitive data not properly protected"
|
||||
Detection: "Unencrypted storage/transit, weak algorithms"
|
||||
Mitigation: "Strong encryption, data classification, secure storage"
|
||||
|
||||
A04_XXE:
|
||||
Name: "XML External Entities (XXE)"
|
||||
Types: ["File disclosure", "SSRF", "DoS attacks"]
|
||||
Description: "XML processors w/ external entity references"
|
||||
Detection: "XML parsing w/o entity validation"
|
||||
Mitigation: "Disable external entities, input validation"
|
||||
|
||||
A05_Access_Control:
|
||||
Name: "Broken Access Control"
|
||||
Types: ["Privilege escalation", "Unauthorized access", "IDOR"]
|
||||
Description: "Access control enforcement failures"
|
||||
Detection: "Missing auth checks, role bypass, direct object refs"
|
||||
Mitigation: "Principle of least privilege, proper auth checks"
|
||||
|
||||
A06_Configuration:
|
||||
Name: "Security Misconfiguration"
|
||||
Types: ["Default configs", "Open cloud storage", "Verbose errors"]
|
||||
Description: "Insecure default configurations"
|
||||
Detection: "Default accounts, unnecessary features, debug info"
|
||||
Mitigation: "Secure defaults, configuration review, hardening"
|
||||
|
||||
A07_XSS:
|
||||
Name: "Cross-Site Scripting (XSS)"
|
||||
Types: ["Reflected", "Stored", "DOM-based"]
|
||||
Description: "Untrusted data included in web page"
|
||||
Detection: "Unvalidated input in HTML output"
|
||||
Mitigation: "Input validation, output encoding, CSP headers"
|
||||
|
||||
A08_Deserialization:
|
||||
Name: "Insecure Deserialization"
|
||||
Types: ["Remote code execution", "Object injection"]
|
||||
Description: "Untrusted data deserialization flaws"
|
||||
Detection: "User-controlled serialization, unsafe deserializers"
|
||||
Mitigation: "Input validation, integrity checks, isolation"
|
||||
|
||||
A09_Components:
|
||||
Name: "Using Components w/ Known Vulnerabilities"
|
||||
Types: ["Outdated libraries", "Unpatched systems"]
|
||||
Description: "Vulnerable components in application"
|
||||
Detection: "Outdated dependencies, missing patches"
|
||||
Mitigation: "Regular updates, vulnerability scanning, monitoring"
|
||||
|
||||
A10_Monitoring:
|
||||
Name: "Insufficient Logging & Monitoring"
|
||||
Types: ["Missing logs", "Poor detection", "Slow response"]
|
||||
Description: "Inadequate logging & incident response"
|
||||
Detection: "Missing audit logs, no alerting, delayed detection"
|
||||
Mitigation: "Comprehensive logging, real-time monitoring, incident response"
|
||||
```
|
||||
|
||||
## Security Analysis Categories
|
||||
|
||||
```yaml
|
||||
Code_Security_Analysis:
|
||||
Input_Validation:
|
||||
Patterns: ["SQL injection points", "XSS vulnerabilities", "Command injection"]
|
||||
Checks: ["Parameter validation", "Input sanitization", "Type checking"]
|
||||
|
||||
Output_Encoding:
|
||||
Patterns: ["HTML encoding", "URL encoding", "JavaScript escaping"]
|
||||
Checks: ["Context-aware encoding", "Output validation", "Content-Type headers"]
|
||||
|
||||
Authentication_Weaknesses:
|
||||
Patterns: ["Weak password policies", "Session management", "Credential storage"]
|
||||
Checks: ["Auth logic review", "Session security", "Password handling"]
|
||||
|
||||
Authorization_Flaws:
|
||||
Patterns: ["Privilege escalation", "Role bypass", "Resource access"]
|
||||
Checks: ["Access control logic", "Permission validation", "Role assignment"]
|
||||
|
||||
Cryptographic_Problems:
|
||||
Patterns: ["Weak algorithms", "Key management", "Random number generation"]
|
||||
Checks: ["Crypto implementation", "Key storage", "Algorithm strength"]
|
||||
|
||||
Error_Handling_Leaks:
|
||||
Patterns: ["Stack traces", "Debug information", "Internal paths"]
|
||||
Checks: ["Error messages", "Exception handling", "Information disclosure"]
|
||||
|
||||
Session_Management:
|
||||
Patterns: ["Session fixation", "Session hijacking", "Timeout handling"]
|
||||
Checks: ["Session generation", "Session storage", "Session invalidation"]
|
||||
|
||||
File_Operation_Safety:
|
||||
Patterns: ["Path traversal", "File upload", "Directory listing"]
|
||||
Checks: ["Path validation", "File type checking", "Access controls"]
|
||||
```
|
||||
|
||||
## Dependency Security Patterns
|
||||
|
||||
```yaml
|
||||
Dependency_Scanning:
|
||||
CVE_Detection:
|
||||
Description: "Known Common Vulnerabilities & Exposures"
|
||||
Sources: ["NVD database", "GitHub advisories", "Vendor bulletins"]
|
||||
Metrics: ["CVSS score", "Exploitability", "Impact assessment"]
|
||||
|
||||
Outdated_Packages:
|
||||
Description: "Components w/ available security updates"
|
||||
Checks: ["Version comparison", "Security patch availability", "EOL status"]
|
||||
Priority: ["Critical patches", "High-risk components", "Deprecated packages"]
|
||||
|
||||
License_Compliance:
|
||||
Description: "Legal & security implications of licenses"
|
||||
Checks: ["GPL compatibility", "Commercial restrictions", "Attribution requirements"]
|
||||
Risks: ["Copyleft obligations", "Patent implications", "Compliance violations"]
|
||||
|
||||
Transitive_Dependencies:
|
||||
Description: "Indirect dependency vulnerabilities"
|
||||
Analysis: ["Dependency tree", "Version conflicts", "Update paths"]
|
||||
Mitigation: ["Version pinning", "Dependency updates", "Alternative libraries"]
|
||||
|
||||
Typosquatting_Detection:
|
||||
Description: "Malicious packages w/ similar names"
|
||||
Patterns: ["Character substitution", "Domain squatting", "Namespace confusion"]
|
||||
Validation: ["Package authenticity", "Maintainer verification", "Download patterns"]
|
||||
|
||||
Security_Patch_Availability:
|
||||
Description: "Available fixes for known vulnerabilities"
|
||||
Tracking: ["Patch release dates", "Compatibility testing", "Update urgency"]
|
||||
Planning: ["Patch scheduling", "Risk assessment", "Rollback procedures"]
|
||||
```
|
||||
|
||||
## Configuration Security Patterns
|
||||
|
||||
```yaml
|
||||
Configuration_Security:
|
||||
Hardcoded_Secrets:
|
||||
Patterns: ["API keys", "Passwords", "Tokens", "Certificates"]
|
||||
Detection: ["String patterns", "Entropy analysis", "Known secret formats"]
|
||||
Mitigation: ["Environment variables", "Secret management", "Key rotation"]
|
||||
|
||||
Environment_Variables:
|
||||
Security: ["Sensitive data exposure", "Injection attacks", "Default values"]
|
||||
Best_Practices: ["Validation", "Sanitization", "Secure defaults"]
|
||||
|
||||
Permission_Configurations:
|
||||
File_Permissions: ["Read/write/execute", "Owner/group/other", "Special bits"]
|
||||
Service_Permissions: ["User accounts", "Service isolation", "Capability dropping"]
|
||||
Network_Permissions: ["Firewall rules", "Port restrictions", "Protocol filtering"]
|
||||
|
||||
Network_Exposure:
|
||||
Open_Ports: ["Unnecessary services", "Default ports", "Admin interfaces"]
|
||||
Protocol_Security: ["Unencrypted protocols", "Weak ciphers", "Version vulnerabilities"]
|
||||
|
||||
TLS_SSL_Settings:
|
||||
Configuration: ["Protocol versions", "Cipher suites", "Certificate validation"]
|
||||
Best_Practices: ["Perfect forward secrecy", "HSTS headers", "Certificate pinning"]
|
||||
|
||||
CORS_Policies:
|
||||
Misconfiguration: ["Wildcard origins", "Credential sharing", "Permissive headers"]
|
||||
Security: ["Origin validation", "Preflight handling", "Error responses"]
|
||||
|
||||
Security_Headers:
|
||||
Required: ["CSP", "HSTS", "X-Frame-Options", "X-Content-Type-Options"]
|
||||
Configuration: ["Policy definitions", "Report URIs", "Enforcement modes"]
|
||||
```
|
||||
|
||||
## Infrastructure Security Patterns
|
||||
|
||||
```yaml
|
||||
Infrastructure_Security:
|
||||
Network_Security:
|
||||
Open_Ports: "Scan for unnecessary exposed services"
|
||||
Firewall_Rules: "Validate access control lists & policies"
|
||||
Service_Discovery: "Identify running services & versions"
|
||||
|
||||
Access_Control:
|
||||
User_Accounts: "Review account permissions & privileges"
|
||||
Service_Accounts: "Validate service-to-service authentication"
|
||||
Admin_Access: "Audit administrative privileges"
|
||||
|
||||
Data_Protection:
|
||||
Encryption_Transit: "Verify TLS/SSL implementation"
|
||||
Encryption_Rest: "Check data storage encryption"
|
||||
Key_Management: "Review cryptographic key handling"
|
||||
|
||||
Monitoring_Security:
|
||||
Log_Collection: "Ensure comprehensive audit logging"
|
||||
Security_Events: "Monitor for security incidents"
|
||||
Anomaly_Detection: "Implement behavioral analysis"
|
||||
|
||||
Backup_Security:
|
||||
Backup_Encryption: "Encrypt backup data"
|
||||
Access_Controls: "Restrict backup access"
|
||||
Recovery_Testing: "Validate restore procedures"
|
||||
```
|
||||
|
||||
## Security Validation Modes
|
||||
|
||||
```yaml
|
||||
Validation_Levels:
|
||||
Quick_Scan:
|
||||
Scope: "Critical security issues only"
|
||||
Time: "< 30 seconds"
|
||||
Focus: ["Hardcoded secrets", "SQL injection", "XSS", "Known CVEs"]
|
||||
Output: "High-priority findings only"
|
||||
|
||||
Standard_Scan:
|
||||
Scope: "Comprehensive security analysis"
|
||||
Time: "2-5 minutes"
|
||||
Focus: ["OWASP Top 10", "Dependency vulnerabilities", "Configuration issues"]
|
||||
Output: "Detailed findings w/ remediation"
|
||||
|
||||
Deep_Scan:
|
||||
Scope: "Thorough security audit"
|
||||
Time: "10-30 minutes"
|
||||
Focus: ["Code analysis", "Architecture review", "Compliance checking"]
|
||||
Output: "Complete security assessment"
|
||||
|
||||
Compliance_Scan:
|
||||
Scope: "Regulatory compliance validation"
|
||||
Frameworks: ["SOC 2", "PCI DSS", "HIPAA", "GDPR"]
|
||||
Focus: ["Data protection", "Access controls", "Audit trails"]
|
||||
Output: "Compliance report w/ gaps"
|
||||
```
|
||||
|
||||
## Risk Assessment Templates
|
||||
|
||||
```yaml
|
||||
Risk_Scoring:
|
||||
Critical_10:
|
||||
Criteria: ["Data breach potential", "System compromise", "Production impact"]
|
||||
Response: "Immediate action required"
|
||||
Examples: ["SQL injection", "Remote code execution", "Credential exposure"]
|
||||
|
||||
High_7_9:
|
||||
Criteria: ["Significant security impact", "Exploitable vulnerabilities"]
|
||||
Response: "Fix before deployment"
|
||||
Examples: ["XSS vulnerabilities", "Authentication bypass", "Privilege escalation"]
|
||||
|
||||
Medium_4_6:
|
||||
Criteria: ["Security concerns", "Best practice violations"]
|
||||
Response: "Address in next sprint"
|
||||
Examples: ["Missing headers", "Weak configurations", "Information disclosure"]
|
||||
|
||||
Low_1_3:
|
||||
Criteria: ["Security improvements", "Hardening opportunities"]
|
||||
Response: "Best practice implementation"
|
||||
Examples: ["Security headers", "Error handling", "Logging improvements"]
|
||||
|
||||
Severity_Factors:
|
||||
Exploitability: ["Attack complexity", "Access requirements", "User interaction"]
|
||||
Impact: ["Confidentiality", "Integrity", "Availability"]
|
||||
Scope: ["System components", "Data sensitivity", "User base"]
|
||||
Context: ["Environment type", "Data classification", "Regulatory requirements"]
|
||||
```
|
||||
|
||||
## Security Remediation Patterns
|
||||
|
||||
```yaml
|
||||
Remediation_Strategies:
|
||||
Immediate_Actions:
|
||||
Critical_Issues:
|
||||
- "Disable vulnerable functionality"
|
||||
- "Block attack vectors"
|
||||
- "Implement emergency patches"
|
||||
- "Monitor for exploitation"
|
||||
|
||||
Short_Term_Fixes:
|
||||
High_Priority:
|
||||
- "Apply security patches"
|
||||
- "Implement input validation"
|
||||
- "Configure security headers"
|
||||
- "Update vulnerable dependencies"
|
||||
|
||||
Long_Term_Improvements:
|
||||
Security_Architecture:
|
||||
- "Implement security by design"
|
||||
- "Establish security testing"
|
||||
- "Create security policies"
|
||||
- "Train development teams"
|
||||
|
||||
Prevention_Strategies:
|
||||
Secure_Development:
|
||||
- "Security requirements definition"
|
||||
- "Threat modeling"
|
||||
- "Secure coding practices"
|
||||
- "Security testing integration"
|
||||
|
||||
Operational_Security:
|
||||
- "Regular security assessments"
|
||||
- "Vulnerability management"
|
||||
- "Incident response procedures"
|
||||
- "Security monitoring"
|
||||
```
|
||||
|
||||
---
|
||||
*Security Patterns v4.0.0 - Comprehensive security knowledge patterns for SuperClaude commands*
|
||||
@@ -141,4 +141,4 @@ conflict_resolution:
|
||||
- git merge requirements
|
||||
- dependency overlaps
|
||||
- resource constraints
|
||||
```
|
||||
```
|
||||
|
||||
@@ -1,252 +0,0 @@
|
||||
# Severity Levels & Response Standards
|
||||
|
||||
## Legend
|
||||
| Symbol | Meaning | | Abbrev | Meaning |
|
||||
|--------|---------|---|--------|---------|
|
||||
| 🚨 | critical/urgent | | sev | severity |
|
||||
| ⚠ | warning/caution | | resp | response |
|
||||
| ℹ | information | | act | action |
|
||||
| ✅ | success/ok | | esc | escalation |
|
||||
|
||||
## Universal Severity Classification
|
||||
|
||||
```yaml
|
||||
Severity_Levels:
|
||||
CRITICAL [10]:
|
||||
Definition: "Data loss, security breach, production down, system compromise"
|
||||
Response: "Immediate stop, alert, rollback, incident response"
|
||||
Recovery: "Manual intervention required, full investigation"
|
||||
Escalation: "Immediate user notification + system halt"
|
||||
Examples:
|
||||
- Security vulnerabilities being committed
|
||||
- Data deletion without backup
|
||||
- Production system failures
|
||||
- Credential exposure
|
||||
- System corruption
|
||||
|
||||
HIGH [7-9]:
|
||||
Definition: "Build failure, test failure, deployment issues, significant bugs"
|
||||
Response: "Stop workflow, notify user, suggest fixes"
|
||||
Recovery: "Automated retry with backoff, alternative paths"
|
||||
Escalation: "User notification + corrective action required"
|
||||
Examples:
|
||||
- Compilation errors
|
||||
- Test suite failures
|
||||
- Deployment rollbacks
|
||||
- API integration failures
|
||||
- Major functionality breaks
|
||||
|
||||
MEDIUM [4-6]:
|
||||
Definition: "Warning conditions, performance degradation, code quality issues"
|
||||
Response: "Continue with warning, log for later review"
|
||||
Recovery: "Attempt optimization, monitor for escalation"
|
||||
Escalation: "Log warning + optional user notification"
|
||||
Examples:
|
||||
- Performance bottlenecks
|
||||
- Code quality violations
|
||||
- Deprecated API usage
|
||||
- Configuration warnings
|
||||
- Non-critical dependency issues
|
||||
|
||||
LOW [1-3]:
|
||||
Definition: "Info messages, style violations, minor optimizations, suggestions"
|
||||
Response: "Note in output, continue execution"
|
||||
Recovery: "Background fixes, cleanup on completion"
|
||||
Escalation: "Silent logging only"
|
||||
Examples:
|
||||
- Code style violations
|
||||
- Minor optimization opportunities
|
||||
- Documentation suggestions
|
||||
- Informational messages
|
||||
- Best practice recommendations
|
||||
```
|
||||
|
||||
## Response Time Requirements
|
||||
|
||||
```yaml
|
||||
Response_Times:
|
||||
CRITICAL [10]:
|
||||
Detection_Time: "Immediate (real-time)"
|
||||
Response_Time: "< 1 second"
|
||||
User_Notification: "Immediate blocking alert"
|
||||
|
||||
HIGH [7-9]:
|
||||
Detection_Time: "< 5 seconds"
|
||||
Response_Time: "< 10 seconds"
|
||||
User_Notification: "Immediate non-blocking alert"
|
||||
|
||||
MEDIUM [4-6]:
|
||||
Detection_Time: "< 30 seconds"
|
||||
Response_Time: "< 60 seconds"
|
||||
User_Notification: "End of operation summary"
|
||||
|
||||
LOW [1-3]:
|
||||
Detection_Time: "Background monitoring"
|
||||
Response_Time: "Batch processing"
|
||||
User_Notification: "Optional reporting"
|
||||
```
|
||||
|
||||
## Context-Specific Severity Mapping
|
||||
|
||||
```yaml
|
||||
Development_Context:
|
||||
File_Operations:
|
||||
File_Not_Found: "HIGH [8] - blocks workflow"
|
||||
Permission_Denied: "HIGH [7] - requires intervention"
|
||||
File_Lock_Conflict: "MEDIUM [5] - retry possible"
|
||||
Large_File_Warning: "LOW [2] - informational"
|
||||
|
||||
Code_Quality:
|
||||
Syntax_Error: "HIGH [9] - prevents execution"
|
||||
Type_Error: "HIGH [8] - runtime failure likely"
|
||||
Unused_Variable: "MEDIUM [4] - code quality"
|
||||
Style_Violation: "LOW [2] - cosmetic issue"
|
||||
|
||||
Git_Operations:
|
||||
Merge_Conflict: "HIGH [8] - manual resolution required"
|
||||
Uncommitted_Changes: "MEDIUM [6] - data loss possible"
|
||||
Branch_Behind: "MEDIUM [5] - sync recommended"
|
||||
Clean_Working_Tree: "LOW [1] - status information"
|
||||
|
||||
Security_Context:
|
||||
Credential_Exposure:
|
||||
Hardcoded_API_Key: "CRITICAL [10] - immediate security risk"
|
||||
Password_In_Code: "CRITICAL [10] - credential leak"
|
||||
Weak_Authentication: "HIGH [8] - security vulnerability"
|
||||
HTTP_vs_HTTPS: "MEDIUM [6] - protocol downgrade"
|
||||
|
||||
Vulnerability_Detection:
|
||||
Known_CVE: "CRITICAL [10] - exploit available"
|
||||
Dependency_Alert: "HIGH [8] - update required"
|
||||
Insecure_Config: "HIGH [7] - hardening needed"
|
||||
Security_Header_Missing: "MEDIUM [5] - best practice"
|
||||
|
||||
Operations_Context:
|
||||
Deployment:
|
||||
Health_Check_Failed: "CRITICAL [10] - service down"
|
||||
Database_Connection_Lost: "CRITICAL [10] - data access failure"
|
||||
Memory_Exhaustion: "HIGH [9] - service degradation"
|
||||
Slow_Response_Time: "MEDIUM [6] - performance issue"
|
||||
|
||||
Performance:
|
||||
CPU_Spike: "HIGH [8] - resource exhaustion"
|
||||
Memory_Leak: "HIGH [7] - gradual degradation"
|
||||
Cache_Miss_Rate: "MEDIUM [5] - efficiency concern"
|
||||
Log_Volume_High: "LOW [3] - monitoring alert"
|
||||
```
|
||||
|
||||
## Automated Response Actions
|
||||
|
||||
```yaml
|
||||
CRITICAL_Responses:
|
||||
Immediate_Actions:
|
||||
- Stop all operations immediately
|
||||
- Create emergency checkpoint
|
||||
- Block further execution
|
||||
- Generate incident report
|
||||
- Alert user with full context
|
||||
|
||||
Recovery_Actions:
|
||||
- Rollback to last known good state
|
||||
- Isolate affected components
|
||||
- Enable safe mode operation
|
||||
- Require manual intervention
|
||||
|
||||
HIGH_Responses:
|
||||
Immediate_Actions:
|
||||
- Pause current operation
|
||||
- Attempt automatic fix
|
||||
- Log detailed error information
|
||||
- Notify user of issue and resolution attempt
|
||||
|
||||
Recovery_Actions:
|
||||
- Retry with alternative approach
|
||||
- Escalate if retry fails
|
||||
- Provide user with fix options
|
||||
- Continue with degraded functionality if safe
|
||||
|
||||
MEDIUM_Responses:
|
||||
Immediate_Actions:
|
||||
- Log warning with context
|
||||
- Continue operation with monitoring
|
||||
- Add issue to cleanup queue
|
||||
- Track for trend analysis
|
||||
|
||||
Recovery_Actions:
|
||||
- Schedule background fix
|
||||
- Monitor for escalation
|
||||
- Include in next maintenance cycle
|
||||
- Update user on resolution
|
||||
|
||||
LOW_Responses:
|
||||
Immediate_Actions:
|
||||
- Silent logging
|
||||
- Continue normal operation
|
||||
- Add to improvement backlog
|
||||
- Include in periodic reports
|
||||
|
||||
Recovery_Actions:
|
||||
- Batch with similar issues
|
||||
- Address during optimization cycles
|
||||
- Include in documentation updates
|
||||
- Track for pattern analysis
|
||||
```
|
||||
|
||||
## Escalation Pathways
|
||||
|
||||
```yaml
|
||||
Escalation_Rules:
|
||||
Frequency_Based:
|
||||
Same_Issue_3x: "Increase severity by 1 level"
|
||||
Same_Issue_5x: "Increase severity by 2 levels"
|
||||
Pattern_Detected: "Escalate to system-level investigation"
|
||||
|
||||
Time_Based:
|
||||
Unresolved_1h: "Increase visibility"
|
||||
Unresolved_4h: "Escalate to user attention"
|
||||
Unresolved_24h: "Mark as systemic issue"
|
||||
|
||||
Impact_Based:
|
||||
Multiple_Users: "Increase severity by 1 level"
|
||||
Production_Environment: "Increase severity by 2 levels"
|
||||
Data_Integrity: "Immediate CRITICAL classification"
|
||||
|
||||
Escalation_Actions:
|
||||
Level_1: "Automated retry with different approach"
|
||||
Level_2: "User notification with recommended actions"
|
||||
Level_3: "System halt with manual intervention required"
|
||||
Level_4: "Emergency protocols + external alerting"
|
||||
```
|
||||
|
||||
## Integration Standards
|
||||
|
||||
```yaml
|
||||
Usage_in_Commands:
|
||||
Error_Classification:
|
||||
- Always assign severity level to errors
|
||||
- Use consistent [level] notation
|
||||
- Include severity in log messages
|
||||
- Map to appropriate response actions
|
||||
|
||||
Response_Selection:
|
||||
- Check severity level first
|
||||
- Apply appropriate response template
|
||||
- Escalate based on frequency/pattern
|
||||
- Document resolution approach
|
||||
|
||||
Reporting_Format:
|
||||
Structure: "[SEVERITY_LEVEL] Category: Description"
|
||||
Examples:
|
||||
- "[CRITICAL] Security: API key detected in commit"
|
||||
- "[HIGH] Build: Compilation failed with 3 errors"
|
||||
- "[MEDIUM] Performance: Query took 2.3s (>1s threshold)"
|
||||
- "[LOW] Style: 5 formatting issues found"
|
||||
|
||||
Cross_Reference_Usage:
|
||||
Commands: "@see shared/severity-levels.yml for error classification"
|
||||
Shared_Files: "@include shared/severity-levels.yml#CRITICAL for critical responses"
|
||||
Templates: "@flags shared/severity-levels.yml#Response_Times for SLA requirements"
|
||||
```
|
||||
|
||||
---
|
||||
*Severity Levels v1.0 - Universal classification and response standards for SuperClaude operations*
|
||||
135
.claude/commands/shared/system-config.yml
Normal file
135
.claude/commands/shared/system-config.yml
Normal file
@@ -0,0 +1,135 @@
|
||||
# System Configuration - Consolidated runtime & session settings
|
||||
# Consolidates common system-level configuration patterns
|
||||
|
||||
## Legend
|
||||
| Symbol | Meaning | | Abbrev | Meaning |
|
||||
|--------|---------|---|--------|---------|
|
||||
| ⚙ | system setting | | cfg | configuration |
|
||||
| 🔄 | session/runtime | | perf | performance |
|
||||
| 📊 | monitoring | | rec | recovery |
|
||||
|
||||
## Session Management
|
||||
|
||||
```yaml
|
||||
Session_Settings:
|
||||
Memory_Management:
|
||||
Context_Limit: "70% warning, 90% critical"
|
||||
Cache_Duration: "30 minutes active session"
|
||||
Auto_Cleanup: "Clear expired context every 5 minutes"
|
||||
Persistence: "Store successful workflows across sessions"
|
||||
|
||||
Context_Sharing:
|
||||
Chain_Results: "Auto-pass relevant results between commands"
|
||||
Intelligent_Workflows: "analyze→improve, build→test, scan→fix"
|
||||
Result_Reuse: "Same target+flags within session"
|
||||
Invalidation: "Modified files trigger cache refresh"
|
||||
|
||||
Recovery_Settings:
|
||||
Session_Recovery:
|
||||
Auto_Save: "Save state every 10 operations"
|
||||
Checkpoint_Triggers: ["Before risky operations", "Major state changes"]
|
||||
Recovery_Options: ["Resume from checkpoint", "Restart clean"]
|
||||
State_Validation: "Verify system state on recovery"
|
||||
|
||||
Error_Recovery:
|
||||
Retry_Patterns: "3 attempts with exponential backoff"
|
||||
Fallback_Strategies: "Native tools if MCP fails"
|
||||
User_Guidance: "Clear next steps on failure"
|
||||
Context_Preservation: "Maintain progress during errors"
|
||||
```
|
||||
|
||||
## Performance Monitoring
|
||||
|
||||
```yaml
|
||||
Performance_Settings:
|
||||
Timing_Metrics:
|
||||
Command_Duration: "Track start/end times"
|
||||
Phase_Breakdown: "Analysis, execution, reporting phases"
|
||||
Token_Usage: "Monitor MCP server consumption"
|
||||
Resource_Usage: "Memory, CPU, network tracking"
|
||||
|
||||
Thresholds:
|
||||
Command_Timeout: "300 seconds (5 minutes)"
|
||||
Token_Warning: ">70% of budget consumed"
|
||||
Memory_Alert: ">500MB CLI usage"
|
||||
Performance_Degradation: ">30s typical operations"
|
||||
|
||||
Optimization:
|
||||
Lazy_Loading: "Load config/patterns on demand"
|
||||
Batch_Operations: "Group similar file operations"
|
||||
Caching_Strategy: "Results, patterns, frequently used data"
|
||||
Resource_Cleanup: "Auto-cleanup temp files and cache"
|
||||
```
|
||||
|
||||
## Planning & Risk Assessment
|
||||
|
||||
```yaml
|
||||
Planning_Control:
|
||||
Flag_Based:
|
||||
--plan: "Force planning mode for any command"
|
||||
--skip-plan: "Execute immediately (overrides risk triggers)"
|
||||
default: "Execute immediately unless --plan specified"
|
||||
|
||||
Risk_Triggers:
|
||||
Production: "deploy --env prod, migrate production data"
|
||||
Data_Loss: "cleanup --all, destructive operations"
|
||||
System_Wide: "spawn agents, global improvements"
|
||||
Security_Critical: "scan --security, auth changes"
|
||||
|
||||
Assessment_Factors:
|
||||
Scope: "Number of files/systems affected"
|
||||
Reversibility: "Can operation be easily undone"
|
||||
Data_Impact: "Potential for data loss/corruption"
|
||||
Security_Impact: "Authentication, authorization changes"
|
||||
```
|
||||
|
||||
## User Experience Settings
|
||||
|
||||
```yaml
|
||||
Interface_Patterns:
|
||||
Progress_Indicators:
|
||||
Long_Operations: "Show progress for >30 second operations"
|
||||
Multi_Step: "Display step N of M for workflows"
|
||||
Real_Time: "Live updates for --watch mode"
|
||||
|
||||
Feedback_Patterns:
|
||||
Success_Messages: "Clear confirmation of completion"
|
||||
Error_Messages: "What failed, why, how to fix"
|
||||
Warning_Messages: "Potential issues, user confirmation"
|
||||
Info_Messages: "Helpful context, next steps"
|
||||
|
||||
Output_Formatting:
|
||||
Structured: "Consistent format across commands"
|
||||
Compressed: "Use --uc flag for token efficiency"
|
||||
Visual_Aids: "Tables, bullets, clear hierarchies"
|
||||
File_References: "Clickable paths, line numbers"
|
||||
```
|
||||
|
||||
## Integration Points
|
||||
|
||||
```yaml
|
||||
Command_Integration:
|
||||
Pre_Execution:
|
||||
Config_Loading: "Load user, project, system config"
|
||||
Validation: "Check prerequisites, permissions"
|
||||
Risk_Assessment: "Evaluate operation safety"
|
||||
|
||||
During_Execution:
|
||||
Progress_Tracking: "Monitor operation progress"
|
||||
Resource_Monitoring: "Track performance metrics"
|
||||
Error_Detection: "Catch and handle failures"
|
||||
|
||||
Post_Execution:
|
||||
Result_Storage: "Cache results for reuse"
|
||||
Cleanup: "Remove temp files, release resources"
|
||||
Reporting: "Generate summaries, logs"
|
||||
|
||||
System_Health:
|
||||
Monitoring: "Track command success rates, performance"
|
||||
Alerting: "Warn on degraded performance, errors"
|
||||
Auto_Maintenance: "Cleanup, optimization, updates"
|
||||
Diagnostics: "Health checks, system validation"
|
||||
```
|
||||
|
||||
---
|
||||
*System Config v4.0.0 - Consolidated runtime, session, performance & UX settings*
|
||||
@@ -300,7 +300,7 @@ Checkpoints:
|
||||
- Todo milestone completion
|
||||
Manual:
|
||||
- /task:pause command
|
||||
- /user:git --checkpoint
|
||||
- /git --checkpoint
|
||||
|
||||
Cleanup_Workflow:
|
||||
On_Complete:
|
||||
@@ -327,9 +327,9 @@ Task_Commands:
|
||||
cancel: "/task:cancel {id}"
|
||||
|
||||
Auto_Detection_Commands:
|
||||
/user:build → "Analyze complexity → create task if needed → proceed"
|
||||
/user:implement → "Always create task → breakdown → execute"
|
||||
/user:create → "Analyze scope → task if multi-step → proceed"
|
||||
/build → "Analyze complexity → create task if needed → proceed"
|
||||
/implement → "Always create task → breakdown → execute"
|
||||
/create → "Analyze scope → task if multi-step → proceed"
|
||||
|
||||
Plan_Mode_Integration:
|
||||
exit_plan_mode:
|
||||
@@ -377,4 +377,4 @@ Example_4_Medium_Complexity:
|
||||
```
|
||||
|
||||
---
|
||||
*Task System v1.0 - Seamless integration of persistent tasks with dynamic todos for SuperClaude*
|
||||
*Task System v4.0.0 - Seamless integration of persistent tasks with dynamic todos for SuperClaude*
|
||||
83
.claude/commands/shared/task-ultracompressed.md
Normal file
83
.claude/commands/shared/task-ultracompressed.md
Normal file
@@ -0,0 +1,83 @@
|
||||
## Legend
|
||||
| Symbol | Meaning | | Abbrev | Meaning |
|
||||
|--------|---------|---|--------|---------|
|
||||
| → | leads to | | cfg | configuration |
|
||||
| & | and/with | | impl | implementation |
|
||||
| w/ | with | | perf | performance |
|
||||
| @ | at/located | | ops | operations |
|
||||
| > | greater than | | val | validation |
|
||||
| ∀ | for all/every | | req | requirements |
|
||||
| ∃ | exists/there is | | deps | dependencies |
|
||||
| ∴ | therefore | | env | environment |
|
||||
| ∵ | because | | db | database |
|
||||
| ≡ | equivalent | | api | interface |
|
||||
| ≈ | approximately | | docs | documentation |
|
||||
| 📁 | directory/path | | std | standard |
|
||||
| 🔢 | number/count | | def | default |
|
||||
| 📝 | text/string | | ctx | context |
|
||||
| ⚙ | setting/config | | err | error |
|
||||
| 🎛 | control/flags | | exec | execution |
|
||||
| 🔧 | configuration | | qual | quality |
|
||||
| 📋 | group/category | | rec | recovery |
|
||||
| 🚨 | critical/urgent | | sev | severity |
|
||||
| ⚠ | warning/caution | | resp | response |
|
||||
| 🔄 | retry/recovery | | esc | escalation |
|
||||
| ✅ | success/fixed | | tok | token |
|
||||
| ❌ | failure/error | | opt | optimization |
|
||||
| ℹ | information | | UX | user experience |
|
||||
| ⚡ | fast/quick | | UI | user interface |
|
||||
| 🐌 | slow/delayed | | C | critical |
|
||||
| ✨ | complete/done | | H | high |
|
||||
| 📖 | read operation | | M | medium |
|
||||
| ✏ | edit operation | | L | low |
|
||||
| 🗑 | delete operation | | |
|
||||
|
||||
## Command Execution
|
||||
Execute: immediate. --plan→show plan first
|
||||
Legend: Generated based on symbols used in command
|
||||
Purpose: "[Action][Subject] in $ARGUMENTS"
|
||||
|
||||
UltraCompressed task template for token efficiency.
|
||||
|
||||
## Universal Flags
|
||||
--plan: "Show execution plan before running"
|
||||
--uc: "UltraCompressed mode (~70% token reduction)"
|
||||
--ultracompressed: "Alias for --uc"
|
||||
--think: "Multi-file analysis w/ context (4K tokens)"
|
||||
--think-hard: "Deep architectural analysis (10K tokens)"
|
||||
--ultrathink: "Critical system redesign (32K tokens)"
|
||||
--c7: "Enable Context7→library documentation lookup"
|
||||
--seq: "Enable Sequential→complex analysis & thinking"
|
||||
--magic: "Enable Magic→UI component generation"
|
||||
--pup: "Enable Puppeteer→browser automation & testing"
|
||||
--all-mcp: "Enable all MCP servers"
|
||||
--no-mcp: "Disable all MCP servers (native tools only)"
|
||||
--no-c7: "Disable Context7 specifically"
|
||||
--no-seq: "Disable Sequential thinking specifically"
|
||||
--no-magic: "Disable Magic UI builder specifically"
|
||||
--no-pup: "Disable Puppeteer specifically"
|
||||
|
||||
T: {TASK_TITLE}
|
||||
ID: {TASK_ID} | S: {STATUS} | P: {PRIORITY}
|
||||
Branch: {BRANCH}
|
||||
|
||||
## Phases
|
||||
□ Analysis: Requirements & design
|
||||
□ Impl: Core functionality
|
||||
□ Test: Unit & integration
|
||||
□ Deploy: Staging & prod
|
||||
|
||||
## Context
|
||||
Dec: {KEY_DECISIONS}
|
||||
Block: {BLOCKERS}
|
||||
Files: {AFFECTED_FILES}
|
||||
Next: {NEXT_STEP}
|
||||
|
||||
## Progress
|
||||
Todos: {ACTIVE}/{TOTAL}
|
||||
Complete: {PERCENTAGE}%
|
||||
Session: {SESSION_TIME}
|
||||
|
||||
## Git
|
||||
Commits: {COMMIT_COUNT}
|
||||
Last: {LAST_COMMIT}
|
||||
@@ -1,88 +0,0 @@
|
||||
# Task UltraCompressed Format Configuration
|
||||
|
||||
## Format Rules
|
||||
```yaml
|
||||
activation:
|
||||
automatic: true for all task operations
|
||||
exceptions: none - always use compressed format
|
||||
|
||||
compression_rules:
|
||||
remove_words:
|
||||
- the, a, an, is, are, was, were
|
||||
- in, on, at, to, for, of, with
|
||||
- that, which, this, these
|
||||
|
||||
abbreviations:
|
||||
status: S | priority: P | implementation: impl
|
||||
configuration: cfg | documentation: docs
|
||||
authentication: auth | database: db
|
||||
architecture: arch | development: dev
|
||||
production: prod | dependencies: deps
|
||||
|
||||
symbols:
|
||||
→: leads to / results in
|
||||
&: and / with
|
||||
w/: with / including
|
||||
w/o: without
|
||||
✓: completed
|
||||
□: pending
|
||||
⚠: blocked
|
||||
|
||||
structure:
|
||||
title_line: "T: {title}"
|
||||
metadata_line: "ID: {id} | S: {status} | P: {priority}"
|
||||
branch_line: "Branch: {branch}"
|
||||
phases: bullet list with symbols
|
||||
context: key:value pairs
|
||||
progress: percentage and todo count
|
||||
```
|
||||
|
||||
## Task File Template
|
||||
```yaml
|
||||
header: |
|
||||
# Legend: → leads to | & and | w/ with | S: status | P: priority | ✓ done | □ pending
|
||||
|
||||
T: {title}
|
||||
ID: {id} | S: {status} | P: {priority}
|
||||
Branch: {branch}
|
||||
|
||||
phases: |
|
||||
## Phases
|
||||
{phase_list}
|
||||
|
||||
context: |
|
||||
## Context
|
||||
Dec: {decisions}
|
||||
Block: {blockers}
|
||||
Files: {files}
|
||||
Next: {next_step}
|
||||
|
||||
progress: |
|
||||
## Progress
|
||||
Todos: {active}/{total}
|
||||
Complete: {percentage}%
|
||||
```
|
||||
|
||||
## Conversion Examples
|
||||
```yaml
|
||||
verbose_to_compressed:
|
||||
before: "Create user authentication system with JWT tokens"
|
||||
after: "T: User auth system w/ JWT"
|
||||
|
||||
before: "Status: in-progress, Priority: high"
|
||||
after: "S: in-progress | P: high"
|
||||
|
||||
before: "Implementation phase is currently blocked by CORS configuration"
|
||||
after: "Impl phase blocked: CORS cfg"
|
||||
|
||||
before: "Decision made: Use PostgreSQL for database"
|
||||
after: "Dec: PostgreSQL for db"
|
||||
```
|
||||
|
||||
## Benefits
|
||||
```yaml
|
||||
token_savings: ~70% reduction
|
||||
readability: maintained through legend
|
||||
consistency: enforced format across all tasks
|
||||
scanning: easier to find key information
|
||||
```
|
||||
@@ -1,59 +0,0 @@
|
||||
# Task: {TASK_NAME}
|
||||
|
||||
## Metadata
|
||||
```yaml
|
||||
id: {TASK_ID}
|
||||
title: {TASK_TITLE}
|
||||
status: pending
|
||||
priority: medium
|
||||
created: {TIMESTAMP}
|
||||
updated: {TIMESTAMP}
|
||||
assignee: Claude
|
||||
branch: feature/{TASK_ID}
|
||||
```
|
||||
|
||||
## Requirement
|
||||
{REQUIREMENT_DESCRIPTION}
|
||||
|
||||
## Breakdown
|
||||
### Analysis Phase
|
||||
- [ ] Understand requirements
|
||||
- [ ] Identify affected files
|
||||
- [ ] Plan architecture changes
|
||||
- [ ] Create git branch
|
||||
|
||||
### Implementation Phase
|
||||
- [ ] {STEP_1}
|
||||
- [ ] {STEP_2}
|
||||
- [ ] {STEP_3}
|
||||
|
||||
### Testing Phase
|
||||
- [ ] Write tests
|
||||
- [ ] Run test suite
|
||||
- [ ] Manual testing
|
||||
|
||||
### Completion Phase
|
||||
- [ ] Code review
|
||||
- [ ] Documentation update
|
||||
- [ ] Merge to main
|
||||
|
||||
## Files Affected
|
||||
```yaml
|
||||
new: []
|
||||
modified: []
|
||||
deleted: []
|
||||
```
|
||||
|
||||
## Context Preservation
|
||||
```yaml
|
||||
key_decisions: []
|
||||
blockers: []
|
||||
notes: []
|
||||
session_state: {}
|
||||
```
|
||||
|
||||
## Checkpoints
|
||||
```yaml
|
||||
commits: []
|
||||
branches: []
|
||||
```
|
||||
@@ -1,26 +0,0 @@
|
||||
# Legend: → leads to | & and | w/ with | S: status | P: priority | ✓ done | □ pending
|
||||
|
||||
T: {TASK_TITLE}
|
||||
ID: {TASK_ID} | S: {STATUS} | P: {PRIORITY}
|
||||
Branch: {BRANCH}
|
||||
|
||||
## Phases
|
||||
□ Analysis: Requirements & design
|
||||
□ Impl: Core functionality
|
||||
□ Test: Unit & integration
|
||||
□ Deploy: Staging & prod
|
||||
|
||||
## Context
|
||||
Dec: {KEY_DECISIONS}
|
||||
Block: {BLOCKERS}
|
||||
Files: {AFFECTED_FILES}
|
||||
Next: {NEXT_STEP}
|
||||
|
||||
## Progress
|
||||
Todos: {ACTIVE}/{TOTAL}
|
||||
Complete: {PERCENTAGE}%
|
||||
Session: {SESSION_TIME}
|
||||
|
||||
## Git
|
||||
Commits: {COMMIT_COUNT}
|
||||
Last: {LAST_COMMIT}
|
||||
@@ -1,61 +0,0 @@
|
||||
# Thinking Mode Config
|
||||
|
||||
## Thinking Mode Flags
|
||||
```yaml
|
||||
Command_Flags:
|
||||
--think: "Standard thinking mode - Multi-file analysis (4K tokens)"
|
||||
--think-hard: "Deep analysis mode - Arch level (10K tokens)"
|
||||
--ultrathink: "Critical analysis mode - System redesign (32K tokens)"
|
||||
|
||||
Default_Behavior:
|
||||
No_flag: "Basic mode - Single file, simple tasks"
|
||||
|
||||
Flag_Combinations:
|
||||
With_planning: "--plan --think" # Plan w/ deeper analysis
|
||||
With_other_flags: Compatible w/ all command-specific flags
|
||||
|
||||
Usage_Examples:
|
||||
- /user:analyze --code --think # Standard code analysis
|
||||
- /user:design --api --think-hard # Deep architectural design
|
||||
- /user:troubleshoot --ultrathink # Critical debugging session
|
||||
- /user:improve --perf --think # Perf analysis w/ context
|
||||
```
|
||||
|
||||
## Mode Characteristics
|
||||
```yaml
|
||||
Basic (no flag):
|
||||
Scope: Single file, <10 lines
|
||||
Use_case: Quick fixes, simple edits, direct answers
|
||||
Token_usage: Minimal
|
||||
|
||||
Standard (--think):
|
||||
Scope: Multi-file coordination
|
||||
Use_case: Feature implementation, moderate complexity
|
||||
Token_usage: ~4K tokens
|
||||
|
||||
Deep (--think-hard):
|
||||
Scope: System architecture, complex patterns
|
||||
Use_case: Design decisions, optimization strategies
|
||||
Token_usage: ~10K tokens
|
||||
|
||||
Critical (--ultrathink):
|
||||
Scope: Complete system analysis
|
||||
Use_case: Redesigns, security audits, critical issues
|
||||
Token_usage: ~32K tokens
|
||||
```
|
||||
|
||||
## Auto-Activation Rules
|
||||
```yaml
|
||||
Command_Triggers:
|
||||
design + --api: Suggest --think-hard for architecture
|
||||
troubleshoot + production: Suggest --ultrathink for critical issues
|
||||
analyze + --security: Auto-apply --think for comprehensive review
|
||||
|
||||
Complexity_Detection:
|
||||
Multi-file_reference: Upgrade to --think
|
||||
Architecture_keywords: Suggest --think-hard
|
||||
Critical_terms: Recommend --ultrathink
|
||||
```
|
||||
|
||||
---
|
||||
*Thinking modes: Control analysis depth through command flags*
|
||||
@@ -1,97 +0,0 @@
|
||||
# UltraCompressed Docs Mode
|
||||
# ~70% token reduction via telegram-style+symbols+abbrevs
|
||||
|
||||
Activation:
|
||||
Flags: --ultracompressed | --uc
|
||||
Natural: "ultracompressed" | "minimal tokens" | "telegram style"
|
||||
Auto: Context>70% | Token budget specified | User preference
|
||||
|
||||
Core_Rules:
|
||||
Remove_Words:
|
||||
Articles: the|a|an
|
||||
Conjunctions: and|or|but|however|therefore
|
||||
Prepositions: of|in|on|at|to|for|with|from|by
|
||||
Fillers: that|which|who|very|really|quite|just
|
||||
Verbose: "in order to"→to | "make sure"→ensure | "as well as"→&
|
||||
|
||||
Symbol_Map:
|
||||
→: to/leads to/results in
|
||||
&: and/with/plus
|
||||
@: at/located at
|
||||
w/: with/including
|
||||
w/o: without/excluding
|
||||
+: add/plus/include
|
||||
-: remove/minus/exclude
|
||||
∴: therefore/thus
|
||||
∵: because/since
|
||||
≈: approximately/about
|
||||
∀: for all/every
|
||||
∃: exists/there is
|
||||
⊂: subset of/part of
|
||||
≡: equivalent to/same as
|
||||
|
||||
Abbreviations:
|
||||
cfg: configuration fn: function
|
||||
impl: implementation req: require/request
|
||||
resp: response auth: authentication
|
||||
db: database api: API/interface
|
||||
env: environment dev: development
|
||||
prod: production deps: dependencies
|
||||
arg: argument param: parameter
|
||||
val: value obj: object
|
||||
arr: array str: string
|
||||
num: number bool: boolean
|
||||
err: error msg: message
|
||||
usr: user sys: system
|
||||
lib: library pkg: package
|
||||
ctx: context ref: reference
|
||||
docs: documentation spec: specification
|
||||
|
||||
Structure_Rules:
|
||||
Headings: <20 chars | No articles | Symbols OK
|
||||
Sentences: <50 chars | Telegram style | No punctuation if clear
|
||||
Paragraphs: <100 chars | 3 sentences max | Lists preferred
|
||||
Lists: Bullets>numbers | No full sentences | Key info only
|
||||
Tables: Headers abbreviated | Cell content minimal | Symbols OK
|
||||
|
||||
Format_Hierarchy:
|
||||
1. YAML/JSON (structured data)
|
||||
2. Tables (comparison/reference)
|
||||
3. Bullet lists (enumeration)
|
||||
4. Numbered lists (sequences)
|
||||
5. Prose (avoid when possible)
|
||||
|
||||
Content_Rules:
|
||||
NO: Introductions|Conclusions|Transitions|Explanations of obvious
|
||||
NO: "Getting Started"|"Overview"|"Introduction" sections
|
||||
NO: Filler phrases|Politeness|Redundancy
|
||||
YES: Direct information|Code>text|Examples>description
|
||||
YES: Symbols>words|Abbreviations>full terms|Active>passive
|
||||
|
||||
Legend_Generation:
|
||||
When: Start of each doc | When new symbols/abbrevs used
|
||||
Format: Compact table | Only used items | Sort by frequency
|
||||
Location: After title | Before content | Collapsible if supported
|
||||
Example: |
|
||||
## Legend
|
||||
| Symbol | Meaning | | Abbrev | Meaning |
|
||||
|--------|---------|---|--------|---------|
|
||||
| → | leads to | | cfg | configuration |
|
||||
| & | and/with | | fn | function |
|
||||
| w/ | with | | impl | implementation |
|
||||
|
||||
Example_Transformations:
|
||||
Before: "This section provides an introduction to getting started with the authentication system"
|
||||
After: "Auth Setup"
|
||||
|
||||
Before: "In order to configure the database connection, you need to set the following environment variables"
|
||||
After: "DB cfg: Set env vars:"
|
||||
|
||||
Before: "The function takes three parameters and returns a boolean value"
|
||||
After: "fn(3 params)→bool"
|
||||
|
||||
Quality_Checks:
|
||||
Token_Reduction: Target 70% | Measure before/after
|
||||
Clarity_Score: Must remain >80% | Test w/ context
|
||||
Info_Density: Maximize bits/token | No info loss
|
||||
Legend_Required: Always include for symbols & abbreviations
|
||||
@@ -1,12 +1,85 @@
|
||||
# Constants & Shared Values
|
||||
# Universal Constants & Shared Values
|
||||
# Single source of truth for all legends, symbols, paths, and common constants
|
||||
|
||||
## Legend
|
||||
## Universal Legend
|
||||
| Symbol | Meaning | | Abbrev | Meaning |
|
||||
|--------|---------|---|--------|---------|
|
||||
| 📁 | directory/path | | cfg | configuration |
|
||||
| 🔢 | number/count | | std | standard |
|
||||
| 📝 | text/string | | val | value |
|
||||
| ⚙ | setting/config | | def | default |
|
||||
| → | leads to | | cfg | configuration |
|
||||
| & | and/with | | impl | implementation |
|
||||
| w/ | with | | perf | performance |
|
||||
| @ | at/located | | ops | operations |
|
||||
| > | greater than | | val | validation |
|
||||
| ∀ | for all/every | | req | requirements |
|
||||
| ∃ | exists/there is | | deps | dependencies |
|
||||
| ∴ | therefore | | env | environment |
|
||||
| ∵ | because | | db | database |
|
||||
| ≡ | equivalent | | api | interface |
|
||||
| ≈ | approximately | | docs | documentation |
|
||||
| 📁 | directory/path | | std | standard |
|
||||
| 🔢 | number/count | | def | default |
|
||||
| 📝 | text/string | | ctx | context |
|
||||
| ⚙ | setting/config | | err | error |
|
||||
| 🎛 | control/flags | | exec | execution |
|
||||
| 🔧 | configuration | | qual | quality |
|
||||
| 📋 | group/category | | rec | recovery |
|
||||
| 🚨 | critical/urgent | | sev | severity |
|
||||
| ⚠ | warning/caution | | resp | response |
|
||||
| 🔄 | retry/recovery | | esc | escalation |
|
||||
| ✅ | success/fixed | | tok | token |
|
||||
| ❌ | failure/error | | opt | optimization |
|
||||
| ℹ | information | | UX | user experience |
|
||||
| ⚡ | fast/quick | | UI | user interface |
|
||||
| 🐌 | slow/delayed | | C | critical |
|
||||
| ✨ | complete/done | | H | high |
|
||||
| 📖 | read operation | | M | medium |
|
||||
| ✏ | edit operation | | L | low |
|
||||
| 🗑 | delete operation | | |
|
||||
|
||||
## Universal Symbols & Process Flow
|
||||
|
||||
```yaml
|
||||
Process_Flow:
|
||||
Leads_To: "→"
|
||||
Combine: "&"
|
||||
With: "w/"
|
||||
At_Location: "@"
|
||||
Greater_Than: ">"
|
||||
For_All: "∀"
|
||||
Exists: "∃"
|
||||
Therefore: "∴"
|
||||
Because: "∵"
|
||||
Equivalent: "≡"
|
||||
Approximately: "≈"
|
||||
|
||||
Status_Indicators:
|
||||
Success: "✅"
|
||||
Failure: "❌"
|
||||
Warning: "⚠"
|
||||
Information: "ℹ"
|
||||
Critical: "🚨"
|
||||
Fast: "⚡"
|
||||
Slow: "🐌"
|
||||
Progress: "🔄"
|
||||
Complete: "✨"
|
||||
|
||||
File_Operations:
|
||||
Read: "📖"
|
||||
Write: "📝"
|
||||
Edit: "✏"
|
||||
Delete: "🗑"
|
||||
Copy: "📋"
|
||||
Move: "➡"
|
||||
Create: "➕"
|
||||
Directory: "📁"
|
||||
|
||||
Control_Elements:
|
||||
Controls: "🎛"
|
||||
Configuration: "🔧"
|
||||
Settings: "⚙"
|
||||
Group: "📋"
|
||||
Count: "🔢"
|
||||
Text: "📝"
|
||||
```
|
||||
|
||||
## Standard Paths & Directories
|
||||
|
||||
@@ -23,7 +96,7 @@ Documentation_Paths:
|
||||
Task_Completed: ".claudedocs/tasks/completed/"
|
||||
Task_Cancelled: ".claudedocs/tasks/cancelled/"
|
||||
|
||||
Project_Docs:
|
||||
Project_Documentation:
|
||||
Documentation: "docs/"
|
||||
API_Docs: "docs/api/"
|
||||
User_Docs: "docs/user/"
|
||||
@@ -45,69 +118,10 @@ Git_Paths:
|
||||
Gitignore: ".gitignore"
|
||||
```
|
||||
|
||||
## File Naming Conventions
|
||||
## Standard Abbreviations & Technical Terms
|
||||
|
||||
```yaml
|
||||
Report_Files:
|
||||
Analysis_Report: "analysis-{type}-{timestamp}.md"
|
||||
Performance_Report: "performance-{date}.md"
|
||||
Security_Report: "security-scan-{timestamp}.md"
|
||||
Daily_Summary: "daily-summary-{YYYY-MM-DD}.md"
|
||||
Weekly_Trends: "weekly-trends-{YYYY-WW}.md"
|
||||
Monthly_Insights: "monthly-insights-{YYYY-MM}.md"
|
||||
|
||||
Task_Files:
|
||||
Task_Format: "{type}-{id}-{slug}.md"
|
||||
Task_ID_Format: "YYYYMMDD-HHMMSS"
|
||||
Task_Types: ["feature", "bugfix", "refactor", "docs", "test"]
|
||||
|
||||
Git_Branches:
|
||||
Task_Branch: "task/{id}-{slug}"
|
||||
Feature_Branch: "feature/{name}"
|
||||
Bugfix_Branch: "bugfix/{name}"
|
||||
Release_Branch: "release/{version}"
|
||||
|
||||
Log_Files:
|
||||
Performance_Log: "performance-{YYYY-MM-DD}.jsonl"
|
||||
Error_Log: "errors-{YYYY-MM-DD}.log"
|
||||
Audit_Log: "audit-{YYYY-MM-DD}.log"
|
||||
Debug_Log: "debug-{timestamp}.log"
|
||||
```
|
||||
|
||||
## Standard Symbols & Abbreviations
|
||||
|
||||
```yaml
|
||||
Process_Symbols:
|
||||
Leads_To: "→"
|
||||
Combine: "&"
|
||||
With: "w/"
|
||||
At_Location: "@"
|
||||
For_All: "∀"
|
||||
Exists: "∃"
|
||||
Therefore: "∴"
|
||||
Because: "∵"
|
||||
|
||||
Status_Symbols:
|
||||
Success: "✅"
|
||||
Failure: "❌"
|
||||
Warning: "⚠"
|
||||
Information: "ℹ"
|
||||
Critical: "🚨"
|
||||
Fast: "⚡"
|
||||
Slow: "🐌"
|
||||
Progress: "🔄"
|
||||
Complete: "✨"
|
||||
|
||||
File_Operations:
|
||||
Read: "📖"
|
||||
Write: "📝"
|
||||
Edit: "✏"
|
||||
Delete: "🗑"
|
||||
Copy: "📋"
|
||||
Move: "➡"
|
||||
Create: "➕"
|
||||
|
||||
Common_Abbreviations:
|
||||
Technical_Terms:
|
||||
Configuration: "cfg"
|
||||
Implementation: "impl"
|
||||
Performance: "perf"
|
||||
@@ -127,6 +141,27 @@ Common_Abbreviations:
|
||||
Execution: "exec"
|
||||
Token: "tok"
|
||||
Optimization: "opt"
|
||||
Quality: "qual"
|
||||
Severity: "sev"
|
||||
Response: "resp"
|
||||
Escalation: "esc"
|
||||
|
||||
Action_Abbreviations:
|
||||
Analyze: "anlz"
|
||||
Build: "bld"
|
||||
Deploy: "dply"
|
||||
Test: "tst"
|
||||
Configure: "cfg"
|
||||
Implement: "impl"
|
||||
Validate: "val"
|
||||
Execute: "exec"
|
||||
Optimize: "opt"
|
||||
|
||||
Severity_Levels:
|
||||
Critical: "C"
|
||||
High: "H"
|
||||
Medium: "M"
|
||||
Low: "L"
|
||||
```
|
||||
|
||||
## Standard Time & Size Limits
|
||||
@@ -161,7 +196,7 @@ Retry_Limits:
|
||||
Max_Consecutive_Failures: 5
|
||||
```
|
||||
|
||||
## Standard Priority & Severity Values
|
||||
## Standard Priority & Status Values
|
||||
|
||||
```yaml
|
||||
Priority_Levels:
|
||||
@@ -208,17 +243,18 @@ MCP_Servers:
|
||||
Magic: "mcp__magic__*"
|
||||
Puppeteer: "mcp__puppeteer__*"
|
||||
|
||||
Common_Commands:
|
||||
Git_Commands: ["status", "add", "commit", "push", "pull", "checkout", "branch", "merge"]
|
||||
Build_Commands: ["build", "test", "lint", "format", "typecheck"]
|
||||
Package_Commands: ["install", "update", "audit", "outdated"]
|
||||
|
||||
Standard_Flags:
|
||||
Universal_Flags:
|
||||
Planning: "--plan"
|
||||
Thinking: ["--think", "--think-hard", "--ultrathink"]
|
||||
Compression: ["--uc", "--ultracompressed"]
|
||||
MCP_Control: ["--c7", "--seq", "--magic", "--pup", "--all-mcp", "--no-mcp"]
|
||||
Execution: ["--dry-run", "--watch", "--interactive", "--force"]
|
||||
Quality: ["--tdd", "--iterate", "--threshold", "--validate", "--security"]
|
||||
|
||||
Common_Commands:
|
||||
Git_Commands: ["status", "add", "commit", "push", "pull", "checkout", "branch", "merge"]
|
||||
Build_Commands: ["build", "test", "lint", "format", "typecheck"]
|
||||
Package_Commands: ["install", "update", "audit", "outdated"]
|
||||
```
|
||||
|
||||
## Standard Messages & Templates
|
||||
@@ -255,17 +291,38 @@ Report_References:
|
||||
Checkpoint_Reference: "🔖 Checkpoint: {id}"
|
||||
```
|
||||
|
||||
## Standard Configuration Values
|
||||
## File Naming Conventions
|
||||
|
||||
```yaml
|
||||
Default_Settings:
|
||||
Max_Retries: 3
|
||||
Timeout_Seconds: 120
|
||||
Context_Warning_Threshold: 0.7
|
||||
Context_Critical_Threshold: 0.9
|
||||
Performance_Alert_Threshold: 30
|
||||
Token_Efficiency_Threshold: 0.5
|
||||
Report_Files:
|
||||
Analysis_Report: "analysis-{type}-{timestamp}.md"
|
||||
Performance_Report: "performance-{date}.md"
|
||||
Security_Report: "security-scan-{timestamp}.md"
|
||||
Daily_Summary: "daily-summary-{YYYY-MM-DD}.md"
|
||||
Weekly_Trends: "weekly-trends-{YYYY-WW}.md"
|
||||
Monthly_Insights: "monthly-insights-{YYYY-MM}.md"
|
||||
|
||||
Task_Files:
|
||||
Task_Format: "{type}-{id}-{slug}.md"
|
||||
Task_ID_Format: "YYYYMMDD-HHMMSS"
|
||||
Task_Types: ["feature", "bugfix", "refactor", "docs", "test"]
|
||||
|
||||
Git_Branches:
|
||||
Task_Branch: "task/{id}-{slug}"
|
||||
Feature_Branch: "feature/{name}"
|
||||
Bugfix_Branch: "bugfix/{name}"
|
||||
Release_Branch: "release/{version}"
|
||||
|
||||
Log_Files:
|
||||
Performance_Log: "performance-{YYYY-MM-DD}.jsonl"
|
||||
Error_Log: "errors-{YYYY-MM-DD}.log"
|
||||
Audit_Log: "audit-{YYYY-MM-DD}.log"
|
||||
Debug_Log: "debug-{timestamp}.log"
|
||||
```
|
||||
|
||||
## Environment & Framework Constants
|
||||
|
||||
```yaml
|
||||
Environment_Types:
|
||||
Development: "dev"
|
||||
Testing: "test"
|
||||
@@ -286,26 +343,31 @@ Supported_Frameworks:
|
||||
Testing: ["Jest", "Mocha", "Pytest", "JUnit", "Cypress", "Playwright"]
|
||||
```
|
||||
|
||||
## Cross-Reference Patterns
|
||||
## Reference System
|
||||
|
||||
```yaml
|
||||
Reference_Formats:
|
||||
Include_Reference: "@include shared/constants.yml#{section}"
|
||||
See_Reference: "@see shared/constants.yml#{section}"
|
||||
Flag_Reference: "@flags shared/constants.yml#{flag_group}"
|
||||
File_Organization:
|
||||
Constants_File: "shared/universal-constants.yml"
|
||||
Patterns_Directory: "shared/*.yml"
|
||||
Commands_Directory: "commands/*.md"
|
||||
|
||||
Common_References:
|
||||
Paths: "@include shared/constants.yml#Documentation_Paths"
|
||||
Symbols: "@include shared/constants.yml#Process_Symbols"
|
||||
Limits: "@include shared/constants.yml#Time_Limits"
|
||||
Messages: "@include shared/constants.yml#Success_Messages"
|
||||
Legend: "See Universal Legend section above"
|
||||
Symbols: "See Process Flow section above"
|
||||
Paths: "See Documentation Paths section above"
|
||||
Limits: "See Time Limits section above"
|
||||
Messages: "See Success Messages section above"
|
||||
Flags: "@include shared/universal-constants.yml#Universal_Flags"
|
||||
|
||||
Usage_Examples:
|
||||
Command_File: |
|
||||
Report location: @include shared/constants.yml#Documentation_Paths.Reports
|
||||
Success format: @include shared/constants.yml#Success_Messages.Operation_Complete
|
||||
Time limit: @include shared/constants.yml#Time_Limits.Standard_Operation
|
||||
Command_Header: |
|
||||
@include shared/universal-constants.yml#Universal_Legend
|
||||
@include shared/universal-constants.yml#Process_Flow
|
||||
Report_Location: |
|
||||
Reports: @include shared/universal-constants.yml#Documentation_Paths.Reports
|
||||
Success_Format: |
|
||||
@include shared/universal-constants.yml#Success_Messages.Operation_Complete
|
||||
```
|
||||
|
||||
---
|
||||
*Constants v1.0 - Shared values, paths, symbols, and standards for SuperClaude consistency*
|
||||
*Universal Constants v4.0.0 - Single source of truth for all SuperClaude shared values*
|
||||
@@ -205,4 +205,4 @@ Platform Adaptation:
|
||||
```
|
||||
|
||||
---
|
||||
*User experience: Human-centered design for developer productivity*
|
||||
*User experience: Human-centered design for developer productivity*
|
||||
|
||||
@@ -1,54 +0,0 @@
|
||||
# Validation Patterns
|
||||
|
||||
## Pre-Execution Checks
|
||||
|
||||
```yaml
|
||||
Always Validate:
|
||||
- Risky ops (delete, overwrite, deploy)
|
||||
- Prod changes
|
||||
- Permission escalations
|
||||
- External API calls
|
||||
|
||||
Check Sequence:
|
||||
1. Ambiguity: shared/ambiguity-check.yml
|
||||
2. Security: Path validation, secrets scan
|
||||
3. Deps: Required tools/libs exist
|
||||
4. Permissions: User has required access
|
||||
5. State: Clean working tree, no conflicts
|
||||
```
|
||||
|
||||
## Risk Assessment
|
||||
|
||||
```yaml
|
||||
Risk Score (1-10):
|
||||
Factors:
|
||||
Data loss potential: +3
|
||||
Irreversibility: +2
|
||||
Scope of impact: +2
|
||||
Security impact: +3
|
||||
|
||||
Mitigations:
|
||||
Backup available: -2
|
||||
Test coverage: -1
|
||||
Sandbox mode: -2
|
||||
|
||||
Actions by Score:
|
||||
1-3: Proceed with note
|
||||
4-6: Warn and confirm
|
||||
7-9: Require explicit approval
|
||||
10: Block execution
|
||||
```
|
||||
|
||||
## Integration
|
||||
|
||||
```yaml
|
||||
Commands:
|
||||
Include: shared/validation.yml
|
||||
Call: validate_pre_execution()
|
||||
|
||||
Auto-Trigger:
|
||||
- Git push/force operations
|
||||
- File deletions
|
||||
- Database migrations
|
||||
- Production deployments
|
||||
```
|
||||
@@ -1,138 +0,0 @@
|
||||
# Workflow Chain Patterns
|
||||
|
||||
## Command Chaining & Orchestration
|
||||
|
||||
```yaml
|
||||
Chain Types:
|
||||
Sequential: A→B→C (linear progression)
|
||||
Parallel: A&B&C (concurrent execution)
|
||||
Conditional: A&&B||C (success/failure paths)
|
||||
Loop: A→B→(condition)→A (iterative workflows)
|
||||
|
||||
Context Propagation:
|
||||
Analysis Results: analyze→build|design|improve (use findings)
|
||||
Design Patterns: design→build|document (apply arch)
|
||||
Test Results: test→improve|deploy (use coverage/results)
|
||||
Error Context: troubleshoot→improve|fix (use root cause)
|
||||
```
|
||||
|
||||
## Predefined Workflow Chains
|
||||
|
||||
```yaml
|
||||
Dev Workflows:
|
||||
New Feature:
|
||||
Chain: load→analyze→design→build→test→scan→deploy
|
||||
Flags: --think for analysis, --magic for UI, --pup for E2E
|
||||
Context: Each step uses previous outputs
|
||||
|
||||
Bug Fix:
|
||||
Chain: troubleshoot --investigate → troubleshoot --fix → test → commit
|
||||
Flags: --think-hard for complex bugs, --seq for root cause
|
||||
Context: Investigation findings guide fix implementation
|
||||
|
||||
Code Review:
|
||||
Chain: analyze --code → improve --quality → scan --validate → test
|
||||
Flags: --think for comprehensive review
|
||||
Context: Analysis results guide improvements
|
||||
|
||||
Quality Workflows:
|
||||
Performance Optimization:
|
||||
Chain: analyze --profile → improve --performance → test → measure
|
||||
Flags: --iterate --threshold 90% for continuous improvement
|
||||
Context: Profile results guide optimization targets
|
||||
|
||||
Security Hardening:
|
||||
Chain: scan --security → improve --quality → scan --validate → test
|
||||
Flags: --owasp for comprehensive security scanning
|
||||
Context: Security findings drive improvements
|
||||
|
||||
Tech Debt Reduction:
|
||||
Chain: analyze --architecture → improve --quality → design → refactor
|
||||
Flags: --think-hard for architectural analysis
|
||||
Context: Debt analysis guides refactoring strategy
|
||||
|
||||
Deployment Workflows:
|
||||
Safe Production Deploy:
|
||||
Chain: test --coverage → scan --validate → deploy --env staging → deploy --env prod
|
||||
Flags: --plan for production deployment
|
||||
Context: All gates must pass before production
|
||||
|
||||
Emergency Rollback:
|
||||
Chain: deploy --rollback → troubleshoot --investigate → git --checkpoint
|
||||
Flags: --ultrathink for critical analysis
|
||||
Context: Preserve state for post-incident analysis
|
||||
|
||||
Blue-Green Deployment:
|
||||
Chain: build → test → deploy --env blue → validate → switch-traffic → monitor
|
||||
Flags: --think-hard for deployment strategy
|
||||
Context: Health checks determine traffic switching
|
||||
```
|
||||
|
||||
## Chain Execution Rules
|
||||
|
||||
```yaml
|
||||
Success Propagation:
|
||||
Continue: If command succeeds, pass context to next
|
||||
Enhanced: Successful results enhance subsequent commands
|
||||
Cache: Store intermediate results for reuse
|
||||
|
||||
Failure Handling:
|
||||
Stop: Critical failures halt the chain
|
||||
Retry: Transient failures trigger retry with backoff
|
||||
Fallback: Use alternative command or skip non-critical steps
|
||||
Recovery: Automatic rollback for deployments
|
||||
|
||||
Context Management:
|
||||
Session: Keep context for entire workflow chain
|
||||
Handoff: Pass specific results between commands
|
||||
Cleanup: Clear context after chain completion
|
||||
Checkpoint: Save state at critical points
|
||||
|
||||
Performance Optimization:
|
||||
Parallel: Execute independent commands concurrently
|
||||
Skip: Avoid redundant operations based on context
|
||||
Cache: Reuse expensive analysis results
|
||||
Smart: Use previous results to inform decisions
|
||||
```
|
||||
|
||||
## Chain Monitoring & Reporting
|
||||
|
||||
```yaml
|
||||
Progress Tracking:
|
||||
Status: Show current step and overall progress
|
||||
Time: Estimate remaining time based on historical data
|
||||
Bottlenecks: Identify slow steps for optimization
|
||||
|
||||
Error Reporting:
|
||||
Point of Failure: Exact command and context where chain failed
|
||||
Recovery Options: Available retry, rollback, or manual intervention
|
||||
Impact Assessment: What was completed vs. what failed
|
||||
|
||||
Metrics Collection:
|
||||
Duration: Total and per-step execution time
|
||||
Success Rate: Chain completion percentage by workflow type
|
||||
Resource Usage: Token consumption and tool utilization
|
||||
Quality Gates: Pass/fail rates for validation steps
|
||||
```
|
||||
|
||||
## Usage Examples
|
||||
|
||||
```yaml
|
||||
CLI Usage:
|
||||
Single Chain: /user:chain "new-feature" --think
|
||||
Custom Chain: /user:analyze → /user:build → /user:test
|
||||
Conditional: /user:test && /user:deploy || /user:troubleshoot
|
||||
|
||||
Flag Inheritance:
|
||||
Global: /user:chain "deploy" --plan --think-hard
|
||||
Specific: /user:analyze --code → /user:build --magic
|
||||
Override: Chain defaults can be overridden per command
|
||||
|
||||
Context Queries:
|
||||
Status: /user:chain-status (show current chain progress)
|
||||
Results: /user:chain-results (show accumulated context)
|
||||
History: /user:chain-history (show previous chain executions)
|
||||
```
|
||||
|
||||
---
|
||||
*Workflow chains: Orchestrated command execution with intelligent context sharing*
|
||||
Reference in New Issue
Block a user