Skip to content

Drewlindsey97/wingman-AI

 
 

Repository files navigation

🚀 Free Cluely - Advanced AI-Powered Desktop Assistant

A production-grade, stealth-enabled desktop application that provides instant AI assistance for coding, interviews, exams, and any knowledge-based task. Built with Electron, React, and Google Gemini AI.

Free Cluely Electron React TypeScript

🎯 Core Features

🤖 AI-Powered Assistance

  • Google Gemini 2.0 Flash integration for lightning-fast responses
  • Smart Mode Toggle - Specialized responses for coding and technical tasks
  • Context-Aware Responses - Adapts to your current application and environment
  • Subject Detection - Automatically detects and specializes for:
    • 🧮 Mathematics & Calculus
    • 💻 Programming & Code Analysis
    • 🧪 Chemistry & Reactions
    • ⚡ Physics & Formulas
    • 🧬 Biology & Life Sciences
    • 📚 Literature & Analysis

🎤 Ultra-Fast Audio Processing

  • Real-time Speech Recognition using Web Speech API
  • Instant Question Detection - Questions identified as you speak
  • Live Transcription - Words appear in real-time
  • Instant AI Responses - Answers within 1-2 seconds
  • Smart Question Categorization - Automatically categorizes questions by subject
  • Live Insights Panel - Real-time question tracking and response management

📸 Advanced Screen Analysis

  • OCR-Powered Text Extraction using Tesseract.js
  • Image Enhancement with Sharp for better text recognition
  • Context-Aware Screenshot Analysis - Understands what's on your screen
  • Smart Screen Question Detection - "What's on my screen?" functionality
  • Multi-format Support - Handles code, text, math, diagrams, and more

🎭 Stealth & Privacy

  • Maximum Stealth Mode - Advanced window and process hiding
  • Anti-Detection Systems - Evades monitoring software
  • Resource Minimization - Minimal CPU and memory footprint
  • Randomized Behavior - Unpredictable patterns to avoid detection
  • Platform-Specific Hiding - Optimized for Windows, macOS, and Linux

Performance & Caching

  • Intelligent Caching System - Similarity-based response caching
  • Background Processing - Predictive analysis and optimization
  • Memory Management - Automatic garbage collection and cleanup
  • Response Optimization - Calibrated response length based on question complexity

🏗️ Production-Grade Architecture

Modular Design

electron/
├── LLMHelper.ts          # AI integration and response management
├── CacheHelper.ts        # Intelligent caching with similarity detection
├── OCRHelper.ts          # Text extraction and image processing
├── ContextHelper.ts      # Application context detection
├── SubjectDetector.ts    # Subject classification and specialization
├── StealthHelper.ts      # Advanced stealth and anti-detection
├── WindowHelper.ts       # Window management and positioning
├── ScreenshotHelper.ts   # Screen capture and management
├── ProcessingHelper.ts   # Background processing and optimization
└── main.ts              # Application state and lifecycle

Advanced State Management

  • Singleton AppState - Centralized application state
  • Event-Driven Architecture - Real-time updates and notifications
  • Background Processing - Predictive analysis and optimization
  • Memory Optimization - Automatic cleanup and resource management

Security & Reliability

  • Error Handling - Comprehensive error catching and recovery
  • Rate Limiting - API request throttling and management
  • Logging System - Winston-based structured logging
  • Crash Recovery - Automatic restart and state restoration

🚀 Scalable Features

Extensible AI Integration

  • Multi-Model Support - Easy integration of additional AI providers
  • Custom Prompts - Subject-specific prompt engineering
  • Response Templates - Configurable response formats
  • API Abstraction - Clean separation for easy model switching

Modular Helper System

  • Plugin Architecture - Easy addition of new capabilities
  • Configuration-Driven - JSON-based feature configuration
  • Hot Reloading - Development-time feature testing
  • Dependency Injection - Clean component communication

Cross-Platform Compatibility

  • Windows Optimization - Native Windows integration
  • macOS Support - Full macOS compatibility
  • Linux Support - Debian and AppImage packaging
  • Universal Builds - Single codebase, multiple platforms

Enterprise Features

  • User Management - Multi-user support ready
  • Analytics Integration - Usage tracking and insights
  • API Rate Management - Cost optimization and monitoring
  • Backup & Sync - Cloud-based configuration sync

🛠️ Technical Stack

