Indexly Usage Guide

Categories:
Tags:

Installation

You can install Indexly directly from PyPI:

pip install indexly

Or install all dependencies from the requirements file:

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

Windows Terminal Setup

See Customizing Windows Terminal

Windows Terminal placeholder

Basic Workflow 

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

Indexing 

indexly index '/path/to/folder'

Sample indexing

Searching 

indexly search "term"
indexly regex "pattern"

Sample Search

Exporting

The formats; .txt, .json and pdf are supported during export.

indexly search "inventory" --export-format pdf --output result.pdf
indexly search "inventory" --export-format txt --output result.txt
indexly search "inventory" --export-format json --output result.json