KHOJ is a Local Search Engine written in Rust

Currently only supports basic text file formats like txt, md, and pdf SOON this would support source code files like c, cpp, py, js, etc. and is not optimized for large files.

Update: Now it does

Quick Start

$ cargo run or cargo build # to build the project and use the prebuilt index
$ cargo run -- refresh or cargo build -- refresh # to refresh the index

Benchmarks

These are the benchmarks on my ryzen 7 5700

=== Indexing Benchmark ===
Indexed 859 files in 3.54s
Indexing Throughput: 242.98 files/sec
Effectively: 23.1 MB/sec

=== Search Benchmark ===
Average Search Latency: 1.68ms

=== Search Throughput Benchmark (5s) ===
Total Queries: 2600
Throughput: 518.58 QPS

Features

Performance

• Background indexing so the tool starts immediately.
• Local index stored in .finder.json for faster subsequent runs.
• Debounced input to keep the interface responsive.

Search

• Fuzzy filename matching.
• Full-text search across files.
• Results ranked by relevance, with filename matches prioritized over content matches.

Terminal UI

• Live file preview with query highlighting.
• Syntax highlighting where applicable.
• Keyboard navigation (Up/Down) and mouse support.

Configuration

• Supports .khojignore for excluding files and directories, same format as .gitignore
• Opens results in VS Code or the editor defined in environment variables.

---

Options

Option	Description
--refresh, -r	Rebuilds the index and ignores any existing .finder.json.

Editor Selection

When opening a file, Khoj checks editors in the following order:

1. code or code-insiders
2. KHOJ_EDITOR
3. EDITOR
4. nano
5. vi

To force a specific editor:

export KHOJ_EDITOR=nvim