everything-ai-chat  by MaskerPRC

AI-powered file search client

Created 1 month ago
597 stars

Top 54.7% on SourcePulse

GitHubView on GitHub
Project Summary

A modern, AI-powered desktop client for the Everything file search engine, designed to bridge the gap between natural language queries and precise file system searches. It targets users who frequently search for files and want a more intuitive, efficient experience than traditional command-line or basic GUI search tools. The primary benefit is significantly faster and simpler file discovery through AI-assisted query translation and a streamlined user interface.

How It Works

The application leverages Electron for a cross-platform desktop interface, with a Vue 3 frontend for a modern UI and a Node.js backend. It integrates with the Everything search engine via its HTTP API. A key feature is its AI-powered natural language processing, which translates user queries like "PDFs modified today" into Everything's specific search syntax. This is achieved by integrating with OpenAI's GPT models. For users without AI configured, it offers local query optimization.

Quick Start & Requirements

  1. Install Everything: Download and install Everything (v1.4.1+), ensuring the HTTP server is enabled in Tools -> Options -> General.
  2. Clone Repository: git clone https://github.com/MaskerPRC/everything-ai-chat.git
  3. Install Dependencies: npm install
  4. Run: npm run dev (development) or npm run build:electron followed by running the executable (production).
  5. Prerequisites: Windows 7/8/10/11, Everything software (v1.4.1+), Node.js 16+. OpenAI API key is optional for AI features.

Highlighted Details

  • AI-powered natural language to Everything search syntax conversion using OpenAI GPT-3.5/4.
  • Automated Everything connection, including multi-strategy location detection and process management.
  • Modern UI with a customizable title bar, real-time status display, and search history.
  • Supports Everything's advanced search syntax for file size, date, and path filtering.

Maintenance & Community

The project is actively maintained by MaskerPRC. Community interaction is encouraged via GitHub Issues for bug reports and feature requests, and GitHub Discussions for technical conversations. An email is provided for urgent issues.

Licensing & Compatibility

The project is licensed under the MIT License, which permits commercial use and modification.

Limitations & Caveats

The AI features require an OpenAI API key and incur associated costs. While the project aims for broad compatibility, specific issues with Everything's HTTP service or port conflicts might require troubleshooting. Some advanced UI features like search result virtualization and dark/light theme support are listed as planned.

Health Check
Last Commit

1 week ago

Responsiveness

Inactive

Pull Requests (30d)
4
Issues (30d)
12
Star History
375 stars in the last 30 days

Explore Similar Projects

Starred by Chip Huyen Chip Huyen(Author of "AI Engineering", "Designing Machine Learning Systems") and Simon Willison Simon Willison(Coauthor of Django).

semantra by freedmand

0.1%
3k
CLI tool for semantic document search
Created 2 years ago
Updated 1 year ago
Feedback? Help us improve.