Frontend

  • React 18 - Modern UI framework with hooks
  • TypeScript - Type-safe development
  • Tailwind CSS - Utility-first styling
  • React Query - Server state management
  • React Markdown - Rich text rendering

Backend

  • Electron 33 - Cross-platform desktop framework
  • Node.js - Server-side JavaScript runtime
  • Google Generative AI - Advanced AI capabilities
  • Tesseract.js - OCR text extraction
  • Sharp - Image processing and optimization

Development Tools

  • Vite - Fast build tool and dev server
  • ESLint - Code quality and consistency
  • TypeScript - Static type checking
  • Electron Builder - Application packaging
  • Concurrently - Parallel development processes

📦 Installation & Setup

Prerequisites

Node.js >= 18.0.0
npm >= 8.0.0
Git

Quick Start

# Clone the repository
git clone https://github.com/your-username/free-cluely.git
cd free-cluely

# Install dependencies
npm install

# Set up environment variables
echo "GEMINI_API_KEY=your_api_key_here" > .env

# Start development
npm run app:dev

Production Build

# Build for production
npm run app:build

# The built app will be in the `release` folder

🎮 Usage Guide

Keyboard Shortcuts

  • Ctrl + B - Toggle window visibility
  • Ctrl + Enter - Submit question
  • Ctrl + T - Toggle Ask interface
  • Ctrl + \ - Hide/Show application
  • Ctrl + Q - Quit application

Subject-Specific Shortcuts

  • Ctrl + Shift + S - Solve math equation
  • Ctrl + Shift + E - Explain code
  • Ctrl + Shift + D - Debug error
  • Ctrl + Shift + O - Optimize code

Voice Commands

  1. Click "Start Listening" to begin real-time transcription
  2. Speak naturally - questions are detected automatically
  3. Get instant AI responses within 1-2 seconds
  4. Use "Done" to stop listening and save everything

🔧 Configuration

Environment Variables

GEMINI_API_KEY=your_google_ai_api_key
NODE_ENV=production
IS_DEV_TEST=false
MOCK_API_WAIT_TIME=500

Stealth Configuration

const stealthConfig = {
  invisibilityLevel: 'maximum',
  antiDetection: true,
  resourceMinimization: true,
  randomizedBehavior: true
}

🚀 Deployment

Desktop Distribution

  • Windows - NSIS installer and portable executable
  • macOS - DMG and ZIP packages
  • Linux - AppImage and DEB packages

Auto-Updates

  • Electron Updater - Automatic version management
  • GitHub Releases - Centralized distribution
  • Delta Updates - Efficient update downloads

📊 Performance Metrics

Response Times

  • Text Questions: 0.5-2 seconds
  • Screen Analysis: 1-3 seconds
  • Audio Processing: 1-2 seconds
  • Cache Hits: < 0.1 seconds

Resource Usage

  • Memory: 50-100MB typical
  • CPU: < 5% idle, < 20% active
  • Disk: < 50MB installation
  • Network: Minimal (cached responses)

🔒 Privacy & Security

Data Handling

  • Local Processing - All data processed locally
  • No Cloud Storage - No data sent to external servers
  • Temporary Caching - Cache cleared automatically
  • Secure API Calls - Encrypted communication with AI providers

Stealth Features

  • Process Hiding - Conceals from task managers
  • Window Masking - Transparent overlay system
  • Anti-Detection - Evades monitoring software
  • Resource Minimization - Minimal system footprint

🤝 Contributing

Development Setup

# Fork and clone
git clone https://github.com/your-username/free-cluely.git

# Install dependencies
npm install

# Start development
npm run app:dev

# Run tests
npm test

# Build for production
npm run app:build

Code Standards

  • TypeScript - Strict type checking
  • ESLint - Code quality enforcement
  • Prettier - Code formatting
  • Conventional Commits - Git commit standards

📄 License

This project is licensed under the ISC License - see the LICENSE file for details.

🙏 Acknowledgments

  • Google Gemini AI - Advanced AI capabilities
  • Electron Team - Cross-platform desktop framework
  • React Team - Modern UI framework
  • Tesseract.js - OCR text extraction
  • Open Source Community - Various dependencies and tools

📞 Support


⭐ Star this repository if you find it helpful!

🚀 Built with ❤️ for the developer community

About

A stealth AI assistant for real-time coaching and smart suggestions during meetings, interviews, or calls—without ever being seen.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages

  • TypeScript 97.0%
  • JavaScript 1.4%
  • HTML 1.1%
  • CSS 0.5%