task-engine-ai-core
Version:
Revolutionary AI-driven task management system with complete transformation trilogy: Frontend v0.1.0, Backend v0.2.0, CLI v0.3.0 - Enterprise-grade performance with 95% improvements
155 lines (113 loc) ⢠3.33 kB
Markdown
# IDE Bridge Quick Start Guide
Get Task-engine working with your IDE's built-in AI agent in just a few minutes!
## š Quick Setup (3 steps)
### 1. Check Prerequisites
```bash
task-master migrate-to-ide --check-prereqs
```
This will verify:
- ā
Node.js version (>=18)
- ā
WebSocket package installed
- ā
Task-engine configuration exists
- ā
IDE detection working
### 2. Run Migration
```bash
task-master migrate-to-ide
```
Follow the interactive wizard to:
- Choose migration mode (gradual recommended)
- Auto-detect your IDE (Cursor, VS Code, Windsurf)
- Configure WebSocket bridge
- Start bridge server automatically
### 3. Test Your Setup
```bash
task-master generate-text "Hello from my IDE!"
```
If successful, you'll see a response generated by your IDE's AI agent!
## šÆ Migration Modes
### Gradual (Recommended)
- ā
IDE as primary AI
- ā
External APIs as fallback
- ā
Safe transition
- ā
Easy rollback
### Complete
- ā
IDE only, no external APIs
- ā
Zero cost
- ā
Full independence
- ā ļø No fallback
### IDE-First
- ā
IDE for main tasks only
- ā
External APIs for research/fallback
- ā
Hybrid approach
## š§ Common Commands
```bash
# Check migration status
task-master migrate-to-ide --status
# Start bridge server
npm run bridge-start
# Check bridge status
npm run bridge-status
# Stop bridge server
npm run bridge-stop
# Rollback migration
task-master migrate-to-ide --rollback
# Check bridge health
npm run bridge-health
```
## š Troubleshooting
### Bridge Won't Start
```bash
# Check if port is in use
lsof -i :8765
# Try different port
# Edit .taskmaster/bridge-config.json
{
"bridge": {
"port": 8766
}
}
```
### IDE Not Detected
```bash
# Manual detection
npm run bridge-detect
# Set IDE type manually
# Edit .taskmaster/bridge-config.json
{
"ide": {
"type": "cursor" # or vscode, windsurf
}
}
```
### Connection Issues
```bash
# Check bridge logs
npm run bridge-logs
# Restart bridge
npm run bridge-restart
# Test connection
task-master generate-text "test"
```
## š Success Indicators
ā
**Bridge Status**: `npm run bridge-status` shows "running: true"
ā
**IDE Detection**: Shows your IDE type (cursor/vscode/windsurf)
ā
**Migration Status**: `task-master migrate-to-ide --status` shows "Migrated: ā
"
ā
**Text Generation**: `task-master generate-text "test"` works without API keys
## š Next Steps
- **Explore Features**: Try `task-master parse-prd`, `task-master add-task`, etc.
- **Configure Models**: Run `task-master models` to see available options
- **Read Full Docs**: See `docs/ide-bridge.md` for advanced configuration
- **Join Community**: Share your experience and get help
## š Rollback Anytime
If you need to go back to external APIs:
```bash
task-master migrate-to-ide --rollback
```
This will:
- ā
Restore original configuration
- ā
Stop bridge server
- ā
Re-enable external API providers
- ā
Keep your backup safe
---
**Need Help?** Check the full documentation in `docs/ide-bridge.md` or open an issue on GitHub.
**Working?** Great! You're now running Task-engine completely independently from external API providers! š