Desktop App
The Khoj Desktop app is a companion application that automatically syncs your local files and folders with Khoj, enabling you to chat with and search your entire knowledge base.The Desktop app keeps your files in sync automatically, so Khoj always has access to your latest documents, notes, and files.
Features
Automatic Sync
Continuously syncs selected files and folders to keep Khoj up-to-date with your latest content.
File Management
Easily add or remove files and folders from the Khoj index through a simple settings interface.
Background Operation
Runs quietly in the background, ensuring your knowledge base is always current.
Cross-Platform
Available for Windows, macOS, and Linux.
Installation
Download the App
Download the Khoj Desktop app for your operating system from khoj.dev/downloads.
Windows
.exe installermacOS
.dmg installerLinux
.AppImage or .debInstall the Application
Run the installer and follow the on-screen instructions to complete the installation.
Configuration
Khoj Cloud Setup
Generate API Key
Navigate to the Khoj Web App Settings and generate a new API key.
Self-Hosted Setup
If you’re running your own Khoj server, follow these additional configuration steps.
API Key (Optional)
If your Khoj server is not running in anonymous mode, generate and enter an API key.Leave the Khoj API Key field empty if running with anonymous mode:
Using the Desktop App
Adding Content
- Add Folders
- Add Individual Files
- Open the Khoj Desktop app settings
- Click Add Folders
- Select the folder(s) you want to sync
- Click Save to start syncing
All files within the selected folders will be recursively indexed and kept in sync.
Removing Content
To remove files or folders from Khoj:- Open the Desktop app settings
- Find the file or folder in the list
- Click the Remove button next to it
- Click Save to apply changes
Sync Status
The Desktop app shows the current sync status:- Syncing: Files are currently being uploaded and indexed
- Up to date: All files are synced with the latest version
- Error: There was an issue syncing (check your connection or API key)
Progressive Web App Alternative
You can also install the Khoj web interface as a Progressive Web App (PWA) on your desktop:Open Khoj in Chrome
Navigate to app.khoj.dev in Chrome or Edge.
The PWA provides the web interface only. To sync local files and folders, you still need the Desktop companion app.
Troubleshooting
Sync not working
Sync not working
- Verify your API key is correct
- Check your internet connection
- Ensure the Khoj server URL is correct
- Try removing and re-adding the problematic files/folders
Cannot connect to server
Cannot connect to server
For Khoj Cloud users:
- Check your internet connection
- Verify the server URL is
https://app.khoj.dev
- Ensure your Khoj server is running
- Verify the server URL and port are correct
- Check firewall settings
API key not working
API key not working
- Generate a new API key from the Settings page
- Copy the entire key (check for extra spaces)
- Paste it into the Desktop app settings
- Click Save and restart the app
High CPU or memory usage
High CPU or memory usage
This is normal during initial indexing of large file collections. Once indexing is complete, resource usage will decrease significantly.If the issue persists:
- Try syncing folders in smaller batches
- Exclude large binary files or databases
- Check for file permission issues
Supported File Types
The Desktop app can sync and index various file types:Documents
- Markdown (
.md) - PDF (
.pdf) - Text (
.txt) - Org mode (
.org)
Office Files
- Word (
.docx) - Excel (
.xlsx) - PowerPoint (
.pptx)
Other
- Images (with OCR)
- Code files
- HTML files
Next Steps
Web Client
Access Khoj from any browser
Chat Features
Learn about chat capabilities
Obsidian Plugin
Integrate with Obsidian
Search
Master natural language search