Metadata-Version: 2.4
Name: ctxvault
Version: 0.1.4
Summary: CtxVault is a local-first knowledge vault that indexes your documents, generates embeddings, and enables fast semantic search via CLI or API. Designed for personal knowledge bases, RAG pipelines, and AI agents.
Author-email: Filippo Venturini <filippoventurini00@gmail.com>
License: MIT
Project-URL: Homepage, https://github.com/Filippo-Venturini/ctx-vault
Project-URL: Repository, https://github.com/Filippo-Venturini/ctx-vault
Project-URL: Issues, https://github.com/Filippo-Venturini/ctx-vault/issues
Keywords: rag,retrieval-augmented-generation,semantic-search,embeddings,vector-database,chroma,llm,ai,knowledge-base,document-search,local-ai,developer-tools,cli,fastapi
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Classifier: Topic :: Database
Classifier: Topic :: Text Processing :: Indexing
Classifier: Topic :: Utilities
Classifier: Environment :: Console
Classifier: Framework :: FastAPI
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: typer>=0.20.0
Requires-Dist: chromadb>=1.3.0
Requires-Dist: sentence-transformers>=5.0.0
Requires-Dist: fastapi>=0.124.0
Requires-Dist: uvicorn>=0.38.0
Requires-Dist: python-dotenv>=1.2.0
Requires-Dist: pydantic>=2.12.0
Requires-Dist: rich>=14.0.0
Requires-Dist: pypdf>=6.0.0
Requires-Dist: python-docx>=1.0.0
Requires-Dist: markdown>=3.0.0
Requires-Dist: strip-tags>=0.5.0
Requires-Dist: build>=1.0.0
Requires-Dist: twine>=5.0.0
Provides-Extra: dev
Requires-Dist: pytest>=9.0.0; extra == "dev"
Requires-Dist: pytest-mock>=3.15.0; extra == "dev"
Requires-Dist: pytest-anyio>=0.0.0; extra == "dev"
Requires-Dist: black>=25.0.0; extra == "dev"
Requires-Dist: isort>=7.0.0; extra == "dev"
Requires-Dist: pre-commit>=3.5.0; extra == "dev"
Dynamic: license-file

# CtxVault

Local semantic search vault for LLMs.

CtxVault lets you index documents locally, generate embeddings, and query them with semantic search.  
Designed as a lightweight RAG backend for agents, scripts, and LLM workflows.

## Why CtxVault

- 100% local (no cloud, no data sharing)
- simple CLI
- works offline
- persistent vector store (Chroma)
- file-based workflow
- agent/API ready (future)

Ideal for:
- personal knowledge bases
- private documents
- local RAG pipelines
- AI agents needing contextual memory

---

## Install

Python 3.10+

```bash
pip install -e .
````

---

## Quickstart

Initialize a vault:

```bash
ctxvault init ./my-vault
```

Index files or folders:

```bash
ctxvault index ./my-vault/docs
```

Query:

```bash
ctxvault query "what is project Orion?"
```

---

## CLI Commands

### init

Initialize a vault directory.

```bash
ctxvault init <path>
```

---

### index

Index a file or directory.

```bash
ctxvault index <path>
```

---

### query

Semantic search inside the vault.

```bash
ctxvault query "<text>"
```

---

### delete

Remove a document from the vault.

```bash
ctxvault delete <path>
```

---

### reindex

Reindex a document after changes.

```bash
ctxvault reindex <path>
```

---

### list

List indexed documents.

```bash
ctxvault list
```

---

## Privacy

All processing happens locally.
No data is sent to external services.

---

## Roadmap

* [x] CLI MVP
* [ ] FastAPI server
* [ ] sync and file watcher
* [ ] multi-vault support

---

## License

MIT
