Skip to content

Repository files navigation

Futurnal logo

Privacy-first personal knowledge engine for understanding your digital life.

Website Quality Gates Release Pipeline MIT License GitHub Stars Python 3.11+ Tauri 2

Why Futurnal

Futurnal turns scattered personal data into a local, queryable intelligence layer.

  • Hybrid retrieval: semantic + graph + temporal
  • Local-first privacy defaults
  • Chat grounded in your own data
  • Desktop shell for search, graph, insights, and privacy controls
  • Multi-source ingestion: Obsidian, IMAP email, GitHub, local files

Core shift: from "What did I know?" to "Why do I think this?"

Quick Start

1. Prerequisites

  • Python 3.11+
  • Ollama
# macOS
brew install ollama

# Linux
curl -fsSL https://ollama.ai/install.sh | sh

# Pull a local model
ollama pull llama3.2:3b

2. Install Futurnal CLI

git clone https://github.com/ChrisRPL/Futurnal.git
cd Futurnal

python -m venv .venv
source .venv/bin/activate  # Windows: .venv\\Scripts\\activate

pip install -e .
futurnal health check

3. Add data and query

# Add a source
futurnal sources obsidian vault add /path/to/vault --name my-notes

# Ingestion status
futurnal sources obsidian vault status my-notes

# Query
futurnal search "what did I work on last week"

# Chat
futurnal chat

Desktop App

Tauri desktop shell lives in desktop/.

cd desktop
npm install
npm run tauri dev

Release artifacts are built in GitHub Actions (production-release.yml).

Architecture

Sources -> Ingestion -> PKG + Embeddings -> Hybrid Search API -> Chat / UI
  • System architecture: docs/architecture/system-architecture.md
  • Causal reasoning boundary: docs/architecture/causal-reasoning.md
  • Research notes: docs/research/README.md

Documentation

  • Docs index: docs/README.md
  • User guide: docs/user-guide/README.md
  • API reference: docs/api-reference/README.md
  • Privacy: PRIVACY.md
  • Changelog: CHANGELOG.md

Research Assets Decision

Bundled paper PDFs and converted paper dumps were removed from this repository during OSS handoff to keep clone size lean and avoid shipping large third-party artifacts. Research foundations remain documented in docs/research/ with references.

Project Status

Phase Name Status Focus
1 Archivist In progress Search, chat, PKG, connectors
2 Analyst Planned Insights, community detection, pattern analysis
3 Guide Planned Causal exploration and recommendations

Contributing

  • Read CONTRIBUTING.md
  • Follow CODE_OF_CONDUCT.md
  • Open issues for bugs and feature requests

GitHub Pages

A branded project site is included under site/ and deployable via GitHub Pages workflow:

  • Source: site/index.html
  • Workflow: .github/workflows/pages.yml
  • Live site: https://chrisrpl.github.io/Futurnal/

License

MIT. See LICENSE.

About

Private AI for Self-Discovery

Resources

Code of conduct

Contributing

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages