Thanks to visit codestin.com
Credit goes to github.com

Skip to content

safecorndiet/free-cluely

 
 

Repository files navigation

⚡ Free Cluely (Enhanced Fork by @safecorndiet)

A cross-platform desktop app that helps you instantly solve problems and generate answers using AI — powered by Gemini API, built with Electron, React, TailwindCSS, and Vite.

🛠️ This is an actively maintained and enhanced fork of Prat011/free-cluely with major improvements.


✨ What's New in This Fork

  • 🚫 Removed large binaries using git-filter-repo for a clean commit history
  • 🪟 Fixed Windows launcher behavior and bundling
  • 🗃️ Refactored folder structure and asset loading
  • 🐛 Bug fixes and UI polish
  • 📦 Production builds now work out of the box (release/ folder)
  • 🔧 Prepped for long-term maintainability

🚀 Quick Start Guide

🔧 Prerequisites

⚙️ Installation

git clone https://github.com/safecorndiet/free-cluely.git
cd free-cluely
npm install

Then create a .env file in the root folder and add:

GEMINI_API_KEY=your_api_key_here

🧪 Development Mode (Recommended)

Start the dev server:

npm run dev -- --port 5180

In a second terminal, launch the Electron window:

NODE_ENV=development npm run electron:dev

📦 Production Build

npm run build

The packaged desktop app will be created in the release/ folder.


🎹 Keyboard Shortcuts

Shortcut Function
Cmd/Ctrl + B Toggle app window
Cmd/Ctrl + H Take screenshot
Cmd + Enter Submit & get solution
Cmd/Ctrl + Arrows Move app window

🧠 Features

  • 🧾 AI-generated answers using screenshots + text
  • ⚙️ Built with Electron + React + TailwindCSS
  • 🖼️ Gemini API integration via .env
  • 🎯 Minimalist overlay UI with global shortcuts

🛠️ Troubleshooting

If the app doesn’t start:

  1. Make sure no other app is using port 5180:

    lsof -i :5180
    kill [PID]
  2. Clean up and reinstall dependencies:

    rm -rf node_modules package-lock.json
    npm install
  3. Ensure .env has your Gemini API key.


📸 Screenshots

App Screenshot
Smart floating overlay app with AI-powered solution fetching


💬 About This Fork

This version is maintained by @safecorndiet, focused on:

  • Performance + UX improvements
  • Clean commit history
  • Long-term project stability

Feel free to connect: [email protected]


🤝 Contributing

PRs are welcome! Please:

  • Fork this repo
  • Create a feature branch
  • Commit your changes
  • Submit a Pull Request 🙌

📜 License

Licensed under the Apache-2.0 License.


📌 Badges

Platform Maintained License Forked

About

Open Source version of Cluely

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 95.4%
  • JavaScript 2.1%
  • HTML 1.7%
  • CSS 0.8%