freak-v
v1.0.0
Published
FREAK Voice Monitor - AI project initialization with voice feedback and auto-fixing
Maintainers
Readme
FREAK-V 🎤
Voice-enabled AI project initialization with auto-fixing and monitoring
🚀 Quick Start
# Initialize any project with voice capabilities
npx freak-v
# Start with monitor running
npx freak-v --start✨ Features
- 🎤 Voice Feedback: Real-time audio status updates using ElevenLabs TTS
- 🔧 Auto-Fix: Automatically detects and fixes project structure issues
- 👁️ Continuous Monitoring: Watches project health every 6 seconds
- 🗣️ Talking Monitor: Speaks about system status, fixes, and health updates
- ⚡ Zero Config: Works out of the box with sensible defaults
📋 Requirements
- Node.js 18+
- Python 3.9+
- ElevenLabs API Key (for voice features)
🔧 Setup
Run FREAK-V initialization:
npx freak-vInstall Python dependencies:
pip install elevenlabs pygameSet your ElevenLabs API key in
config.ini:[elevenlabs] api_key = your-api-key-hereTest voice system:
python3 test-voice-working.pyStart talking monitor:
python3 freak-talking-monitor.py
🎵 Voice Features
What the system says:
- Startup: "FREAK talking monitor starting up! Voice system initialized!"
- Issues found: "Alert! Found 3 issues. Fixing them now!"
- Fixes completed: "All issues resolved! System is healthy again!"
- Health updates: "Status update: Completed 25 monitoring cycles. Everything looks good!"
- Shutdown: "FREAK talking monitor shutting down. Goodbye!"
Voice Configuration
Edit config.ini to customize:
[elevenlabs]
enabled = true
api_key = your-api-key-here
voice = EXAVITQu4vr4xnSDxMaL # Female voice ID
model = eleven_multilingual_v2
stability = 0.5
similarity_boost = 0.75🏗️ Project Structure
FREAK-V creates this structure:
your-project/
├── FR3K.md # Project configuration
├── config.ini # Voice and monitor settings
├── freak-talking-monitor.py # Voice monitoring system
├── test-voice-working.py # Voice test script
├── .fr3k/
│ ├── fr3k.json # Project metadata
│ ├── commands/ # Custom commands
│ ├── agents/ # AI agent configs
│ └── hooks/ # Quality hooks
└── docs/
├── prd/ # Product requirements
├── architecture/ # System design
├── stories/ # User stories
└── qa/ # Quality assessments🔧 Monitoring Features
The talking monitor:
- ✅ Checks project structure every 6 seconds
- ✅ Auto-creates missing directories and files
- ✅ Provides voice feedback on all actions
- ✅ Logs all activity to console and files
- ✅ Graceful shutdown with voice confirmation
🎯 Use Cases
- AI Project Initialization: Quick setup for AI/ML projects
- Voice-Enabled Development: Audio feedback during development
- Continuous Project Health: Monitoring and auto-fixing
- Accessibility: Audio-first development experience
- Demo Projects: Impressive voice-enabled project showcases
🛠️ Commands
# Basic initialization
npx freak-v
# Initialize and start monitor
npx freak-v --start
# Test voice system
python3 test-voice-working.py
# Start monitor manually
python3 freak-talking-monitor.py
# Stop monitor
Ctrl+C (will announce shutdown)🔊 Troubleshooting
No voice output:
- Check ElevenLabs API key in
config.ini - Verify Python packages:
pip install elevenlabs pygame - Test with:
python3 test-voice-working.py
Monitor not starting:
- Check Python 3.9+ installed
- Verify project structure exists
- Check file permissions
Voice quality issues:
- Try different voice IDs in config
- Adjust stability/similarity_boost values
- Check internet connection for ElevenLabs API
📄 License
MIT License - Feel free to use in your projects!
🚀 About FREAK
FREAK-V is pronounced "FREAK" (not F-R-3-K). It's a voice-enabled project initialization system that makes AI development more accessible and engaging through audio feedback.
🎉 Ready to make your projects talk? Run npx freak-v and get started!
