UNPKG

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
# 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! šŸŽ‰