Documentation
Everything you need to get started with ClueInterview
Getting Started
ClueInterview is a desktop application designed to help anyone prepare for or conduct technical interviews with AI assistance. Whether you're a candidate preparing for your next role or an interviewer wanting to improve your process, this guide will walk you through the setup.
Who can use ClueInterview?
- • Job Candidates: Practice technical interviews and get AI-powered feedback
- • Interviewers: Conduct structured interviews with transcription and analytics
- • Coding Bootcamp Students: Prepare for graduation interviews
- • Career Switchers: Build confidence in technical interviews
- • HR Professionals: Standardize your interview process
Before you begin:
- • Ensure you have a microphone and speakers/headphones
- • Have your resume ready in text or PDF format (optional)
- • Check your internet connection for cloud transcription and AI features
- • Prepare an API key for your preferred AI provider (OpenAI, Google Gemini, etc.)
Installation
ClueInterview is available for Windows, macOS, and Linux. Choose your platform below for detailed installation instructions.
Windows
Windows users can download the pre-built installer for the quickest setup.
- Download
ClueInterview-Setup-1.2.0.exefrom the download page - Run the installer and follow the installation wizard
- Accept the default installation location or customize it
- Launch ClueInterview from your desktop or Start menu
- Configure your resume and AI settings on first launch
Note: Windows Defender may flag the executable. Click "More info" then "Run anyway" if prompted.
macOS
macOS users can download pre-built binaries or build from source.
Option 1: Download Pre-built Application
- Download the .dmg file from the download page or releases page
- Open the .dmg file and drag ClueInterview to Applications folder
- Open Applications and double-click ClueInterview to launch
- If you see "cannot be opened because it is from an unidentified developer", right-click and select "Open"
Option 2: Build from Source
- Install Node.js 18+ from nodejs.org
- Clone the repository:
git clone https://github.com/Iamholak/clueinterview.git && cd clueinterview - Install dependencies:
npm install - Build for macOS:
npm run build:mac - Launch the app:
npm start
Linux
Linux users can download AppImage files or build from source.
Option 1: AppImage (Recommended)
- Download the .AppImage from the download page or releases page
- Make it executable:
chmod +x ClueInterview-*.AppImage - Run the application:
./ClueInterview-*.AppImage
Option 2: Build from Source
- Install dependencies:
sudo apt-get install nodejs npm git python3 build-essential - Clone the repository:
git clone https://github.com/Iamholak/clueinterview.git && cd clueinterview - Install npm packages:
npm install - Build for Linux:
npm run build:linux - Launch:
npm start
Troubleshooting: If AppImage won't run, try fuse installation: sudo apt-get install libfuse2
Building from Source
For advanced users or those on unsupported platforms, you can build ClueInterview directly from the source code. This provides full control over the build process and allows you to modify the application.
Why Build from Source?
- • Get the latest development version before official releases
- • Customize the application to your needs
- • Contribute to the project development
- • Deploy on your own infrastructure
Prerequisites
Before building, ensure you have installed:
- •Node.js 18+ - Download from nodejs.org
- •Git - Version control system for cloning the repository
- •Build Tools - Compiler and build utilities for your platform
Step-by-Step Build Guide
1. Clone the Repository
git clone https://github.com/Iamholak/clueinterview.git && cd clueinterview2. Install Dependencies
npm installThis downloads all required packages and may take a few minutes.
3. Configure Environment (Optional)
If you want to customize API keys or settings:
cp .env.example .envEdit the .env file with your preferred settings.
4. Build the Application
Choose the command for your platform:
macOS:
npm run build:macLinux:
npm run build:linuxWindows:
npm run build:win5. Run the Application
npm startThis will launch ClueInterview in development mode.
Development Mode
To run ClueInterview in development mode (useful for debugging or contributing):
npm run devThis starts the development server with hot-reload enabled. Changes to the code will automatically refresh the application.
Troubleshooting Build Issues
- Build fails: Ensure Node.js 18+ is installed and npm cache is clean (
npm cache clean --force) - Native modules error: You may need build tools. On Windows, install Visual Studio Build Tools. On Mac/Linux, install build-essential.
- Port already in use: Change the port by setting
PORT=3001 npm start
Resume Setup
Your resume helps the AI ask relevant questions tailored to your experience and skills.
Adding Your Resume
- Open ClueInterview and navigate to the Profile tab
- Click on the "Resume" section
- Paste your resume content in the text area
- Click Save to store your resume locally
Tip:
Include your professional summary, key skills, work experience, and projects. The AI will use this information to generate relevant interview questions.
Interview Settings
Configure ClueInterview to match your preferences and requirements.
Transcription Engine
Choose between cloud transcription for higher accuracy or built-in transcription for local processing.
- Cloud Transcription: Uses cloud API for better accuracy, requires internet
- Built-in: Processes transcription locally, no internet required
Stealth Mode
When enabled, your interview window is hidden from screen shares. Only others see what you want them to see.
AI Provider
Configure your preferred AI model and provider (OpenAI, Google Gemini, etc.) for interview questions.
Keyboard Shortcuts
Speed up your workflow with these keyboard shortcuts:
| Space | Send message |
| Ctrl/Cmd + K | Clear chat |
| Ctrl/Cmd + Shift + H | Hide/Show app on screen |
| Ctrl/Cmd + L | Toggle code block |
| Escape | Close settings |
Troubleshooting
Having issues? Check these common solutions:
Audio not working
Check that your microphone is connected and enabled in system settings. Restart ClueInterview and try again.
Transcription errors
Ensure your microphone is working properly and you're speaking clearly. Try switching between transcription engines in settings.
App crashes on startup
Try reinstalling the application. Remove the config files from ~/.clueinterview and restart.
AI not responding
Check your internet connection and verify your AI API key is configured correctly in settings.