Skip to main content

FileSeek – AI-Powered Local Document Archive&Search

Project description

📌 FileSeek – AI-Powered Local Document Archivist

🚀 Fast. Private. Local. – FileSeek is a lightweight AI-powered file archive and search tool that helps you organize and retrieve documents instantly using natural language.

It runs entirely on your machine, ensuring full privacy while giving you a cyber-style experience.


🔍 Key Features

  • Smart Search – Natural language search with semantic understanding
  • Similar Document Finding – Discover related documents automatically
  • AI-Powered OCR – Extract text from images and scanned PDFs
  • Local-First – Runs fully offline for complete privacy
  • Zero Config – Works out of the box with sensible defaults
  • Real-time Monitoring – Auto-detects new and modified files

📖 Why FileSeek?

  • Blazing Fast – Semantic search in milliseconds
  • 🔒 Privacy First – No cloud, no data sharing, fully local
  • 🤖 AI-Powered – Advanced OCR and semantic understanding
  • 🪶 Lightweight – Minimal dependencies, smooth performance
  • 💻 Developer-Friendly – Clean CLI with rich terminal UI

🛠 System Requirements

Required Dependencies

Make sure you have these system packages installed:

Ubuntu/Debian:

sudo apt-get install tesseract-ocr poppler-utils libmagic1

Fedora:

sudo dnf install tesseract poppler-utils file-libs

macOS:

brew install tesseract poppler libmagic

Windows:

# Using Chocolatey (Run as Administrator)
choco install tesseract poppler libmagic

🚀 Quick Start

1️⃣ Process Documents

Add documents to the archive:

fileseek process -r /path/to/documents

Supports: PDFs, text files, images (with OCR), and scanned documents

2️⃣ Search Documents

Find documents using natural language:

fileseek search "find my notes on machine learning"

3️⃣ Find Similar Documents

Discover documents similar to a reference file:

fileseek similar /path/to/reference/file

4️⃣ Monitor for Changes

Automatically process new, modified, or deleted files:

fileseek watch /path/to/watch

5️⃣ List All Processed Documents

View all archived documents:

fileseek list

📦 Run from Source

git clone https://github.com/yourusername/fileseek.git
pip install -e .

Now you can use all commands directly:

fileseek process ~/Documents
fileseek search "find my course note on machine learning"
fileseek similar ~/Documents/project_plan.pdf
fileseek watch ~/Documents
fileseek list
fileseek validate

⚙️ Configuration

FileSeek is zero-config by default but highly customizable:

# Set custom storage location
fileseek config set storage_path=~/FileSeekData

# Enable debug logging
fileseek config set logging.level=DEBUG

# Set OCR language (ISO 639-2 codes)
fileseek config set ocr.languages=["eng","fra"]

Key Configuration Options:

  • storage_path: Where to store the document index
  • ocr.languages: Languages for OCR processing
  • search.max_results: Maximum number of search results
  • monitoring.watch_interval: File monitoring frequency

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

fileseek-0.1.0.tar.gz (38.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

fileseek-0.1.0-py3-none-any.whl (44.1 kB view details)

Uploaded Python 3

File details

Details for the file fileseek-0.1.0.tar.gz.

File metadata

  • Download URL: fileseek-0.1.0.tar.gz
  • Upload date:
  • Size: 38.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.8

File hashes

Hashes for fileseek-0.1.0.tar.gz
Algorithm Hash digest
SHA256 481edeefd1d9f5a2fd71f10b77dd1d2404037debc0409aff9840c6ec7130f6b5
MD5 62f8b594866ebec9ccf14604d53af473
BLAKE2b-256 a62cf907c0bf18ceaf36fec6a13d7768b1822d5efb337f98480adc59e39f1d50

See more details on using hashes here.

Provenance

The following attestation bundles were made for fileseek-0.1.0.tar.gz:

Publisher: publish.yml on KyrieTangSheng/file-seek

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file fileseek-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: fileseek-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 44.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.8

File hashes

Hashes for fileseek-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 1bc9de4533e29d799407250586f9117bd88c19bf52a060b3cf76f5fd47338c08
MD5 bda877f3aaf9fd4e3b024694c389302e
BLAKE2b-256 99b0c73a410474a262e23d7c3f86f68b40ace6ecdd7804a15133d1c193a89706

See more details on using hashes here.

Provenance

The following attestation bundles were made for fileseek-0.1.0-py3-none-any.whl:

Publisher: publish.yml on KyrieTangSheng/file-seek

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page