Getting Started

Get Foxhound running on your machine in under 5 minutes.

Prerequisites

Python 3.12+
uv (Python package manager)
Ollama with mistral:7b model (for free local analysis)
OpenRouter API key (only for paid cloud analysis)

Installation

Clone the repository and install dependencies:

git clone <repo-url>
cd foxhound

All Python dependencies are managed by uv and installed automatically on first run.

Configuration

Copy the example config and edit your source paths:

cp config.example.yaml config.yaml

Email Sources

Configure email paths under deduplication.source_paths:

deduplication:
  source_paths:
    - "~/path/to/exported-emails"

Other Sources

Configure diary, meeting notes, and documents under ingestion.sources:

ingestion:
  sources:
    - type: diary
      path: "~/path/to/diary"
      entry_separator: "## "
    - type: meeting_note
      path: "~/path/to/meeting-notes"
    - type: document
      path: "~/path/to/documents"

First Run

1. Deduplicate emails (skip if no emails)

uv run python dedup.py

2. Embed all sources into ChromaDB

uv run python ingest.py

3. Explore your corpus

uv run python explore.py

4. Run your first search

uv run python query.py --semantic "important topic" --top-k 50

Next Steps

Browse Use Cases to see real-world workflows
Read Guides for detailed how-to instructions
Check Reference for all CLI options

Overview Overview