Metadata-Version: 2.4
Name: localmind
Version: 0.1.0
Summary: Privacy-first local AI memory system for storing and retrieving personal knowledge and documents
Author: Ajay Ray Samala
License: MIT License
        
        Copyright (c) 2026 Ajay Ray Samala
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
Project-URL: Homepage, https://github.com/ajayy51/localmind
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: typer
Requires-Dist: rich
Requires-Dist: sentence-transformers
Requires-Dist: numpy
Requires-Dist: faiss-cpu
Requires-Dist: rank-bm25
Requires-Dist: pymupdf
Requires-Dist: pytesseract
Requires-Dist: Pillow
Requires-Dist: python-docx
Requires-Dist: python-pptx
Requires-Dist: requests
Dynamic: license-file


# 🧠 LocalMind

**LocalMind** is a privacy-first local AI memory system that lets you store, search, and retrieve personal knowledge and documents using AI.

Unlike typical document chat tools, LocalMind allows you to store **personal information, notes, and files** and retrieve them intelligently using hybrid search and local language models.

All data stays **fully on your machine**.

---

# ✨ Features

• Store personal knowledge locally  
• Ask questions over your stored information  
• Upload and search documents  
• Hybrid retrieval (FAISS + BM25)  
• Cross-encoder reranking for better answers  
• CLI interface for quick access  
• Privacy-first design (no cloud required)

---

# 📦 Installation

Install LocalMind from PyPI:

```bash
pip install localmind
````

---

# ⚙️ Windows Setup (If `localmind` command not found)

After installing, if you see:

```
localmind: The term 'localmind' is not recognized
```

it means Python’s **Scripts folder is not in your PATH**.

### Step 1 — Find Scripts folder

Run:

```powershell
python -m site --user-base
```

Example output:

```
C:\Users\yourname\AppData\Roaming\Python\Python312
```

Your Scripts folder will be:

```
C:\Users\yourname\AppData\Roaming\Python\Python312\Scripts
```

For Windows Store Python it may be:

```
C:\Users\yourname\AppData\Local\Packages\PythonSoftwareFoundation.Python.3.12_qbz5n2kfra8p0\LocalCache\local-packages\Python312\Scripts
```

### Step 2 — Add to PATH

1. Open **Environment Variables**
2. Edit **User Path**
3. Add the Scripts folder
4. Restart PowerShell

Now the command will work:

```bash
localmind init
```

---

# 🚀 First Run

Initialize LocalMind:

```bash
localmind init
```

This command will:

1. Create LocalMind storage directories
2. Prepare the vector database
3. Check for Ollama
4. Download the recommended model (`phi3:mini`)
5. Prepare the embedding model

---

# ➕ Add Personal Knowledge

You can directly store personal information.

Example:

```bash
localmind add "My Aadhaar number is 1234 5678 9123"
```

Example:

```bash
localmind add "My passport expires in 2029"
```

LocalMind will index this information so it can be retrieved later.

---

# 📄 Upload a File

You can upload a document.

```bash
localmind upload notes.txt
```

The file will be:

1. Parsed
2. Cleaned
3. Split into chunks
4. Embedded
5. Indexed for search

---

# 📂 Scan an Entire Folder

Index multiple documents at once.

```bash
localmind scan ./documents
```

LocalMind will recursively scan the folder and index supported files.

---

# ❓ Ask Questions

After storing knowledge or uploading documents, you can ask questions.

Example:

```bash
localmind ask "What is my Aadhaar number?"
```

LocalMind will:

1. Search the knowledge base
2. Retrieve relevant information
3. Rerank results
4. Generate an answer

Example output:

```
1234 5678 9123
```

Sources used will also be displayed.

---

# 📊 Check System Status

```bash
localmind status
```

Shows:

• number of stored items
• index size
• LocalMind storage location

---

# 🩺 Diagnose Environment

If something is not working:

```bash
localmind doctor
```

This checks:

• Ollama installation
• embedding model readiness
• system environment

---

# 📄 Supported File Types

LocalMind supports:

```
.txt
.md
.csv
.log
.pdf
.docx
.pptx
```

---

# ⭐ Best Results

LocalMind works **best with clean text documents**, such as:

• `.txt`
• `.md`
• `.docx`

Documents containing **many images or scanned pages may produce weaker results**, because the system primarily processes textual content.

---

# 🔒 Privacy

All data stays **local on your device**.

LocalMind does **not send your documents or personal information to external servers**.

---

# 📜 License

MIT License

---

# 👨‍💻 Author

Ajay Ray Samala

