� Codex Pilot
🚀 Intelligent AI Instruction Engine for VS Code
🎯 What is Codex Pilot?
Codex Pilot is a VS Code extension that automatically loads context-aware instructions for AI assistants like GitHub Copilot, Claude, Cursor, and more. It helps you work smarter by:
- 📚 Loading the right instructions based on the file you're editing
- 🔄 Managing phased workflows with visible progress tracking
- 💡 Registering patterns you discover for future reference
- 🛡️ Enforcing security best practices with Snyk integration
✨ Features
🎯 Context-Aware Instructions
Instructions are automatically loaded based on file type using applyTo patterns:
---
applyTo: "**/*.ts"
description: "TypeScript conventions"
---
# Your instructions here...
📊 Phased Workflow Management
- Work in numbered phases with visible history
- 3 suggested next actions after each phase
- Persistent session tracking
📚 19 Built-in Templates
| Category |
Templates |
| Methodology |
Phased, TDD, Clean Code |
| Languages |
TypeScript, Python, Rust, Go, Java, C#, PHP, Ruby, SQL |
| Security |
OWASP Top 10, Snyk Integration |
| AI Agents |
Copilot, Claude, Cursor, Windsurf, Aider |
Real-time panel showing:
- Active instructions for current file
- Current phase and session
- Top discovered patterns
- Quick actions
🚀 Installation
From Marketplace
ext install AlchTech.codex-pilot
From Source
git clone https://github.com/AlchTech/Codex-Pilot.git
cd Codex-Pilot
npm install
npm run compile
# Press F5 to launch in debug mode
📋 Commands
| Command |
Description |
Codex Pilot: Initialize |
Set up Codex Pilot in current project |
Codex Pilot: Open Hub |
Open the central hub |
Codex Pilot: Install Instructions |
Install instruction templates |
Codex Pilot: Show Active |
Show active instructions for current file |
Codex Pilot: Start Session |
Start a new phased work session |
Codex Pilot: Refresh |
Refresh instructions sidebar |
⚙️ Configuration
| Option |
Default |
Description |
codexPilot.autoPrompt |
true |
Auto-prompt for initialization |
codexPilot.instructionsPath |
.github/instructions |
Instructions folder path |
codexPilot.enableSidebar |
true |
Show instructions sidebar |
📁 File Structure
your-project/
├── .github/
│ ├── copilot-instructions.md # Global Copilot instructions
│ └── instructions/ # Context-specific instructions
│ ├── typescript.instructions.md
│ ├── security.instructions.md
│ └── ...
├── .codexpilot/
│ ├── phase-history.json # Workflow history
│ └── patterns-registry.json # Discovered patterns
🔧 Supported Instruction Frontmatter
| Field |
Description |
applyTo |
Glob pattern (e.g., **/*.ts, src/**) |
description |
Short description for UI |
name |
Alternative display name |
🛡️ Security
Codex Pilot integrates with Snyk for automated security scanning:
- Scans generated code automatically
- Reports vulnerabilities in real-time
- Suggests fixes based on Snyk recommendations
🛠️ Development
npm install # Install dependencies
npm run compile # Compile TypeScript
npm run watch # Watch mode
npm run lint # Lint with Biome
npm run package # Create .vsix
🤝 Contributing
Contributions are welcome! Please see our Contributing Guide.
- Fork the repository
- Create your feature branch (
git checkout -b feature/amazing-feature)
- Commit your changes (
git commit -m 'Add amazing feature')
- Push to the branch (
git push origin feature/amazing-feature)
- Open a Pull Request
📜 License
MIT License - see LICENSE for details.
Made with ❤️ by AlchTech
