GitHub Copilot
MUR syncs patterns to GitHub Copilot via the copilot-instructions.md file.
How It Works
GitHub Copilot reads project-specific instructions from .github/copilot-instructions.md. MUR syncs your patterns there:
~/.github/
āāā copilot-instructions.md # Patterns for Copilot
Setup
# Initialize mur (if not done)
mur init
# Sync patterns to Copilot
mur sync
GitHub Copilot will automatically use these instructions when generating code.
Verify Integration
cat ~/.github/copilot-instructions.md
# Should show your patterns
mur stats
# Should show "GitHub Copilot" as a sync target
Usage
Once synced, GitHub Copilot will:
- Consider patterns when generating completions
- Follow conventions from your patterns
- Apply learned best practices
Manual Re-sync
After adding or updating patterns:
mur sync
Auto-sync
Enable automatic background sync:
mur sync auto enable
Per-Project Instructions
You can also add project-specific instructions in your repository:
# In your project root
mkdir -p .github
echo "# Project-specific instructions" > .github/copilot-instructions.md
MUR's global instructions complement project-specific ones.
Troubleshooting
Patterns not being used
- Ensure Copilot is enabled in VS Code/IDE
- Check file exists:
cat ~/.github/copilot-instructions.md - Restart your IDE
Too many patterns
MUR truncates patterns to fit Copilot's context. High-effectiveness patterns are prioritized.