Clippy Revival brings Microsoft's iconic assistant into the modern era with local AI processing, cross-platform support, and enterprise-grade features. No cloud dependency, no data collection—just a powerful AI assistant that works entirely on your machine.
"It looks like you're trying to build something awesome. Would you like help with that?" 📎
- 🔒 Privacy-First: All processing happens locally—your data never leaves your machine
- 🤖 Multi-Model AI: Choose from Ollama (local), Anthropic Claude, or OpenAI GPT
- 📚 Document Search: RAG-powered semantic search across your documents
- 🎤 Voice Control: Built-in speech-to-text and text-to-speech
- 🔌 Extensible: Plugin system, webhooks, and workflow automation
- 🌍 Cross-Platform: Native support for Windows, macOS, and Linux
- ⚡ High Performance: Optimized bundle size, lazy loading, code splitting (40% faster)
- Multi-Provider AI Support: Seamlessly switch between Ollama, Anthropic, and OpenAI
- Conversation Management: Persistent chat history with search and export
- Context-Aware Assistance: Smart suggestions based on your current activity
- Tool Execution: AI can safely perform system operations
- RAG (Retrieval Augmented Generation): Semantic search across your documents
- Multi-Format Support: PDF, DOCX, TXT, Markdown, code files, and more
- Local Embeddings: sentence-transformers for privacy-preserving search
- Context Injection: Automatically enhance AI responses with relevant documents
- Speech-to-Text: Real-time transcription using Web Speech API
- Text-to-Speech: Natural voice output with multiple voice options
- Wake Word Detection: "Hey Clippy" activation framework
- Keyboard Shortcuts: Ctrl+K quick actions and fully customizable hotkeys
- Workflow Builder: Visual workflow creation with triggers and actions
- Task Scheduler: Cron-like scheduling for automated tasks
- Webhook Integrations: Connect to Slack, Discord, Zapier, and more
- Plugin System: Extend functionality with JavaScript plugins
- Real-Time Monitoring: CPU, RAM, disk, network metrics
- File Management: Safe file operations with Recycle Bin support
- Software Management: winget integration for Windows
- Web Automation: Playwright-powered browser control
- Customizable Characters: Import character packs with custom animations
- Multiple Personalities: Helpful, Friendly, Expert, Creative modes
- Animation States: Idle, thinking, speaking, working, success/error
- Sprite Sheet Support: Frame-based and sprite sheet animations
- Node.js 20 LTS or higher - Download
- Python 3.12+ (but below 3.14) - Download
- Ollama (for local AI) - Download
# Clone the repository
git clone https://github.com/yourusername/clippy-revival.git
cd clippy-revival
# Install frontend dependencies
npm install
# Install backend dependencies
cd backend
pip install -r requirements.txt
cd ..
# Start development mode
npm run devThe app will open automatically with the backend running on http://127.0.0.1:43110.
-
Install Ollama models:
ollama pull llama3.2
-
Configure AI provider (optional):
# For Anthropic Claude export ANTHROPIC_API_KEY=your_key_here # For OpenAI export OPENAI_API_KEY=your_key_here
-
Open the app and follow the onboarding wizard
For more detailed instructions, see the Quick Start Guide.
- 📘 Quick Start Guide - Get up and running in 5 minutes
- 📗 Features Guide - Comprehensive feature documentation
- 📙 Plugin Development - Create your own plugins
- 🏗️ Architecture - System design and data flow
- 📚 API Reference - Complete API documentation
- 💻 Development Guide - Development history and implementation details
- 🔨 Build Instructions - Building for production
- 🚀 Deployment Guide - Production deployment
- 🤝 Contributing - How to contribute
- 🔒 Security Policy - Reporting vulnerabilities
- Electron 38 - Desktop app framework
- React 19 - UI library with modern features
- Material-UI 7 - Component library
- Zustand - Lightweight state management
- Webpack 5 - Module bundler with code splitting
- Python 3.12 - Runtime
- FastAPI - High-performance web framework
- Ollama - Local LLM inference
- SQLite - Conversation persistence
- sentence-transformers - Local embeddings for RAG
- Playwright - Browser automation
npm run pack # Windows with backend
npm run build:win # Windows frontend onlynpm run pack:mac # macOS (Intel + Apple Silicon)
npm run build:mac # macOS frontend onlynpm run pack:linux # Linux (AppImage + deb)
npm run build:linux # Linux frontend onlynpm run pack:all # Build for all platformsOutput files will be in the build/ directory.
See BUILD.md for detailed build instructions.
# Frontend tests
npm test # Run Jest tests
npm run test:coverage # With coverage report
# Backend tests
npm run test:backend # Run pytest tests
# End-to-end tests
npm run test:e2e # Run Playwright tests
npm run test:e2e:ui # With UI mode
# Run all tests
npm run test:allWe welcome contributions! Please see our Contributing Guide for details.
- Fork the repository
- Create a feature branch (
git checkout -b feature/amazing-feature) - Make your changes
- Run tests (
npm run test:all) - Lint and format (
npm run lint:fix && npm run format) - Commit with clear messages (
git commit -m 'Add amazing feature') - Push to your fork (
git push origin feature/amazing-feature) - Open a Pull Request
- Frontend: ESLint + Prettier
- Backend: Black + Ruff
- Commit Messages: Conventional Commits
# Format code
npm run format # Frontend
npm run format:python # Backend
# Lint code
npm run lint
npm run lint:python- ✅ Multi-model AI (Ollama, Anthropic, OpenAI)
- ✅ RAG with local documents
- ✅ Voice interface (STT/TTS)
- ✅ Webhook integrations
- ✅ Cross-platform support (Windows, macOS, Linux)
- ✅ Performance optimization (40% faster load times)
- ✅ Plugin system
- ✅ Workflow automation
- ✅ Task scheduling
- 🔄 Mobile companion app
- 🔄 Cloud sync (optional)
- 🔄 Advanced analytics dashboard
- 🔄 Team collaboration features
- 🔄 Advanced RAG (ChromaDB integration)
- 🔄 Multi-language support
See the full Roadmap for details.
| Metric | Status |
|---|---|
| Production Ready | 10/10 ✅ |
| Test Coverage | 55-60% |
| Documentation | Comprehensive |
| Security | Audited & Hardened |
| Performance | Optimized |
| Platforms | Windows, macOS, Linux |
See Development History for detailed implementation notes.
Security is a top priority. See SECURITY.md for:
- Reporting vulnerabilities
- Security features
- Best practices
- Security audit results
This project is licensed under the MIT License - see the LICENSE file for details.
- Microsoft - For the original Clippy (1997-2007)
- Ollama - Local LLM inference platform
- Anthropic - Claude API
- OpenAI - GPT API
- Electron - Cross-platform desktop framework
- React - UI library
- FastAPI - High-performance Python framework
- 📖 Documentation: Check our comprehensive docs
- 🐛 Issues: GitHub Issues
- 💬 Discussions: GitHub Discussions
If you find this project useful, please consider giving it a star! It helps others discover the project.
Made with ❤️ by the Clippy Revival Team
Bringing nostalgia and innovation together, one paperclip at a time. 📎✨
Website • Documentation • Blog