Skip to content

CairoAC/finder

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

48 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Finder

A CLI tool for searching and chatting with your markdown files.

What it does

Search - Find text across all .md files in the current directory. Type and see results instantly. Case-insensitive, fuzzy matching, works with partial words. Matched characters are highlighted. A live preview pane shows the file content with the matched line centered. Press Enter to open in Neovim at the exact line.

Chat - Ask questions about your documents using AI. All markdown files are loaded as context, and you can chat with Gemini 2.5 Flash-Lite with streaming responses. The AI includes citations to specific lines. Press Alt+c to browse and search citations with a preview pane.

Quick Answer - Type @ followed by your question for fast answers you can read aloud in meetings. Uses RAG (BM25 via Tantivy) to find the most relevant paragraphs from your docs. Press Tab to see which sources were used. The index is cached on disk for instant startup.

Directory Picker - Press Ctrl+O to navigate to a different directory without leaving the app. Fuzzy search through parent directories (3 levels up) and subdirectories (5 levels down). Preview directory contents before switching.

Installation

cargo install --git https://github.com/CairoAC/finder.git

Update

f --update

The tool checks for updates on startup and notifies you when a new version is available.

Usage

cd ~/your-docs
f

Search Mode

Key Action
Type Search
Up/Down Navigate
Enter Open in Neovim
? Chat mode
@ Quick answer
Ctrl+O Directory picker
Esc Quit

Select text with mouse to copy to clipboard (like tmux).

Chat Mode

Press ? to chat with your documents.

Key Action
Type Write question
Enter Send
Up/Down Scroll response
Alt+c Browse citations
Ctrl+C Cancel stream
Esc Back to search

Citations Mode

Press Alt+c in chat mode to browse citations.

Key Action
Type Filter citations
Up/Down Navigate
Enter Open in Neovim
Esc Back to chat

Quick Answer

Type @ followed by a question for fast answers.

Key Action
Type Write question
Enter Send (follow-ups remember context)
Tab Toggle sources
Up/Down Navigate sources (when expanded)
Enter Open source in Neovim (when expanded)
Ctrl+N New conversation (clears history)
Ctrl+R Rebuild RAG index (clears cache)
Ctrl+C Cancel stream
Esc Back to search

Directory Picker

Press Ctrl+O to change directories.

Key Action
Type Filter directories
Up/Down Navigate
Enter Switch to directory
Esc Cancel

Chat Setup

For chat mode, add your OpenRouter API key:

echo 'OPENROUTER_API_KEY=sk-or-...' >> ~/.env

Dependencies

  • Rust 1.70+
  • Neovim
  • xclip (Linux) or clip.exe (WSL) for clipboard
  • OpenRouter API key (optional, for chat)

License

MIT

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •  

Languages