A template for integrating the Echo Protocol with GitHub Copilot, creating a programming assistant that uses structured reasoning patterns to solve software development problems through intelligent chat interaction.
This repository enhances GitHub Copilot with structured reasoning capabilities:
- Echo Protocol: Modular reasoning patterns for systematic problem-solving
- GitHub Copilot Integration: Seamless activation through chat or automatic detection
- Intelligent Reasoning: AI that follows validated cognitive patterns for software development
The result is an enhanced Copilot that not only generates code, but reasons systematically about development problems, automatically applying the most appropriate reasoning pattern for your specific context.
Thought Echos are structured cognitive units that define specific reasoning processes for GitHub Copilot:
- Structured reasoning patterns that guide AI analysis and problem-solving
- Automatic activation when appropriate context is detected
- Manual invocation through direct chat requests
- Auditable processes with explicit and traceable steps
- Modular design that can be combined for complex workflows
- Automatic Detection: Copilot analyzes your questions and code context to determine when to apply specific Echo patterns
- Manual Activation: You can explicitly request an Echo (e.g., "Run the diagnostic echo on this error")
- Structured Output: Each Echo follows a systematic approach with defined steps and validation criteria
- Contextual Adaptation: Echos adapt their analysis to your specific programming language, framework, and problem domain
This template includes echos especially useful for programming:
| Echo | Description | Use in Development |
|---|---|---|
| π οΈ Diagnostic | Technical analysis to detect the root of a problem | Debug, troubleshooting, error analysis |
| π§ Planning | Step-by-step structure for learning or execution | Software architecture, project roadmaps |
| π§ͺ Evaluation | Critical evaluation with explicit criteria | Code review, quality analysis, validation |
| βοΈ Optimization | Refactor without losing original intention | Refactoring, performance improvement |
| β Coherence | Self-correction when losing focus | Maintain code consistency |
| π’ Prioritization | Order alternatives with decision criteria | Feature management, bug prioritization |
Get started in seconds with automatic installation:
# Unix/macOS/Linux
curl -sSL https://raw.githubusercontent.com/beogip/echos-copilot/main/install.sh | bash# Windows PowerShell
Invoke-WebRequest -Uri "https://raw.githubusercontent.com/beogip/echos-copilot/main/install.ps1" -OutFile "install.ps1"; .\install.ps1# Node.js (Cross-platform)
curl -sSL https://raw.githubusercontent.com/beogip/echos-copilot/main/install.js | nodeπ Need detailed installation instructions? See the Installation Guide for comprehensive setup options, troubleshooting, and advanced configuration.
Once installed, GitHub Copilot will automatically load the Echo instructions. You can activate Echos in two ways:
Ask GitHub Copilot to use a specific Echo directly in your conversation:
"Run the diagnostic echo to analyze this performance issue"
"Execute the planning echo for implementing user authentication"
"Apply the evaluation echo to review this API design"
GitHub Copilot will automatically choose and execute the appropriate Echo based on your question or code context:
"This function is running slowly, help me understand why"
β Copilot automatically applies the diagnostic echo
"I need to refactor this module safely"
β Copilot automatically applies the planning + optimization echos
| Echo Type | Purpose | Example Usage |
|---|---|---|
| Diagnostic | Analyze and debug problems | "Run diagnostic echo on this error" |
| Planning | Create structured plans | "Use planning echo for this feature" |
| Evaluation | Review code and proposals | "Apply evaluation echo to this code" |
| Optimization | Improve efficiency | "Execute optimization echo here" |
| Coherence | Verify consistency | "Run coherence echo on this module" |
| Prioritization | Rank tasks and features | "Use prioritization echo for backlog" |
echos-copilot/
βββ .github/
β βββ copilot-instructions.md # Complete instructions (comprehensive mode)
β βββ instructions/ # Individual instruction files (default mode)
βββ build/ # Build system and automation
βββ instructions-source/ # Source templates for instruction generation
βββ examples/ # Usage examples in multiple languages
βββ ai-assistant/ # Development context and planning
βββ install.sh # Cross-platform installer
Generate customized instructions from modular sources:
npm install # Install dependencies
npm run build # Build all instruction formats
npm run build:watch # Development mode with auto-rebuildRun comprehensive tests with optimized performance monitoring:
# Complete test suite
npm test # Run all tests (same as npm run test:all)
npm run test:all # Complete testing suite
# Individual test categories
npm run test:edge # Edge case tests (optimized with timing)
npm run test:installer # Installer functionality tests
npm run test:integration # Integration tests
npm run test:unit # Unit tests
# Specialized test modes
npm run test:edge-only # Only edge cases via test runner
npm run test:quick # Quick validation (installer + unit tests)
npm run test:verbose # Detailed output with additional loggingπ§ͺ Optimized Edge Cases: The edge case tests now include performance monitoring, reduced code duplication (75% less), and cross-platform compatibility for macOS/Linux.
Validate all YAML echo files or a single file for schema and formatting:
# Validar todos los archivos .yaml en echos-sources/
npx ts-node scripts/validate-prs-yaml.ts
# Validar un solo archivo especΓfico
e.g.
npx ts-node scripts/validate-prs-yaml.ts echos-sources/creativity/creativity-divergent.prs.es.yaml- El validador reporta errores de formato, raΓz de objeto y sintaxis YAML.
- Γtil para CI/CD, revisiΓ³n de PRs y desarrollo local.
- Edit sources in
instructions-source/ - Add custom echos with YAML files
- Rebuild:
npm run build - Test with your Copilot setup
π Full development documentation available in
instructions-source/README.md
- Structured reasoning about complex problems
- More systematic debugging process
- More consistent code reviews
- Clearer architecture planning
- Shared thinking patterns
- More structured communication about technical decisions
- More effective onboarding with clear processes
- Documentation of architectural decisions
- Traceability of technical decisions
- More predictable maintenance
- Safer refactoring
- More manageable technical debt
Your request:
"This login function fails intermittently in production. Run the diagnostic echo to help me understand why."
Copilot with Diagnostic Echo will:
- Isolate the intermittent failure pattern
- Collect symptoms (timing, frequency, user patterns)
- Form technical hypotheses (token timing, race conditions, etc.)
- Prioritize most likely causes
- Propose specific tests to verify
async function authenticateUser(credentials) {
// Copilot provides structured analysis of potential issues:
// - Race conditions in token validation
// - Database connection timeouts
// - Network latency patterns
// With specific testing recommendations
}Your request:
"I need to implement a distributed cache system. Use the planning echo to structure this."
Copilot with Planning Echo will:
- Clarify objectives (performance targets, scalability requirements)
- Analyze current context and constraints
- Diagnose current state (existing session management)
- Detect obstacles (consistency, network partitions)
- Define execution modules (cache layer, invalidation, monitoring)
- Create progress tracking (metrics, validation points)
class CacheManager:
# Copilot provides structured implementation plan:
# - Module breakdown with dependencies
# - Performance benchmarks and validation
# - Risk mitigation strategies
# - Testing and rollout approach- Fork the repository
- Create a feature branch
- Add or improve echo patterns
- Include usage examples
- Submit a pull request
- π¦ Installation Guide - Detailed setup and troubleshooting
- Echo Protocol Repository - Complete protocol documentation
- GitHub Copilot Docs - Official Copilot documentation
MIT License - Use freely in your projects.
Ready to enhance your coding with structured reasoning? π§ π
Install now and start using Echo patterns in your development workflow.