Free Cluely

A desktop application to help you cheat on everything.

🚀 Quick Start Guide

Prerequisites

• Make sure you have Node.js installed on your computer
• Git installed on your computer
• Either:
  • A Gemini API key (get it from Google AI Studio), OR
  • Ollama installed locally with a vision-capable model (like llama3.1:8b)

Installation Steps

1. Clone the repository:

git clone [repository-url]
cd free-cluely

2. Install dependencies:

npm install

3. Set up environment variables:

   • Create a file named .env in the root folder
   • Choose your LLM provider and add the appropriate configuration:

   Option A: Using Gemini (default)

   LLM_PROVIDER=gemini
   GEMINI_API_KEY=your_api_key_here
   

   Option B: Using Ollama

   LLM_PROVIDER=ollama
   OLLAMA_BASE_URL=http://localhost:11434
   OLLAMA_MODEL=llama3.1:8b
   

   • Save the file

Ollama Setup (if using Ollama)

If you chose to use Ollama as your LLM provider:

1. Install Ollama from ollama.ai
2. Pull the llama3.1:8b model:

   ollama pull llama3.1:8b

3. Make sure Ollama is running:

   ollama serve

4. Verify the model is available:

   ollama list

Running the App

Method 1: Development Mode (Recommended for first run)

1. Open a terminal and run:

npm run dev -- --port 5180

2. Open another terminal in the same folder and run:

NODE_ENV=development npm run electron:dev

Method 2: Production Mode

npm run build

The built app will be in the release folder.

⚠️ Important Notes

1. Closing the App:

   • Press Cmd + Q (Mac) or Ctrl + Q (Windows/Linux) to quit
   • Or use Activity Monitor/Task Manager to close Interview Coder
   • The X button currently doesn't work (known issue)

2. If the app doesn't start:

   • Make sure no other app is using port 5180
   • Try killing existing processes:

     # Find processes using port 5180
     lsof -i :5180
     # Kill them (replace [PID] with the process ID)
     kill [PID]

3. Keyboard Shortcuts:

   • Cmd/Ctrl + B: Toggle window visibility
   • Cmd/Ctrl + H: Take screenshot
   • 'Cmd/Enter': Get solution
   • Cmd/Ctrl + Arrow Keys: Move window

Troubleshooting

Note: Working to add proper support to windows and ubuntu

If you see errors:

1. Delete the node_modules folder
2. Delete package-lock.json
3. Run npm install again
4. Try running the app again using Method 1

Contribution

I'm unable to maintain this repo actively because I do not have the time for it. Please do not create issues, if you have any PRs feel free to create them and i'll review and merge it.

If you are looking to integrate this for your company, i can work with you to create custom solution. Reach out on twitter