Terraphim AI Assistant

# Terraphim AI Assistant

[![Crates.io](https://img.shields.io/crates/v/terraphim_agent.svg)](https://crates.io/crates/terraphim_agent)
[![Homebrew](https://img.shields.io/badge/homebrew-terraphim-orange?logo=homebrew)](https://github.com/terraphim/homebrew-terraphim)
[![npm](https://img.shields.io/npm/v/@terraphim/autocomplete.svg)](https://www.npmjs.com/package/@terraphim/autocomplete)
[![PyPI](https://img.shields.io/pypi/v/terraphim-automata.svg)](https://pypi.org/project/terraphim-automata/)
[![Discord](https://img.shields.io/discord/852545081613615144?label=Discord&logo=Discord)](https://discord.gg/VPJXB6BGuY)
[![Discourse](https://img.shields.io/discourse/users?server=https%3A%2F%2Fterraphim.discourse.group)](https://terraphim.discourse.group)
[![Crates.io](https://img.shields.io/crates/v/terraphim-repl.svg)](https://crates.io/crates/terraphim-repl)

Terraphim is a privacy-first AI assistant that works for you under your complete control and is fully deterministic.

## 🆕 v1.0.0 Minimal Release - NOW AVAILABLE!

**Quick Install** (works on Linux, macOS, Windows):

**Option 1: Universal Installer** (recommended)
```bash
# Single command installation with platform detection
curl -fsSL https://raw.githubusercontent.com/terraphim/terraphim-ai/main/scripts/install.sh | bash

# Install both agent and CLI tools
curl -fsSL https://raw.githubusercontent.com/terraphim/terraphim-ai/main/scripts/install.sh | bash --with-cli
```

**Option 2: Homebrew** (macOS/Linux - recommended)
```bash
# Add Terraphim tap
brew tap terraphim/terraphim

# Install server
brew install terraphim-server

# Install TUI/REPL
brew install terraphim-agent
```

**Option 3: Cargo Install**
```bash
cargo install terraphim-repl    # Interactive REPL (11 commands)
cargo install terraphim-cli     # Automation CLI (8 commands)
```

**Features**:
- 🔍 Semantic knowledge graph search
- 🔗 Smart text linking (markdown/html/wiki)
- 💾 Offline-capable (embedded defaults)
- ⚡ Lightweight (15 MB RAM, 13 MB disk)
- 🚀 Fast (<200ms operations)

**Learn more**: [v1.0.0 Release Notes](RELEASE_NOTES_v1.0.0.md) | [Cross-Platform Guide](CROSS_PLATFORM_STATUS.md)

You can use it as a local search engine, configured to search for different types of content on StackOverflow, GitHub, and the local filesystem using a predefined folder, which includes your Markdown files.

Terraphim operates on local infrastructure and works exclusively for the owner's benefit.

## 🎉 v1.0.0 Major Release

We're excited to announce Terraphim AI v1.0.0 with comprehensive multi-language support:

### ✨ New Packages Available
- **🦀 Rust**: `terraphim_agent` - Complete CLI and TUI interface via crates.io
- **📦 Node.js**: `@terraphim/autocomplete` - Native npm package with autocomplete and knowledge graph
- **🐍 Python**: `terraphim-automata` - High-performance text processing library via PyPI

### 🚀 Quick Installation

**Universal Installer (Recommended)**
```bash
# Single command installation for all platforms
curl -fsSL https://raw.githubusercontent.com/terraphim/terraphim-ai/main/scripts/install.sh | bash
```

**Package Managers**
```bash
# Homebrew (macOS/Linux - signed & notarized binaries)
brew tap terraphim/terraphim
brew install terraphim-server  # HTTP API server
brew install terraphim-agent   # TUI/REPL interface

# Rust CLI (interactive TUI)
cargo install terraphim_agent

# Node.js package (autocomplete + knowledge graph)
npm install @terraphim/autocomplete

# Python library (high-performance text processing)
pip install terraphim-automata
```

https://github.com/terraphim/terraphim-ai/assets/175809/59c74652-bab4-45b2-99aa-1c0c9b90196b


## Why Terraphim?

There are growing concerns about the privacy of data and the sharing of individuals' data across an ever-growing list of services, some of which have questionable data ethics policies. <sup>[1],[2],[3],[4]</sup>

**Individuals struggle to find relevant information in different knowledge repositories:**

- Personal ones like Roam Research, Obsidian, Coda, and Notion.
- Team-focused ones like Jira, Confluence, and SharePoint.
- Public sources such as StackOverflow and GitHub.

Terraphim aims to bridge this gap by providing a privacy-first AI assistant that operates locally on the user's hardware, enabling seamless access to various knowledge repositories without compromising privacy. With Terraphim, users can efficiently search personal, team-focused, and public knowledge sources, ensuring that their data remains under their control at all times.

[1]: https://www.coveo.com/en/resources/reports/relevance-report-workplace
[2]: https://cottrillresearch.com/various-survey-statistics-workers-spend-too-much-time-searching-for-information/
[3]: https://www.forbes.com/sites/forbestechcouncil/2019/12/17/reality-check-still-spending-more-time-gathering-instead-of-analyzing/
[4]: https://www.theatlantic.com/technology/archive/2021/06/the-internet-is-a-collective-hallucination/619320/

## 🚀 Getting Started

### Option 1: Install fr

... (truncated)