Skip to content

OpenCluely is a free, open source Cluely (alternative), built for technical interviews like DSA, OAs, and CP. It offers an invisible overlay, real-time AI help, Smart Image Processing for question capture, and multi-language supportโ€”100% customizable and private.

License

Notifications You must be signed in to change notification settings

TechyCSR/OpenCluely

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

44 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

๐Ÿง  OpenCluely

Under Active Development

Core is working; improvements are shipping daily.

OpenCluely Typing Animation

OpenCluely Badge

Platform Stealth AI Speech


OpenCluely is a revolutionary AI-powered desktop application that provides invisible, real-time assistance during technical rounds.

๐ŸŽฌ Demo Video

OopenCluelyDemo.mp4

๐ŸŒŸ Why OpenCluely?

๐Ÿฅท 100% Stealth Mode

  • Invisible to Screen Sharing: Zoom, Teams, Meet, Discord
  • Process Disguise: Appears as normal system process (Terminal, Activity Monitor, Settings)
  • Click-Through Windows: Transparent overlay technology
  • Draggable UI: Move windows anywhere on screen
  • Zero Detection: Bypasses all recording software

๐Ÿš€ AI-Powered Intelligence

  • Direct Image Analysis: Screenshots are analyzed by Gemini (no Tesseract OCR)
  • Voice Commands: Optional Azure Speech (Whisper questions, get instant answers)
  • Context Memory: Remembers entire interview conversation
  • Multi-Language Support: C++, Python, Java, JavaScript, C
  • Smart Response Window: Draggable with close button

๐Ÿ–ผ๏ธ Modern UI Features

๐Ÿ“ฑ Interactive Windows

  • Floating Overlay Bar: Compact command center with camera, mic, and skill selector
  • Draggable Answer Window: Move and resize AI response window anywhere
  • Close Button: Clean ร— button to close answer window when needed
  • Auto-Hide Mic: Microphone button appears only when Azure Speech is configured
  • Interactive Chat: Full conversation window with markdown support

๐ŸŽจ Visual Design

  • Glass Morphism: Beautiful blur effects and transparency
  • Adaptive Layout: UI adjusts based on available services
  • Smart Resizing: Windows resize automatically to fit content
  • Professional Look: Mimics system applications for perfect stealth

๐ŸŽฏ Functional Overview

๐Ÿ“‹ Core Components

๐Ÿ–ฑ๏ธ Main Overlay

  • Floating command bar
  • Screenshot capture (โŒ˜โ‡งS)
  • Microphone toggle (Optional)
  • Skill selector (DSA)
  • Language picker
  • Status indicator

๐Ÿ’ฌ Interactive Chat

  • Real-time transcription
  • AI conversation
  • Markdown formatting
  • Session memory
  • Listening animations
  • Auto-scroll messages

๐Ÿ“Š Answer Window

  • Draggable interface
  • Close button (ร—)
  • Split layout for code
  • Full markdown support
  • Syntax highlighting
  • Smart content sizing

โœ… To-Do List & Development Status

๐ŸŽฏ Core Features (Completed)

  • Stealth overlay with draggable command bar and clickโ€‘through toggle
  • Screenshot capture with direct Gemini analysis (no OCR step)
  • AI response window with markdown and code highlighting
  • Global shortcuts (capture, visibility, interaction, chat, settings)
  • Session memory and chat UI
  • Language picker and DSA skill prompt
  • Optional Azure Speech integration with autoโ€‘hide mic
  • Multiโ€‘monitor and area capture APIs
  • Window binding and positioning system
  • Settings management with app icon/stealth modes

๐Ÿšง Planned Features (In Development)

  • Hidden during screen share (autoโ€‘hide all windows while screen is being shared)
  • Multiโ€‘model support (OpenAI/Anthropic/Local backends alongside Gemini)
  • Autoโ€‘typer for code snippets (paste or simulate typing into editors/IDEs)
  • Export conversation history (save sessions as markdown/PDF)
  • Performance optimizations (faster startup, reduced memory usage)
  • Enhanced stealth modes (process name randomization, deeper OS integration)

โš™๏ธ Configuration

The setup script automatically handles configuration. You only need:

# Required: Google Gemini API Key (setup script will ask for this)
GEMINI_API_KEY=your_gemini_api_key_here

# Optional: Azure Speech Recognition (add later if you want voice features)
AZURE_SPEECH_KEY=your_azure_speech_key
AZURE_SPEECH_REGION=your_region

Note: Speech recognition is completely optional. If Azure credentials are not provided, the microphone button will be automatically hidden from all interfaces.

๐Ÿš€ Quick Start & Installation

