localmind 0.1.0

Privacy-first local AI memory system for storing and retrieving personal knowledge and documents

🧠 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:

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:

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:

localmind init

---

🚀 First Run

Initialize LocalMind:

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:

localmind add "My Aadhaar number is 1234 5678 9123"

Example:

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.

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.

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:

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

localmind status

Shows:

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

---

🩺 Diagnose Environment

If something is not working:

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