Indexly Overview

“You who searches, finds.”

Welcome to Indexly – your fast, flexible, full-text local file search engine. Powered by Python and SQLite FTS5, Indexly brings powerful content searching, tagging, exporting, and indexing to your terminal.

Works great on Windows (tested), Linux, and macOS. CLI-only for now; GUI may come later.

flowchart TD
    %% Nodes
    A["📘 Indexly Overview"]:::overview
    B["✨ Features Overview"]:::features
    C["⚙️ Configuration & Features"]:::config
    D["📖 Usage Guide"]:::usage
    E["🛠️ Developer Guide"]:::dev
    F["🏷️ Virtual Tag Detection"]:::tags
    G["🖥️ Customizing Windows Terminal"]:::terminal

    %% Links
    A --> B
    A --> C
    A --> D
    A --> E
    A --> F
    D --> G

    B -->|Dev references| E
    C -->|Profiles & advanced filters| D
    C -->|Dev references| E
    F -->|CLI usage| D
    F -->|Developer tag extension| E

    %% Styles
    classDef overview fill:#F0F8FF,stroke:#333,stroke-width:1px;
    classDef features fill:#FFFACD,stroke:#333,stroke-width:1px;
    classDef config fill:#E6E6FA,stroke:#333,stroke-width:1px;
    classDef usage fill:#F5F5DC,stroke:#333,stroke-width:1px;
    classDef dev fill:#FFE4E1,stroke:#333,stroke-width:1px;
    classDef tags fill:#F0FFF0,stroke:#333,stroke-width:1px;
    classDef terminal fill:#FFF0F5,stroke:#333,stroke-width:1px;

Table of Contents

• Features
• Installation
• Basic Usage
• Search Profiles
• Tagging
• Exporting
• Watchdog
• Advanced Options
• Developer Notes
• License & Credits

Key Highlights

• Full-text search via SQLite FTS5
• Regex & fuzzy search
• Tagging & filtering
• CSV analysis & stats
• Watchdog real-time indexing
• Export to PDF, TXT, JSON
• Developer-friendly modular CLI

For full instructions, explore Usage Guide, Config & Features, or Developer Notes.

Requirements

• Python 3.10+
• Run locally, no server needed

pip install -r requirements.txt

Or manually:

pip install nltk pymupdf pytesseract pillow python-docx openpyxl rapidfuzz fpdf2 reportlab \
beautifulsoup4 extract_msg eml-parser PyPDF2 watchdog colorama

📌 See Installation Guide for Windows tips.

Workflow Overview

flowchart LR
    A[Index files 📂] --> B[Search 🔍]
    B --> C[Filter & tag 🏷️]
    C --> D[Export results 🧾]

Related Docs

• How to Use Indexly
• Configuration & Filtering
• Developer Setup

License & Credits

Author: N. K Franklin-Gent Built with ❤️ for the curious mind. Licensed under the MIT License.