โšก Three Simple Steps (All Operating Systems)

  1. Clone the repository

    git clone https://github.com/TechyCSR/OpenCluely.git
    cd OpenCluely
  2. Get your Gemini API key (Required)

    • Visit Google AI Studio
    • Click "Create API Key"
    • Copy the key (you'll need it in step 3)
  3. Run the setup script (One command does everything!)

    ./setup.sh

That's it! The setup script will:

  • Install all dependencies automatically
  • Create and configure your .env file
  • Build the app (if needed)
  • Launch OpenCluely ready to use (if not works use npm install & then npm start)

๐Ÿ’ป Platform-Specific Notes

  • Windows: Use Git Bash (comes with Git for Windows), WSL, or any bash environment
  • macOS/Linux: Use your regular terminal
  • All platforms: No manual npm commands needed - the setup script handles everything

๐ŸŽ›๏ธ Setup Script Options

./setup.sh --build          # Build distributable for your OS
./setup.sh --ci             # Use npm ci instead of npm install
./setup.sh --no-run         # Setup only, don't launch the app
./setup.sh --install-system-deps  # Install sox for microphone (optional)

๐Ÿ”ง Optional: Azure Speech Setup (For Voice Features)

Voice recognition is completely optional. The setup script will create a .env file with just the required Gemini key. To add voice features:

  1. Get Azure Speech credentials:

    • Visit Azure Portal
    • Create a Speech Service
    • Copy your key and region
  2. Add to your .env file:

    # Already configured by setup script
    GEMINI_API_KEY=your_gemini_api_key_here
    
    # Add these for voice features (optional)
    AZURE_SPEECH_KEY=your_azure_speech_key
    AZURE_SPEECH_REGION=your_region
  3. Restart the app - microphone buttons will now appear automatically

๐ŸŽฎ How to Use

๐Ÿ–ฑ๏ธ Main Controls

Action Shortcut Description
Screenshot Capture โŒ˜โ‡งS Capture screen and analyze via Gemini (image understanding)
Toggle Speech Alt+R Start/stop voice recognition (if configured)
Toggle Visibility โŒ˜โ‡งV Show/hide all windows
Toggle Interaction โŒ˜โ‡งI or Alt+A Enable/disable window interaction
Switch to Chat โŒ˜โ‡งC Open interactive chat window
Settings โŒ˜, Open settings panel

๐ŸŽฏ Workflow

  1. Start OpenCluely โ†’ App appears as system process (Terminal/Activity Monitor)
  2. Position Windows โ†’ Drag overlay and answer windows to preferred locations
  3. Capture Questions โ†’ Use screenshot (โŒ˜โ‡งS) or voice commands
  4. Get AI Answers โ†’ Instant responses in draggable answer window
  5. Interactive Chat โ†’ Type or speak for detailed conversations
  6. Stay Stealth โ†’ All operations invisible to screen recording

๐Ÿ”ง Advanced Features

๐ŸŽจ Window Management

  • Draggable Interface: Click and drag any window to reposition
  • Auto-resize: Windows automatically adjust to content
  • Close Button: Click ร— to close answer window
  • Always on Top: Windows stay above all applications

๐Ÿง  AI Intelligence

  • Context Awareness: Remembers entire conversation
  • Code Detection: Automatically formats code blocks
  • Language Specific: Tailored responses for selected programming language
  • Session Memory: Maintains context across multiple questions
  • Image Understanding: DSA prompt is applied only for new image-based queries; chat messages donโ€™t include the full prompt
  • Multi-monitor & Area Capture: Programmatic APIs allow targeting a display and optional rectangular crop for focused analysis

๐Ÿ”Š Optional Voice Features (Azure Speech)

  • Real-time Transcription: Speak questions naturally
  • Listening Animation: Visual feedback during recording
  • Interim Results: See transcription as you speak
  • Auto-processing: Instant AI responses to voice input ]

๐Ÿงฉ Troubleshooting

Setup Issues

  • setup.sh not found or won't run

    • Make sure you're in the OpenCluely directory: cd OpenCluely
    • Make the script executable: chmod +x setup.sh
    • On Windows, use Git Bash (comes with Git for Windows)
  • Setup script stops with exit code 130

    • This means you pressed Ctrl+C. Just run ./setup.sh again
  • Node or npm not found

    • Install Node.js 18+ from nodejs.org
    • Restart your terminal and try again

App Issues

  • Electron won't start or shows blank window (Linux)

    • Try: npm run dev
    • Ensure X11/XWayland is available if running in headless environments
  • macOS screen capture doesn't work

    • Grant "Screen Recording" permission in System Settings โ†’ Privacy & Security โ†’ Screen Recording
    • Quit and relaunch the app after granting permission
  • Windows SmartScreen blocks the app

    • Click "More info" โ†’ "Run anyway" or use npm start during development
  • Microphone/voice not working

    • Voice is optional - ignore related warnings if you don't need it
    • To enable: install sox (Linux/macOS) and add Azure keys to .env
โš–๏ธ Legal & Ethics

๐Ÿ“‹ Disclaimer

OpenCluely is provided for educational and research purposes. Users are responsible for:

  • Complying with interview guidelines
  • Respecting company policies
  • Understanding legal implications
  • Using ethically and responsibly

๐Ÿ”’ Privacy

  • No data collection or telemetry
  • All processing happens locally
  • API communications are encrypted
  • Session data stays on your device

๐Ÿ“„ License

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

๐Ÿ™ Acknowledgments

  • Google Gemini: Powering AI intelligence

  • Azure Speech: Optional voice recognition

  • Electron: Cross-platform desktop framework

  • Community: Amazing contributors and feedback

  • Vysper: UI and code structure inspiration โ€” see Vysper by varun-singhh


โญ Star this repo if OpenCluely helped you ace your interviews or you vibed with it!

Made with โค๏ธ by TechyCSR

About

OpenCluely is a free, open source Cluely (alternative), built for technical interviews like DSA, OAs, and CP. It offers an invisible overlay, real-time AI help, Smart Image Processing for question capture, and multi-language supportโ€”100% customizable and private.

Topics

Resources

License

Stars

Watchers

Forks

Contributors 4

  •  
  •  
  •  
  •